Setting Up the Transactions Connector
The transactions connector enables OCI Process Automation to exchange transaction-related information with the Oracle Permitting and Licensing system.
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.
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. In some resource attributes, such as paths or parameters, trans is used in place of transaction for simplicity.
Procedure Overview for Setting Up the Transactions Connector
Setting up the Transactions Connector comprises multiple procedures with multiple steps. The following set of steps outline the high-level set of procedures involved with this task. Each item in the following list is explained in more detail in the following sections, in the listed sequence.
Download JSON Files for Workflow Integration Configuration (only if you are building from scratch and not using the provided samples in the Solution Package).
Create the Transactions Connector
Add the Transaction Resource
Add the PATCH Operation for Transaction Statuses
Add the GET Operation for Transaction Base Data
Add the GET Operation for Transaction Fields Data
Add the GET Operation for Transaction Data
Add the GET Operation for Transaction Assignee
Add the GET Operation for Transaction Type Resource
Add the Transaction Type Data
-
Add the POST Operation for the Business Rules Request.
Step 1: Download Required JSON Files for Workflow Integration Configuration
For creating integrations from scratch, Oracle provides a set of JSON files for defining the integration between OCI Process Automation and the Oracle Permitting and Licensing system. Download all of the files first so that you can access them easily while completing the procedures documented in this topic.
To download the required JSON:
Sign on to My Oracle Support.
Access Doc ID 2449735.1, Public Sector Compliance and Regulation: JSON Files for Transaction Integration.
Download the following files to a local folder:
RequestTransStatusUpdate.json
ResponseTransStatusUpdate.json
ResponseTransBase.json
ResponseTransFields.json
ResponseTransData.json
ResponseTransAssignee.json
ResponseTransType.json
Step 2: Creating the Transaction Connector
This procedure explains how to create the transaction connector. Additional procedures that follow this one explain how to set up the operations for this connector.
To set up the transactions connector:
Access the main console in OCI Process Automation.
In the list of applications, click the application for your workflow process.
Select the Connectors node in the toolbar.
Click the Create button, then in the pop-up menu under the Create button, select
In the Add component drawer, enter the following:
Page Element
Description
Name
Enter a descriptive name, such as TransactionConnector.
Note:The name TransactionConnector is suggested, however, you can choose your own name if needed. This documentation refers to TransactionConnector.
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 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
Click Create.
Click the Security icon from the toolbar on the right.
-
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.
-
Depending on the security type selected, enter the appropriate information.
Click Save
Step 3: Add the Transactions Resource
Before starting this procedure, be sure to complete the procedure “Setting Up the Transactions Connector.”
Access the main console in OCI Process Automation.
In the list of applications, click the application for your workflow process.
Click the Connectors option.
Click the TransactionConnector connector.
In the Resources section of the Rest Connector Editor, click Add.
Expand the new Resource section that appears, and enter TransactionResource in the Name field.
Step 4: Add the PATCH Operation for Transaction Statuses
Workflow in OCI Process Automation uses the PATCH operation to update the status of a transaction.
To set up the PATCH operation:
In the Operations section of TransactionResource, click the Add button and then select PATCH operation from the drop-down menu.
Click the new PATCH operation.
Enter the following information:
Page Element
Value
Name
patchTransactionStatus
Path
{transResource}/{transRecordKey}
Although you can choose different names for the resource name and record key parameters, this procedure assumes that you use the given values.
Documentation
Update transaction status.
Click Request
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter RequestTransStatusUpdate in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the RequestTransStatusUpdate.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 PATCH operation request:
Page Element
Value to Enter
Body
BusinessData.RequestTransStatusUpdate
Media Type
Custom
Media Type details
application/vnd.oracle.adf.resourceitem+json
In each row of the Parameters list, click the Enter a description text and enter a description.
These are example descriptions:
Parameter
Description
transResource
Transaction Resource Name
transRecordKey
Transaction Record Key
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransStatusUpdate in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransStatusUpdate.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 PATCH operation response:
Field
Value
Body
BusinessData.ResponseTransStatusUpdate
Media Type
application/JSON
Click Apply.
Click Save.
Step 5: Add the GET Operation for Transaction Base Data
Before starting this procedure, be sure to complete the procedure “Adding a PATCH Operation for Transaction Statuses.”
The getTransactionBaseData operation gets general transaction data that is found in all transactions, such as the permit type, the permit status, and the permit applicant for a permit transaction.
Expand the TransactionResource resource.
In the Operations section, click the Add button and then select GET operation from the drop-down menu.
Click the new GET operation.
Enter the following information:
Field
Value
Name
getTransactionBaseData
Path
{transResource}/{transRecordKey}
Although you can choose different names for the resource name and record key parameters, this procedure assumes that you use the given values.
Description
Get base transaction data, such as applicant information
Click Request
In each row of the Parameters list, click the Enter a description text and enter a description.
These are example descriptions:
Parameter
Description
transResource
Transaction Resource Name
transRecordKey
Transaction Record Key
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransBase in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransBase.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 GET operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseTransBase
Media Type
application/JSON
Click Apply.
Step 6: Add the GET Operation for Transaction Fields Data
The getTransactionFieldsData gets field data from the application intake form configured using the Intake Form Designer.
In the Operations section of the Transactions Resource, click the Add button and then select GET operation from the drop-down menu.
Click the new GET operation.
The new GET operation has the default name of GetTransactionResources.
Enter the following information:
Field
Value
Name
getTransactionFieldsData
Path
{transResource}/{transRecordKey}/child/FieldGroups
Although you can choose different names for the resource name and record key parameters, this procedure assumes that you use the given values.
Description
Get specific transaction data, such as job cost.
Click Request.
In each row of the Parameters list, click the Enter a description text and enter a description.
These are example descriptions:
Parameter
Description
transResource
Transaction Resource Name
transRecordKey
Transaction Record Key
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransFields in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransFields.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 GET operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseTransFields
Media Type
application/JSON
Click Apply.
Click Save.
Step 7: Add the GET Operation for Transaction Data
The getTransactionData combines getTransactionBaseData and getTransactionFieldsData into a single operation, which you can use instead of using getTransactionBaseData and getTransactionFieldsData separately.
In the Operations section, click the Add button and then select GET operation from the drop-down menu.
Click the new GET operation.
The new GET operation has the default name of GetTransactionResources.
Enter the following information:
Field
Value
Name
getTransactionData
Path
{transResource}/{transRecordKey}
Although you can choose different names for the resource name and record key parameters, this procedure assumes that you use the given values.
Description
Combines getTransactionBaseData and getTransactionFieldsData into a single operation.
Click Request.
In each row of the Parameters list, click the Enter a description text and enter a description.
These are example descriptions:
Parameter
Description
transResource
Transaction Resource Name
transRecordKey
Transaction Record Key
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransactionData in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransactionData.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 GET operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseTransactionData
Media Type
application/JSON
Click Apply.
Click Save.
Step 8: Add the GET Operation for Transaction Assignee
In the Operations section, click the Add button and then select GET operation from the drop-down menu.
Click the new GET operation.
The new GET operation has the default name of GetTransactionResources.
Enter the following information:
Field
Value
Name
getTransactionAssignee
Path
publicSectorTransactionLatestAssignees/{transRecordKey}
Although you can choose different names for the resource name and record key parameters, this procedure assumes that you use the given values.
Description
Get specific transaction data, such as job cost.
Click Request.
In each row of the Parameters list, click the Enter a description text and enter a description.
These are example descriptions:
Parameter
Description
transRecordKey
Transaction Record Key
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransactionFields in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransAssignee.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 GET operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseTransAssignee
Media Type
application/JSON
Click Apply.
Click Save.
Step 9: Add the Transaction Type Resource
Before starting this procedure, be sure to complete the previous procedures.
Access the main console in OCI Process Automation.
In the list of OCI Process Automation applications, click the application for your workflow process.
Click the Integrations option in the left frame.
Click the TransactionsConnector integration.
In the header of the Resources section, click Add to create a new transaction type resource.
Expand the new Resource section that appears, and enter the following information:
Field
Value
Name
TransactionTypeResource
Path
publicSectorRecordTypes
Step 10: Add the GET Operation for Transaction Type Data
The GetTransactionTypeData operation gets data that is associated with the transaction type definition rather than with an individual transaction. For example, this operation can get the overall fee structure for a permit definition, because the fee structure is associated with the permit type.
To set up the GET operations for transaction type data:
In the Operations section of the Transaction Type Resource, click the Add button and then select GET operation from the drop-down menu.
Click the new GET operation.
Enter the following information:
Page Element
Value
Name
getTransactionTypeData
Path
{transResource}
Documentation
Get transaction type setup data.
Click Request
In the Parameters list, click the Enter a description text and enter a description.
Here is an example description:
Parameter
Description
transResource
Transaction Resource Name
Click Response.
Click the + icon next to the Body field to open the Import Business Object from JSON window.
Enter ResponseTransTypeData in the Name field.
Click Schema.
Click the Import from File icon next to the Schema button.
Locate and upload the ResponseTransType.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 GET operation response:
Page Element
Value to Enter
Body
BusinessData.ResponseTransTypeData
Media Type
application/JSON
Click Apply.
Click Save.
Step 11: Add the POST Operation for the Business Rules Request
This step describes how to configure integration with Oracle Permitting and Licensing by calling REST resources directly from workflow process definitions.
Generally, any REST API can be called from your workflow process definition. There are multiple REST API’s provided with the Oracle Permitting and Licensing offerings. The sample workflow models provided to get you started include only a handful of the integrations that could be configured, depending on your business requirements.
Each process definition has a set of connectors that you can view on the Integrations tab. In the sample workflow process definitions and documentation the each connector is separated to make it easier to view and describe. However, you may choose to combine all the individual connectors into a single connector.
This procedure outlines how you can configure additional integrations within process definitions to call Oracle Permitting and Licensing REST APIs to incorporate more data to drive your workflow process. This example demonstrates how to configure an integration with a Business Rules Framework API.
For more information on the Business Rules Framework, see Business Rules Framework Overview.
To set up an integration:
-
Open the Transaction Connector.
-
In the Resources box, click Add.
-
Expand the added resource and enter these values:
Page Element
Description
Value
Name
The name of the integration or connector. You can enter a custom name as needed.
BusinessRules
Path
The name of the REST resource you intend to call.
publicSectorBusinessRulesFrameworkRequests
-
On the new resource, click Add, and select the appropriate operation.
In this case, select POST operation.
-
Click the newly added operation.
-
(Optional) Add a different name or additional path.
-
Configure the JSON Request.
-
In the Response and Request section, select the Request tab, and click Create business object under the Body field to open the Import Business Object from JSON dialog box.
-
For Name enter a recognizable name for the request, such as RequestBusinessRules.
-
In the Enter the JSON edit box, select Schema.
-
Copy and paste the following JSON.
{ "type" : "object", "properties" : { "EventCode" : { "type" : "string" }, "RecordFirstKeyName" : { "type" : "string" }, "RecordFirstKeyValue" : { "type" : "string" } } }
-
Click Import.
-
Close the Import Business Object from JSON dialog box.
-
-
Configure the JSON Response.
-
In the Response and Request section, select the Request tab, and click Create business object under the Body field to open the Import Business Object from JSON dialog box.
-
For Name enter a recognizable name for the response, such as ResponseBusinessRules.
-
In the Enter the JSON edit box, select Schema.
-
Copy and paste the following JSON.
{ "type" : "object", "properties" : { "CreationDate" : { "type" : "string" }, "EventCode" : { "type" : "string" }, "EventId" : { "format" : "long", "type" : "number" }, "ExecutionId" : { "type" : "string" }, "LastUpdateDate" : { "type" : "string" }, "LogId" : { "format" : "long", "type" : "number" }, "NoRules" : { "type" : "string" }, "RecordFifthKeyName" : { "type" : null }, "RecordFifthKeyValue" : { "type" : null }, "RecordFirstKeyName" : { "type" : "string" }, "RecordFirstKeyValue" : { "type" : "string" }, "RecordFourthKeyName" : { "type" : null }, "RecordFourthKeyValue" : { "type" : null }, "RecordIdentifier" : { "type" : null }, "RecordSecondKeyName" : { "type" : null }, "RecordSecondKeyValue" : { "type" : null }, "RecordSubIdentifier" : { "type" : null }, "RecordThirdKeyName" : { "type" : null }, "RecordThirdKeyValue" : { "type" : null }, "ResourceId" : { "format" : "long", "type" : "number" }, "StopProcess" : { "type" : "string" } }
-
Click Import.
-
Close the Import Business Object from JSON dialog box.
-
-
Click Apply and Save.
-
Add a task to the process definition to incorporate the integration.
-
Open the process definition.
-
In the BPMN palette, expand the Integrations section, and drag your integration onto the process definition in the desired location and update the connectors as needed.
-
-
Confirm the integration is referencing the correct operation.
-
Select the task and click Open Properties.
-
Select Implementation, General and then click Configure for the Service Call.
-
-
Configure data associations.
-
Select your integration task and select Open Data Association.
-
On the Data Association page, select the Input tab.
-
Map the following process definition data attributes to your Business Rules integration attributes, and click Apply and Save.
Data Object
Integration
"LNP-PERMT-UPDATE"
or
"PZ-PLANNING-UPDATE"
Enter these values manually, depending on whether this process definition is being used for Permits or Planning and Zoning.
body.EventCode
"LnpRecordKey"
Enter this value manually.
body.RecordFirstKeyName
transaction.transactionKey
body.RecordFirstKeyValue
-