Update documentation formatting and cross references

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:
+
 +
 --
 

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.
 
 --

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.
+
+|===
 
 

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.
 
 --