Read JSON activity

An activity that maps data from a JSON code snippet to your schema.


Read JSON activity

Configure the Read JSON activity

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

Prerequisites

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?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Document Document icon tab.
      2. On the Document Document icon tab, drag the Read JSON Read JSON icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Source Configuration Source Configuration icon.
  3. On the Source Repository screen, select the source location of your JSON code snippet to map the values in your process schema.
  4. Click JSON Reader Configuration JSON Reader Configuration icon.
  5. Complete the fields on the JSON Reader Template Configuration screen.

    For more information, refer to Read a JSON File.

  6. Click JSON Reader Schema Configuration JSON Reader Schema Configuration icon.
  7. Complete the fields on the JSON Reader Schema Configuration screen.
  8. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Read JSON activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data 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
Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Source Repository

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

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon
Function:
Specifies that Amazon S3 is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (Amazon S3) - Read JSON.

Box Box icon
Function:
Specifies that Box is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (Box) - Read JSON.

Dropbox Dropbox icon
Function:
Specifies that Dropbox is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox) - Read JSON.

File System File System icon
Function:
Specifies that the file system on the AgilePoint Server machine is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (File System) - Read JSON.

FTP FTP icon
Function:
Specifies that FTP is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (FTP) - Read JSON.

Google Drive Google Drive icon
Function:
Specifies that Google Drive is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive) - Read JSON.

NetSuite NetSuite icon
Function:
Specifies that NetSuite is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (NetSuite) - Read JSON.

OneDrive OneDrive icon
Function:
Specifies that OneDrive is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive) - Read JSON.

OneDrive For Business OneDrive For Business icon
Function:
Specifies that OneDrive for Business is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive For Business) - Read JSON.

Salesforce Salesforce icon
Function:
Specifies that Salesforce is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce) - Read JSON.

SFTP SFTP icon
Function:
Specifies that SFTP is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (SFTP) - Read JSON.

SharePoint SharePoint icon
Function:
Specifies that SharePoint is the source location of your JSON code snippet to map the values in your process schema.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint) - Read JSON.

Read JSON Configuration

Loads your JSON code snippet to connect with your process.

Figure: JSON Reader Template Configuration screen

JSON Reader Template Configuration screen

Fields

Field Name Definition

JSON Source
Function:
Specifies the JSON code snippet to connect to your process.
Accepted 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
Function:
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.

Figure: JSON Reader Schema Configuration screen

JSON Reader Schema Configuration screen

Fields

Field Name Definition

Mapping Schema
Function:
Connects the schemas to your schema.

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

Accepted 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:

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

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

Data Conversion
Function:
Specifies the data conversion between the source and the destination schema fields.
Accepted 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

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.

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.