Setting Up the Communications Connector
The communications connector enables Oracle Integration Cloud (OIC) to send data to the communications center in the Oracle Permitting and Licensing system using a POST operation. This connector is used when a workflow process definition includes a communication task, such as sending a permit applicant an email when the permit status changes.
Oracle provides a Solution Package with sample integration configurations. You can clone these samples and use them as starting points for your own connectors. The instructions in this procedure explain how to set up the communications connector from scratch.
The following procedure explains how to set up the communications connector with the specific integration information that is required by the Public Sector system. For general instructions related to setting up integrations in OIC, refer to your OIC documentation at https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/integrate-applications-and-services.html.
To set up the communication connector:
Go to My Oracle Support, access Doc ID 2449735.1, Public Sector Compliance and Regulation: JSON Files for Transaction Integration, and download the following files that you will use later in this procedure:
RequestCommunications.json
ResponseCommunications.json
Access the main console in OIC.
In the list of OIC applications, click the application with your transaction workflow.
Click the Integrations option in the left frame.
Click the Create button, then in the pop-up menu under the Create button, select
In the Create REST Connector window, enter the following:
Page Element
Description
Name
Enter a descriptive name such as CommunicationsConnector.
Note: The name CommunicationsConnector is suggested, however, you can choose your own name if needed.Base URL
Enter the URL for your Oracle Public Sector Cloud REST API resources. The URL follows this pattern, where ServerName is the server name for your instance of the application:
https://ServerName/fscmRestApi/resources/11.13.18.05
Open Immediately
Select this check box if it is not already selected.
Click Create.
The Rest Connector Editor opens.
To set up security for this integration, click the Edit link for the Configuration section.
Note: If you prefer to set up security when you activate the workflow application, you can skip the security-related steps in this procedure and skip ahead to step 13. Setting up security now simplifies the application activation steps.Click the Security tab.
In the Security Type field, select APP Id - Basic Authentication.
Complete these additional fields that appear after you select the Security Type:
Page Element
Description
Keystore Credential
If you previously created a keystore credential, select it. Otherwise, leave this field set to [New Key] so that the system will create the keystore credential when you apply your changes.
Key Name
If you selected [New Key] as the keystore credential, enter the name to give to the new keystore.
If you selected an existing keystore credential, this field is read-only and displays the key name.
Username
Enter the user name for the process cloud proxy user that you previously created.
If you’re using an existing keystore credential, that credential supplies a default username.
Password
Enter the password for the process cloud proxy user that you previously created.
If you’re using an existing keystore credential, that credential supplies a default password.
Click Apply to save the security information and close the Configuration section.
In the Resources section of the Rest Connector Editor, click Add.
Expand the new Resource section that appears, and enter the following values:
Field
Value
Name
OutboundCommunications
Path
publicSectorCommunicationRequests
When added to the base URL, this completes the path to the communications-related REST APIs.
In the Operations section, click the Add button and then select POST operation from the drop-down menu.
Click the new POST operation.
Enter Trigger transaction communications in the Documentation field.
You can leave the default values in the other fields, including leaving the Path field blank.
Click Request
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter RequestCommunications in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.Locate and upload the RequestCommunications.json file that you downloaded from My Oracle Support.
The imported JSON code appears in the Import Business Object from JSON window.
Click the Import button at the bottom of the window to save the code and close the window.
Ensure that the following values now appear for the POST operation request:
Page Element
Value
Body
BusinessData.RequestCommunications
Media Type
Custom
Media Type details
application/vnd.oracle.adf.resourceitem+json
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseCommunications in the Name field.
Click Schema.
- Click the Import from File icon next to the Schema button.
Locate and upload the ResponseCommunications.json file that you downloaded from My Oracle Support.
The imported JSON code appears in the Import Business Object from JSON window.
Click the Import button at the bottom of the window to save the code and close the window.
Ensure that the following values appear for the POST operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseCommunications
Media Type
application/JSON
Click Apply.
Click Save.