Integrate with Document Adapter

Here's how you can integrate Buying experience with the Framework document management adapter:

Configure the CX Industries Framework document management adapter to integrate with the content management system.
Create a service request on My Oracle Support to add the content management system as a spoke system in the CX Industries Framework, and configure Buying experience appropriately.
Ensure that you provide the following details in the service request that you raise:
- Document Management System ID: Any string to indicate the instance ID such as OCM1.
- In addition to these details, to generate contracts, you must provide:
  - CONTENTMANAGEMENT TEMPLATES FOLDERID: The folder in the content management system where uploaded contract templates will be stored.
  - CONTENTMANAGEMENT CONTRACTS FOLDERID: The folder in the content management system where generated contract documents will be stored.
- In addition to these details, to store individual attachments, you must also provide:
  - CONTENT MANAGEMENT INDIVIDUAL DOCS FOLDERID: Folder in the content management system to store individual identification document.

Document management adapter is designed to integrate with any document management system. You must configure the preferred document management system as a spoke system in CX Industries Framework. See samples in the following sections.

Configure Oracle Content Management as a Spoke System in CX Industries Framework

The CX Industries Framework document management adapter is designed to work with Oracle Content Management (OCE) as the default document management system. Perform the following steps to configure a Oracle Content Management instance as a spoke in CX Industries Framework.

Prerequisites

The following information is required to configure:

OCE URL: The URL of the OCE instance.
OCE IDCS URL: The URL of the Oracle Identity Cloud Service instance of OCE.
OCE IDCS Scope: The scope of the OCE instance as configured in the Oracle Identity Cloud Service instance of OCE.
OCE IDCS Client ID: The client ID generated by the confidential application.
OCE IDCS Client Secret: The client secret generated by the confidential application.
Document Management System ID : Any arbitrary string to represent the OCM instance such as OCM1.
Note: You must use the value of the document management system ID configured here in the buying configuration also.

Configure Oracle Content Management as a Spoke System in Framework Cluster

Here are the steps that you must perform through the Framework APIs with the Framework OAuth credentials.

OCM API Definition in Framework.

Verify API definition.

DO GET is available at https://<fabric api gw >/admin/apis

Verify that the API ocm-v1 is available as shown in the following API definition (GET) sample response:

{
   "api-name":"ocm-v1",
   "api-id":"ocm-100",
   "api-version":"v1",
   "api-resources":[
      {
         "resource-id":"file-id",
         "name":"file-id",
         "resource-path":"{document-management-system-id}/api/1.2/files/{id}",
         "path-parameters":[
            {
               "parameter-name":"id",
               "parameter-type":"string",
               "is-record-id":false
            },
            {
               "parameter-name":"document-management-system-id",
               "parameter-type":"string",
               "is-record-id":false
            }
         ],
         "cors-preflight-handling":"fabric",
         "routing-ambiguity-resolution-strategy":"HTTP400BadRequest"
      },
      {
         "resource-id":"file-id-data",
         "name":"file-id-data",
         "resource-path":"{document-management-system-id}/api/1.2/files/{id}/data",
         "path-parameters":[
            {
               "parameter-name":"id",
               "parameter-type":"string",
               "is-record-id":false
            },
            {
               "parameter-name":"document-management-system-id",
               "parameter-type":"string",
               "is-record-id":false
            }
         ],
         "cors-preflight-handling":"fabric",
         "routing-ambiguity-resolution-strategy":"HTTP400BadRequest"
      },
      {
         "cors-preflight-handling":"fabric",
         "name":"folder-id",
         "path-parameters":[
            {
               "is-record-id":false,
               "parameter-name":"id",
               "parameter-type":"string"
            },
            {
               "is-record-id":false,
               "parameter-name":"document-management-system-id",
               "parameter-type":"string"
            }
         ],
         "resource-id":"folder-id",
         "resource-path":"{document-management-system-id}/api/1.2/folders/{id}",
         "routing-ambiguity-resolution-strategy":"HTTP400BadRequest"
      }
   ],
   "alternative-root-path":"documents",
   "api-events":[
       
   ],
   "openapi-document-url":"https:/do-nothing",
   "id":"ocm-v1"
}

Create a new target type definition (TTD) or system descriptor.

Go ahead and define the target type definition (TTD), also known as the system descriptor.

REST API: POST

https://<fabric api gw >/admin/systemDescriptors

Note the id returned in the response.

OCM sysDescriptors (post request payload)

{
   "target-name":"ocm-v1",
   "external":{
      "apis":[
         {
            "api-id":"ocm-100",
            "api-version":"v1",
            "api-resources":[
               {
                  "resources":[
                     {
                        "resource-id":"file-id"
                     },
                     {
                        "resource-id":"file-id-data"
                     },
                     {
                        "resource-id":"folder-id"
                     }
                  ]
               }
            ]
         }
      ]
   },
   "system":"ocm",
   "domain":"ocm",
   "type":"external"
}

Create a new TIC or connection descriptor.

REST API: POST

https://<fabric api gw >/admin/connectionDescriptors

The end point, client id, and secret of the target OCM instance are required.

Note the id returned in the response.

connectionDescriptor (Post request payload)

{
    "system-descriptor": "ocm-api-ttd",   #id obtained in the previous step
    "endpoint-name": "ocm-v1",
    "endpoint-url": "<OCE URL>", #actual OCM instance URL
    "fabric-facing-auth": {
        "oidc-client-credentials": {
            "client-id": "<OCE IDCS Client ID>", #actual client id
            "client-secret": "<OCE IDCS Client Secret>", # secret
            "identity-uri": "<OCE IDCS URL>/oauth2/v1/token", # IDCS used to authenticate OCM
            "scope": "<OCE IDCS Scope>" #actual scope
        }
    },
    "type": "external"
}

Create routing criteria based on path param (documentManagementSystemId)

POST

https://<fabric api gw >/admin/routingCriteria

As the user, you can give any arbitrary value. This should be used as the docAdapterDocumentManagementSystemId in the buying configuration or caller configuration.

Routing Criteria (Post request payload)

{
        "any-criteria-of": [
            {
                "path-param-criteria": {
                    "path-parameters": [
                        {
                            "path-parameter-name": "document-management-system-id",
                            "path-parameter-value-oneOf": [
                                "<Document Management System ID>"
                            ],
                            "path-parameter-backend-handling": "routing-only"
                        }
                    ]
                }
            }
        ],
        "criteria-link-key": "OCM Criteria"
    }

Note the id returned in the response. This id is required in the GKR claim process.

Claim GKR
You have defined the APIs , defined TTD for the system, and a TIC also. You must now claim the resources. After TTD and TIC are submitted, you will see an autogenerated GKR. Get the ID of the newly generated GKR and claim the resources along with any criteria, that you may want to define.
DO GET is available at https://<fabric api gw >/admin/gatekeepingRules?endpoint-name=ocm-v1
From the response get the id (gkrID) of the corresponding record and use the id to update gkr with the following steps (sample response):
```
[
    {
        "endpoint-name": "ocm-v1",
        "rule-name": "Generated gatekeeping rule for endpoint ocm-v1",
        "destination-selection": [
            {
                "api-id": "ocm-100",
                "api-version": "v1",
                "criteria": [
                    {
                        "rank": 10,
                        "resource-ids": [
                            "file-id",
                            "file-id-data",
                            "folder-id"
                        ]
                    }
                ]
            }
        ],
        "id": "gkr-ocm-v1nxccm"
    }
]
```
DO GET is available at https://<fabric api gw >/admin/gatekeepingRules/{gkrID}
Copy the response.
API PUT is available at https://<fabric api gw >/admin/gatekeepingRules/{gkrID}
GKR Claim (Put request payload): Update the GKR with the criterion-link field having the ID of the criterion obtained from the previous step.
```
{
   "endpoint-name":"ocm-v1",
   "rule-name":"Generated gatekeeping rule for endpoint ocm-v1",
   "destination-selection":[
      {
         "api-id":"ocm-100",
         "api-version":"v1",
         "criteria":[
            {
               "rank":10,
               "resource-ids":[
                  "file-id",
                  "file-id-data",
                  "folder-id"
               ],
               "criterion-link":"UNI1702899361" //ID From previous step
            }
         ]
      }
   ]
}
```

Note: You can download the latest version of the Framework Implementation guide from the My Oracle Support (Article ID 2720527.1) and see the Set Up Custom APIs chapter.