Invoke Function (MS Azure Functions) activity

An activity that invokes a function in Microsoft Azure Functions.


Invoke Function activity

Configure the Invoke Function activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the MS Azure Functions tab.

    Open MS Azure Functions tab
  3. On the MS Azure Functions tab, drag the Invoke Function activity onto your process.

    Drag Invoke Function activity

General Configuration

Specifies the basic settings for the Invoke Function activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Invoke Function Configuration > Request Mapping tab

Connects the request payload from Microsoft Azure Functions to the process schema.

Figure: Invoke Function Configuration > Request Mapping tab

Invoke Function Configuration Request Mapping tab

Fields

Field NameDefinition

MS Azure Functions

Description:
Specifies the access token that connects to Microsoft Azure Functions.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Azure Functions
Function of this Screen:
Configure an access token to connect to Microsoft Azure Functions.

Function

Description:
Specifies the name of the function to execute in Microsoft Azure Functions.
Allowed Values:
A function from the list.

When you select the access token in the MS Azure Functions field, this field shows the functions associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Method

Description:
Specifies the method to call in the function.
Allowed Values:
A method from the list.

When you select the function, this field shows the methods associated with the function.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Enter Request Payload / Get Request Payload From This Variable

Description:
Specifies how to connect the request data from Microsoft Azure Functions to the AgilePoint process schema.
Allowed Values:
  • Enter Request Payload – Specify a payload to use to connect to the process schema.

    In the text field, specify a payload in JSON format.

    Click Map Request button to open the Schema Mapper screen. Use this screen to connect the payload values to the AgilePoint process schema.

  • Get Request Payload From This VariableSpecifies a variable that stores the payload. The value of the process data variable must be in a valid JSON format.
Default Value:
Enter Request Payload
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Invoke Function Configuration > Response Mapping tab

Specifies where to store the response from Microsoft Azure Functions.

Figure: Invoke Function Configuration > Response Mapping tab

Invoke Function Configuration Response Mapping tab

Fields

Field NameDefinition

MS Azure Functions

Description:
Specifies the access token that connects to Microsoft Azure Functions.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Azure Functions
Function of this Screen:
Configure an access token to connect to Microsoft Azure Functions.

Function

Description:
Specifies the name of the function to execute in Microsoft Azure Functions.
Allowed Values:
A function from the list.

When you select the access token in the MS Azure Functions field, this field shows the functions associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Method

Description:
Specifies the method to call in the function.
Allowed Values:
A method from the list.

When you select the function, this field shows the methods associated with the function.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Enter Response Payload / Store Response In This Variable

Description:
Specifies where to store the response from Microsoft Azure Functions.
Allowed Values:
  • Enter Response Payload – Specifies a payload to use to map the response to the AgilePoint process schema.

    Click the Map Response button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

  • Store Response In This VariableSelect this option if you want to store the information from Microsoft Azure Function to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

Default Value:
Enter Response Payload
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?