Payroll Flows Outbound API Notifications
Configure an outbound notification with the payroll flows Outbound API Notifications feature. Once a task in a flow completes, it sends a completion message to an external downstream server. The server gets an automatic notification once the task completes, and it then triggers downstream non-payroll processes.
The flows outbound API notification solution utilizes the industry standard client credentials flow, OAuth 2.0. This standard allows for secure communication between servers based on a token authentication approach. This solution is automatically called once the task completes.
Use the Outbound Integration tab on the flow setup page and enter this information required by OAuth 2.0 to allow for an outbound confirmation notification to be sent.
Use the Payroll Flow Patterns task under Payroll in My Client Groups to search for a flow and click Edit. Under the Outbound Integration tab enter this information required by OAuth 2.0 to allow for an outbound confirmation notification to be sent.
- Client ID
- Client Secret
- Authorization Service URL
- Resource Service URL
You must also select the Enable Outbound check box on the flow setup page.
The configuration level for this feature is at flow pattern level. However, a notification is sent for each task in the flow.
- Flow Instance Name
- Checklist Name
- Flow Task Group Status
-
Owner Type
- Owner
-
Completion Time
Retry Notifications
An automatic and manual retry option for the notification is available if a response isn’t received from the customer application. The number of automatic retries is set to 5 and the wait time between each retry is 1, 2, 4, 8, 16 seconds respectively.
For a task that is in Complete status, you can use the manual retry option available in the Actions menu on the Checklist page. This option isn’t available for tasks in Not Started or In Progress status. You can view the notification and retry notification messages in the View Messages page. Navigate to the View Messages page using the Actions menu on the Checklist page.
Enable Outbound API Notifications
Use the ORA_PAY_SEC_UI_FLO profile option to enable the Outbound API Notifications feature. Before you enable the profile option, log an SR with Oracle Support so they can generate a key and run the upgrade process so as to enable the profile option.