Clarizen connector advanced in Jitterbit Design Studio

The following items cover advanced options, tips, and links to other reference materials that may be useful for Clarizen integrations.

Clarizen Query Language (CZQL)

Clarizen Query Language (CZQL) can be used to enter manual query strings in place of using the wizard provided in Clarizen connector query. The general syntax of CZQL is provided below. For further information and examples, see Clarizen's REST API Reference Guide.

CZQL Query Syntax

SELECT field|groupingFunction[ASalias]|(Relation Query)

FROM EntityType

WHERE Condition

GROUP BY groupByFields

ORDER BY orderByFields[ASC|DESC]

LIMIT rows OFFSET startFrom

Bulk API

All activities provided in the Clarizen Connector (Create, Update, Query, Delete) use Clarizen's bulk API by default. Each bulk request is considered by Clarizen to be a single API request. So for example if the request returns 1,000 records, this is considered one request, not 1,000 requests.

Upsert functionality

The Clarizen application does not support a native upsert functionality. As a workaround in Jitterbit, instead you can first set up a Clarizen connector query to pull back all IDs from the Clarizen instance. Then, depending on the results of the query:

• If the ID of the entity you want to upsert is within the query results, set up a Clarizen Connector Update activity to run. On the Update transformation, use a condition to filter out items you want to run in the Clarizen connector create operation.
• If the ID of the entity you want to upsert is not within the query results, set up a Clarizen Connector Create activity to run. On the Create transformation, use a condition to filter out items you want to run in the Clarizen connector update operation.

For further detail and examples of how to use Jitterbit to upsert data into Clarizen, see Upserting Clarizen data with a chain of operations.

Outbound messaging

Within your Clarizen instance, you can set up workflow rules and custom actions. This is similar to Salesforce Configuring outbound messages with hosted HTTP endpoints and similar steps can be extrapolated for the Clarizen application.

Design patterns

The following design patterns may be useful for Clarizen integrations:

• Capturing data changes with an API Manager API or HTTP endpoint

• Capturing data changes with file sources

• Capturing data changes with source field values

• Capture data changes with table or file changes

• Capturing data changes with timestamp-based queries

• Creating single- or multiple-record output

• Creating transformation iterator dynamically

• Harmony best practices

• Linking source or target records using shared IDs

• Looking up data during runtime

• Looking up data using a dictionary

• Persisting data for later processing using Temporary Storage

• Persisting inbound data for later processing

• Processing target records conditionally

• Running next operations conditionally using operation chains

• Set up a team collaboration project

• Set up alerting, logging, and error handling

• Updating multiple targets from a single source record

• Upserting Clarizen data with a chain of operations