Image Classification - Send Notification activity

An activity that creates classifications for an image uploaded as input to Amazon SageMaker. The image classification data represents labels or categories associated with the image you can use in your AgilePoint NX app. If conditions configured in the AI model occur in the prediction, the app can send an email notification.

This feature is part of the AI Control Tower.


Image Classification Send Notification activity

Configure the Image Classification - Send Notification 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 Amazon SageMaker tab.

    Amazon SageMaker tab
  3. On the Amazon SageMaker tab, drag the Image Classification - Send Notification activity onto your process.

    Drag Image Classification Send Notification activity

General Configuration

Specifies the basic settings for the Image Classification - Send Notification 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

Image Location Configuration

Specifies the input source of an image to upload to Amazon SageMaker to create an image classification.

Figure: Image Location Configuration screen

Image Location Configuration screen

Fields

Field NameDefinition

Get Image From Source Repository / Get Image From URL or Base64

Description:
Specifies the location from which to upload the image in Amazon SageMaker.
Allowed Values:
  • Get Image From Source Repository – Configures the Source Repository screen to specify a repository to upload the image.
  • Get Image From URL Or Base64 – Specifies the URL or Base64 string of an image to upload to Amazon SageMaker to create a classification.
Default Value:
Get Image From Source Repository
Example:
Refer to:
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?

URL Or Base64 For The Image

Description:
Specifies the URL or Base64 image string to upload to Amazon SageMaker to create a classification.
To Open this Field:
  1. On the Image Location Configuration screen, select Get Image From URL Or Base64.
Allowed Values:
One line of text (a string).

Represents:

  • A reference to an image.

    These requirements apply:

    • Images must be stored on a web server or cloud storage location accessible through HTTPS that AgilePoint NX can access.
    • Images cannot be stored on a local file system, such as your local machine or the AgilePoint Server machine.
    • Images must be referenced with an absolute URL or a Base64 encoded value.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Source Repository

Specifies the original, or source, location for your files.

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Source Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

Image Classification - Send Notification Configuration > Amazon Web Services tab

Configures the Amazon SageMaker model to create an image classification.

Figure: Image Classification - Send Notification Configuration > Amazon Web Services tab

Image Classification Send Notification Configuration Amazon Web Services tab

Fields

Field NameDefinition

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 Add Token icon

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 execute the AI model to use for an image classification.
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
Example:
Refer to:
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 image classification.

If you select a multi-container endpoint in the Endpoint field, you can specify the container host name to invoke.

Allowed Values:
One line of text (a string) that represents a target container host name from Amazon SageMaker.
Default Value:
None
Accepts Variables:
Yes
Example:

Target Model

Description:
Specifies the name of the target model from the Amazon SageMaker endpoint to use for image classification.

This field enables when you select a multi-model endpoint in the Endpoint field.

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
Example:
Refer to:
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?

Image Classification - Send Notification Configuration > Triggering Event tab

Configures an activity on which to run the Amazon SageMaker model to create an image classification.

Figure: Image Classification - Send Notification Configuration > Triggering Event tab

Image Classification Send Notification Configuration Triggering Event tab

Fields

Field NameDefinition

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
Example:
Refer to:

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
Example:
Refer to:

Set Trigger Condition

Opens this Screen:
Image Classification - Send Notification Configuration > Triggering Event tab > Set Trigger Condition
Function of this Screen:
Specifies the conditions that cause the Amazon SageMaker model to run.

Image Classification - Send Notification Configuration > Triggering Event tab > Set Trigger Condition

Specifies the conditions that cause the Amazon SageMaker model to run.

Figure: Image Classification - Send Notification Configuration > Triggering Event tab > Set Trigger Condition screen

Image Classification Send Notification Configuration Triggering Event tab Set Trigger Condition screen

Fields

Field NameDefinition

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 Add New Rule icon.

  • ELSE - The rule executes if the all the specified conditions are false.
Default Value:
  1. IF
  2. 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

Edit Edit icon

Opens this Screen:
Image Classification - Send Notification Configuration > Triggering Event > 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 Delete icon

Function:
Deletes the selected row.

Image Classification - Send Notification Configuration > Triggering Event > Condition Builder screen

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

Figure: Image Classification - Send Notification Configuration > Triggering Event > Condition Builder screen

Image Classification - Send Notification Configuration Triggering Event Condition Builder screen

Fields

Field NameDefinition

Condition Name

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

Preview Preview icon

Function:
Shows the preview of your rule.

Validate Validate icon

Function:
Makes sure the rule is correct.

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:

Operator

Description:
Lets you select the operators for a logical expression.
Allowed Values:
Data TypeExpression 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 Add Row icon

Function:
Creates a condition row.

Select Nest Type

Function:
Specifies the use of logical AND and OR operators to nest conditions to use for predictions.

You must set the condition first, before you specify the nest type.

Allowed Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
AND

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.

Image Classification - Send Notification Configuration > Response tab

Specifies where to store the response from Amazon SageMaker.

Figure: Image Classification - Send Notification Configuration > Response tab

Image Classification Send Notification Configuration Response tab

Fields

Field NameDefinition

Response Template

Description:
Specifies the template to use to format the image classification result from Amazon SageMaker.
Allowed Values:
A response template from the list.
Default Value:
None
Example:
Refer to:

Show Response Payload Sample

Description:
Specifies whether to show the Response Payload Sample field to view the sample payload for the image classification result.
Allowed Values:
  • Selected - Shows the Response Payload Sample field to view the sample payload for the image classification result.
  • Deselected - Hides the Response Payload Sample field and does not show the sample payload.
Default Value:
Deselected
Example:
Refer to:
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?

Response Payload Sample

Description:
Specifies the sample response payload to use to format the image classification result.
To Open this Field:
  1. On the Get Image Classification > Response tab, select Show Response Payload Sample field.
Allowed Values:
More than one line of text.
Default Value:
None
Example:
Refer to:
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?

Classes

Description:
Specifies the classes to use to classify the objects that exist in the image.

The classes represent categories or labels that the image classification model is trained to recognize in an image.

To Open this Field:
  1. On the Get Image Classification > Response tab, select Show Response Payload Sample field.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Example:
Refer to:
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?

Store Response In This Variable

Description:
Specifies a variable to store the result of image classification from Amazon SageMaker.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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 Inference Status In This Variable (Boolean)

Description:
Specifies a variable to store the inference status as a Boolean value of true or false.

The value is true if the prediction has no errors.

Allowed Values:
A variable.

Format:

  • Boolean

Response Values

  • true
  • false
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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 Inference Error Message In This Variable (String)

Description:
Specifies a variable to store the inference error message of the image classification.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Image Classification - Send Notification Configuration > Parsing tab

Configures the parsing actions to extract the information from the image classification result.

Figure: Image Classification - Send Notification Configuration > Parsing tab

Image Classification Send Notification Configuration Parsing tab

Fields

Field NameDefinition

Add Row Add Row icon

Function:
Adds a row to create a parsing action.

Validate Validate icon

Opens this Screen:
Image Classification - Send Notification Configuration > Parsing > Validate screen
Function of this Screen:
Makes sure whether the parsing actions configured on the Parsing tab are correct.
Limitations:
To enable this field, you must specify the value in the Store Response In This Variable field on the Response tab.

Action

Description:
Specifies the protocol to use for parsing the image classification result from Amazon SageMaker.

The parsing actions execute in the order added in the field.

Allowed Values:
A protocol from the list.
Default Value:
None
Example:
Refer to:

Input

Description:
Specifies a variable that stores the result for image classification from Amazon SageMaker.

You must specify the variable configured in the Store Response In This Variable field on the Response tab.

Allowed Values:
A variable.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Results

Description:
Specifies a variable to store the result of the parsing action.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Settings

Description:
Shows the settings configured for the parsing action.
Allowed Values:
Read only.
Example:
Refer to:

On Fail

Description:
Specifies whether to skip the parsing action when an error occurs.
Allowed Values:
  • Selected - Skips the parsing action when an error occurs and moves to the next action.
  • Deselected - Pauses the parsing action when an error occurs, and stores the error message in a variable if specified in the Save Parsing Error Message in this Variable field.
Default Value:
Selected
Example:
Refer to:
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?

Delete Delete icon

Function:
Deletes the selected row.

JSON Path

Description:
Specifies a JSON code snippet to use for parsing the image classification result.
To Open this Field:
  1. In the Action field, select JSON Path.
  2. Click Edit Edit icon.
Allowed Values:
A JSON code snippet.
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?

Edit Edit icon (Inline Function)

Opens this Screen:
Image Classification - Send Notification Configuration > Parsing > Inline Functions
To Open this Field:
  1. In the Action field, select Inline Function.
Function of this Screen:
Configures one or more inline functions for parsing the image classification result.

Edit Edit icon (Regex Parsing)

Opens this Screen:
Image Classification - Send Notification Configuration > Parsing > Regular Expression
To Open this Field:
  1. In the Action field, select Regex Parsing.
Function of this Screen:
Configures a regular expression for parsing the image classification result.

Save Parsing Status In This Variable (Boolean)

Description:
Specifies a variable to store the parsing status of an image classification as a Boolean value.

The value is true if the prediction has no errors.

Allowed Values:
A variable.

Format:

  • Boolean

Response Values

  • true
  • false
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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 Parsing Error Message In This Variable (String)

Description:
Specifies a variable to store the error message of the parsing action.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Image Classification - Send Notification Configuration > Parsing > Inline Functions

Configures one or more inline functions for parsing the image classification result.

Figure: Image Classification - Send Notification Configuration > Parsing > Inline Functions screen

Image Classification Send Notification Configuration Parsing Inline Functions screen

Fields

Field NameDefinition

Formula

Description:
Specifies the syntax of your formula.
Allowed Values:

An expression you build from the list of functions.

You can create a formula or expression using Text, Number, Currency, and Date functions from Inline Functions list, or process data variables.

To add more than one formula for your inline function, replace the text inside the parentheses ( ) of one function with a different function, in thise format:

@function1(@function2(variable1, variable2))

Default Value:
None
Example:
  • @Max(Number1, Number2) - Gives the higher of the numbers represented by the varialbes Number1 and Number2.
  • @UpperCase(SourceString) - Gives the text represented by the variable SourceString in capital letters.
  • @UpperCase(@Substring(SourceString, StartIndex, EndIndex)) - Gives the specified substring of the text represnted by the SourString variable in capital letters.

Also refer to:

Inline Functions

Description:
Specifies the Text, Number, Currency, and Date functions to use in the formula.
Allowed Values:
  • Concat - Joins two or more specified text values into one string.
  • Stringlen - Gives the number of characters in the specified text value.
  • Replace - Replaces all the occurrences of a specified text value in the instance with another specified text value.
  • Remove - Deletes all the characters in the instance that begin at a specified position and continue through the last position.
  • Reverse - Reverses the order of the elements in the instance.
  • UpperCase - Returns a copy of the specified text value in capital letters, using the casing rule of the specified culture.
  • LowerCase - Returns a copy of the specified text value in small letters, using the casing rule of the specified culture.
  • TitleCase - Returns the specified text value in title case, except for the words that are in all capital letters, which are considered to be acronyms.
  • PadRight - Returns a new text value that left-aligns the characters in an instance by padding them on the right with a specified Unicode character, for a specified total length.
  • PadLeft - Returns a new text value that right-aligns the characters in an instance by padding them on the left with a specified Unicode character, for a specified total length.
  • Substring - Gets a substring from an instance. The substring starts at a specified character position and has a specified length.
  • GUID - Returns a text value of the GUID instance in a specific format.
  • Insert - Returns a new text value in which a specified text is inserted at a specified index position in the instance.
  • Trim - Remove all leading and trailing white space characters from the specified text.
  • XmlEncode - Returns the specified text with escape characters by adding slashes (/) to use in XML attributes.
  • XmlDecode - Returns the specified text as literal XML code.
  • Compare - Returns true if both the specified text values are the same. This function is case sensitive.
  • CompareIgnoreCase - Returns true if both the specified text values are the same. This function is not case sensitive.
  • Absolute - Returns the absolute value of a number.
  • Max - Returns the larger number of the two specified numbers.
  • Min - Returns the smaller number of the two specified numbers.
  • Power - Returns the specified number increased to the specified power.
  • Round - Rounds the decimal value to the nearest integral value.
  • Subtraction - Returns the difference of the specified n numbers. This function subtracts all numbers from the first number.
  • Sum - Returns the sum of the specified n numbers.
  • Average - Returns the mean of the specified numbers.
  • Multiple - Returns the product of the specified n numbers.
  • Modulo - Returns the remainder of the two specified numbers.
  • Percentage - Returns the percentage of the two specified numbers. Number1 represents current value and Number2 represents total value.
  • ToDecimal - Returns a decimal number.
  • ToDouble - Returns a double-precision floating-point number.
  • ToFloat - Returns a single-precision floating-point number.
  • ToLong - Returns a number to an equivalent 64-bit signed integer.
  • Currency - Shows the currency values in the format that you specify. This function shows the currency values with no decimal numbers.
  • Currency - Shows the currency values in the format that you specify. This function shows the currency values with a specified number of decimal places.
  • DateDiffDays - Calculates the difference in days between the two dates.
  • DateDiffHours - Calculates the difference in hours between the two dates.
  • DateDiffMinutes - Calculates the difference in minutes between the two dates.
  • DateDiffSeconds - Calculates the difference in seconds between the two dates.
  • FormatDate - Shows the date-time value in the format that you specify.
  • AddYears - Returns a new date that is result of addition of the specified number of years to the specified date value.
  • AddMonths - Returns a new date that is result of addition of the specified number of months to the specified date value.
  • AddDays - Returns a new date that is result of addition of the specified number of days to the specified date value.
  • AddHours - Returns a new date that is result of addition of the specified number of hours to the specified date time value.
  • AddMinutes - Returns a new date that is result of addition of the specified number of minutes to the specified date time value.
  • AddSeconds - Returns a new date that is result of addition of the specified number of seconds to the specified date time value.
  • AddMilliSeconds - Returns a new date that is result of addition of the specified number of milliseconds to the specified date time value.
  • AddTicks - Returns a new date that is result of addition of the specified number of ticks to the specified date time value.
  • ParseDateTime - Converts the specified string representation of a date and time into its date and time value with the specified date format.
Default Value:
None
Example:
Refer to:
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?

Description

Function:
Specifies the details of the function.
Default Value:
Read only.

Apply

Function:
Uses the configured formulas in your inline function.
Example:
Refer to:

Image Classification - Send Notification Configuration > Parsing > Regular Expression

Configures a regular expression for parsing the image classification result.

Figure: Image Classification - Send Notification Configuration > Parsing > Regular Expression screen

Image Classification Send Notification Configuration Parsing Regular Expression screen

Fields

Field NameDefinition

Regex Syntax

Description:
Specifies the format for your regular expression.
  • The Regular Expression activity uses .NET syntax for regular expressions.

    For more information, refer to Regular Expression Language - Quick Reference.

  • To change the regular expression, double-click Regex Syntex, and change your expression.
Allowed Values:
A valid regular expression..
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Perform Regex Match on Below Text

Description:
Lets you specify the text to evaluate with the regular expression.
Allowed Values:
More than one line of text.

Format:

  • Plain text
  • A variable
  • A combination of text and variables
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

Match Result

Description:
Specifies the connection from the Match Result parameter to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

Use this screen to connect the result of the match to the data model for your process.

The data type for the schema node must match the data type for the match result. For example, if the match can have more than one result, the mapped schema node must be repeating.

Default Value:
None
Example:
Refer to:
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?

Image Classification - Send Notification Configuration > Parsing > Validate screen

Makes sure whether the parsing actions configured on the Parsing tab are correct.

Figure: Image Classification - Send Notification Configuration > Parsing > Validate screen

Image Classification Send Notification Configuration Parsing Validate screen

Fields

Field NameDefinition

Response Payload Sample

Description:
Specifies the sample response payload to validate the parsing actions configured on the Parsing tab.
Allowed Values:
More than one line of text.
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?

Settings

Description:
Shows the settings configured for the parsing action.
To Open this Field:
  1. Click Test.
Allowed Values:
Read only.

Input

Description:
Shows the input value that is configured in the Input field on the Parsing tab.
To Open this Field:
  1. Click Test.
Allowed Values:
Read only.

Results

Description:
Shows the test result for the parsing action.
To Open this Field:
  1. Click Test.
Allowed Values:
Read only.

Test

Function:
Runs a test to validate the parsing actions configured on the Parsing tab with the response payload specified in the Response Payload Sample field.

Image Classification - Send Notification Configuration > Additional Actions tab

Specifies an email template to use to send the notification when the specified conditions occur in the image classification.

Figure: Image Classification - Send Notification Configuration > Additional Actions tab

Image Classification Send Notification Configuration Additional Actions tab

Fields

Field NameDefinition

Notification

Description:
Specifies an email template to use to send the notification when the specified conditions occur in the image classification.

This field shows the list of email templates in the AgilePoint NX app.

Allowed Values:
An email template name from the list.
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?

Send Notifications

Description:
Specifies how frequently the email notification is sent based on the image classification.

An event for a specified activity is configured on the Triggered Events tab. Each time this event occurs, the AI model creates an image classification. When the classification meets the configured criteria, the AI Control Tower can be configured to send an email notification. If the activity associated with the notification-triggering event runs in a process loop (the activity executes more than one time during a process instance) this field determines whether to send the email only the first time the event on the Triggered Events tab occurs (the first session), or to send the email every time the event occurs (every session).

Allowed Values:
  • Only On First Session - Sends the email notification only the first time the triggering conditions occur.
  • For All Sessions - Sends the email notification every time the triggering conditions occur.
Default Value:
Only On First Session
Example:
Refer to:
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?

Set Action Trigger Condition

Opens this Screen:
Image Classification - Send Notification Configuration > Additional Actions tab > Set Action Trigger Condition
Function of this Screen:
Specifies the conditions to send an email notification in AgilePoint NX.

Save Status In This Variable (Boolean)

Description:
Specifies a variable to store the status of an image classification as a Boolean value.

The value is true if the prediction has no errors.

Allowed Values:
A variable.

Format:

  • Boolean

Response Values

  • true
  • false
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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 Error Message In This Variable (String)

Description:
Specifies a variable to store the error message for image classification.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
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?

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
Example:
Refer to:

Enable Debug

Description:
Specifies whether to store the debugging information for the AI Control Tower activity in the debug log folder on the AgilePoint Server machine.
Allowed Values:
Default Value:
Selected
Example:
Refer to:

Image Classification - Send Notification Configuration > Additional Actions tab > Set Action Trigger Condition

Specifies the conditions to send an email notification in AgilePoint NX.

Figure: Image Classification - Send Notification Configuration > Additional Actions tab > Set Action Trigger Condition screen

Image Classification Send Notification Configuration Additional Actions tab Set Action Trigger Condition screen

Fields

Field NameDefinition

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 Add New Rule icon.

  • ELSE - The rule executes if the all the specified conditions are false.
Default Value:
  1. IF
  2. 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

Edit Edit icon

Opens this Screen:
Image Classification - Send Notification Configuration > Additional Actions tab > 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 Delete icon

Function:
Deletes the selected row.

Image Classification - Send Notification Configuration > Additional Actions tab > Condition Builder screen

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

Figure: Image Classification - Send Notification Configuration > Additional Actions tab > Condition Builder screen

Image Classification - Send Notification Configuration Additional Actions tab Condition Builder screen

Fields

Field NameDefinition

Condition Name

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

Preview Preview icon

Function:
Shows the preview of your rule.

Validate Validate icon

Function:
Makes sure the rule is correct.

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:

Operator

Description:
Lets you select the operators for a logical expression.
Allowed Values:
Data TypeExpression 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 Add Row icon

Function:
Creates a condition row.

Select Nest Type

Function:
Specifies the use of logical AND and OR operators to nest conditions to use for predictions.

You must set the condition first, before you specify the nest type.

Allowed Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
AND

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.