Read JSON activity

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

Read JSON Runtime Payload From Source Repository / Read JSON Runtime Payload From A Variable

Description:

Specifies the source for the JSON code snippet to connect to your process.

Allowed Values:

• Read JSON Runtime Payload From Source Repository - Configures the Source Repository screen to specify a repository that stores the JSON code snippet.
• Read JSON Runtime Payload From A Variable - Specifies a process data variable that stores the JSON code snippet.

Default Value:

Read JSON Runtime Payload From Source Repository

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.

JSON Source

Description:

Specifies the JSON code snippet to connect to your process.

Allowed Values:

A valid JSON code snippet.

Default Value:

None

Example:

//Storing data:
myObj = { "name":"John", "age":31, "city":"New York" };
myJSON = JSON.stringify(myObj);
localStorage.setItem("testJSON", myJSON);

Load

Description:

Runs the JSON code to get data from the external service.

To Open this Field:

• On the JSON Reader Selection Configuration screen, select Read JSON Runtime Payload From Source Repository.

Read JSON Runtime Payload From This Variable

Description:

Specifies a process data variable that stores the JSON code snippet to use in your process.

To Open this Field:

• On the JSON Reader Selection Configuration screen, select Read JSON Runtime Payload From A Variable.

Allowed Values:

A process data variable that accepts a text string in JSON format.

Default Value:

None

Limitations:

This field is available in these releases:

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

Mapping Schema

Description:

Connects the schemas to your process schema.

The source and the destination schemas show in a tree view in the left and right panes.

Allowed Values:

Read only - However, the drag and drop operations are supported to map the schemas.

Drag a data node from the source schema pane to the destination schema pane:

• Green line - The data type of source and destination nodes matches.
• Blue line - The data type of source and destination nodes doesn't match. The data conversion is required to map the schemas.
• Red line - Specifies that the custom data conversion is required.

Example:

Refer to:

• (Example) Schema Mapper
• (Example) How Can I Map a Repeating Schema Element to Data Population?
• (Example) Create Zoom Meeting

AutoMap

Function:

Maps all fields in the data source and the process schema that have the same name.

Example:

Refer to:

• (Example) Schema Mapper

Reset

Function:

Deletes all connections that have been made in the Schema Mapper for this activity.

Data Conversion

Description:

Specifies the data conversion between the source and the destination schema fields.

Allowed Values:

• No Data Conversion Needed - The data type of the source schema elements matches the data type of the target schema elements, or no data type conversion is necessary.
• Default Conversion - The data type of the source schema elements does not match the data type of the target schema elements. This option uses a default conversion methodology.
• Custom Data Conversion - Uses a data conversion method you specify.

  If you specify a custom data conversion method, it must return the results in valid XML format.

Default Value:

No Data Conversion Needed

Example:

Refer to:

• (Example) Schema Mapper

Add

Opens this Screen:

Custom Mapping screen

Function of this Screen:

Specifies custom C# code that can be used to map fields to an XML schema.

Example:

Refer to:

• (Example) Schema Mapper

Edit

Opens this Screen:

Custom Mapping screen

Function of this Screen:

Specifies custom C# code that can be used to map fields to an XML schema.

Delete

Function:

Deletes the selected custom data conversion from the list.

Reload

Function:

Runs the JSON code to connect the data again.