Amazon SageMaker activity

An activity that gives predictions based on an Amazon SageMaker model for the AgilePoint NX app. You can also skip activities in a process if the conditions specified in the Amazon SageMaker model occur.

Amazon SageMaker analyzes data in an app to make predictions. For example, if an app accepts data for college admission that has grades, course history, and other relevant data, Amazon SageMaker can predict whether the candidate qualifies for admission to a school.

Configure the Amazon SageMaker activity

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 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 Machine Learning tab.
On the Machine Learning tab, drag the Amazon SageMaker activity onto your process.

General Configuration

Specifies the basic settings for the Amazon SageMaker 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

Amazon SageMaker Configuration > Request tab

Configures the models for an activity where the Amazon SageMaker model runs.

Fields

Field Name	Definition
Add Model	Function: Creates a model with a name you specify. In this activity, you can create more than one model to configure an Amazon SageMaker model to give predictions for an app. Each configuration is stored as a model with a name specified in this field. 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?
Edit	Function: Changes the model name.
Delete	Function: Deletes the selected model.
Amazon Web Services	Description: Specifies the access token that connects to your Amazon Web Services. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Amazon Web Services Function of this Screen: Configure an access token to connect to Amazon Web Services.
Endpoint	Description: Specifies the Amazon SageMaker endpoint to use for predictions. Allowed Values: An endpoint from the list. When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token. Default Value: None Accepts Variables: No 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?
Target Container Host Name	Description: Specifies the host name of the target container to use for predictions. Allowed Values: One line of text (a string). Accepted: Letters Numbers Hyphens (-) Not Accepted: Spaces Other special characters Default Value: None Accepts Variables: Yes Example: AmazonSagemaker-02101989
Target Model	Description: Specifies the name of the target model from Amazon SageMaker to use for predictions. Allowed Values: A target model from the list. When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint. 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?
Activity	Description: Specifies an activity on which to run the Amazon SageMaker model. Allowed Values: An activity from the list. Default Value: None Accepts Variables: No
On Event	Description: Specifies the status for an activity instance where the change occurs. Allowed Values: Assign Work Item - Amazon SageMaker runs when the specified task is ready to be Assigned to a participant. Complete Work Item - Amazon SageMaker runs when a task is Completed. Cancel Work Item - Amazon SageMaker runs when a task is Cancelled. Enter Activity Instance - Amazon SageMaker runs when the activity instance starts. Leave Activity Instance - Amazon SageMaker runs when the activity instance ends. Reassign Work Item - Amazon SageMaker runs when a task is Reassigned. Work Item Assigned - Amazon SageMaker runs after the specified task is Assigned to a participant. Work Item Overdue - Amazon SageMaker runs when a task is Overdue. Default Value: None
Content Type	Description: Specifies the format to send the request. Allowed Values: CSV JSON Default Value: None Accepts Variables: No
Configure Request Mapping	Opens this Screen: Amazon SageMaker Configuration > Configure Request Mapping To Open this Field: On the Amazon SageMaker Configuration > Request tab, click Configure Request Mapping. Function of this Screen: Specifies the conditions that cause the process to skip activities.
Save	Opens this Screen: Saves the configuration for your model and does not close the configuration screen.

Amazon SageMaker Configuration > Configure Request Mapping

Configures the request in Amazon SageMaker.

Fields

Field Name	Definition
Read Message From This Variable / Map Payload To App Schema / Map Payload To Grid	Description: Specifies how to connect the request data from Amazon SageMaker to your AgilePoint process schema. Allowed Values: Read Payload From This Variable - Sends a request with a variable in the AgilePoint NX app. In the text field, specify a variable that stores the request. Map Payload To App Schema - Connects the values in your payload with your process schema. Click Map Schema button to open the Schema Mapper screen. Use this screen to connect the values in the payload to your AgilePoint process schema. Map Payload To Grid - Sends a request in specified key-value pairs. Default Value: Read Payload From This Variable 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?
Column Name	Description: Specifies the name of the column to use for predictions. To Open this Field: On the Configure Request Mapping screen, select Map Payload To Grid. Allowed Values: A column name from Amazon SageMaker. Default Value: None Accepts Variables: No Example: CustomerName
Column Value	Description: Specifies a value for the column in a key-value pair. To Open this Field: On the Configure Request Mapping screen, select Map Payload To Grid. Allowed Values: A number or a text string that can contain spaces. Default Value: None Accepts Variables: Yes
Create	Function: Adds a row for the Column Name and Column Value. To Open this Field: On the Configure Request Mapping screen, select Map Payload To Grid.
Delete	Function: Deletes the selected row. To Open this Field: On the Configure Request Mapping screen, select Map Payload To Grid.

Amazon SageMaker Configuration > Response tab

Specifies where to store the response from Amazon SageMaker.

Fields

Field Name	Definition
Add Model	Function: Creates a model with a name you specify. In this activity, you can create more than one model to configure an Amazon SageMaker model to give predictions for an app. Each configuration is stored as a model with a name specified in this field. 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?
Edit	Function: Changes the model name.
Delete	Function: Deletes the selected model.
Amazon Web Services	Description: Specifies the access token that connects to your Amazon Web Services. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Amazon Web Services Function of this Screen: Configure an access token to connect to Amazon Web Services.
Endpoint	Description: Specifies the Amazon SageMaker endpoint to use for predictions. Allowed Values: An endpoint from the list. When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token. Default Value: None Accepts Variables: No 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?
Target Container Host Name	Description: Specifies the host name of the target container to use for predictions. Allowed Values: One line of text (a string). Accepted: Letters Numbers Hyphens (-) Not Accepted: Spaces Other special characters Default Value: None Accepts Variables: Yes Example: AmazonSagemaker-02101989
Target Model	Description: Specifies the name of the target model from Amazon SageMaker to use for predictions. Allowed Values: A target model from the list. When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint. 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?
Activity	Description: Specifies an activity on which to run the Amazon SageMaker model. Allowed Values: An activity from the list. Default Value: None Accepts Variables: No
On Event	Description: Specifies the status for an activity instance where the change occurs. Allowed Values: Assign Work Item - Amazon SageMaker runs when the specified task is ready to be Assigned to a participant. Complete Work Item - Amazon SageMaker runs when a task is Completed. Cancel Work Item - Amazon SageMaker runs when a task is Cancelled. Enter Activity Instance - Amazon SageMaker runs when the activity instance starts. Leave Activity Instance - Amazon SageMaker runs when the activity instance ends. Reassign Work Item - Amazon SageMaker runs when a task is Reassigned. Work Item Assigned - Amazon SageMaker runs after the specified task is Assigned to a participant. Work Item Overdue - Amazon SageMaker runs when a task is Overdue. Default Value: None
Map Response To App Schema / Store Response In This Variable	Description: Specifies where to store the response from Amazon SageMaker. Allowed Values: Map Response To App Schema – Select this option if you want to map the information from the Amazon SageMaker data model to your process schema. Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Store Response In This Variable – Select this option if you want to store the information from Amazon SageMaker 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: Map Response To App Schema 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?
Save	Opens this Screen: Saves the configuration for your model and does not close the configuration screen.

Amazon SageMaker Configuration > Additional Actions tab

Specifies whether to skip the activities in the AgilePoint process when specified conditions occur.

Fields

Field Name	Definition
Add Model	Function: Creates a model with a name you specify. In this activity, you can create more than one model to configure an Amazon SageMaker model to give predictions for an app. Each configuration is stored as a model with a name specified in this field. 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?
Edit	Function: Changes the model name.
Delete	Function: Deletes the selected model.
Amazon Web Services	Description: Specifies the access token that connects to your Amazon Web Services. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Amazon Web Services Function of this Screen: Configure an access token to connect to Amazon Web Services.
Endpoint	Description: Specifies the Amazon SageMaker endpoint to use for predictions. Allowed Values: An endpoint from the list. When you select the access token in the Amazon Web Services field, this field shows the endpoints associated with the access token. Default Value: None Accepts Variables: No 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?
Target Container Host Name	Description: Specifies the host name of the target container to use for predictions. Allowed Values: One line of text (a string). Accepted: Letters Numbers Hyphens (-) Not Accepted: Spaces Other special characters Default Value: None Accepts Variables: Yes Example: AmazonSagemaker-02101989
Target Model	Description: Specifies the name of the target model from Amazon SageMaker to use for predictions. Allowed Values: A target model from the list. When you select the endpoint from the Endpoint field, this field shows the target model names associated with the endpoint. 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?
Activity	Description: Specifies an activity on which to run the Amazon SageMaker model. Allowed Values: An activity from the list. Default Value: None Accepts Variables: No
On Event	Description: Specifies the status for an activity instance where the change occurs. Allowed Values: Assign Work Item - Amazon SageMaker runs when the specified task is ready to be Assigned to a participant. Complete Work Item - Amazon SageMaker runs when a task is Completed. Cancel Work Item - Amazon SageMaker runs when a task is Cancelled. Enter Activity Instance - Amazon SageMaker runs when the activity instance starts. Leave Activity Instance - Amazon SageMaker runs when the activity instance ends. Reassign Work Item - Amazon SageMaker runs when a task is Reassigned. Work Item Assigned - Amazon SageMaker runs after the specified task is Assigned to a participant. Work Item Overdue - Amazon SageMaker runs when a task is Overdue. Default Value: None
Change Flow	Description: Specifies whether to skip the specified activities in the process after specified conditions occur. Allowed Values: Selected - Skips the specified activities in the AgilePoint process. Deselected - Follows the standard process flow, and does not skip any activities. Default Value: Deselected
Configure Conditions	Opens this Screen: Amazon SageMaker Configuration > Create Conditions To Open this Field: On the Additional Actions tab, click Change Flow. Function of this Screen: Specifies the conditions that cause the process to skip activities.
Suspend Process Instance If Exception Occurs	Description: Specifies whether to move the process forward when an error occurs in the AgilePoint NX app. Allowed Values: Selected - Pauses the process when an error occurs, and shows an error in the log. Deselected - Shows an error in the log when an error occurs, but does not pause the process. Default Value: Selected
Save	Opens this Screen: Saves the configuration for your model and does not close the configuration screen.

Amazon SageMaker Configuration > Create Conditions

Specifies the conditions that cause the process to skip activities.

Fields

Field Name	Definition
Rule Type	Description: Specifies a rule to execute. Allowed Values: IF - Specifies a rule to execute if a specified condition is true. ELSE IF - Specifies a rule to execute if the previous condition is false. To open this field, click Add New Rule . ELSE - The rule executes if the all the specified conditions are false. Default Value: IF ELSE
Condition	Description: Specifies a name for a rule in your condition. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: Rule Name 1
Change Flow	Description: Specifies the activity to skip in the AgilePoint process after specific conditions occur. This field shows the activities in AgilePoint process. Allowed Values: An activity from the list. Default Value: Deselected
Add New Rule	Function: Lets you to add more than one rule.
Edit	Opens this Screen: Amazon SageMaker Configuration > Condition Builder screen Function of this Screen: Creates or changes logical rules. You can put one statement inside another statement to create complex logical expressions.
Delete	Function: Deletes the selected row.

Amazon SageMaker Configuration > Condition Builder screen

Creates or changes logical rules. You can put one statement inside another statement to create complex logical expressions.

Fields

Field Name

Definition

Condition Name

Description:: Shows the name for your rule.
Allowed Values:: Read only.
Default Value:: Rule Name 1

Validate Validate icon

Function:: Makes sure the rule is correct.

Preview Preview icon

Function:: Shows the preview of your rule.

Rule Variable

Description:

Specifies the value to analyze.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Yes

Example:

Refer to:

(Example) Configure a Condition Activity (Check Leave Approval Status)

Operator

Description:

Lets you select the operators for a logical expression.

Allowed Values:

Data Type	Expression Operators
String	, ==, Starts with, Ends with, Contains, Does Not Contains, !=, Does Not Contain Data, Contains Data
Bool	==
Date Time	, ==, >, >= , <, <=, !=
Number	, ==, >, >=, <, <=, !=

Default Value:

None

Example:

Refer to:

Rule Value

Description:

The value for the data variable.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Yes

Example:

Refer to:

Add Row

Function:: Adds a row for the Field Name and Field Value.

Indent Right Indent Right icon

Function:: Creates the statement that is a condition of a parent statement.

Delete Delete icon

Function:: Deletes the selected row.

Back Back icon

Function:: Saves the rule and goes back to the Create Condition screen.