Skip to main content

Adding cloud functions to Process Orchestration steps

Cloud functions enable you to define and execute authenticated API calls to any external web services directly from Process Orchestrationsteps. This allows you to collect relevant data from external services and inject it back into your orchestration.

Before you begin

  • To use cloud functions in Process Orchestration, you will have to establish a connection between your orchestration step and a dedicated cloud server. Make sure you have your connection details handy, or check with your system admin for them. For the list of required settings, see the detailed steps below.

  • Create a Process Orchestration step. See Editing process steps.

Adding cloud functions to process steps

  1. In the process step editor, select the Cloud function tab.

    Process Orchestration step editor with the Cloud function step selected.

  2. Click Configure cloud function.

  3. Give the cloud function a name.

  4. Provide the connection details. From the dropdown menu, select the cloud provider. Select from the following connection types:

    • Amazon Connect - this is a preconfigured integration for which you only need to provide your connection information. You should be able to find the following information in your AWS Management Console:

      • Connection name

      • Default region

      • Access key ID

      • Secret access key

      Cloud function tab settings in the Process Orchestration tab. Amazon Connect is selected as the cloud provider and there are several connection setting entered.

    • Custom - connect to a cloud provider of your choice. Provide the following information:

      • Connection name - label for this connection,

      • Base URL - address of the cloud server,

      • Authentication type - authentication method; select one of the following and provide the necessary information:

        • API key

          • Location - where to attach the API key in the outgoing request.

          • Name - label that your cloud server will be looking for.

          • Value - unique password or token.

        • OAuth 2.0

          • Client ID - public identifier.

          • Client secret - authorization password or token.

          • Scopes - specific permissions you want your application to have when connecting to the cloud server. Check your server provider’s documentation for the exact list of scopes and their format.

          • Token URL - URL of your access token.

          • Refresh URL  - URL that allows you to get new access token without user’s interaction.

  5. Define Execution settings using the HTTPS request builder. Enter the following values:

    • Method - the exaction you want to action you want to perform on a specific resource identified by a URL. The most commonly used HTTP request methods are: GET, POST, PUT, DELETE,

    • URI - the address of the external service you want to reach.

      Important

      The URI address must be static text wrapped in double quotes, for example: "this-is-my-uri".

    • Query parameters - key-value pairs that allow you to filter or sort data.

    • Body (JSON format) - the data payload sent with the request.

    • Headers - metadata sent along with the request.

  6. Select a completion event. Select an existing event or create a new one.

    Completion events log details about the current step to provide content to the next steps in orchestration. Subsequent steps use this data to determine when the previous step has completed so they can begin execution.

Your step is created. Continue building your process. We advise testing it before deployment.

Related topics