The following table provides definitions and sample data for the settings in the inserverUR.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [General] in the order the groups appear in the INI file. Each setting offers two or more options, which are defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file.
The settings for configuring the User Replication Agent are located in the inserverUR.ini file in the Perceptive Content shared etc directory $(IMAGENOWDIR6)\etc. To change these settings, you modify this file. After modifying this file, restart Perceptive Content User Replication Agent to make the changes effective.
| Group | Setting | Options | Description |
|---|---|---|---|
| General | ldap.sync.interval | Any positive integer |
Specifies the number of hours User Replication Agent waits between synchronizations with the LDAP server. Note: If the value is set to 0 or less,
synchronization is continuous, which is CPU intensive and
dramatically effects performance.
The default is 4. Example: ldap.sync.interval=4 |
| General | ldap.login | Any text string |
Specifies the LDAP user Distinguished Name (DN) as supported by your LDAP server. Example: ldap.login=CN=Manager Note: User Replication will automatically
attempt an anonymous login if ldap.login is left blank.
|
| General | ldap.password | Any text string |
Specifies the password for the LDAP user DN. This value is encrypted and then removed from the setting after running the inserverUR -encrypt-config command. Example: ldap.password=<password> Note: User Replication Agent automatically
attempts an anonymous login if ldap.password is left
blank.
|
| General | ldap.password.encrypted | Any text string |
Specifies the encrypted password for the LDAP user DN. The password is supplied in ldap.password. Note: User Replication Agent automatically
attempts an anonymous login if ldap.password is left
blank.
|
| General | ur.strict.user.sync.mode |
0 1 |
Controls whether users who are not specified in a replication group in this INI file are removed from Perceptive Content if no corresponding user node is found in the LDAP server. 0 = User Replication Agent does not remove a user from Perceptive Content. 1 = User Replication Agent removes a user from Perceptive Content. The default is 0. Example: ur.strict.user.sync.mode=1 |
| General | ur.max.retry.attempts | Any whole number |
Specifies the number of times the agent attempts the synchronization before pausing for the interval specified in the ldap.sync.interval property. The default is 5. Example: ur.max.retry.attempts=8 |
| General | ldap.server | Any valid fully qualified domain name (FQDN) |
Specifies your LDAP server's host name. You must specify a valid fully qualified domain name. An IP address will not work. Example: ldap.server=<hostname> |
| General | ldap.server.port | Any valid port address |
Specifies your LDAP server's port, typically 636 when using TLS and 389 when not using TLS. Example: ldap.server.port=636 |
| General | ldap.use.ssl |
TRUE FALSE |
Specifies whether User Replication Agent uses TLS when connecting to the LDAP server. TRUE = User Replication Agent uses TLS when connecting to the LDAP server. FALSE = User Replication Agent does not use TLS. The default is TRUE. Example: ldap.use.ssl=TRUE |
| General | ldap.ssl.cert.path | Any valid directory |
For Linux only, specifies the path of your TLS certificates when using TLS. We recommend that certificate database files are stored in a subdirectory under /opt/inserver/etc. Example: ldap.ssl.cert.path=/opt/inserver/etc/certs |
| Logging | debug.level.file |
0 1 2 3 |
Specifies the level User Replication Agent uses to log errors for troubleshooting. 0 = Logging is off. 1 = The least verbose logging. 3 = The most verbose logging. If you set logging on a higher option for tracking or debugging, make sure that you reset it to a lower number when you are finished. Example: debug.level.file=3 The default is 0. |
| Remote | remoted |
TRUE FALSE |
Specifies whether you installed User Replication Agent on the Perceptive Content Server or on a different server. TRUE = User Replication Agent and Perceptive Content Server are installed on different servers. FALSE = User Replication Agent and Perceptive Content Server are installed on the same server. The default is FALSE. |
| Remote | server.ip.address | Any valid IP address or a semicolon delimited string of valid IP addresses. |
Specifies the IP address of Perceptive Content Server. You can supply multiple IP addresses with a semicolon delimited string. For example: 123.12.123.10;234.23.234.2;345.34.345.3. When you use a delimited list of IP addresses, Import Agent attempts to connect to the IP addresses in the order listed until it establishes a successful connection. |
| Remote | server.ip.port | Any existing port number |
Specifies the port number of the Perceptive Content Server. |
| Remote | authentication.token | Any valid token |
Specifies the authentication token to use for authentication with Perceptive Content Server. This value will be encrypted and removed from the setting after running the inserverUR -encrypt-config command. |
| Remote | authentication.token.encrypted | Any valid token |
Indicates the encrypted agent authentication token. The agent authentication token is specified in the authentication.token setting and can be encrypted by running the inserverUR -encrypt-config command. This command should be run each time the agent authentication token is updated. Do not manually update this setting. |
| Group | group.mode |
1 0 |
Specifies the method User Replication Agent uses to locate groups and their members in the LDAP directory. If you place the group.mode property in any heading section of the INI file, the agent recognizes that heading section as a group section and attempts to import users into the group. 0 = User Replication Agent searches for all entries one level below the given DN. When the query is successful, these entries are considered members of the group. Group members are based on the DN of an actual container in the LDAP directory, such as the Organizational Unit (OU). The agent searches for all entries that are one level below the container given in the property, group.dn. 1 = User Replication Agent queries the given DN for an attribute that holds the group members' DNs. Group members are based on the value of an attribute in one entry in the LDAP server. For example in Active Directory, you might use sAMAaccountName. You can use a different mode for each group section. |
| Group | group.department | Any valid string |
Specifies the department in which the group should be created. Does not support moving groups to or from other departments. This setting does not apply to existing groups. |
| Group | group.license.group | Any valid string |
Specifies the name of the license group to which users are added according to the group. Users are limited to one license group. Based on the results of an LDAP query, if a user belongs to several groups, they will remain in the license group associated with the group in which they were last discovered. |
| Group | group.dn.<number> | Any valid string. See description for details |
Specifies the DN of the container where User Replication Agent begins searching for group members in the LDAP directory. Do not use single quotes around this the value for this property. For example, avoid group.dn='OU=Marketing'. Modify the group.dn property for the DN of the container where the agent begins its search for group members in the LDAP directory. You can specify additional containers by creating additional group.dn<number> properties. Start with the number 2 and then increment each additional property by 1. For example, group.dn, group.dn.2, and group.dn.3. When configuring multiple group.dn properties, use sequential numbering. If you skip a number, any properties after that skipped property number are ignored. Example: group.dn='OU=Sales,DC=acme, DC=com' Group.dn.2=’OU=Marketing,DC=acme,DC=com’ |
| Group | group.member.login.attr | Any valid string |
Specifies the value of an attribute of a group member entry as the login and user name in Perceptive Content. If you do not enter a value, common name (CN) is used. Example: group.member.login.attr=sAMAccountName |
| Group | group.member.filter | Any valid string that complies with this format: (BooleanOperator (filter1) (filter2) (filter3)) |
If group.mode is set to 0 or 1, this property specifies groups User Replication Agent excludes from the directory. Do not use single quotes around this the value for this property. For example, avoid group.dn='OU=Marketing'. Use Boolean operators to specify filter behavior. For more information, refer to the basic operators table in the “Group operators and search filters” section. Example: group.member.filter='(sAMAccountType=805306368)' |
| Group | group.member.attr | Any valid DN |
If group.mode is set to 1, this property represents an attribute on the node specified in the group.dn. User Replication Agent uses the group.member.attr property to find the DNs that represent the users to import. Example: group.member.attr=AcctMembers |
| Group | group.member.attr.email | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's e-mail address. |
| Group | group.member.attr.external.id | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's external ID. |
| Group | group.member.attr.fax | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's fax number. |
| Group | group.member.attr.first.name | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's first name. |
| Group | group.member.attr.last.name | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's last name. |
| Group | group.member.attr.locality | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's locality. |
| Group | group.member.attr.mobile | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's mobile number. |
| Group | group.member.attr.org | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's organization. |
| Group | group.member.attr.ou | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's organizational unit. |
| Group | group.member.attr.pager | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's pager number. |
| Group | group.member.attr.phone | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's phone number. |
| Group | group.member.attr.prefix | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's prefix. |
| Group | group.member.attr.suffix | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's suffix. |
| Group | group.member.attr.title | Any valid string |
Specifies the LDAP attribute User Replication Agent imports as the user's title. |