- Create: Create a new object ( usually an account ) in a target data store.
- Update: Update an existing object e.g. if a user changes their email address then we may want to update the user record in a target data store.
- Get: Retrieve a specific instance of an object ( e.g. an account) from a target data store.
- Search: Query the collection and return a specific set of results.
- Provisioner configuration: configuration data defining the connector usually containing:
- Reference to the underlying Java class that implements the connector. This should be populated automatically when you choose your connector type. You can explore the connector source code if you like but for the most part you shouldn’t need to be concerned with the underlying classes.
- All of the credentials and configuration needed to access the data store. You need to configure this.
- The data store schema for the object or account. You need to configure this.
- Data Synchronization engine outputs data and a requested operation e.g. create, delete, update or one of several others
- Provisioner engine invokes the connector class with the requested operation and the data from the synchronization engine.
- Connector class uses the configuration parameters from the provisioner file and the data passed in the invocation to actually do the work and push or pull to or from the target.
- Header UID = id
- Header Name = username
- Header Password: We will not be processing any passwords from this CSV, that might be something you want to do, although typically you will have OpenIDM generate passwords for you ( more on that later ).
- Quote Character: If you have an unusually formatted CSV, you can change the character that surrounds your data values. This is used by OpenIDM to successfully parse the CSV file.
- Field Delimiter: Similarly if you are using a delimiter ( the character that splits up data entries ) that is anything other than a “,” you can tell OpenIDM here.
- Newline String: As above.
- Sync Retention Count: Todo
What you should be able to see if a list of all of the attributes in the CSV file. OpenIDM has automatically parsed the CSV and built a schema for interpreting the data. You may also spot “__NAME__”. This is a special attribute, and it maps to the Header Name attribute we configured earlier.
On this page you can configure LiveSync. LiveSync is a special case of synchronization. Ordinarily synchronization is performed through the mappings interface ( or automatically on a schedule ).
Connectors And The REST API
Let’s take a look at this now. Navigate back to the data accounts page from earlier:
Take a look at the URL:
As before, this corresponds to our REST API. Please fire up Postman again.
You should see the following result
http://localhost.localdomain.com:8080/openidm/system/UserLoadCSV/__ACCOUNT__?_queryFilter=/email eq “email@example.com”
Here we are searching for the user with the email address firstname.lastname@example.org.
Again, this is just a small sample of what the REST API is capable of, you can learn much more here:
And more on how queries work here: