Setting Up the Communications Connector

The communications connector enables OCI Process Automation 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.

Important: Oracle provides a Solution Package with sample process definitions with preconfigured connector configurations. It is recommended to clone these samples and use them as starting points for your own process definitions. The instructions in this procedure explain how to set up the communications connector from scratch and should be considered only a sample for illustration purposes.

The following procedure explains how to set up the communications connector with the specific integration information that is required by the Public Sector system.

Note: Currently, in the context of data object parameters, data association parameters, and REST resource attributes, the terms record, transaction,, permit, business license, or planning application are interchangeable.

To set up the communication connector:

1. (Optional) If you are building the process application from scratch, you can download sample JSON from My Oracle Support.

   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

2. Access the main console in OCI Process Automation.

3. In the list of applications, click the process application with your transaction workflow.

4. Click the Connectors node at the top.

5. Click the Add button, then in Add component drawer, expand Connectors > REST API

6. In the Add component drawer, enter the following:

   Page Element	Description
   Title	Enter a descriptive name such as CommunicationsConnector. Note: The name CommunicationsConnector is suggested, however, you can choose your own name if needed. The title is the user friendly term.
   Identifier Name	Automatically created by the title you enter but can be changed before saving. This is the internal system ID for the connector.
   Base URL	Enter the URL for your Oracle Permitting and Licensing 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

7. Click Create.

8. Click the Security icon on the right.

9. On the Security drawer, for Security Type select either OAuth or Global Credential, the recommend options.

   This is where you provide the proxy user information. See Setting Up OCI Process Automation Proxy User.

10. Depending on the security type selected, enter the appropriate information.

11. Click Save.

12. Click Add in the header.

13. 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. Note: If you need to call a Business Rules Framework event to run a business rule to send a notification only if the scenario meets your criteria, you can set up the connector to call the Business Rules Framework Request API (publicSectorBusinessRulesFrameworkRequests).

14. In the Operations section, click the Add button and then select POST from the drop-down menu.

15. Click the new POST operation.

16. Enter Trigger transaction communications in the Description field.

    You can leave the default values in the other fields, including leaving the Path field blank.

17. Click Request

18. Click the + icon next to the Body field to open the Import Business Object from JSON window.

19. Enter RequestCommunications in the Name field.

20. Click Schema.

21. Click the Import from File icon next to the Schema button.

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

23. Click the Import button at the bottom of the window to save the code and close the window.

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

25. Click Response.

26. Click the + icon next to the Body field to open the Import Business Object from JSON window.

27. Enter ResponseCommunications in the Name field.

28. Click Schema.

29. Click the Import from File icon next to the Schema button.

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

31. Click the Import button at the bottom of the window to save the code and close the window.

32. Ensure that the following values appear for the POST operation response:

    Page Element	Value to Enter
    Body	BusinessData.ResponseCommunications
    Media Type	application/JSON

33. Click Apply.

34. Click Save.