Organisation LDAPConnection

From Pro 9 Wiki
Jump to navigation Jump to search

LDAP Connection

The LDAP connection is a stepped process to integrate with the AD/HVD system. The connection fetches the relevant data to be integrated in to Pro and by using a scheduled import the information is automatically updated on a regular basis.

How to - Show LDAP Connection

  1. Click the role Organization Management in the navigation tree
  2. Select Scheduled organization import > LDAP Connection
    • The view LDAP Connection is displayed

How to - Set up an LDAP Connection

Connection

  1. Enter a server name
  2. Enter a server port
    • Default server port is 389 and 636 (SSL)
  3. Enter a user name
    • Use the format domain\user name
  4. Enter a password
  5. Check the use secure connection (SSL) box if the connection uses SSL
  6. Check the auto connect box if you want to save the connection
    • The entered username and password will be saved until next time you login to Pro
    • Note: The connection is always saved in the database to be used for the automatic update
  7. Click connect to connect to the AD/HVD system
    • The refine search tab opens

Refine Search

  1. Select an domain component
  2. Select organization units:
    • Select organization units in the left column and click the arrow button Icon Move Selected.png to move the selected organization units to the right column
    • By using the double arrow button Icon Move All.png, you can move all organization units from the left column to the right column
  3. Check the only changed objects box if you only want to collect changed objects
  4. Check the add all available OU levels if you want Pro to recognize all OU levels from the AD/HVD
  5. Select object classes:
    • Select object classes in the left column and click the arrow button Icon Move Selected.png to move the selected object classes to the right column
    • By using the double arrow button Icon Move All.png, you can move all object classes from the left column to the right column
  6. Select object class filter logic
  7. Select object properties:
    • Select object properties in the left column and click the arrow button Icon Move Selected.png to move the selected object properties to the right column
    • By using the double arrow button Icon Move All.png, you can move all object properties from the left column to the right column
  8. Enter LDAP custom add-on script if you want to add a custom script
    • The custom add-on script will be added and visible in the filter script textbox
  9. Click test search filter if you want to create a test file from the AD/HVD
    • The created file will be available in the set location for import files on the server
  10. Click save and continue
    • The schedule tab opens

Schedule LDAP Connection

Set a schedule for when the file should be automatically updated from the AD/HVD.

  1. Check the enabled box if you want the schedule to be enabled
  2. Select according to what time zone the schedule times are defined
  3. Select schedule type:
    1. Recurring - Select the recurring schedule type to run regularly
      • The repeats menu defines how often the schedule is run; select monthly or weekly
      1. If you select monthly - define in the occurs menu on what day of the month the schedule is to be run
      2. If you select weekly - define on what weekday the schedule is to be run by checking the corresponding box
        • It's possible to select more than one weekday if you want to run the schedule more than once a week
      • Define the daily frequency; select Occurs once at or Occurs every
      1. Occurs once at - the schedule is run once on that day
        • Define at what time during the day the schedule is to be run
      2. Occurs every - regularly during a defined time interval during the day
        • In hours or minutes, select the frequency of how often to run the schedule during the defined time interval
      • Define the time interval by entering a time to start at and a time to end at
    2. One-time - Select the one-time schedule type to run the schedule once
      • Define the date and time for the one-time occurrence
      1. Define a date
      2. Define what time to start at
  4. Click save and continue to the data mapping if you want to continue to the data mapping view
    • The data mapping view opens
  5. Click only save schedule if you only want to save the schedule

Data Mapping

  1. Enter a name of the data mapping
  2. Select map by in the drop down list
    • Column number - If you want to map by column number
    • Column name - If you want to map by column name
    • Note: Settings for file location, file name, column name in the first data row, first data row number and column separator is generated within the LDAP connection and should not be manually updated
    1. Select to map columns
      • Select columns to map in the left column and click the arrow button Icon Move Selected.png to move the selected columns to map to the right column
      • By using the double arrow button Icon Move All.png, you can move all columns to map from the left column to the right column
      • Enter a separator value if you select multiple columns to map
  3. Click save
    • Note: All of the import columns need to be mapped to a column in the file before you click save
  4. Select if you want to create a filter and/or a modification:
  5. Click create filter
    1. Enter a name
    2. Check the active box if you want the filter to be active
    3. Select priority in the dropdown list
    4. Select to keep or discard rows that matches the following rules
    5. Enter a description
    6. Click add rule Icon Add Rule Action.png to add a rule
      • Select column, condition and value
      • Note: If you select more than one rule select to separate by and/or
    7. Click add child rule Icon Add Child Rule.png to add a child rule
    8. Click save
  6. Click create modification
    1. Enter a name
    2. Check the active box if you want the modification to be active
    3. Select priority in the dropdown list
    4. Enter a description
    5. Click add action Icon Add Rule Action.png to add an action
      • Select column, condition and result
    6. Click add action with rule Icon Add Action with Rule.png to add an action with a rule
    7. Click add child rule Icon Add Child Rule.png to add a child rule
    8. Click save
      • Open the tab filter & modifications to view, edit or change priority

Import into Pro

The information from AD/HVD system is ready to be imported into Pro, do a manual import or set up a scheduled import to be run regularly. Read more about how to schedule an import

Manual Import:

  1. Go to the settings tab
  2. Select a main group
    • Select use mapped field value if you want to use value from the data mapping
  3. Select a node
    • Select use mapped field value if you want to use value from the data mapping
  4. Select an object type
    • Select use mapped field value if you want to use value from the data mapping
  5. Select a data mappings
    • Note: Settings for file location, file name and validate is generated within the LDAP connection and should not be manually updated
  6. Run the import:
    • Click try to try the import settings
    • Click import to run the import and import updates from AD/HVD in Pro