diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-groovy.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-groovy.adoc index 6660dbfc2..a3f86cd4d 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-groovy.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-groovy.adoc @@ -12,12 +12,14 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-groovy] @@ -30,7 +32,7 @@ The Groovy Connector Toolkit is not a complete connector in the traditional sens [#groovy-connector] === Groovy Connector Toolkit -The Groovy Connector Toolkit is bundled with OpenIDM 4.5, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. +The Groovy Connector Toolkit is bundled with OpenIDM {openidm-version-short}, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. Sample implementations are provided in xref:../samples-guide/chap-groovy-samples.adoc#chap-groovy-samples["Samples That Use the Groovy Connector Toolkit to Create Scripted Connectors"] in the __Samples Guide__. 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 e3acb7fa9..0a46cc8f9 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-ldap.adoc @@ -12,12 +12,14 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-ldap] @@ -30,7 +32,7 @@ OpenICF provides a legacy Active Directory (AD) .NET connector. Note, however, t [#ldap-connector-config] === Setting Up the Generic LDAP Connector -OpenIDM 4.5 bundles version 1.4.1.2 of the LDAP connector. Three sample LDAP connector configurations are provided in the `path/to/openidm/samples/provisioners/` directory: +OpenIDM {openidm-version-short} bundles version 1.4.1.2 of the LDAP connector. Three sample LDAP connector configurations are provided in the `path/to/openidm/samples/provisioners/` directory: * `provisioner.openicf-opendjldap.json` provides a sample LDAP connector configuration for an OpenDJ directory server. diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/chap-overview.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/chap-overview.adoc index 08b3ebe6f..e7ae7a9b0 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/chap-overview.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/chap-overview.adoc @@ -12,18 +12,20 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-overview] -== Overview of the Connectors Supported With OpenIDM 4.5 +== Overview of the Connectors Supported With OpenIDM {openidm-version-short} -This chapter provides a high-level overview of the connectors supported with OpenIDM 4.5. Additional OpenICF connectors, not supported with OpenIDM, are available on the OpenICF download site, but are not described in this guide. +This chapter provides a high-level overview of the connectors supported with OpenIDM {openidm-version-short}. Additional OpenICF connectors, not supported with OpenIDM, are available on the OpenICF download site, but are not described in this guide. For instructions on building connector configurations interactively, see xref:../integrators-guide/chap-resource-conf.adoc#connector-wiz["Creating Default Connector Configurations"] in the __Integrator's Guide__. diff --git a/openidm-doc/src/main/asciidoc/connectors-guide/index.adoc b/openidm-doc/src/main/asciidoc/connectors-guide/index.adoc index 1060fad3f..7b1f6cbd9 100644 --- a/openidm-doc/src/main/asciidoc/connectors-guide/index.adoc +++ b/openidm-doc/src/main/asciidoc/connectors-guide/index.adoc @@ -26,8 +26,11 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 + [abstract] -This guide describes the connectors that are supported with OpenIDM 4.5. The guide provides installation and configuration instructions for each connectors, and examples that demonstrate how to use the connectors in a deployment. +This guide describes the connectors that are supported with OpenIDM {openidm-version-short}. The guide provides installation and configuration instructions for each connectors, and examples that demonstrate how to use the connectors in a deployment. include::./preface.adoc[] include::./chap-overview.adoc[] diff --git a/openidm-doc/src/main/asciidoc/getting-started/chap-basic-install.adoc b/openidm-doc/src/main/asciidoc/getting-started/chap-basic-install.adoc index 6d281ca2a..73139d94f 100644 --- a/openidm-doc/src/main/asciidoc/getting-started/chap-basic-install.adoc +++ b/openidm-doc/src/main/asciidoc/getting-started/chap-basic-install.adoc @@ -12,7 +12,7 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: @@ -67,7 +67,7 @@ This section covers what you need to have on your system before running OpenIDM: * Operating System: Windows or UNIX/Linux. -* Java: Java Runtime Environment (JRE) Standard Edition (Java SE) 7, update 6 or later, or Java 8. Alternatively, you can use the same version of the Java Development Kit (JDK). On Linux, you may also install the OpenJDK package native to your updated Linux distribution. +* Java: Java Runtime Environment (JRE) Standard Edition (Java SE) 8, or later. Alternatively, you can use the same version of the Java Development Kit (JDK). On Linux, you may also install the OpenJDK package native to your updated Linux distribution. * At least 250 MB of free disk space. @@ -77,18 +77,20 @@ This section covers what you need to have on your system before running OpenIDM: We provide this document, __Getting Started with OpenIDM__, for demonstration purposes only. -With this document, we want to make it as easy as possible to set up a demonstration of OpenIDM. To that end, we have written this document for installations on a desktop operating system, Microsoft Windows 7. +With this document, we want to make it as easy as possible to set up a demonstration of OpenIDM. To that end, we have written this document for installations on a desktop operating system, Microsoft Windows 10. [#java-prerequisites] ==== Java Environment -On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 7, take the following steps: +On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 10, take the following steps: ==== -. Locate your JRE or JDK installation directory. For a default installation of Java 8 on Windows 7, you should find the directory here: `C:\Program Files\Java\jre-version`. +. Locate your JRE or JDK installation directory. For a default installation of Java 8 on Windows 10, you should find the directory here: `C:\Program Files\Java\jre-version`. -. Select Start > Control Panel > System and Security > Advanced System Settings to open a System Properties window. +. Press `Windows + R` to launch the Windows Run prompt Properties window. + +. Enter `sysdm.cpl` and press Enter to launch the System Properties window. . Select Advanced > Environment Variables. @@ -101,12 +103,11 @@ On Windows systems, after installing Java, set the `JAVA_HOME` environment varia [#download-and-start] === Downloading and Starting OpenIDM - [#download-start-openidm] ==== This procedure assumes that you are downloading and starting OpenIDM as a regular (not administrative) user named `user`. -. Download enterprise software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank]. +. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank]. + For more information on the contents of the OpenIDM binary package, see xref:../integrators-guide/appendix-file-layout.adoc#appendix-file-layout["File Layout"] in the __Integrator's Guide__. diff --git a/openidm-doc/src/main/asciidoc/getting-started/chap-where-to-go.adoc b/openidm-doc/src/main/asciidoc/getting-started/chap-where-to-go.adoc index 29a840f00..6d9a3d8dc 100644 --- a/openidm-doc/src/main/asciidoc/getting-started/chap-where-to-go.adoc +++ b/openidm-doc/src/main/asciidoc/getting-started/chap-where-to-go.adoc @@ -193,6 +193,6 @@ Press Return, and enter the following command: . OpenIDM is self-contained. After you shut down OpenIDM, you can choose to delete the files in the `/path/to/openidm` directory. OpenIDM includes no artifacts in system registries or elsewhere. ==== -We hope that you want to continue exploring OpenIDM. To do so, review the rest of the link:../../../openidm/4.5[OpenIDM documentation, window=\_blank]. +We hope that you want to continue exploring OpenIDM. To do so, review the rest of the link:/openidm[OpenIDM documentation, window=\_blank]. diff --git a/openidm-doc/src/main/asciidoc/images/gsg-selfservice-menu.png b/openidm-doc/src/main/asciidoc/images/gsg-selfservice-menu.png index 3e0e1c443..5322d0534 100644 Binary files a/openidm-doc/src/main/asciidoc/images/gsg-selfservice-menu.png and b/openidm-doc/src/main/asciidoc/images/gsg-selfservice-menu.png differ diff --git a/openidm-doc/src/main/asciidoc/images/gsg-windows.png b/openidm-doc/src/main/asciidoc/images/gsg-windows.png index 1ecd75028..8f05d3b67 100644 Binary files a/openidm-doc/src/main/asciidoc/images/gsg-windows.png and b/openidm-doc/src/main/asciidoc/images/gsg-windows.png differ diff --git a/openidm-doc/src/main/asciidoc/install-guide/appendix-ro-install.adoc b/openidm-doc/src/main/asciidoc/install-guide/appendix-ro-install.adoc index ad8fea3b7..768834493 100644 --- a/openidm-doc/src/main/asciidoc/install-guide/appendix-ro-install.adoc +++ b/openidm-doc/src/main/asciidoc/install-guide/appendix-ro-install.adoc @@ -12,13 +12,13 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: - +:openidm-version: 6.2.3 [appendix] [#appendix-ro-install] @@ -64,9 +64,9 @@ $ sudo mount -o remount,rw /idm ---- With the following commands, you can unpack the OpenIDM binary in the `/idm` directory, and give user `idm` ownership of all files in that directory: -[source, console] +[source, console, subs="attributes"] ---- -$ sudo unzip /idm/openidm-4.5.1-20.zip +$ sudo unzip /idm/openidm-{openidm-version}.zip $ sudo chown -R idm.idm /idm ---- @@ -118,7 +118,7 @@ Make sure `handlerForQueries` is set to `repo`. Redirect the `logDirectory` property to the newly created `/var/log/openidm/audit` subdirectory: + -[source, javascript] +[source, json] ---- { "auditServiceConfig" : { diff --git a/openidm-doc/src/main/asciidoc/install-guide/chap-install.adoc b/openidm-doc/src/main/asciidoc/install-guide/chap-install.adoc index e0a91c615..ab94364d1 100644 --- a/openidm-doc/src/main/asciidoc/install-guide/chap-install.adoc +++ b/openidm-doc/src/main/asciidoc/install-guide/chap-install.adoc @@ -18,6 +18,7 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 [#chap-install] @@ -38,7 +39,7 @@ This section covers what you need to know before running OpenIDM. [#java-prerequisites] ==== Java Environment -On Windows systems, you must set the `JAVA_HOME` environment variable to point to the root of a valid Java installation. The following steps indicate how to set the `JAVA_HOME` environment variable on Windows Server 2008 R2. Adjust the steps for your specific environment: +On Windows systems, you must set the `JAVA_HOME` environment variable to point to the root of a valid Java installation. The following steps indicate how to set the `JAVA_HOME` environment variable on Windows Server 2012 R2. Adjust the steps for your specific environment: . Locate your JRE Installation Directory. If you have not changed the installation path for the Java Runtime Environment during installation, it will be in a directory under `C:\Program Files\Java\`. @@ -50,7 +51,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t . Under System Variables, click New. -. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre7`. +. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre8`. . Click OK. @@ -59,7 +60,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t [#application-container-prerequisites] ==== Application Container -OpenIDM services run in an OSGi container with an embedded Servlet container, and an embedded noSQL database. By default the OSGi container is Apache Felix (Felix). The default Servlet container is Jetty. For OpenIDM 4.5, the only supported configuration is running the services in Felix and Jetty. +OpenIDM services run in an OSGi container with an embedded Servlet container, and an embedded noSQL database. By default the OSGi container is Apache Felix (Felix). The default Servlet container is Jetty. For OpenIDM 6.2, the only supported configuration is running the services in Felix and Jetty. @@ -79,9 +80,9 @@ Follow these steps to install OpenIDM: [source, console] ---- $ java -version -java version "1.7.0_79" -Java(TM) SE Runtime Environment (build 1.7.0_79-b15) -Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode) +openjdk version "1.8.0_362" +OpenJDK Runtime Environment (Temurin)(build 1.8.0_362-b09) +OpenJDK 64-Bit Server VM (Temurin)(build 25.362-b09, mixed mode) ---- . Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank]. @@ -89,14 +90,14 @@ Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode) . Unpack the contents of the .zip file into the install location: + -[source, console] +[source, console, subs="attributes"] ---- $ cd /path/to -$ unzip ~/Downloads/openidm-4.5.1-20.zip -Archive: openidm-4.5.1-20.zip +$ unzip ~/Downloads/openidm-{openidm-version}.zip +Archive: openidm-{openidm-version}.zip inflating: openidm/.checksums.csv creating: openidm/bundle/ - extracting: openidm/bundle/openidm-audit-4.5.1-20.jar + extracting: openidm/bundle/openidm-audit-{openidm-version}.jar ... ---- diff --git a/openidm-doc/src/main/asciidoc/install-guide/chap-repository.adoc b/openidm-doc/src/main/asciidoc/install-guide/chap-repository.adoc index 2280ca45f..95d9bd7fd 100644 --- a/openidm-doc/src/main/asciidoc/install-guide/chap-repository.adoc +++ b/openidm-doc/src/main/asciidoc/install-guide/chap-repository.adoc @@ -18,13 +18,15 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-repository] == Installing a Repository For Production By default, OpenIDM uses OrientDB for its internal repository so that you do not have to install a database in order to evaluate OpenIDM. Before using OpenIDM in production, however, you must replace OrientDB with a supported JDBC repository. -In production environments, OpenIDM 4.5 supports the use of the following internal repositories: +In production environments, OpenIDM {openidm-version-short} supports the use of the following internal repositories: * MySQL diff --git a/openidm-doc/src/main/asciidoc/install-guide/chap-update.adoc b/openidm-doc/src/main/asciidoc/install-guide/chap-update.adoc index d11126802..9bb99159a 100644 --- a/openidm-doc/src/main/asciidoc/install-guide/chap-update.adoc +++ b/openidm-doc/src/main/asciidoc/install-guide/chap-update.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-update] @@ -49,7 +51,7 @@ OpenIDM must be running when you launch an update (using the UI or the CLI). Thi ==== Before starting the update process, back up your existing deployment by archiving the `openidm` directory, as well as the contents of your supported repository. As there is no "undo" option available during the OpenIDM update process, this backup can be used to restore your deployment or restart the update process if something goes wrong. -Save any customized `*.json` configuration files, typically located in your project's `conf/` subdirectory. You'll need to make judgements on how to apply these customizations to your OpenIDM 4.5 deployment after the update is complete. +Save any customized `*.json` configuration files, typically located in your project's `conf/` subdirectory. You'll need to make judgements on how to apply these customizations to your OpenIDM {openidm-version-short} deployment after the update is complete. ==== [#install-update-process] @@ -94,7 +96,7 @@ The update process compares the current checksum of every file with: * The checksum of any file included in the update or patch. -As described in xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"], updates work in the OpenIDM `project-dir`, either in the default directory, `/path/to/openidm`, or outside of the OpenIDM directory tree, such as `/home/project`. If that `project-dir` is outside of the OpenIDM directory tree, there is no MD5 checksum for that file. Based on that information, the update mechanism takes the following actions: +As described in xref:#migrate-idm-40["Updating From OpenIDM 4.0 to OpenIDM {openidm-version-short}"], updates work in the OpenIDM `project-dir`, either in the default directory, `/path/to/openidm`, or outside of the OpenIDM directory tree, such as `/home/project`. If that `project-dir` is outside of the OpenIDM directory tree, there is no MD5 checksum for that file. Based on that information, the update mechanism takes the following actions: -- Files in `openidm/bundle`:: @@ -113,29 +115,29 @@ New files are written to the target directory. If the original file was customized, it is saved with a .old-__unix_time__ extension. `project-dir/script/access.js`:: -The update process writes `access.js` files with a `.new-unix_time` extension in the same directory. You __must__ merge any changes from the latest version of the `.new` file into your customized script file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +The update process writes `access.js` files with a `.new-unix_time` extension in the same directory. You __must__ merge any changes from the latest version of the `.new` file into your customized script file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. Files in the `project-dir/conf` directory, outside of the `/path/to/openidm` directory tree:: -Project configuration files (JSON): Files related to your project are patched with the content of the corresponding 4.5 configuration file, regardless of whether they have been customized. +Project configuration files (JSON): Files related to your project are patched with the content of the corresponding {openidm-version-short} configuration file, regardless of whether they have been customized. + [WARNING] ====== -If you have a customized version of standard OpenIDM 4.0 JSON configuration files, be careful. If you overwrite a new OpenIDM 4.5 version of that file, you might overwrite new features. As a best practice, apply and test each custom change to the new OpenIDM 4.5 configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +If you have a customized version of standard OpenIDM 4.0 JSON configuration files, be careful. If you overwrite a new OpenIDM {openidm-version-short} version of that file, you might overwrite new features. As a best practice, apply and test each custom change to the new OpenIDM {openidm-version-short} configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. ====== + -System configuration files: (`boot.properties`, `system.properties`, `config.properties`, and `jetty.xml`) are written with a `.-new-unix_time` extension in the same directory, regardless of whether they have been customized. You __must__ merge any changes from the latest version of the `.new` file into your existing configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. Currently, the `logging.properties` file is not addressed by the update process, as the default version of this file has not changed since OpenIDM 4.0. +System configuration files: (`boot.properties`, `system.properties`, `config.properties`, and `jetty.xml`) are written with a `.-new-unix_time` extension in the same directory, regardless of whether they have been customized. You __must__ merge any changes from the latest version of the `.new` file into your existing configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. Currently, the `logging.properties` file is not addressed by the update process, as the default version of this file has not changed since OpenIDM 4.0. Files in the default `project-dir/conf` directory, where `project-dir` is `/path/to/openidm`:: -Project configuration files (JSON): Files related to your project are patched with the content of the corresponding 4.5 configuration file, regardless of whether they have been customized. +Project configuration files (JSON): Files related to your project are patched with the content of the corresponding {openidm-version-short} configuration file, regardless of whether they have been customized. + [WARNING] ====== -If you have a customized version of standard OpenIDM 4.0 JSON configuration files in your project directory, be careful. If you overwrite a new OpenIDM 4.5 version of that file, you might overwrite new features. As a best practice, apply and test each custom change to the new OpenIDM 4.5 configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +If you have a customized version of standard OpenIDM 4.0 JSON configuration files in your project directory, be careful. If you overwrite a new OpenIDM {openidm-version-short} version of that file, you might overwrite new features. As a best practice, apply and test each custom change to the new OpenIDM {openidm-version-short} configuration file. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. ====== + -System configuration files: (`boot.properties`, `system.properties`, `config.properties`, and `jetty.xml`) are not patched if they have been customized. Instead, the update process creates configuration files with a `.new-unix_time` extension in the same directory. You __must__ merge any changes from these `.new-` files into your customized configuration files. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. If you have not customized these files, the update process replaces the existing configuration file with the corresponding 4.5 file. Currently, the `logging.properties` file is not addressed by the update process, as the default version of this file has not changed since OpenIDM 4.0. +System configuration files: (`boot.properties`, `system.properties`, `config.properties`, and `jetty.xml`) are not patched if they have been customized. Instead, the update process creates configuration files with a `.new-unix_time` extension in the same directory. You __must__ merge any changes from these `.new-` files into your customized configuration files. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. If you have not customized these files, the update process replaces the existing configuration file with the corresponding {openidm-version-short} file. Currently, the `logging.properties` file is not addressed by the update process, as the default version of this file has not changed since OpenIDM 4.0. Files in any other directory:: Existing files are overwritten and no backup files are created. @@ -175,7 +177,7 @@ Apply the `v1_*` script first, followed by the `v2_*` script, and so on. The upd [#update-idm-cli] ==== Command Line Update Options -As noted in xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"], you can update OpenIDM 4.0 to OpenIDM 4.5 via the UNIX/Linux CLI. You'll find detailed information on the `cli.sh update` option in this section. For general information on `cli.sh` and `cli.bat`, see xref:../integrators-guide/chap-cli.adoc#chap-cli["OpenIDM Command-Line Interface"] in the __Integrator's Guide__. +As noted in xref:#migrate-idm-40["Updating From OpenIDM 4.0 to OpenIDM {openidm-version-short}"], you can update OpenIDM 4.0 to OpenIDM {openidm-version-short} via the UNIX/Linux CLI. You'll find detailed information on the `cli.sh update` option in this section. For general information on `cli.sh` and `cli.bat`, see xref:../integrators-guide/chap-cli.adoc#chap-cli["OpenIDM Command-Line Interface"] in the __Integrator's Guide__. The following command updates the local system with the `openidm-new.zip` binary: @@ -339,12 +341,12 @@ a|The update removed the file. -[#migrate-idm-40-45] -=== Updating From OpenIDM 4.0 to OpenIDM 4.5 +[#migrate-idm-40] +=== Updating From OpenIDM 4.0 to OpenIDM 6.2 -The release of OpenIDM 4.5 includes additional automation in the update service for deployments installed on UNIX/Linux systems, including repository updates. +The release of OpenIDM {openidm-version-short} includes additional automation in the update service for deployments installed on UNIX/Linux systems, including repository updates. -If you've installed OpenIDM on Microsoft Windows, you'll have to migrate your systems manually. For the procedure, see xref:#migrate-idm-4045-windows["Migrating From OpenIDM 4.0 to OpenIDM 4.5 on Windows"]. +If you've installed OpenIDM on Microsoft Windows, you'll have to migrate your systems manually. For the procedure, see xref:#migrate-idm-40-windows["Migrating From OpenIDM 4.0 to OpenIDM {openidm-version-short} on Windows"]. [NOTE] ==== @@ -389,30 +391,30 @@ Make sure you've saved any customized `*.json` configuration files, typically in If your OpenIDM project directory is located on a read-only volume, mount that directory in read-write mode before starting the update process. ==== -Because of the transition between the OpenIDM 4.0 and OpenIDM 4.5 update services, updating from OpenIDM 4.0 is a multi-stage process that requires two update patches in addition to the OpenIDM 4.5 binary. This section starts with an overview, with links to detailed subsections: +Because of the transition between the OpenIDM 4.0 and OpenIDM {openidm-version-short} update services, updating from OpenIDM 4.0 is a multi-stage process that requires two update patches in addition to the OpenIDM {openidm-version-short} binary. This section starts with an overview, with links to detailed subsections: * Download the update binaries. + -To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to Open Identity Platform's link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[BackStage, window=\_blank] repository and download the following binaries: +To update from OpenIDM 4.0 to OpenIDM {openidm-version-short}, navigate to the Open Identity Platform link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[repository, window=\_blank] and download the following binaries: + ** Update Patch 1 (`openidm-4.0.0-1.zip`) ** Update Patch 2 (`openidm-4.0.0-2.zip`) -** OpenIDM 4.5 (`openidm-4.5.0.zip`) +** OpenIDM {openidm-version-short} (`openidm-{openidm-version}.zip`) + -* Before starting the update process, extract and apply the repository update scripts from the OpenIDM 4.5 binary. You may want to share them with your Database Administrator (DBA). For more information, see xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. +* Before starting the update process, extract and apply the repository update scripts from the OpenIDM {openidm-version-short} binary. You may want to share them with your Database Administrator (DBA). For more information, see xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. -* Before starting the update process, identify files in custom directories not known to OpenIDM. Save them, and apply them to your OpenIDM deployment after all stages of the update process are complete. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +* Before starting the update process, identify files in custom directories not known to OpenIDM. Save them, and apply them to your OpenIDM deployment after all stages of the update process are complete. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. + [WARNING] ==== If you use anything but the standard OpenIDM Admin and Self-Service UIs, this issue related to custom directories applies to you. If you followed the procedure described in xref:../integrators-guide/chap-ui.adoc#ui-customizing["Customizing the UI"] in the __Integrator's Guide__, you'll have custom files in the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` directories. -OpenIDM 4.5 includes significant UI improvements. The update process does not copy those improvements to the noted `extension/` subdirectories. +OpenIDM {openidm-version-short} includes significant UI improvements. The update process does not copy those improvements to the noted `extension/` subdirectories. ==== * When you're ready to start the first stage of the update process, see xref:#update-4045-stage1["Updating OpenIDM 4.0, Stage One"]. @@ -421,13 +423,13 @@ OpenIDM 4.5 includes significant UI improvements. The update process does not co * When you're ready for the main part of the update, see xref:#update-4002-45["Updating OpenIDM 4.0, Stage Three"]. -* Once the update is complete, you may have additional work before putting your system back into production. Start with files that include `.new-unix_time` extensions. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +* Once the update is complete, you may have additional work before putting your system back into production. Start with files that include `.new-unix_time` extensions. For more information, see xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. [#update-4045-repo] ==== Updating OpenIDM 4.0, Repository Scripts -Review repository changes between OpenIDM 4.0 and OpenIDM 4.5. You can find update scripts in an unpacked OpenIDM 4.5 binary, in the `openidm/db/repo/scripts/updates` directory, where __repo__ is the subdirectory for your supported repository. +Review repository changes between OpenIDM 4.0 and OpenIDM {openidm-version-short}. You can find update scripts in an unpacked OpenIDM {openidm-version-short} binary, in the `openidm/db/repo/scripts/updates` directory, where __repo__ is the subdirectory for your supported repository. Each supported repository includes the following scripts: @@ -436,7 +438,7 @@ Each supported repository includes the following scripts: v1_increase_changedfields_size.sql v2_shorten_link_columns.sql ---- -If you're running PostgreSQL, OpenIDM 4.5 includes two additional scripts: +If you're running PostgreSQL, OpenIDM {openidm-version-short} includes two additional scripts: [source, console] ---- @@ -445,13 +447,13 @@ v4_modify_indices_for_relationships.sql ---- You can extract repository files individually; for example, to extract `v1_increase_changedfields_size.sql` for MySQL, run the following command: -[source, console] +[source, console, subs="attributes"] ---- -$ unzip -p openidm-4.5.0.zip \ +$ unzip -p openidm-{openidm-version}.zip \ openidm/db/mysql/scripts/updates/v1_increase_changedfields_size.sql \ > v1_increase_changedfields_size.sql ---- -If you need DBA approval to update the OpenIDM repository, share these scripts with your DBA. Before updating from OpenIDM 4.0 to OpenIDM 4.5, apply these scripts now, in numeric order. In other words, apply the script that starts with `v1_*` first, followed by `v2_*` and so on. +If you need DBA approval to update the OpenIDM repository, share these scripts with your DBA. Before updating from OpenIDM 4.0 to OpenIDM {openidm-version-short}, apply these scripts now, in numeric order. In other words, apply the script that starts with `v1_*` first, followed by `v2_*` and so on. Once you have approval, you can shut down OpenIDM and apply these scripts immediately; for example, the following commands apply these scripts to a MySQL repository: @@ -463,16 +465,16 @@ $ mysql -u root -p < /path/to/openidm/db/mysql/scripts/updates/v2_shorten_link_c [NOTE] ==== -The OpenIDM repository update scripts address the differences between the OpenIDM 4.0 and OpenIDM 4.5 supported repositories. They may not address any custom schema, columns, or tables that you have implemented in production. +The OpenIDM repository update scripts address the differences between the OpenIDM 4.0 and OpenIDM {openidm-version-short} supported repositories. They may not address any custom schema, columns, or tables that you have implemented in production. -As OrientDB is not supported in production, Open Identity Platform Community does not support updates of deployments with that repository, and OpenIDM 4.5 does not include OrientDB update scripts. +As OrientDB is not supported in production, Open Identity Platform Community does not support updates of deployments with that repository, and OpenIDM {openidm-version-short} does not include OrientDB update scripts. ==== [#update-4045-stage1] ==== Updating OpenIDM 4.0, Stage One -Now you're ready to start the first part of the update process, where you will use the OpenIDM 4.0 update facility to include several OpenIDM 4.5 bundles. +Now you're ready to start the first part of the update process, where you will use the OpenIDM 4.0 update facility to include several OpenIDM {openidm-version-short} bundles. [#update-to-4001-linux] .Updating OpenIDM 4.0, Stage One for UNIX/Linux Systems @@ -699,7 +701,7 @@ Scroll to the bottom of the Admin UI. After refreshing your browser, you should [#update-4002-45] ==== Updating OpenIDM 4.0, Stage Three -Now your OpenIDM system is ready for a full update to OpenIDM 4.5. Given the details, this section includes different procedures for updates at the command line and from the Admin UI. However, the first two steps are the same: +Now your OpenIDM system is ready for a full update to OpenIDM {openidm-version-short}. Given the details, this section includes different procedures for updates at the command line and from the Admin UI. However, the first two steps are the same: [#d9505e3937] .Common Steps @@ -713,25 +715,25 @@ Now your OpenIDM system is ready for a full update to OpenIDM 4.5. Given the det $ rm /path/to/openidm/bin/update/openidm-4.0.0-2.zip ---- -. Copy the third update binary, `openidm-4.5.0.zip` , to the noted directory: +. Copy the third update binary, `openidm-{openidm-version}.zip` , to the noted directory: + -[source, console] +[source, console, subs="attributes"] ---- $ cd /path/to/Downloads -$ cp openidm-4.5.0.zip /path/to/openidm/bin/update/ +$ cp openidm-{openidm-version}.zip /path/to/openidm/bin/update/ ---- ==== [#update-to-45-cli] -.Updating to OpenIDM 4.5 Through the CLI +.Updating to OpenIDM {openidm-version-short} Through the CLI ==== . Start this part of the update from the command line: + -[source, console] +[source, console, subs="attributes"] ---- $ cd /path/to/openidm $ ./cli.sh update \ @@ -739,7 +741,7 @@ $ ./cli.sh update \ --acceptLicense \ --user openidm-admin:openidm-admin \ --url http://localhost:8080/openidm \ -openidm-4.5.0.zip +openidm-{openidm-version}.zip ---- + @@ -753,7 +755,7 @@ You should have already applied repository update scripts, as described in xref: . The update process for this stage may be longer than xref:#update-to-4002[""]. During the process, you should see the following messages: + -[source, console] +[source, console, subs="attributes"] ---- License was accepted via command line argument. Repository update preview was skipped. @@ -763,7 +765,7 @@ Waiting for running jobs to finish. All running jobs have finished. Entering into maintenance mode... Now in maintenance mode. -Installing the update archive openidm-4.5.0.zip +Installing the update archive openidm-{openidm-version}.zip Update procedure is still processing... ... Update procedure is still processing... @@ -789,9 +791,9 @@ Restart request completed. You should also see the following messages in the OpenIDM console + -[source, console] +[source, console, subs="attributes"] ---- -OpenIDM version "4.5.0" +OpenIDM version "{openidm-version}" ... OpenIDM ready Using boot properties at /path/to/openidm/conf/boot/boot.properties @@ -818,8 +820,8 @@ If you want to set up a script for this process, note the delay between the `Res ==== -[#update-to-45-ui] -.Updating to OpenIDM 4.5 Through the Admin UI +[#update-ui] +.Updating to OpenIDM {openidm-version-short} Through the Admin UI ==== . Log into the Admin UI at `\http://localhost:8080/admin`. @@ -850,13 +852,13 @@ SEVERE: RuntimeException caught java.lang.ClassCastException: ====== ==== -In either case the process may not be complete. You may find files with the `.new-unix_time` extension. If they now exist, you may have additional work to do, as described in xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +In either case the process may not be complete. You may find files with the `.new-unix_time` extension. If they now exist, you may have additional work to do, as described in xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. -If you see errors in the console after OpenIDM restarts, they could be related to updated files, as discussed in xref:#update-afterwards["What You Should Do After Updating to OpenIDM 4.5"]. +If you see errors in the console after OpenIDM restarts, they could be related to updated files, as discussed in xref:#update-afterwards["What You Should Do After Updating to OpenIDM {openidm-version-short}"]. [#update-afterwards] -==== What You Should Do After Updating to OpenIDM 4.5 +==== What You Should Do After Updating to OpenIDM {openidm-version-short} If you've customized OpenIDM 4.0, you may find files with the following extensions: `.old` and `.new`. For more information, see xref:#update-process["An Overview of the OpenIDM Update Process"]. @@ -871,9 +873,9 @@ $ find . -type f -name "*.new*" * Files with the `.old-unix_time` extension are saved from the configuration you had when starting this update process. -* Files with the `.new-unix_time` extension are files from OpenIDM 4.5 that have not been incorporated into your updated installation. For example, if you find a `system.properties.new-unix_time` file in your `project-dir` directory, OpenIDM is still using your pre-update version of this file, which would still be named `system.properties`. +* Files with the `.new-unix_time` extension are files from OpenIDM {openidm-version-short} that have not been incorporated into your updated installation. For example, if you find a `system.properties.new-unix_time` file in your `project-dir` directory, OpenIDM is still using your pre-update version of this file, which would still be named `system.properties`. + -To take full advantage of OpenIDM 4.5, you will want to incorporate the new features from files with the `.new-unix_time` extension in your deployment. If you have files with multiple `.new-unix_time` extensions, use the file with the latest __unix_time__. +To take full advantage of OpenIDM {openidm-version-short}, you will want to incorporate the new features from files with the `.new-unix_time` extension in your deployment. If you have files with multiple `.new-unix_time` extensions, use the file with the latest __unix_time__. + Pay particular attention to your connector configuration files (`provisioner.openicf-connector-name.json`). The update removes outdated connector versions so you __must__ make sure that the `bundleVersion` in your connector configuration matches the version of the connector in `/path/to/openidm/connectors`, or specifies a range that includes the connector version, for example `[1.1.0.0,1.4.0.0]`. For more information, see xref:../integrators-guide/chap-resource-conf.adoc#connector-reference["Setting the Connector Reference Properties"] in the __Integrator's Guide__. @@ -903,25 +905,25 @@ org.eclipse.jetty.server.HttpConnection.level=FINE [#update-afterwards-json] -===== What You Should Do With Your JSON Files After Updating to OpenIDM 4.5 +===== What You Should Do With Your JSON Files After Updating to OpenIDM {openidm-version-short} -The OpenIDM update process does not account for any changes that you made to existing standard JSON files such as `sync.json` and `managed.json`. In fact, the update process overwrites these files with the standard OpenIDM 4.5 versions of those files. +The OpenIDM update process does not account for any changes that you made to existing standard JSON files such as `sync.json` and `managed.json`. In fact, the update process overwrites these files with the standard OpenIDM {openidm-version-short} versions of those files. -Do not overwrite these OpenIDM 4.5 JSON files. Instead, analyze the custom settings from your original JSON files. Apply each custom setting to the files now in your OpenIDM 4.5 deployment, and test the results, to make sure they still work as intended. +Do not overwrite these OpenIDM {openidm-version-short} JSON files. Instead, analyze the custom settings from your original JSON files. Apply each custom setting to the files now in your OpenIDM {openidm-version-short} deployment, and test the results, to make sure they still work as intended. [#update-afterwards-ui] -===== What You Should Do With Your UI After Updating to OpenIDM 4.5 +===== What You Should Do With Your UI After Updating to OpenIDM {openidm-version-short} If you have a custom OpenIDM Admin or Self-Service UI, you need to take a few extra steps. -This assumes that you followed the instructions shown in the introduction shown in xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"], and have saved any custom UI configuration files that you set up in the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories. +This assumes that you followed the instructions shown in the introduction shown in xref:#migrate-idm-40["Updating From OpenIDM 4.0 to OpenIDM {openidm-version-short}"], and have saved any custom UI configuration files that you set up in the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories. You will need the updated UI files from the `openidm/ui/admin/default` and `openidm/ui/selfservice/default` directories. So you'll have to delete some files first. [WARNING] ==== -Make sure you've saved any custom files from the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories, as described in the introduction to xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"], and then follow these steps: +Make sure you've saved any custom files from the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories, as described in the introduction to xref:#migrate-idm-40["Updating From OpenIDM 4.0 to OpenIDM {openidm-version-short}"], and then follow these steps: ==== [#update-afterwards-ui-procedure] @@ -939,28 +941,28 @@ $ cp -r selfservice/default/. selfservice/extension $ cp -r admin/default/. admin/extension ---- -. Review your UI custom files. Compare them against the OpenIDM 4.5 version of these files. +. Review your UI custom files. Compare them against the OpenIDM {openidm-version-short} version of these files. -. Apply your custom changes to each new OpenIDM 4.5 UI file in the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories. +. Apply your custom changes to each new OpenIDM {openidm-version-short} UI file in the `openidm/ui/admin/extension` and `openidm/ui/selfservice/extension` subdirectories. ==== -[#migrate-idm-4045-windows] -==== Migrating From OpenIDM 4.0 to OpenIDM 4.5 on Windows +[#migrate-idm-40-windows] +==== Migrating From OpenIDM 4.0 to OpenIDM {openidm-version-short} on Windows -The steps outlined in this section will help you take advantage of the new functionality offered in OpenIDM 4.5, while preserving your custom configuration where possible. Some of these changes might affect your existing deployment. +The steps outlined in this section will help you take advantage of the new functionality offered in OpenIDM {openidm-version-short}, while preserving your custom configuration where possible. Some of these changes might affect your existing deployment. [NOTE] ==== -Updates from OpenIDM 4.0 to OpenIDM 4.5 on Microsoft Windows are still a manual process. +Updates from OpenIDM 4.0 to OpenIDM {openidm-version-short} on Microsoft Windows are still a manual process. ==== ==== -To perform a migration from OpenIDM 4.0 to OpenIDM 4.5 on Windows, follow these steps. For the purposes of this procedure, the path to the existing instance of OpenIDM 4.0 is defined as `\path\to\openidm-4.0`. In contrast, the path to the OpenIDM 4.5 is defined as `\path\to\openidm-4.5`: +To perform a migration from OpenIDM 4.0 to OpenIDM {openidm-version-short} on Windows, follow these steps. For the purposes of this procedure, the path to the existing instance of OpenIDM 4.0 is defined as `\path\to\openidm-4.0`. In contrast, the path to the OpenIDM {openidm-version-short} is defined as `\path\to\openidm-{openidm-version-short}`: -. Download and extract the OpenIDM 4.5 `.zip` file. +. Download and extract the OpenIDM {openidm-version-short} `.zip` file. . Stop your existing OpenIDM 4.0 server, if it is running. Access the Java console where it is running and enter the `shutdown` command at the OSGi console: + @@ -973,7 +975,7 @@ To perform a migration from OpenIDM 4.0 to OpenIDM 4.5 on Windows, follow these . Backup: Save your current deployment. Archive the `openidm` directory. -. Boot properties: On the OpenIDM 4.5 server, edit the `conf\boot\boot.properties` file to match any customizations that you made on your OpenIDM 4.0 server. Specifically, check the following elements: +. Boot properties: On the OpenIDM {openidm-version-short} server, edit the `conf\boot\boot.properties` file to match any customizations that you made on your OpenIDM 4.0 server. Specifically, check the following elements: + * The HTTP, HTTPS, and mutual authentication ports are specified in the `conf\boot\boot.properties` file. If you changed the default ports in your OpenIDM 4.0 deployment, make sure that the corresponding ports are specified in this file. @@ -981,9 +983,9 @@ To perform a migration from OpenIDM 4.0 to OpenIDM 4.5 on Windows, follow these * Check that the keystore and truststore passwords match the current passwords for the keystore and truststore of your OpenIDM 4.0 deployment. + -Depending on the level of customization you have made in your current deployment, it might be simpler to start with your OpenIDM 4.0 `boot.properties` file, and copy all new settings from that file to the version associated with OpenIDM 4.5. However, as a best practice, you should keep all configuration customizations (including new properties and changed settings) in a single location. You can then copy and paste these changes as appropriate. +Depending on the level of customization you have made in your current deployment, it might be simpler to start with your OpenIDM 4.0 `boot.properties` file, and copy all new settings from that file to the version associated with OpenIDM {openidm-version-short}. However, as a best practice, you should keep all configuration customizations (including new properties and changed settings) in a single location. You can then copy and paste these changes as appropriate. -. Security files: Copy the contents of your OpenIDM 4.0 `security\` folder to the OpenIDM 4.5 instance. +. Security files: Copy the contents of your OpenIDM 4.0 `security\` folder to the OpenIDM {openidm-version-short} instance. + Examine the following excerpt from the `boot.properties` file. OpenIDM automatically prepends the locations of the `keystore.jceks` and `truststore` files with the installation directory. + @@ -998,31 +1000,31 @@ openidm.keystore.location=security/keystore.jceks openidm.truststore.location=security/truststore ---- -. Scripts: Migrate any custom scripts or default scripts that you have modified to the scripts directory of your OpenIDM 4.5 instance. In general, custom and customized scripts should be located in the `openidm-4.0\script` directory on the OpenIDM 4.0 deployment: +. Scripts: Migrate any custom scripts or default scripts that you have modified to the scripts directory of your OpenIDM {openidm-version-short} instance. In general, custom and customized scripts should be located in the `openidm-4.0\script` directory on the OpenIDM 4.0 deployment: + -* If you modified an existing OpenIDM 4.0 script, compare the default versions of the OpenIDM 4.0 and OpenIDM 4.5 scripts. If you're confident that your changes will work as intended, then copy the customized scripts to the new `openidm-4.5\script` directory. For example: +* If you modified an existing OpenIDM 4.0 script, compare the default versions of the OpenIDM 4.0 and OpenIDM {openidm-version-short} scripts. If you're confident that your changes will work as intended, then copy the customized scripts to the new `openidm\script` directory. For example: + [source, console] ---- -PS C:\> cd \path\to\openidm-4.5 +PS C:\> cd \path\to\openidm PS C:\> cp \path\to\openidm-4.0\script\policy.js .\script\ ---- -* If a default script has changed since the 4.0 release, copy the modified script to the `openidm-4.5\script` directory. For example: +* If a default script has changed since the 4.0 release, copy the modified script to the `openidm\script` directory. For example: + [source, console] ---- -PS C:\> cd \path\to\openidm-4.5 +PS C:\> cd \path\to\openidm PS C:\> cp bin\default\script\linkedView.js .\script ---- + -Check that your customizations work as expected, then port the changes for OpenIDM 4.5 to the new script in the `openidm-4.5\script` directory. +Check that your customizations work as expected, then port the changes for OpenIDM {openidm-version-short} to the new script in the `openidm\script` directory. -. Provisioner files: Modify any customized provisioner configurations in your existing project to point to the connectors that are provided with OpenIDM-4.5. Specifically, make sure that the `"connectorRef"` properties reflect the new connectors, where applicable. For example: +. Provisioner files: Modify any customized provisioner configurations in your existing project to point to the connectors that are provided with OpenIDM-{openidm-version-short}. Specifically, make sure that the `"connectorRef"` properties reflect the new connectors, where applicable. For example: + [source, json] @@ -1036,28 +1038,28 @@ Check that your customizations work as expected, then port the changes for OpenI + Alternatively, copy the connector .jars from your existing installation into the `openidm\connectors\` folder of the new installation. -. Complete the OpenIDM 4.5 installation, as described in xref:chap-install.adoc#chap-install["Installing OpenIDM Services"]. +. Complete the OpenIDM {openidm-version-short} installation, as described in xref:chap-install.adoc#chap-install["Installing OpenIDM Services"]. -. As there is no automated way to migrate a customized configuration to OpenIDM 4.5, we recommend the following strategy: +. As there is no automated way to migrate a customized configuration to OpenIDM {openidm-version-short}, we recommend the following strategy: + * Start with the default 4.0 configuration. -* For each configuration file that you have customized, use a file comparison tool such as the Windows `fc.exe` utility to assess the differences between your customized file and the OpenIDM 4.5 file. +* For each configuration file that you have customized, use a file comparison tool such as the Windows `fc.exe` utility to assess the differences between your customized file and the OpenIDM {openidm-version-short} file. -* Based on the results of the `fc.exe` review, use either your existing file as a base and port the OpenIDM 4.5 changes to that file, or vice versa. Ultimately, you want to preserve your customizations but ensure that you are up to date with the latest default configuration. All files should end up in the `openidm-4.5/conf` directory. +* Based on the results of the `fc.exe` review, use either your existing file as a base and port the OpenIDM {openidm-version-short} changes to that file, or vice versa. Ultimately, you want to preserve your customizations but ensure that you are up to date with the latest default configuration. All files should end up in the `openidm/conf` directory. -* OpenIDM 4.5 includes scripts to reflect repository changes. You can apply them directly, as described in xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. +* OpenIDM {openidm-version-short} includes scripts to reflect repository changes. You can apply them directly, as described in xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. . If you are using the UI, clear your browser cache after the migration. The browser cache contains files from the previous OpenIDM release, that might not be refreshed when you log in to the new UI. -. Start OpenIDM 4.5: +. Start OpenIDM {openidm-version-short}: + [source, console] ---- -PS C:\> cd \path\to\openidm-4.5 +PS C:\> cd \path\to\openidm PS C:\> .\startup.bat ---- diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-file-layout.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-file-layout.adoc index 2e407a296..054405d05 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-file-layout.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-file-layout.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [appendix] @@ -25,7 +27,7 @@ == File Layout -- -When you unpack and start OpenIDM 4.5, you create the following files and directories. Note that the precise paths will depend on the install, project, and working directories that you have selected during startup. For more information, see xref:chap-services.adoc#startup-configuration["Specifying the OpenIDM Startup Configuration"]. +When you unpack and start OpenIDM {openidm-version-short}, you create the following files and directories. Note that the precise paths will depend on the install, project, and working directories that you have selected during startup. For more information, see xref:chap-services.adoc#startup-configuration["Specifying the OpenIDM Startup Configuration"]. `openidm/audit/`:: OpenIDM audit log directory default location, created at run time, as configured in `openidm/conf/audit.json` diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-jetty.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-jetty.adoc index 1de7e7de1..944a8d46f 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-jetty.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-jetty.adoc @@ -18,13 +18,15 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [appendix] [#appendix-jetty] == Embedded Jetty Configuration -OpenIDM 4.5 includes an embedded Jetty web server. +OpenIDM {openidm-version-short} includes an embedded Jetty web server. To configure the embedded Jetty server, edit `openidm/conf/jetty.xml`. OpenIDM delegates most of the connector configuration to `jetty.xml`. OSGi and PAX web specific settings for connector configuration therefore do not have an effect. This lets you take advantage of all Jetty capabilities, as the web server is not configured through an abstraction that might limit some of the options. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-ports-used.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-ports-used.adoc index b2b4b711e..941b277ac 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/appendix-ports-used.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/appendix-ports-used.adoc @@ -12,12 +12,14 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [appendix] @@ -25,7 +27,7 @@ == Ports Used -- -By default, OpenIDM 4.5 listens on the following ports (specified in the file `/path/to/openidm/conf/boot/boot.properties`): +By default, OpenIDM {openidm-version-short} listens on the following ports (specified in the file `/path/to/openidm/conf/boot/boot.properties`): `8080`:: + diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-auditing.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-auditing.adoc index 396e1c50d..deb317815 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-auditing.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-auditing.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-auditing] @@ -29,7 +31,7 @@ OpenIDM audit logs can help you record activity by account. With audit data, you OpenIDM logs data from six audit events: access details, system activity, authentication operations, configuration changes, reconciliations, and synchronizations. Auditing provides the data for all relevant reports, including those related to orphan accounts. -OpenIDM 4.5 supports customization of data from all six audit events. +OpenIDM {openidm-version-short} supports customization of data from all six audit events. Regardless of where audit information is logged, you may query audit logs over the REST interface. For more information, see xref:#querying-audit-over-rest["Querying Audit Logs Over REST"]. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-auth.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-auth.adoc index d28e456b6..80ce42f3b 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-auth.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-auth.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-auth] @@ -484,7 +486,7 @@ The IWA module enables users to authenticate by using Integrated Windows Authent [#passthrough-auth] ==== Configuring Pass-Through Authentication -OpenIDM 4.5 supports a pass-through authentication mechanism. With pass-through authentication, the credentials included with the REST request are validated against those stored in a remote system, such as an LDAP server. +OpenIDM {openidm-version-short} supports a pass-through authentication mechanism. With pass-through authentication, the credentials included with the REST request are validated against those stored in a remote system, such as an LDAP server. The following excerpt of an `authentication.json` shows a pass-through authentication configuration for an LDAP system. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-best-practices.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-best-practices.adoc index b8f4bbf4a..1d7f07638 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-best-practices.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-best-practices.adoc @@ -12,7 +12,7 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: @@ -86,7 +86,7 @@ This phase configures and tests the solution prior to moving the solution into p -- Configure a Connector:: -Most deployments include a connection to one or more remote data stores. You should first define all properties for your connector configuration as described in xref:chap-resource-conf.adoc#connectors-with-openidm["Connectors Supported With OpenIDM 4.5"]. +Most deployments include a connection to one or more remote data stores. You should first define all properties for your connector configuration as described in xref:chap-resource-conf.adoc#connectors-with-openidm["Connectors Supported With OpenIDM"]. + If you have custom attributes, you can add them as described in: xref:chap-resource-conf.adoc#adding-to-connector-config["Adding Attributes to Connector Configurations"]. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-cli.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-cli.adoc index e51dd72cf..f952debc7 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-cli.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-cli.adoc @@ -12,12 +12,14 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-cli] @@ -525,6 +527,6 @@ Using boot properties at /path/to/openidm/conf/boot/boot.properties [#cli-update] === Using the update Subcommand -The `update` subcommand supports updates of OpenIDM 4.5 for patches and migrations. For an example of this process, see xref:../install-guide/chap-update.adoc#chap-update["Updating OpenIDM"] in the __Installation Guide__. +The `update` subcommand supports updates of OpenIDM {openidm-version-short} for patches and migrations. For an example of this process, see xref:../install-guide/chap-update.adoc#chap-update["Updating OpenIDM"] in the __Installation Guide__. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-external-rest.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-external-rest.adoc index 77e6f1c15..8237e693b 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-external-rest.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-external-rest.adoc @@ -12,12 +12,14 @@ information: "Portions copyright [year] [name of copyright owner]". Copyright 2017 ForgeRock AS. - Portions Copyright 2024 3A Systems LLC. + Portions Copyright 2024-2025 3A Systems LLC. //// :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-external-rest] @@ -90,7 +92,7 @@ Possible actions include `"POST"`, `"GET"`, `"PUT"`, `"DELETE"`, and `"OPTIONS"` * `authenticate`. The authentication type, and the details with which to authenticate. + -OpenIDM 4.5 supports the following authentication types: +OpenIDM {openidm-version-short} supports the following authentication types: + ** `basic` authentication, with a username and password, for example: diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-overview.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-overview.adoc index a3a01bb01..92bf1bbe2 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-overview.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-overview.adoc @@ -18,7 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: - +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-overview] == Architectural Overview @@ -96,7 +97,7 @@ Auditing logs all relevant system activity to the configured log stores. This in For more information, see xref:chap-auditing.adoc#chap-auditing["Using Audit Logs"]. Repository:: -The repository provides a common abstraction for a pluggable persistence layer. OpenIDM 4.5 supports reconciliation and synchronization with several major external repositories in production, including relational databases, LDAP servers, and even flat CSV and XML files. +The repository provides a common abstraction for a pluggable persistence layer. OpenIDM {openidm-version-short} supports reconciliation and synchronization with several major external repositories in production, including relational databases, LDAP servers, and even flat CSV and XML files. + The repository API uses a JSON-based object model with RESTful principles consistent with the other OpenIDM services. To facilitate testing, OpenIDM includes an embedded instance of OrientDB, a NoSQL database. You can then incorporate a supported internal repository, as described in xref:../install-guide/chap-repository.adoc#chap-repository["Installing a Repository For Production"] in the __Installation Guide__. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-resource-conf.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-resource-conf.adoc index 3c9e12770..14effeb13 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-resource-conf.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-resource-conf.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-resource-conf] @@ -1557,11 +1559,11 @@ Log files are available in the `\path\to\openicf\logs` directory. [#connectors-with-openidm] -=== Connectors Supported With OpenIDM 4.5 +=== Connectors Supported With OpenIDM -OpenIDM 4.5 provides several connectors by default, in the `path/to/openidm/connectors` directory. The supported connectors that are not bundled with OpenIDM, and a number of additional connectors, can be downloaded from the link:https://github.com/OpenIdentityPlatform/OpenICF/[OpenICF community site, window=\_blank]. +OpenIDM {openidm-version-short} provides several connectors by default, in the `path/to/openidm/connectors` directory. The supported connectors that are not bundled with OpenIDM, and a number of additional connectors, can be downloaded from the link:https://github.com/OpenIdentityPlatform/OpenICF/[OpenICF community site, window=\_blank]. -For details about the connectors that are supported for use with OpenIDM 4.5, see xref:../connectors-guide/index.adoc[Connectors Guide]. +For details about the connectors that are supported for use with OpenIDM {openidm-version-short}, see xref:../connectors-guide/index.adoc[Connectors Guide]. [#connector-wiz] @@ -1569,7 +1571,7 @@ For details about the connectors that are supported for use with OpenIDM 4.5, se You have three ways to create provisioner files: -* Start with the sample provisioner files in the `/path/to/openidm/samples/provisioners` directory. For more information, see xref:#connectors-with-openidm["Connectors Supported With OpenIDM 4.5"]. +* Start with the sample provisioner files in the `/path/to/openidm/samples/provisioners` directory. For more information, see xref:#connectors-with-openidm["Connectors Supported With OpenIDM"]. * Set up connectors with the help of the Admin UI. To start this process, navigate to `\https://localhost:8443/admin` and log in to OpenIDM. Continue with xref:#connector-wiz-adminui["Adding New Connectors from the Admin UI"]. @@ -1581,11 +1583,11 @@ You have three ways to create provisioner files: You can include several different connectors in an OpenIDM configuration. In the Admin UI, select Configure > Connector. Try some of the different connector types in the screen that appears. Observe as the Admin UI changes the configuration options to match the requirements of the connector type. -The list of connectors shown in the Admin UI does not include all supported connectors. For information and examples of how each supported connector is configured, see xref:#connectors-with-openidm["Connectors Supported With OpenIDM 4.5"]. +The list of connectors shown in the Admin UI does not include all supported connectors. For information and examples of how each supported connector is configured, see xref:#connectors-with-openidm["Connectors Supported With OpenIDM"]. When you have filled in all required text boxes, the Admin UI allows you to validate the connector configuration. -If you want to configure a different connector through the Admin UI, you could copy the provisioner file from the `/path/to/openidm/samples/provisioners` directory. However, additional configuration may be required, as described in xref:#connectors-with-openidm["Connectors Supported With OpenIDM 4.5"]. +If you want to configure a different connector through the Admin UI, you could copy the provisioner file from the `/path/to/openidm/samples/provisioners` directory. However, additional configuration may be required, as described in xref:#connectors-with-openidm["Connectors Supported With OpenIDM"]. Alternatively, some connectors are included with the configuration of a specific sample. For example, if you want to build a ScriptedSQL connector, read xref:../samples-guide/chap-groovy-samples.adoc#more-sample3["Sample 3 - Using the Custom Scripted Connector Bundler to Build a ScriptedSQL Connector"] in the __Samples Guide__. @@ -1612,7 +1614,7 @@ $ curl \ --request POST \ "http://localhost:8080/openidm/system?_action=availableConnectors" ---- -Available connectors are installed in `openidm/connectors`. OpenIDM 4.5 bundles the following connectors: +Available connectors are installed in `openidm/connectors`. OpenIDM bundles the following connectors: * CSV File Connector diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-scripting.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-scripting.adoc index 961613352..ec75e0255 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-scripting.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-scripting.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-scripting] diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-security.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-security.adoc index 0cca77ef3..c4e282b84 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-security.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-security.adoc @@ -18,7 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: - +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-security] == Securing & Hardening OpenIDM @@ -707,9 +708,9 @@ To set an obfuscated version of the keystore password in the `boot.properties` f . Generate an obfuscated version of the password, by using the crypto bundle provided with OpenIDM: + -[source, console] +[source, console, subs="attributes"] ---- -$ $ java -jar /path/to/openidm/bundle/openidm-crypto-4.5.1-20.jar +$ java -jar /path/to/openidm/bundle/openidm-crypto-{openidm-version}.jar This utility helps obfuscate passwords to prevent casual observation. It is not securely encrypted and needs further measures to prevent disclosure. Please enter the password: @@ -887,7 +888,7 @@ password=password [#security-protect-repo] ==== Protect the OpenIDM Repository -OpenIDM 4.5 only supports the use of a JDBC repository in production. +OpenIDM {openidm-version-short} only supports the use of a JDBC repository in production. Use a strong password for the JDBC connection and change at least the password of the database user (`openidm` by default). When you change the database username and/or password, you must update the database connection configuration file (`datasource.jdbc-default.json`) for your repository type. diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-services.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-services.adoc index 3e66c7cff..b01f429e0 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-services.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-services.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-services] @@ -714,7 +716,7 @@ To debug custom libraries, you can start OpenIDM with the option to use the Java * Start OpenIDM with the `jpda` option: + -[source, console] +[source, console, subs="attributes"] ---- $ cd /path/to/openidm $ ./startup.sh jpda @@ -726,7 +728,7 @@ Using LOGGING_CONFIG: -Djava.util.logging.config.file=/path/to/openidm/conf/logging.properties Listening for transport dt_socket at address: 5005 Using boot properties at /path/to/openidm/conf/boot/boot.properties --> OpenIDM version "4.5.1-20" (revision: xxxx) +-> OpenIDM version "{openidm-version}" (revision: xxxx) OpenIDM ready ---- + diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-synchronization.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-synchronization.adoc index f48ec7473..972b2a654 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-synchronization.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-synchronization.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-synchronization] @@ -1507,7 +1509,7 @@ To restrict reconciliation to only those records whose `employeeType` on the sou }, ... ---- -The format of the query can be any query type that is supported by the resource, and can include additional parameters, if applicable. OpenIDM 4.5 supports the following query types. +The format of the query can be any query type that is supported by the resource, and can include additional parameters, if applicable. OpenIDM {openidm-version-short} supports the following query types. For queries on managed objects: * `_queryId` for arbitrary predefined, parameterized queries diff --git a/openidm-doc/src/main/asciidoc/integrators-guide/chap-workflow.adoc b/openidm-doc/src/main/asciidoc/integrators-guide/chap-workflow.adoc index 45f9c4652..33bc740a5 100644 --- a/openidm-doc/src/main/asciidoc/integrators-guide/chap-workflow.adoc +++ b/openidm-doc/src/main/asciidoc/integrators-guide/chap-workflow.adoc @@ -18,6 +18,8 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-workflow] @@ -190,12 +192,12 @@ There are several additional configuration properties for the Activiti module. A The sample `workflow.json` file contains the following configuration: -[source, json] +[source, json, subs="attributes"] ---- { "location" : "remote", "engine" : { - "url" : "http://localhost:9090/openidm-workflow-remote-4.5.1-20", + "url" : "http://localhost:9090/openidm-workflow-remote-{openidm-version}", "username" : "youractivitiuser", "password" : "youractivitipassword" }, diff --git a/openidm-doc/src/main/asciidoc/samples-guide/chap-groovy-samples.adoc b/openidm-doc/src/main/asciidoc/samples-guide/chap-groovy-samples.adoc index 37be2adb2..942768a14 100644 --- a/openidm-doc/src/main/asciidoc/samples-guide/chap-groovy-samples.adoc +++ b/openidm-doc/src/main/asciidoc/samples-guide/chap-groovy-samples.adoc @@ -18,12 +18,14 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-groovy-samples] == Samples That Use the Groovy Connector Toolkit to Create Scripted Connectors -OpenIDM 4.5 includes a generic Groovy Connector Toolkit that enables you to run Groovy scripts on any external resource. +OpenIDM {openidm-version-short} includes a generic Groovy Connector Toolkit that enables you to run Groovy scripts on any external resource. The Groovy Connector Toolkit is not a complete connector, in the traditional sense. Rather, it is a framework within which you must write your own Groovy scripts to address the requirements of your implementation. Specific scripts are provided within these samples, which demonstrate how the Groovy Connector Toolkit can be used. These scripts cannot be used "as is" in your deployment, but are a good starting point on which to base your customization. @@ -141,10 +143,10 @@ $ cd /path/to/openidm/samples/sample3/create-connector . Run the custom scripted connector bundler .jar, with the configuration file for this sample (`sample3/data/scriptedsql.json`). + -[source, console] +[source, console, subs="attributes"] ---- -$ java -jar ../../../tools/custom-scripted-connector-bundler-4.5.1-20.jar -c ../data/scriptedsql.json -Custom Scripted Connector Bundler for OpenIDM v4.5.1-20 +$ java -jar ../../../tools/custom-scripted-connector-bundler-{openidm-version}.jar -c ../data/scriptedsql.json +Custom Scripted Connector Bundler for OpenIDM v{openidm-version} Generating connector sources for HRDB-ScriptedSQLConnector ---- + @@ -589,7 +591,7 @@ For more information about paging support, see xref:../integrators-guide/chap-da This sample uses the Groovy Connector Toolkit to implement a ScriptedREST connector, which interacts with the OpenDJ REST API. -The Groovy Connector Toolkit is bundled with OpenIDM 4.5, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. +The Groovy Connector Toolkit is bundled with OpenIDM {openidm-version-short}, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. The connector configuration file for this sample (`samples/scriptedrest2dj/conf/provisioner.openicf-scriptedrest.json`) indicates the ScriptedREST implementation of the Groovy connector as follows: @@ -1026,7 +1028,7 @@ $ curl \ This sample uses the Groovy Connector Toolkit to implement a ScriptedCREST connector, which interacts with the ForgeRock Commons REST (CREST) API to connect to an OpenDJ instance. The main difference between a CREST-based API and a generic REST API is that the CREST API is inherently recognizable by all ForgeRock products. As such, the sample can leverage CREST resources in the groovy scripts, to create CREST requests. -The Groovy Connector Toolkit is bundled with OpenIDM 4.5, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. +The Groovy Connector Toolkit is bundled with OpenIDM {openidm-version-short}, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`. The connector configuration file for this sample (`samples/scriptedcrest2dj/conf/provisioner.openicf-scriptedcrest.json`) indicates the ScriptedCREST implementation of the Groovy Connector Toolkit as follows: diff --git a/openidm-doc/src/main/asciidoc/samples-guide/chap-salesforce-sample.adoc b/openidm-doc/src/main/asciidoc/samples-guide/chap-salesforce-sample.adoc index c6c020cca..458e339bd 100644 --- a/openidm-doc/src/main/asciidoc/samples-guide/chap-salesforce-sample.adoc +++ b/openidm-doc/src/main/asciidoc/samples-guide/chap-salesforce-sample.adoc @@ -18,12 +18,14 @@ :figure-caption!: :example-caption!: :table-caption!: +:openidm-version: 6.2.3 +:openidm-version-short: 6.2 [#chap-salesforce-sample] == Salesforce Sample - Salesforce With the Salesforce Connector -OpenIDM 4.5 provides a Salesforce Connector that enables provisioning, reconciliation, and synchronization with a Salesforce organization. The Salesforce Connector is not an OpenICF connector, but a separate OpenIDM module, based on the Open Identity Platform Common Resource API. +OpenIDM {openidm-version-short} provides a Salesforce Connector that enables provisioning, reconciliation, and synchronization with a Salesforce organization. The Salesforce Connector is not an OpenICF connector, but a separate OpenIDM module, based on the Open Identity Platform Common Resource API. [NOTE] ====