Funcionalidades

Funcionalidade	Suportado	Notas
Definir frequência da pipeline	Sim	Para mais detalhes, acesse.
Sincronização Full load	Sim	Consulte as tabelas
Sincronização Incremental	Sim	Consulte as tabelas
Conexão via API Token	Sim	Passo a passo para gerar seu API Token aqui.

Guia rápido

Para iniciar a criação de uma Pipeline, basta ir no módulo Coletar, "Pipelines" aperte em "Nova Pipeline".

Escolha a fonte de dados

Utilize uma fonte já cadastrada ou cadastre uma nova

Parâmetros para conexão (cadastro da fonte)

Nome do campo	Descrição	Exemplo
Subdomínio	Conteúdo inicial da sua URL.	empresa
API Token	Para gerar um token de API, você deve ser um administrador e o acesso ao token de API deve estar ativado. Passo a passo para gerar seu API Token aqui.	THISISAVERYLONGTOKEN
E-mail	Utilizado para acessar a conta.	[email protected]

Informações da pipeline

Atribua o nome e uma breve descrição para sua Pipeline.

Parâmetros para configurações da pipeline

Nome do campo	Descrição	Exemplo
Data de início	Determina quantos dados históricos serão extraídos.	dd/mm/aaaa

Clique em "Salvar e Continuar".

Especificar os objetos

Sincronização disponível para cada objeto:

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

Após inserir as credenciais você estará apto a visualizar e selecionar quais entidades da fonte conectada serão importados na coleta de dados e as colunas que serão importadas.

Além disso, pode definir o modo de sincronização por objeto. Para saber mais, acesse.

📘
Ao selecionar mais de uma entidade, para cada tabela ou view importada será criado um dataset diferente no catálogo.

Frequência

Por último, configure a frequência desejada para que sua pipeline rode. É possível escolher dentre as opções apresentadas ou inserir uma frequência customizada através de uma expressão cron. Para saber mais, acesse.

📘

O fuso horário padrão utilizado na frequência é o UTC.

Todos os métodos de frequência definem quando as extrações serão iniciadas. Eles não controlam por quanto tempo o trabalho de replicação será executado ou quando os dados estarão efetivamente no destino.

Pronto! Agora basta aguardar a coleta ser feita no horário e dia agendado.

Caso queira executar a pipeline imediatamente, é possível executá-la manualmente em até 30 segundos após a criação da pipeline. Vá em "Pipelines", "Lista" e "Sincronizar Pipeline".

Após alguns minutos, sua pipeline estará catalogada na aba de exploração como um Data Asset.

É possível também consultar na lista de pipelines os detalhes da pipeline, como: resumo, lista de entidades e colunas coletadas, histórico de execução e de micro-transformação, em "Ver pipeline".