Get Organizations activity

Configure the Get Organizations activity

To configure the Get Organizations activity, do the procedure in this topic.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 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 Zendesk tab.
On the Zendesk tab, drag the Get Organizations activity onto your process.

General Configuration

Specifies the basic settings for the Get Organizations activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

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

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

Get Organizations Configuration > Request tab

Specifies the information about one or more organizations to get from Zendesk.

Fields

Field Name	Definition
Zendesk	Function: Specifies the access token that connects to your Zendesk service. Accepted Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for Zendesk Function of this Screen: Configure an access token to connect to Zendesk.
Organization Details	Function: Specifies which organization details to get in Zendesk. Accepted Values: Get All Organizations' Details - Gets the information about all organizations. Get Specific Organizations' Details - Gets the information about the organizations you specify. Default Value: None
Number of Organizations to Retrieve	Function: Specifies the number of organizations to get in Zendesk. Accepted Values: An integer. Default Value: None Accepts Process Data Variables: Yes
Organization IDs (one or more)	Function: Specifies one or more organization IDs for the Zendesk organizations to get. Accepted Values: One or more Zendesk organization IDs, separated by semicolons (;). Default Value: None Accepts Process Data 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?

Get Organizations Configuration > Response tab

Specifies how to store the information about one or more organizations in process data variables.

Fields

Field Name	Definition
Zendesk	Function: Specifies the access token that connects to your Zendesk service. Accepted Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for Zendesk Function of this Screen: Configure an access token to connect to Zendesk.
Map Response to AgilePoint Schema	Function: Maps information about the organizations from the Zendesk data model to your process schema. To Open this Field: Click the Response tab. Accepted Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper
Store the Response in this Variable	Function: Specifies the process data variable that stores an information about the retrieved organizations from the Zendesk. To Open this Field: Click the Response tab. Accepted Values: A process data variable that accepts an alphanumeric string in JSON format. Note: In most cases, AgilePoint recommends the Map Response to AgilePoint Schema option. Only get the raw JSON string if you need this data for custom coding. Default Value: None Accepts Process Data Variables: Yes Example: [{"Details":"","DomainNames":["gmail.com"],"ExternalId":null,"GroupId":null,"Name":"ABC","Notes":"","OrganizationFields":{},"SharedComments":false,"SharedTickets":false,"Tags":[],"CreatedAt":"\/Date(1528965061000)\/","Id":360032614154…}]