configureconnector

The configureconnector subcommand generates a configuration for an ICF connector.

Usage is as follows:

./cli.sh configureconnector --user username:password --name connector-name

Select the type of connector that you want to configure. The following example configures a new CSV connector:

./cli.sh configureconnector --user openidm-admin:openidm-admin --name myCsvConnector
Executing ./cli.sh...
Starting shell in /path/to/openidm
Mar 26, 2020 06:08:52 PM org.forgerock.openidm.core.FilePropertyAccessor loadProps
0. SSH Connector version 1.5.20.12
1. ServiceNow Connector version 1.5.20.12
2. Scripted SQL Connector version 1.5.20.12
3. Scripted REST Connector version 1.5.20.12
4. Scim Connector version 1.5.20.12
5. Salesforce Connector version 1.5.20.12
6. MSGraphAPI Connector version 1.5.20.12
7. MongoDB Connector version 1.5.20.12
8. Marketo Connector version 1.5.20.12
9. LDAP Connector version 1.5.20.12
10. Kerberos Connector version 1.5.20.12
11. Scripted Poolable Groovy Connector version 1.5.20.12
12. Scripted Groovy Connector version 1.5.20.12
13. GoogleApps Connector version 1.5.20.12
14. Database Table Connector version 1.5.20.12
15. CSV File Connector version 1.5.20.12
16. Adobe Marketing Cloud Connector version 1.5.20.12
17. Exit
Select [0..17]:   15
Edit the configuration file and run the command again. The configuration was saved to
  /path/to/openidm/temp/provisioner.openicf-myCsvConnector.json

The basic configuration is saved in a file named /openidm/temp/provisioner.openicf-connector-name.json. Edit at least the configurationProperties parameter in this file to complete the connector configuration. For example, for a CSV connector:

"configurationProperties" : {
    "headerPassword" : "password",
    "csvFile" : "&{idm.instance.dir}/data/csvConnectorData.csv",
    "newlineString" : "\n",
    "headerUid" : "uid",
    "quoteCharacter" : "\"",
    "fieldDelimiter" : ",",
    "syncFileRetentionCount" : 3
}

For more information about the connector configuration properties, see Configure Connectors.

When you have modified the file, run the configureconnector command again so that IDM can pick up the new connector configuration:

./cli.sh configureconnector --user openidm-admin:openidm-admin --name myCsvConnector
Executing ./cli.sh...
Starting shell in /path/to/openidm
Using boot properties at /path/to/openidm/resolver/boot.properties
Configuration was found and read from: /path/to/openidm/temp/provisioner.openicf-myCsvConnector.json

You can now copy the new provisioner.openicf-myCsvConnector.json file to your project's conf/ subdirectory.

You can also configure connectors over the REST interface, or through the Admin UI. For more information, see Configure Connectors.