Features

Feature	Supported	Notes
Set pipeline frequency	Yes	For more details, see the guide.
Full load synchronization	Yes	See the tables
Incremental synchronization	Yes	See the tables
API Token connection	Yes	Follow the steps to generate your API Token here.

Quick Start

To create a pipeline, open the Collect module, go to "Pipelines", and click "New Pipeline".

Choose the Data Source

Use an existing source or register a new one

Connection Parameters (Source Registration)

Field name	Description	Example
Subdomain	Initial part of your URL.	empresa
API Token	To generate an API token, you must be an administrator and API token access must be enabled. Follow the steps to generate your API Token here.	THISISAVERYLONGTOKEN
Email	Used to access the account.	nome.sobrenome@dominio.com

Pipeline Information

Assign a name and a brief description to your pipeline.

Pipeline Configuration Parameters

Field name	Description	Example
Start date	Determines how much historical data will be extracted.	dd/mm/aaaa

Click "Save and Continue".

Specify Objects

Synchronization available for each object:

• agents_activity
  • Replication strategy: FULL_TABLE
• articles
  • Replication strategy: INCREMENTAL | FULL_TABLE
• organizations
  • Replication strategy: INCREMENTAL | FULL_TABLE
• users
  • Replication strategy: INCREMENTAL | FULL_TABLE
• tickets
  • Replication strategy: INCREMENTAL | FULL_TABLE
• ticket_audits
  • Replication strategy: INCREMENTAL | FULL_TABLE
• ticket_metrics
  • Replication strategy: INCREMENTAL | FULL_TABLE
• ticket_comments
  • Replication strategy: INCREMENTAL | FULL_TABLE
• ticket_metric_events
  • Replication strategy: INCREMENTAL | FULL_TABLE
• satisfaction_ratings
  • Replication strategy: INCREMENTAL | FULL_TABLE
• groups
  • Replication strategy: INCREMENTAL | FULL_TABLE
• macros
  • Replication strategy: INCREMENTAL | FULL_TABLE
• tags
  • Replication strategy: FULL_TABLE
• ticket_fields
  • Replication strategy: INCREMENTAL | FULL_TABLE
• ticket_forms
  • Replication strategy: INCREMENTAL | FULL_TABLE
• group_memberships
  • Replication strategy: INCREMENTAL | FULL_TABLE
• sla_policies
  • Replication strategy: FULL_TABLE

After entering the credentials, you can view and select the entities and columns from the connected source to import during data collection.

You can also define the synchronization mode per object. For more information, see the guide.

📘

When selecting more than one entity, a separate dataset is created in the catalog for each imported table or view.

Frequency

• Finally, configure how often your pipeline should run. Choose one of the available options or enter a custom frequency using a cron expression. For more information, see the guide.

📘

• The default time zone for scheduling is UTC.
• All frequency methods define when extractions begin. They do not control how long replication runs or when the data actually reaches its destination.

Done! Wait for collection to run on the scheduled day and time.

To run the pipeline immediately, you can start it manually within 30 seconds after creating it. Go to "Pipelines", "List", and "Synchronize Pipeline".

After a few minutes, your pipeline will be cataloged as a Data Asset in the Explore tab.

You can also open "View pipeline" in the pipeline list to review the summary, collected entities and columns, execution history, and micro-transformation history.