Zendesk Service Input node

Use the Zendesk Service Input node to accept input from Zendesk Service.

The Zendesk Service Input node is available on Windows, AIX®, and Linux® systems.

This topic contains the following sections:

Purpose

Use the Zendesk Service Input node in a message flow to accept input from Zendesk Service. For example, you can use the Zendesk Service Input node to monitor a Zendesk Service system for new tickets. When a new ticket is created, the Zendesk Service Input node generates a message tree that represents the business object with details of the new ticket. The message tree is propagated to the Out terminal so that the rest of the message flow can use the data to update other systems or to audit the changes.

The Zendesk Service Input node operations are synchronous and non-transactional, which means that, if a message flow fails and rolls back after the Zendesk Service Input node, the operation on the data source will still complete.

The Zendesk Service Input node is contained in the Zendesk Service drawer of the message flow node palette, and is represented in the IBM® App Connect Enterprise Toolkit by the following icon:
This image shows the Zendesk Service Input node icon.

Terminals and properties

When you put an instance of the Zendesk Service Input node into a message flow, you can configure it. For more information, see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those without a default value) are marked with an asterisk.

The Zendesk Service Input node terminals are described in the following table.

Terminal Description
Out The output terminal from which the message tree is propagated. The output message tree contains the object that is returned from the Zendesk Service connector.
Catch The output terminal to which the message collection is routed if an exception is thrown downstream and caught by this node.
Failure If an error occurs in the Zendesk Service Input node, the message is sent to the Failure terminal.

The following tables describe the node properties. The columns headed M indicate whether the property is mandatory (marked with an asterisk on the panel if you must enter a value when no default is defined). The columns headed C indicate whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The Zendesk Service Input node Description properties are described in the following table:
Property M C Default Description
Node name Yes No The node type,Zendesk Service Input The name of the node.
Short description No No   A brief description of the node.
Long description No No   Text that describes the purpose of the node in the message flow.
The Zendesk Service Input node Basic properties are described in the following table.
Property M C Default Description
Action Yes No   This property shows the action to be performed by the Zendesk Service Input node. The action is defined through the Connector Discovery wizard, and is then displayed in the Action property in read-only format.

Click Launch Connector Discovery to start the Connector Discovery wizard for the Zendesk Service connector, and define the action that you require.

Object Yes No   This property shows the object on which the specified action is to be performed. The object is defined through the Connector Discovery wizard, and is then displayed in the Object property in read-only format.
Schema base name Yes No   The base name of the schema file that describes the format of the message that is returned by the Zendesk Service connector for the Zendesk Service object. The schema file can be used by a Mapping node to map the data values that are returned. You can open the schema by clicking the Open schema button.
The Zendesk Service Input node Connection properties are described in the following table.
Property M C Default Description
Policy Yes No   This property specifies the name of the policy that contains the details of the security identity that is used for the connection. The policy has a type of Zendesk Service and is defined in a policy project.
The Zendesk Service Input node Polling properties are described in the following table. All these properties are set through the Connector Discovery wizard. If a polling interaction is selected during connector discovery, the polling properties can be edited, saved, and returned to the Zendesk Service Input node, where they are displayed in read-only format in the Polling tab of the node.
Property M C Default Description
Created timestamp field No No   This property specifies the field in the object that contains the creation timestamp that is used to determine which objects are detected by polling and returned by the Zendesk Service connector to the Zendesk Service Input node. Objects created after the specified time are detected and returned to the node.
  • When the action is CREATEDORUPDATED_POLLER, only the Last updated timestamp field property is used when polling. The Created timestamp field is not used. The poll returns all objects that have been created or updated in that polling interval.
  • When the action is UPDATED_POLLER, both the Created timestamp field and Last updated timestamp field properties are used when polling. The poll returns all objects that have been updated in the polling interval, excluding newly created objects.
  • When the action is CREATED_POLLER, both the Created timestamp field and Last updated timestamp field properties are used when polling. The poll returns all objects that have been created in the polling interval, excluding those that have been subsequently updated.
  • When the action is CREATED_POLLER and the Is created timestamp queryable property is checked, only the Created timestamp field property is used when polling. The Last updated timestamp field property is not used. The poll returns all objects that have been created in the polling interval.
Last updated timestamp field No No   This property specifies the field in the object that contains the last-updated timestamp that is used to determine which objects are detected by polling and returned by the Zendesk Service connector to the Zendesk Service Input node. Objects updated after the specified time are detected and returned to the node.
  • When the action is CREATEDORUPDATED_POLLER, only the Last updated timestamp field property is used when polling. The Created timestamp field is not used. The poll returns all objects that have been created or updated in that polling interval.
  • When the action is UPDATED_POLLER, both the Created timestamp field and Last updated timestamp field properties are used when polling. The poll returns all objects that have been updated in the polling interval, excluding newly created objects.
  • When the action is CREATED_POLLER, both the Created timestamp field and Last updated timestamp field properties are used when polling. The poll returns all objects that have been created in the polling interval, excluding those that have been subsequently updated.
  • When the action is CREATED_POLLER and the Is created timestamp queryable property is checked, only the Created timestamp field property is used when polling. The Last updated timestamp field property is not used. The poll returns all objects that have been created in the polling interval.
Format of the timestamps No No   This property specifies the format of the timestamps in the Created timestamp field and the Last updated timestamp field of the object.

Enter a format for the timestamp by using letters. For example: YYYY-MM-DDTHH:mm::ssZ.
Timezone No No UTC This property specifies the time zone that applies to the timestamps. The default time zone is UTC (Coordinated Universal Time).
Polling interval (minutes) No No   This property specifies the polling interval, in minutes, which controls how frequently the node checks for changes to the object.
Is created timestamp queryable No No   This property is applicable only for new events (CREATED_POLLER). If this property is selected, polling uses the Created timestamp field only. If it is not selected, polling uses the Created timestamp field and the Last updated timestamp field.
The Zendesk Service Input node Retry properties are described in the following table.
Property M C Default Description
Retry mechanism Yes No Failure How the node handles a flow failure. Valid options are:
  • Failure
  • Short retry
  • Short and long retry
Retry threshold No Yes 0 The number of times to try the flow transaction again when the Retry mechanism property value is Short retry or Short and long retry.
Short retry interval No Yes 0 The interval, in seconds, between each retry if Retry threshold property is not zero.
Long retry interval No Yes 300 The interval between retries, if Retry mechanism property is Short and long retry and the retry threshold has been exhausted.
The Zendesk Service Input node Input Message Parsing properties are described in the following table.
Property M C Default Description
Message domain Yes No JSON The domain that is used to parse the response message. This property is set to JSON and cannot be changed.
Message model No No   The name of the message model schema file in which the incoming message is defined. This property is set to the full filename of the response schema, which is the base name set in the Schema base name property, suffixed with response.schema.json (for example, gen/flow1.zendeskservice_Input.response.schema.json).
Message No No   The name of the response message. The node detects the message type automatically; you cannot set this property.
Physical format No No   The name of the physical format of the response message. You cannot set this property.
The Zendesk Service Input node Instances properties are described in the following table.
Property M C Default Description
Additional instances pool No No None The pool that is associated with the message flow.
Additional instances No Yes 0 The number of additional instances.
The Zendesk Service Input node Monitoring properties are described in the following table.
Property M C Default Description
Events No No None Events that you define for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change, or delete monitoring events for the node; see Configuring monitoring event sources by using monitoring properties for details.

You can enable and disable events that are shown here by selecting or clearing the Enabled check box.