Read JSON activity

Configure the Read JSON activity

To configure the Read JSON activity, do the procedure in this topic.

Prerequisites

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

Good to Know

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 Document tab.
On the Document tab, drag the Read JSON activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click Source Configuration .
On the Source Repository screen, select the source location of your JSON code snippet to map the values in your process schema.
Click JSON Reader Configuration .
Complete the fields on the JSON Reader Template Configuration screen.
For more information, refer to Read a JSON File.
Click JSON Reader Schema Configuration .
Complete the fields on the JSON Reader Schema Configuration screen.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Read JSON 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:

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

Source Repository

Specifies the source location of your JSON code snippet to map the values in your process schema.

Fields

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

Read JSON Configuration

Loads your JSON code snippet to connect with your process.

Figure: JSON Reader Template Configuration screen

Fields

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

JSON Reader Schema Configuration

Maps the values in your JSON code snippet to schema elements in your process.

Fields

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