diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ad.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ad.adoc index 7faf8fa2e..5016484d8 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ad.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ad.adoc @@ -58,23 +58,21 @@ $ cp samples/provisioners/provisioner.openicf-ad.json project-dir/conf/ ---- . Edit the Active Directory connector configuration to match your Active Directory deployment. -+ Specifically, check and edit the `configurationProperties` that define the connection details to the Active Directory server. + Also, check that the `bundleVersion` of the connector matches the version of the `ActiveDirectory.Connector.dll` in the Connector Server directory. The bundle version can be a range that includes the version of the connector bundle. To check the .dll version: + - +[open] +======== * Right click on the `ActiveDirectory.Connector.dll` file and select Properties. - * Select the Details tab and note the Product Version. +======== + - image::images/bundle-version.png[] - + The following configuration extract shows sample values for the `connectorRef` and `configurationProperties`: -+ ++ [source] ---- ... @@ -102,6 +100,7 @@ The following configuration extract shows sample values for the `connectorRef` a ---- + The main configurable properties are as follows: + + -- diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-csv.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-csv.adoc index 6c7091ea4..5cfab1cf2 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-csv.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-csv.adoc @@ -106,25 +106,25 @@ Default: `3` The CSV File Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-BatchApiOp[Batch]:: +xref:appendix-interfaces.adoc#interface-BatchApiOp[Batch]:: Execute a series of operations in a single request. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -135,13 +135,13 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -150,7 +150,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-database.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-database.adoc index f8913b506..8e579bf56 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-database.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-database.adoc @@ -32,7 +32,7 @@ A sample connector configuration for the Database Table connector is provided in The following excerpt shows the settings for the connector configuration properties in the sample Database Table connector: -[source, javascript] +[source, json] ---- "configurationProperties" : { @@ -78,22 +78,22 @@ The column value that is used as the unique identifier for rows in the table. The Database Table Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -104,13 +104,13 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -119,7 +119,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- @@ -134,10 +134,166 @@ The Database Table Connector has the following configurable properties. ==== Configuration Properties -[cols="33%,17%,16%,17%,17%"] -|=== -|Property |Type |Default |Encrypted |Required +[cols="33%,17%,16%,17%,17%", stripes=even] |=== +|Property |Type |Default |Encrypted |Required + +a| `quoting` +a| `String` +a| +a| +a| No +5+a| Select whether database column names for this resource should be quoted, and the quoting characters. By default, database column names are not quoted (None). For other selections (Single, Double, Back, or Brackets), column names will appear between single quotes, double quotes, back quotes, or brackets in the SQL generated to access the database. + +a| `host` +a| `String` +a| +a| +a| No +5+a| Enter the name of the host on which the database is running. + +a| `port` +a| `String` +a| +a| +a| No +5+a| Enter the port number on which the database server is listening.. + +a| `user` +a| `String` +a| +a| +a| No +5+a| Enter the name of the mandatory Database user with permission to access the accounts table. + +a| `password` +a| `GuardedString` +a| `null` +a| Yes +a| No + +5+a| Enter a user account that has permission to access the accounts table. + +a| `database` +a| `String` +a| +a| +a| No + +5+a| Enter the name of the database on the database server that contains the table. + +a| `table` +a| `String` +a| +a| +a| Yes + +5+a| Enter the name of the table in the database that contains the accounts. + +a| `keyColumn` +a| `String` +a| +a| +a| Yes + +5+a| This mandatory column value will be used as the unique identifier for rows in the table. + +a| `passwordColumn` +a| `String` +a| +a| +a| No + +5+a| Enter the name of the column in the table that will hold the password values. If empty, no validation is done on resources and passwords. + +a| `jdbcDriver` +a| `String` +a| `oracle.jdbc.driver.OracleDriver` +a| +a| No + +5+a| Specify the JDBC Driver class name. For Oracle: oracle.jdbc.driver.OracleDriver. For MySQL: org.gjt.mm.mysql.Driver. Can be empty if datasource is provided. + +a| `jdbcUrlTemplate` +a| `String` +a| `jdbc:oracle:thin:@%h:%p:%d` +a| +a| No + +5+a| Specify the JDBC Driver Connection URL. Oracle template is jdbc:oracle:thin:@[host]:[port(1521)]:[DB]. MySQL template is jdbc:mysql://[host]:[port(3306)]/[db], for more info, read the JDBC driver documentation. Could be empty if datasource is provided + +a| `enableEmptyString` +a| `boolean` +a| `false` +a| +a| No + +5+a| Select to enable support for writing an empty string, instead of a NULL value, in character based columns defined as not-null in the table schema. This option does not influence the way strings are written for Oracle based tables. By default empty strings are written as a NULL value. + +a| `rethrowAllSQLExceptions` +a| `boolean` +a| `true` +a| +a| No + +5+a| If this is not checked, SQL statements which throw SQLExceptions with a 0 ErrorCode will be have the exception caught and suppressed. Check it to have exceptions with 0 ErrorCodes rethrown. + +a| `nativeTimestamps` +a| `boolean` +a| `false` +a| +a| No + +5+a| Select to retrieve Timestamp data type of the columns in java.sql.Timestamp format from the database table. + +a| `allNative` +a| `boolean` +a| `false` +a| +a| No + +5+a| Select to retrieve all data types of columns in native format from the database table. + +a| `validConnectionQuery` +a| `String` +a| `null` +a| +a| No + +5+a| Specify whether the check connection alive query should be used. If empty, the default implementation checks the connection by switching autocommit on/off. It might be more efficient to test the connection by selecting 1 from a dummy table. + +a| `changeLogColumn` +a| `String` +a| `{empty}` +a| +a| xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync] + +5+a| The change log column stores the latest change time. Providing this value the Sync capabilities are activated. + +a| `datasource` +a| `String` +a| `{empty}` +a| +a| No +5+a| If specified, the connector will attempt to connect using only this data source, and will ignore other specified resource parameters. For example: jdbc/SampleDataSourceName + +a| `jndiProperties` +a| `String[]` +a| `null` +a| +a| No + +5+a| Could be empty or enter the JDBC JNDI Initial context factory, context provider in a format: key = value. + +a| `suppressPassword` +a| `boolean` +a| `true` +a| +a| No + +5+a| If set to true then the password will not be returned. Never. Even though it is explicitly requested. If set to false then the password will be returned if it is explicitly requested. + +|=== diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-kerberos.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-kerberos.adoc index 880f8e251..89f07a4ec 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-kerberos.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-kerberos.adoc @@ -238,22 +238,22 @@ The script that is used for each OpenICF operation. Do not change these script n The Kerberos Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -264,16 +264,16 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-ScriptOnResourceApiOp[Script on Resource]:: +xref:appendix-interfaces.adoc#interface-ScriptOnResourceApiOp[Script on Resource]:: Runs a script on the target resource that is managed by this connector. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -282,7 +282,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc index 4ea0b2ebb..e3acb7fa9 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc @@ -585,22 +585,22 @@ The generic LDAP connector therefore converts any dates from Active Directory to The LDAP Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -611,13 +611,13 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -626,7 +626,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-sap.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-sap.adoc index 8e84c2a74..05fb076d4 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-sap.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-sap.adoc @@ -1388,22 +1388,22 @@ The output shows no `ACTIVITYGROUPS` attribute, as this attribute is now empty. The SAP Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -1414,16 +1414,16 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-ScriptOnResourceApiOp[Script on Resource]:: +xref:appendix-interfaces.adoc#interface-ScriptOnResourceApiOp[Script on Resource]:: Runs a script on the target resource that is managed by this connector. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -1432,7 +1432,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ssh.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ssh.adoc index ce95f0146..802671f51 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ssh.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ssh.adoc @@ -200,22 +200,22 @@ The name of the Groovy script that is used for each OpenICF operation. The SSH Connector implements the following OpenICF interfaces. -- -link:../connectors-guide/index.html#interface-AuthenticationApiOp[Authenticate]:: +xref:appendix-interfaces.adoc#interface-AuthenticationApiOp[Authenticate]:: Provides simple authentication with two parameters, presumed to be a user name and password. -link:../connectors-guide/index.html#interface-CreateApiOp[Create]:: +xref:appendix-interfaces.adoc#interface-CreateApiOp[Create]:: Creates an object and its `uid`. -link:../connectors-guide/index.html#interface-DeleteApiOp[Delete]:: +xref:appendix-interfaces.adoc#interface-DeleteApiOp[Delete]:: Deletes an object, referenced by its `uid`. -link:../connectors-guide/index.html#interface-ResolveUsernameApiOp[Resolve Username]:: +xref:appendix-interfaces.adoc#interface-ResolveUsernameApiOp[Resolve Username]:: Resolves an object by its username and returns the `uid` of the object. -link:../connectors-guide/index.html#interface-SchemaApiOp[Schema]:: +xref:appendix-interfaces.adoc#interface-SchemaApiOp[Schema]:: Describes the object types, operations, and options that the connector supports. -link:../connectors-guide/index.html#interface-ScriptOnConnectorApiOp[Script on Connector]:: +xref:appendix-interfaces.adoc#interface-ScriptOnConnectorApiOp[Script on Connector]:: Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: + @@ -226,16 +226,16 @@ Enables an application to run a script in the context of the connector. Any scri * The script has access to any script-arguments passed in by the application. -link:../connectors-guide/index.html#interface-ScriptOnResourceApiOp[Script on Resource]:: +xref:appendix-interfaces.adoc#interface-ScriptOnResourceApiOp[Script on Resource]:: Runs a script on the target resource that is managed by this connector. -link:../connectors-guide/index.html#interface-SearchApiOp[Search]:: +xref:appendix-interfaces.adoc#interface-SearchApiOp[Search]:: Searches the target resource for all objects that match the specified object class and filter. -link:../connectors-guide/index.html#interface-SyncApiOp[Sync]:: +xref:appendix-interfaces.adoc#interface-SyncApiOp[Sync]:: Polls the target resource for synchronization events, that is, native changes to objects on the target resource. -link:../connectors-guide/index.html#interface-TestApiOp[Test]:: +xref:appendix-interfaces.adoc#interface-TestApiOp[Test]:: Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. + @@ -244,7 +244,7 @@ This operation might need to connect to a resource, and, as such, might take som + You can invoke the test operation before a connector configuration has been validated. -link:../connectors-guide/index.html#interface-UpdateApiOp[Update]:: +xref:appendix-interfaces.adoc#interface-UpdateApiOp[Update]:: Updates (modifies or replaces) objects on a target resource. -- diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-scripting.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-scripting.adoc index d5e328ec9..b6166256c 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-scripting.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-scripting.adoc @@ -74,21 +74,20 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: The created OpenIDM resource object. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be created. -- .Example -- - -:: +{empty}:: [source, javascript] ---- @@ -139,21 +138,21 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: The modified OpenIDM resource object. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be updated. -- .Examples -- -:: +{empty}:: Patching an object to add a value to an array: + @@ -222,14 +221,14 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: The OpenIDM resource object, or `null` if not found. -- .Example -- -:: +{empty}:: [source, javascript] ---- @@ -280,21 +279,21 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: The modified OpenIDM resource object. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be updated. -- .Example -- -:: +{empty}:: In this example, the managed user entry is read (with an `openidm.read`, the user entry that has been read is updated with a new description, and the entire updated object is replaced with the new value. + @@ -343,21 +342,21 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: Returns the deleted object if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be deleted. -- .Example -- -:: +{empty}:: [source, javascript] ---- @@ -424,7 +423,7 @@ Fields are specified as JSON pointers. .Returns -- -:: +{empty}:: The result of the query. A query result includes the following parameters: + [open] @@ -470,14 +469,14 @@ The following example shows the result of a custom query that requests the ID, u .Throws -- -:: +{empty}:: An exception is thrown if the given query could not be processed. -- .Examples -- -:: +{empty}:: The following sample query uses a `_queryFilter` to query the managed user repository. + @@ -673,14 +672,14 @@ An array of the fields that should be returned in the result. The list of fields .Returns -- -:: +{empty}:: The result of the action may be `null`. -- .Throws -- -:: +{empty}:: If the action cannot be executed, an exception is thrown. -- @@ -715,14 +714,14 @@ The key alias in the keystore with which to encrypt the node. .Returns -- -:: +{empty}:: The value, encrypted with the specified cipher and key. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be encrypted for any reason. -- @@ -745,14 +744,14 @@ The value to be decrypted. .Returns -- -:: +{empty}:: A deep copy of the value, with any encrypted value decrypted. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be decrypted for any reason. An error is thrown if the value is passed in as a string - it must be passed in an object. -- @@ -775,14 +774,14 @@ The object whose value should be checked to determine if it is encrypted. .Returns -- -:: +{empty}:: Boolean, `true` if the value is encrypted, and `false` if it is not encrypted. -- .Throws -- -:: +{empty}:: An exception is thrown if the server is unable to detect whether the value is encrypted, for any reason. -- @@ -811,14 +810,14 @@ The algorithm with which to hash the value. Example: `SHA-512`. If no algorithm .Returns -- -:: +{empty}:: The value, calculated with the specified hash algorithm. -- .Throws -- -:: +{empty}:: An exception is thrown if the object could not be hashed for any reason. -- @@ -841,14 +840,14 @@ The value to be reviewed. .Returns -- -:: +{empty}:: Boolean, `true` if the value is hashed, and `false` otherwise. -- .Throws -- -:: +{empty}:: An exception is thrown if the server is unable to detect whether the value is hashed, for any reason. -- @@ -877,14 +876,14 @@ A hashed value to compare to the string. .Returns -- -:: +{empty}:: Boolean, `true` if the hash of the string matches the hashed value, and `false` otherwise. -- .Throws -- -:: +{empty}:: An exception is thrown if the string could not be hashed. -- @@ -959,14 +958,14 @@ Arguments to include in the message. .Returns -- -:: +{empty}:: A `null` value if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the message could not be logged. -- @@ -995,14 +994,14 @@ Arguments to include in the message. .Returns -- -:: +{empty}:: A `null` value if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the message could not be logged. -- @@ -1031,14 +1030,14 @@ Arguments to include in the message. .Returns -- -:: +{empty}:: A `null` value if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the message could not be logged. -- @@ -1067,14 +1066,14 @@ Arguments to include in the message. .Returns -- -:: +{empty}:: A `null` value if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the message could not be logged. -- @@ -1103,14 +1102,14 @@ Arguments to include in the message. .Returns -- -:: +{empty}:: A `null` value if successful. -- .Throws -- -:: +{empty}:: An exception is thrown if the message could not be logged. -- @@ -1198,11 +1197,11 @@ a|oldObject a|onSync a|request, oldObject, newObject, success (boolean) - action (string) +action (string) - syncDetails - an array of maps, each detailing the mappings that were attempted to be synchronized +syncDetails - an array of maps, each detailing the mappings that were attempted to be synchronized - syncResults - a map that includes all the syncDetails in one place +syncResults - a map that includes all the syncDetails in one place a|onStore, onValidate a|object, value (the content to be stored or validated for the object) @@ -1228,11 +1227,11 @@ a|source, linkQualifier a|linkQualifiers a|mapping - the name of the current mapping - object - the value of the source object. During a DELETE event, that source object may not exist, and may be null. +object - the value of the source object. During a DELETE event, that source object may not exist, and may be null. - oldValue - The former value of the deleted source object, if any. If the source object is new, oldValue will be null. When there are deleted objects, oldValue is populated only if the source is a managed object. +oldValue - The former value of the deleted source object, if any. If the source object is new, oldValue will be null. When there are deleted objects, oldValue is populated only if the source is a managed object. - returnAll (boolean) - you must configure the script to return every valid link qualifier when returnAll is true, independent of the source object. So you might want your script first to check the value of returnAll. If returnAll is true, the script must not attempt to use the object variable, because it will be null. +returnAll (boolean) - you must configure the script to return every valid link qualifier when returnAll is true, independent of the source object. So you might want your script first to check the value of returnAll. If returnAll is true, the script must not attempt to use the object variable, because it will be null. a|onCreate a|source, target, situation, linkQualifier, context, sourceId, targetId, mappingConfig - a configuration object representing the mapping being processed @@ -1256,7 +1255,7 @@ a|target, linkQualifier a|condition a|object, linkQualifier, target, oldTarget, oldSource - available during UPDATE and DELETE operations performed through implicit sync. With implicit synchronization, the synchronization operation is triggered by a specific change to the source object. As such, implicit sync can populate the old value within the `oldSource` variable and pass it on to the sync engine. - During reconciliation operations `oldSource` will be undefined. A reconciliation operation cannot populate the value of the `oldSource` variable as it has no awareness of the specific change to the source object. Reconciliation simply synchronizes the static source object to the target. +During reconciliation operations `oldSource` will be undefined. A reconciliation operation cannot populate the value of the `oldSource` variable as it has no awareness of the specific change to the source object. Reconciliation simply synchronizes the static source object to the target. a|transform a|source, linkQualifier