gRPC Service activity

An activity that calls a gRPC service method from an AgilePoint NX app.

Configure the gRPC Service activity

Examples

(External) AgilePoint NX Connector For gRPC Service
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.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Web Services tab.
On the Web Services tab, drag the gRPC Service activity onto your process.

General Configuration

Specifies the basic settings for the gRPC Service activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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

gRPC Service Configuration > Request Mapping tab

Specifies the gRPC service method to call when the activity starts.

Fields

Field Name	Definition
gRPC Service	Description: Specifies the access token that connects to your gRPC service. Allowed Values: A list of access tokens configured for your environment. Default Value: A process data variable based on the parameter name.
Create	Opens this Screen: Access tokens for gRPC Service Function of this Screen: Configure an access token to connect to a gRPC service.
Service	Description: Specifies the name of the service to call in gRPC. Allowed Values: A service from the list. When you select the access token from the gRPC Service field, this field shows the services associated with the access token. Default Value: None 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 gRPC service. Allowed Values: A method from the list. When you select the service name from the Service field, this field shows the methods associated with the service. Default Value: None 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?
Auto Discover Request Schema / Manually Enter Sample Request Payload	Description: Specifies how to connect the request data from the gRPC service request to the AgilePoint process schema. Allowed Values: Auto Discover Request Schema - Sends a request using the protobuf value configured in the gRPC Service access token in AgilePoint NX. Click Map Request To App Schema to open the Schema Mapper screen. Use this screen to connect the payload values to the AgilePoint process schema. Manually Enter Sample Request Payload – Specify a payload in JSON format to use to connect to the process schema. Click Map Schema to open the Schema Mapper screen. Use this screen to connect the payload values to the AgilePoint process schema. Default Value: None Example: Refer to: (Example) Schema Mapper

gRPC Service Configuration > Response Mapping tab

Specifies where to store the response from the gRPC service.

Fields

Field Name	Definition
gRPC Service	Description: Specifies the access token that connects to your gRPC service. Allowed Values: A list of access tokens configured for your environment. Default Value: A process data variable based on the parameter name.
Create	Opens this Screen: Access tokens for gRPC Service Function of this Screen: Configure an access token to connect to a gRPC service.
Service	Description: Specifies the name of the service to call in gRPC. Allowed Values: A service from the list. When you select the access token from the gRPC Service field, this field shows the services associated with the access token. Default Value: None 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 gRPC service. Allowed Values: A method from the list. When you select the service name from the Service field, this field shows the methods associated with the service. Default Value: None 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?
Auto Discover Response Schema / Manually Enter Sample Response Payload	Description: Specifies where to store the response from the gRPC service. Allowed Values: Auto Discover Response Schema - Creates a response using the protobuf value configured in the gRPC Service access token in AgilePoint NX. Click Map Respose To App Schema to open the Schema Mapper screen. Use this screen to connect the response to the data model for your process. Manually Enter Sample Response Payload – Specify a payload in JSON format to use to map the response to the process schema. Click Map Response to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper

gRPC Service Configuration > Metadata tab

Configures the metadata for the gRPC service.

Fields

Field Name	Definition
gRPC Service	Description: Specifies the access token that connects to your gRPC service. Allowed Values: A list of access tokens configured for your environment. Default Value: A process data variable based on the parameter name.
Create	Opens this Screen: Access tokens for gRPC Service Function of this Screen: Configure an access token to connect to a gRPC service.
Service	Description: Specifies the name of the service to call in gRPC. Allowed Values: A service from the list. When you select the access token from the gRPC Service field, this field shows the services associated with the access token. Default Value: None 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 gRPC service. Allowed Values: A method from the list. When you select the service name from the Service field, this field shows the methods associated with the service. Default Value: None 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?
Key	Description: Specifies the name of the key to add as metadata to the gRPC service in a key-value pair. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters 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?
Value	Description: Specifies the value for the key in a key-value pair. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters 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?
Create	Function: Adds a row for the Key and Value fields.
Delete	Function: Deletes the selected row.