Skip to content

Commit c12e703

Browse files
authored
Fix documentation issues and update links (#92)
1 parent bb8479d commit c12e703

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+785
-386
lines changed

openidm-doc/src/main/asciidoc/connectors-guide/chap-ad.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -36,7 +36,7 @@ Before you configure the Active Directory Connector, make sure that the .NET Con
3636
.Setting Up the Active Directory Connector
3737
====
3838
39-
. Download the Active Directory Connector from link:https://forgerock.org/downloads/[ForgeRock's download page, window=\_blank].
39+
. Download the Active Directory Connector from the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank].
4040
4141
. Extract the contents of the AD Connector zip file into the directory in which you installed the Connector Server (by default `c:\Program Files (x86)\Identity Connectors\Connector Server>`).
4242
+

openidm-doc/src/main/asciidoc/connectors-guide/chap-google.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -23,7 +23,7 @@
2323
[#chap-google]
2424
== Google Apps Connector
2525
26-
The link:https://forgerock.org/downloads/[Enterprise build, window=\_blank] of OpenIDM includes a Google Apps connector, along with a sample connector configuration. The Google Apps Connector enables you to interact with Google's web applications.
26+
link:https://github.com/OpenIdentityPlatform/OpenICF[OpenICF, window=\_blank] includes a Google Apps connector, along with a sample connector configuration. The Google Apps Connector enables you to interact with Google's web applications.
2727
2828
[#google-connector-config]
2929
=== Configuring the Google Apps Connector

openidm-doc/src/main/asciidoc/connectors-guide/chap-salesforce.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -23,7 +23,7 @@
2323
[#chap-salesforce]
2424
== Salesforce Connector
2525
26-
The link:https://forgerock.org/downloads/[Enterprise build, window=\_blank] of OpenIDM includes a Salesforce connector, along with a sample connector configuration. The Salesforce connector enables provisioning, reconciliation, and synchronization between Salesforce and the OpenIDM repository.
26+
link:https://github.com/OpenIdentityPlatform/OpenICF[OpenICF, window=\_blank] includes a Salesforce connector, along with a sample connector configuration. The Salesforce connector enables provisioning, reconciliation, and synchronization between Salesforce and the OpenIDM repository.
2727
2828
To use this connector, you need a Salesforce account, and a Connected App that has OAuth enabled, which will allow you to retrieve the required consumer key and consumer secret.
2929

openidm-doc/src/main/asciidoc/connectors-guide/chap-sap.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -36,9 +36,9 @@ The sample scripts illustrate the following scenarios:
3636
=== Before You Start
3737
3838
39-
* The SAP connector is provided only with the OpenIDM Enterprise build, and is available on the link:https://backstage.forgerock.com[ForgeRock Backstage, window=\_blank] site.
39+
* The SAP connector is available on the link:https://github.com/OpenIdentityPlatform/OpenICF/releases[GitHub, window=\_blank] site.
4040
41-
* The SAP connector requires the SAP Java Connector (JCo) libraries, version 3.0.12 or later. ForgeRock distributes the SAP connector without these JCo libraries. Before you can use the SAP connector, you must obtain the JCo libraries that correspond to your architecture.
41+
* The SAP connector requires the SAP Java Connector (JCo) libraries, version 3.0.12 or later. Open Identity Platform Community distributes the SAP connector without these JCo libraries. Before you can use the SAP connector, you must obtain the JCo libraries that correspond to your architecture.
4242
4343
4444
@@ -48,7 +48,7 @@ The sample scripts illustrate the following scenarios:
4848
4949
====
5050
51-
. Download the SAP connector from the link:https://backstage.forgerock.com[ForgeRock Backstage, window=\_blank] site.
51+
. Download the SAP connector from the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank].
5252
5353
. Copy the SAP connector JAR file (`sap-connector-1.4.0.0.jar`) to the `openidm/connectors` directory:
5454
+
@@ -138,7 +138,7 @@ For optimum performance, set this value to an integer between `5` and `10`.
138138
139139
--
140140
141-
. To test this connector, you can use the sample Groovy scripts available from the link:https://maven.forgerock.org/repo/webapp/#/artifacts/browse/tree/General/releases/org/forgerock/openicf/connectors/sap-connector/1.4.0.0/sap-connector-1.4.0.0-sources.jar/samples/[ForgeRock Artifact Repository Browser, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/hr/` subdirectory.
141+
. To test this connector, you can use the sample Groovy scripts available on the link:https://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/hr/` subdirectory.
142142
+
143143
[none]
144144
* `TestSAP.groovy`
@@ -496,7 +496,7 @@ For optimum performance, set this value to an integer between `5` and `10`.
496496
497497
--
498498
499-
. To test this connector, you can use the sample Groovy scripts available from the link:https://maven.forgerock.org/repo/webapp/#/artifacts/browse/tree/General/releases/org/forgerock/openicf/connectors/sap-connector/1.4.0.0/sap-connector-1.4.0.0-sources.jar/samples/[ForgeRock Artifact Repository Browser, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/r3/` subdirectory.
499+
. To test this connector, you can use the sample Groovy scripts available on the link:hhttps://github.com/OpenIdentityPlatform/OpenICF/releases/[GitHub, window=\_blank]. You can find the source for these scripts in this location, in the `samples/` directory, as well as the `samples/r3/` subdirectory.
500500
+
501501
[none]
502502
* `TestSAP.groovy`

openidm-doc/src/main/asciidoc/getting-started/chap-where-to-go.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -128,7 +128,7 @@ OpenIDM is a lightweight and highly customizable identity management product.
128128
129129
The OpenIDM documentation includes additional use cases. Most of them are known as __Samples__, and are described in xref:../samples-guide/chap-overview.adoc#chap-overview["Overview of the OpenIDM Samples"] in the __Samples Guide__.
130130
131-
These samples include step-by-step instructions on how you can connect to different data stores, customize product behavior using JavaScript and Groovy, and administer OpenIDM with ForgeRock's commons RESTful API commands.
131+
These samples include step-by-step instructions on how you can connect to different data stores, customize product behavior using JavaScript and Groovy, and administer OpenIDM with Open Identity Platform's commons RESTful API commands.
132132
133133
134134
[#gsg-integration]

openidm-doc/src/main/asciidoc/install-guide/chap-install.adoc

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -27,7 +27,7 @@ This chapter covers the tasks required to install and start OpenIDM.
2727
2828
[NOTE]
2929
====
30-
ForgeRock documentation includes a separate xref:../samples-guide/index.adoc[Samples Guide]. When you have read the first two chapters of this document, you can use the xref:../samples-guide/index.adoc[Samples Guide] to test OpenIDM in a number of different configurations.
30+
Open Identity Platform documentation includes a separate xref:../samples-guide/index.adoc[Samples Guide]. When you have read the first two chapters of this document, you can use the xref:../samples-guide/index.adoc[Samples Guide] to test OpenIDM in a number of different configurations.
3131
====
3232
3333
[#before-you-start]
@@ -117,7 +117,7 @@ Follow these steps to run OpenIDM interactively:
117117
118118
. Start the Felix container, load all OpenIDM services, and start a command shell to allow you to manage the container:
119119
+
120-
120+
--
121121
* Start OpenIDM (UNIX):
122122
+
123123
@@ -135,7 +135,6 @@ Using boot properties at /path/to/openidm/conf/boot/boot.properties
135135
136136
* Start OpenIDM (Windows):
137137
+
138-
139138
[source, console]
140139
----
141140
C:\> cd \path\to\openidm
@@ -150,9 +149,7 @@ Using boot properties at \path\to\openidm\conf\boot\boot.properties
150149
->
151150
----
152151
153-
+
154152
At the OSGi console `->` prompt, you can enter commands such as `help` for usage, or `ps` to view the bundles installed. To see a list of all the OpenIDM core services and their states, enter the following command:
155-
+
156153
157154
[source, console]
158155
----
@@ -219,11 +216,11 @@ At the OSGi console `->` prompt, you can enter commands such as `help` for usage
219216
[ 29] [active ] org.forgerock.openidm.maintenance
220217
->
221218
----
222-
+
219+
223220
A default startup does not include certain configurable services, which will indicate an `unsatisfied` state until they are included in the configuration. As you work through the sample configurations described later in this guide, you will notice that these services are active.
224-
+
225-
Startup errors and messages are logged to the console by default. You can also view these messages in the log files at `/path/to/openidm/logs`.
226221
222+
Startup errors and messages are logged to the console by default. You can also view these messages in the log files at `/path/to/openidm/logs`.
223+
--
227224
. Alternatively, you can manage the container and services from the Apache Felix Web Console.
228225
+
229226
Use these hints to connect to the Apache Felix Web Console:
@@ -303,12 +300,11 @@ C:\openidm\bin>
303300
[source, console]
304301
----
305302
C:\openidm\bin>install-service.bat openidm
306-
ForgeRock Launcher Java Service successfully installed as "openidm" service
303+
Open Identity Platform Launcher Java Service successfully installed as "openidm" service
307304
----
308305
309306
. Use the Windows Service manager to manage the OpenIDM service.
310-
311-
307+
+
312308
[#d9505e641]
313309
image::images/windows-service.png[]
314310
@@ -325,15 +321,12 @@ To change the user account:
325321
.. Select This Account and browse for an Active Directory administrative account.
326322
327323
.. Enter the password for the administrative account.
328-
329-
324+
+
330325
[#d9505e676]
331326
image::images/service-acct.png[]
332327
333-
334328
.. Click Apply to save the changes.
335329
336-
337330
. Use the Windows Service Manager to start, stop, or restart the service.
338331
339332
. To uninstall the OpenIDM service stop the service, then run the following command:
@@ -524,7 +517,7 @@ $ curl \
524517
"https://localhost:8443/openidm/managed/user/joe" \
525518
| jq .
526519
----
527-
The ForgeRock REST API includes an optional `_prettyPrint` request parameter. The default value is `false`. To use the ForgeRock REST API to format output, add a parameter such as `?_prettyPrint=true` or `&_prettyPrint=true`, depending on whether it is added to the end of an existing request parameter. In this case, the following command would return formatted output:
520+
The Open Identity Platform REST API includes an optional `_prettyPrint` request parameter. The default value is `false`. To use the Open Identity Platform REST API to format output, add a parameter such as `?_prettyPrint=true` or `&_prettyPrint=true`, depending on whether it is added to the end of an existing request parameter. In this case, the following command would return formatted output:
528521
529522
[source, console]
530523
----

openidm-doc/src/main/asciidoc/install-guide/chap-update.adoc

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -23,23 +23,14 @@
2323
[#chap-update]
2424
== Updating OpenIDM
2525
26-
The update process is largely dependent on your deployment and on the extent to which you have customized OpenIDM. Engage link:https://www.forgerock.com/support/support-services[ForgeRock Support Services, window=\_top] for help in updating an existing deployment.
26+
The update process is largely dependent on your deployment and on the extent to which you have customized OpenIDM. Engage link:https://github.com/OpenIdentityPlatform/.github/wiki/Approved-Vendor-List[Open Identity Platform Approved Vendors, window=\_top] for help in updating an existing deployment.
2727
2828
If you are updating from OpenIDM 4.0, you can take advantage of new OpenIDM update options from the command line and the Admin UI. For a generic view of the update process, see xref:#update-process["An Overview of the OpenIDM Update Process"].
2929
30-
If you are migrating a deployment from earlier versions of OpenIDM, follow the manual update process.
31-
32-
* To migrate a deployment from OpenIDM 3.1.0 to OpenIDM 4.0, see link:../../../openidm/4/install-guide/#migrate-idm-314[Migrating From OpenIDM 3.1 to OpenIDM 4.0, window=\_blank] in the __OpenIDM 4 Installation Guide__.
33-
34-
* To migrate a deployment from OpenIDM 3.0.0 to 3.1.0, see link:../../../openidm/3.1/install-guide/#chap-upgrade[Migrating to OpenIDM 3.1.0, window=\_blank] in the __OpenIDM 3.1.0 Installation Guide__.
35-
36-
* To migrate a deployment from OpenIDM 2.1.0 to 3.0.0, see link:../../../openidm/3/install-guide/#chap-upgrade[Migrating to OpenIDM 3.0.0, window=\_blank] in the __OpenIDM 3.0.0 Installation Guide__.
37-
38-
3930
[#update-process]
4031
=== An Overview of the OpenIDM Update Process
4132
42-
This section provides background information on the OpenIDM update process. If you want to jump to the steps required to update OpenIDM from version 4.0 to 4.5, read xref:#migrate-idm-40-45["Updating From OpenIDM 4.0 to OpenIDM 4.5"].
33+
This section provides background information on the OpenIDM update process.
4334
4435
OpenIDM must be running when you launch an update (using the UI or the CLI). This section details the capabilities of the OpenIDM update process, in the following sub-sections:
4536
@@ -210,7 +201,7 @@ The URL of the OpenIDM REST service. The default URL is `\http://localhost:8080/
210201
The port number associated with the OpenIDM REST service. If specified, this option overrides any port number specified with the `--url` option. The default port is 8080. This option is used by all three subcommands.
211202
212203
`--acceptLicense`::
213-
Automatically accept the license shown in `/path/to/openidm/legal-notices/Forgerock_License.txt`. If you omit this option, the update process prompts you to accept or decline the license.
204+
Automatically accept the license shown in `/path/to/openidm/legal-notices/CDDLv1_0.txt`. If you omit this option, the update process prompts you to accept or decline the license.
214205
215206
`--skipRepoUpdatePreview`::
216207
Bypasses a preview of repository updates. Suitable if you have already downloaded and approved changes to your repository.
@@ -402,7 +393,7 @@ Because of the transition between the OpenIDM 4.0 and OpenIDM 4.5 update service
402393
403394
* Download the update binaries.
404395
+
405-
To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to ForgeRock's link:https://backstage.forgerock.com/[BackStage, window=\_blank] site and download the following binaries:
396+
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:
406397
+
407398
408399
** Update Patch 1 (`openidm-4.0.0-1.zip`)
@@ -412,7 +403,6 @@ To update from OpenIDM 4.0 to OpenIDM 4.5, navigate to ForgeRock's link:https://
412403
** OpenIDM 4.5 (`openidm-4.5.0.zip`)
413404
414405
+
415-
Access to the update binaries is restricted to ForgeRock customers.
416406
417407
* 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"].
418408
@@ -475,7 +465,7 @@ $ mysql -u root -p < /path/to/openidm/db/mysql/scripts/updates/v2_shorten_link_c
475465
====
476466
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.
477467
478-
As OrientDB is not supported in production, ForgeRock does not support updates of deployments with that repository, and OpenIDM 4.5 does not include OrientDB update scripts.
468+
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.
479469
====
480470
481471
@@ -834,7 +824,8 @@ If you want to set up a script for this process, note the delay between the `Res
834824
835825
. Log into the Admin UI at `\http://localhost:8080/admin`.
836826
837-
.
827+
. {nbsp}
828+
+
838829
[WARNING]
839830
======
840831
Updating the repository is your responsibility. You should have already done so in xref:#update-4045-repo["Updating OpenIDM 4.0, Repository Scripts"]. Assuming that is true, confirm this when the Admin UI prompts you to download and acknowledge that you've run these scripts.

openidm-doc/src/main/asciidoc/integrators-guide/appendix-audit.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -130,7 +130,7 @@ The following code is an excerpt from the `audit.json` file, with Elasticsearch
130130
----
131131
You should also set up configuration for the Elasticsearch event handler. The entries shown are defaults, and can be configured. In fact, if you have set up Elasticsearch Shield, with or without SSL/TLS, as described in xref:#elastic-install["Installing and Configuring Elasticsearch"], you should change some of these defaults.
132132
133-
[source, javascript]
133+
[source, json]
134134
----
135135
"eventHandlers" : [
136136
{
@@ -168,7 +168,7 @@ If you set `useSSL` to true, add the following properties to the `connection` co
168168
[source, javascript]
169169
----
170170
"username" : "myUsername",
171-
"password" : "myPassword",
171+
"password" : "myPassword",
172172
----
173173
For more information on the other options shown in `audit.json`, see xref:#audit-event-prop["Common Audit Event Handler Property Configuration"].
174174
@@ -632,7 +632,7 @@ Two properties shown only in the `audit.json` file for your project are:
632632
* The class name used to build the handler, which may shown as one of the `availableAuditEventHandlers`, as shown in this excerpt from the `audit.json` file:
633633
+
634634
635-
[source, javascript]
635+
[source, json]
636636
----
637637
"availableAuditEventHandlers" : [
638638
"org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler",
@@ -645,7 +645,7 @@ Two properties shown only in the `audit.json` file for your project are:
645645
* The audit event handler `config` property, which comes after a second instance of the class name of that audit event handler. For an example, see the following excerpt of an `audit.json` file:
646646
+
647647
648-
[source, javascript]
648+
[source, json]
649649
----
650650
"eventHandlers" : [
651651
{
@@ -770,7 +770,7 @@ a|Buffering: avoids flushing after each event
770770
|===
771771
Except for the common properties shown in xref:#audit-event-prop["Common Audit Event Handler Property Configuration"], the Repository and Router audit event handlers share one unique property: `resourcePath`:
772772
773-
[source, javascript]
773+
[source, json]
774774
----
775775
{
776776
"class" : "org.forgerock.openidm.audit.impl.RouterAuditEventHandler",
@@ -795,7 +795,7 @@ a|Path to the repository resource
795795
796796
[NOTE]
797797
====
798-
Take care when reading JMS properties in the `audit.json` file. They include the standard ForgeRock audit event topics, along with JMS-unique topics:
798+
Take care when reading JMS properties in the `audit.json` file. They include the standard Open Identity Platform audit event topics, along with JMS-unique topics:
799799
====
800800
801801
[#audit-config-prop-jms]

0 commit comments

Comments
 (0)