Conector de saída de arquivos

Sobre o conector de saída de arquivos

Você pode usar o conector de saída de arquivos para extrair dados enriquecidos do XM Discover para fins de conformidade e backup de dados ou para atuar nele em aplicativos externos.

Você pode exportar dados nos níveis da frase e do documento, limitá-los a registros novos e atualizados e escolher quais campos, aprimoramentos e classificações devem ser exportados. O conector de saída de arquivos salva dados em um servidor Secure File Transfer Protocol (SFTP).

ANTES DE INICIAR

Antes de configurar um job usando o conector de saída de arquivos, certifique-se de que:

• Nome de usuário e senha da sua conta SFTP.
• Uma chave PGP/GPG se você deseja criptografar arquivos fornecidos pelo XM Discover.

Os formatos de arquivo suportados são:

• Arquivos de texto delimitados (CSV).
• Arquivos JavaScript Object Notation (JSON).

CONFIGURANDO A CONEXÃO

1. Iniciar sessão nos conectores.
2. Clique no botão Novo trabalho no canto superior direito de Trabalhos.
   
3. Na página Conectores, vá para as FONTES DE SAÍDA.
   
4. Clique em Arquivos Saída.

Configuração de uma tarefa de conector de saída de arquivos

Depois de configurar a conexão, siga as etapas abaixo para configurar um job:

• Etapa 1: fornecer nome do job
• Etapa 2: especificar projeto e descrição
• Etapa 3: Fornecer credenciais para uma pasta SFTP da Qualtrics
• Etapa 4: Configurar credenciais de exportação do XM Discover
• Etapa 5: Configuração de consulta
• Etapa 6: Fornecer configuração de arquivos
• Etapa 7: Mapear campos desejados na Qualtrics
• Etapa 9: Especificar filtro (opcional) e limite de registros
• Etapa 10: Configuração de notificação (opcional)
• Etapa 11: Configurar opções adicionais para job
• Etapa 12: confirmar todas as configurações de job

Qdica: Clique nos botões Voltar e Avançar para navegar entre as páginas ou use as teclas de seta: ESQUERDA para voltar, DIREITA para ir em seguida. Se você quiser cancelar a configuração, clique no botão Cancelar.

Etapa 1: fornecer nome do job

1. Insira um nome de job reconhecível na caixa Nome do job na parte superior esquerda da página.
   
   Qdica: você pode modificar o nome da tarefa durante a configuração por meio do campo Nome da tarefa que é exibido na parte superior de cada página durante a configuração.
2. Clique em Seguinte.

Etapa 2: especificar projeto e descrição

1. Na página Especificar projeto e descrição, selecione um projeto do qual extrair dados do menu suspenso de projetos.
   
   Qdica: o projeto deve corresponder ao identificado pela chave de API de exportação. Se existir uma inconsistência, o job utilizará o projeto identificado pela chave API.
   Qdica: você tem a opção de inserir uma observação sobre a tarefa na caixa Descrição do cargo. A descrição do job que você insere na caixa Descrição do job só pode ser acessada na lista Conectores e não é exportada como parte dos dados para um job.
2. Clique em Seguinte.

Etapa 3: fornecer credenciais para uma conta SFTP da Qualtrics

1. Na página Fornecer credenciais para uma pasta SFTP do Qualtrics, você pode selecionar um conjunto existente de credenciais no menu suspenso ou adicionar um novo conjunto de credenciais. Consulte a seção Adição de novas credenciais SFTP para obter informações sobre a adição de um novo conjunto de credenciais.
   
2. Clique em Seguinte.

Etapa 4: Configurar credenciais de exportação do XM Discover

1. Na página Configurar credenciais de exportação do XM Discover, forneça o URL do serviço de API de exportação do XM Discover relevante para sua região (sem o tipo de ponto de acesso) na caixa HOST.
   
   Qdica: Para obter mais informações, consulte Exportar pontos de extremidade da API v2.
2. Clique em Seguinte.

Etapa 5: Configuração de consulta

Na página Configuração de consulta, você pode especificar o nível para exportar dados do XM Discover e escolher quais registros deseja recuperar.

1. Selecione uma das seguintes opções no menu suspenso Selecionar o nível de dados para escolher o nível de resolução de dados associado aos dados de saída:
   
   • Sentenças: use a exportação no nível da frase para obter informações mais granulares e enriquecimentos no nível da frase, como tópicos, sentimento, pontuações de esforço e assim por diante.
   • Documentos: use a exportação no nível do documento quando você deseja exportar valores para atributos estruturados relacionados a um documento inteiro.
     Atenção: ao usar enriquecimentos no nível de frase, defina o nível de dados como frases.
   • Para mais informações sobre os enriquecimentos disponíveis para cada nível, consulte Atributos predefinidos.
2. Forneça uma consulta para filtrar os dados de saída na caixa Inserir a consulta(opcional).
   Qdica: use a mesma sintaxe usada para procurar dados no Designer. Para saber mais sobre as consultas de pesquisa suportadas, consulte Consultas de pesquisa.
   Exemplo: você pode especificar um ou mais IDs de pesquisa para atualizar apenas os registros de pesquisa selecionados usando a seguinte sintaxe: survey yid:sv_01.
3. Forneça o nome do filtro do seu projeto que deve ser aplicado aos dados de saída na caixa Inserir o nome do filtro(opcional).
4. Em Escolha os registros que deseja recuperar, selecione os registros a serem extraídos:
   • Carregar novos registros (padrão). Extrair somente os registros que foram criados desde a última execução do job de saída.
   • Carregar registros novos e atualizados. Extrair os registros que foram criados ou atualizados desde a última execução do job de saída.
   • Carregar registros atualizados. Extrair somente os registros que foram atualizados desde a última execução do job de saída.
     Qdica: as tarefas de conector de saída de arquivos definidas como Carregar registros novos e atualizados ou Carregar registros atualizados só podem ser agendadas para execução em uma frequência semanal ou mensal.
     Atenção: a categorização em execução ou em nova execução atualiza um registro no sistema XM Discover.
5. Você pode definir que dados de classificação devem ser incluídos nos dados de saída (opcional). Marque o campo de seleção Todos os modelos para incluir os dados de classificação de todos os modelos disponíveis no projeto. Não marque o campo de seleção Todos os modelos se você só quiser incluir modelos selecionados. Se a opção Todos os modelos não estiver selecionada, você poderá selecionar modelos específicos a serem incluídos nos dados de saída a partir do menu suspenso.
   
6. Selecione uma das seguintes opções a partir do menu suspenso Filtros resultados aplicando regras de modelo:
   • Ignorar: nenhuma filtragem é aplicada com base nos modelos selecionados.
   • Classificado atualmente: Retorna as frases/documentos que foram classificados pelo(s) modelo(s) selecionado(s) durante a execução de classificação mais recente.
   • Ever Classified: Retorna as frases/documentos que foram classificados pelo(s) modelo(s) selecionado(s) a qualquer momento.
7. Marque o campo de seleção Se devem ser retornados IDs de categoria (verdadeiro) em vez de nomes de categoria (falso) para usar IDs de categoria em vez de nomes de categoria (Opcional).
8. Selecione os resultados de Filtros aplicando a consulta de filtro com todos os caminhos de nós-folha para adicionar vários modelos com o parâmetro “código somente folha” à chamada da API de exportação (opcional).
9. Clique em Seguinte.

Etapa 6: Fornecer configuração de arquivos

Na página Fornecer configuração de arquivos, escolha o tipo de arquivo a ser usado para a exportação de dados e, em seguida, dependendo do tipo de arquivo selecionado, aponte para o local onde os arquivos devem ser salvos e especifique outras configurações.

1. Na seção Configuração de arquivos, selecione o tipo de arquivo a partir das duas opções seguintes:
   
   • Arquivos de texto delimitados (CSV): selecione isso para exportar dados usando arquivos de texto delimitado (CSV).
   • Arquivos JavaScript Object Notation (JSON): selecione isto para exportar dados usando arquivos JavaScript Object Notation (JSON).
2. Se você selecionar Arquivos de texto delimitados (CSV), aplique as opções de configuração para esse tipo de arquivo.
   • Codificação de arquivos: selecione o sistema de codificação a ser usado no arquivo.
   • Caractere delimitador: especifique o caractere para delimitar as entradas de dados no arquivo. Apenas um caractere. Se estiver usando um CSV, seu delimitador será uma vírgula.
   • Caractere de embalagem: especifique o caractere para incluir cada campo de dados no arquivo. Apenas um caractere.
   • Sem embalagem: selecione este campo de seleção se os caracteres de embalagem forem opcionais.
3. Clique em Procurar na seção Local dos arquivos para apontar para a pasta onde os arquivos devem ser armazenados no servidor SFTP.
4. Na janela Selecionar localização de arquivos, selecione a pasta onde os arquivos devem ser armazenados.
   
   Qdica: clique no nome da pasta para selecioná-la e, em seguida, clique no ícone da pasta para abrir a pasta.
5. Assim que a pasta onde os arquivos estão armazenados for selecionada, clique em OK.
6. Na seção Convenções de nomes, você pode selecionar as seguintes opções:
   
   • Forneça um nome de arquivo para o prefixo: selecione esta opção para fornecer um prefixo a ser adicionado ao nome do arquivo gerado. Use esta opção para aplicar convenções de nomes personalizadas para compreender melhor quais arquivos correspondem a um determinado job ou execução de job.
     Qdica: O valor não pode conter [ ] \ / e deve ter no máximo 100 caracteres.
   • Forneça um nome de arquivo para o sufixo: selecione esta opção para fornecer um sufixo a ser adicionado ao nome do arquivo gerado. Use esta opção para aplicar convenções de nomes personalizadas para compreender melhor quais arquivos correspondem a um determinado job ou execução de job.
     Qdica: O valor não pode conter [ ] \ / e deve ter no máximo 100 caracteres.
7. Você pode criptografar arquivos fornecidos pelo XM Discover e fornecer uma chave PGP/GPG para criptografia na caixa de chave PGP/GPG(opcional). Marque a caixa de seleção Criptografar arquivos fornecidos pelo XM Discover para garantir que os dados sejam transferidos com segurança do XM Discover e forneça uma chave PGP/GPG para criptografia. Como alternativa, desmarque a caixa de seleção Criptografar arquivos fornecidos pelo XM Discover se nenhuma criptografia for necessária.
8. Clique em Seguinte.

Etapa 7: Mapear campos desejados para arquivos

Na página Mapear campos desejados para arquivos, você pode selecionar quais atributos XM Discover e resultados de classificação devem ser incluídos na exportação.

1. Clique dentro da caixa de campo personalizado vazio e selecione o campo XM Discover que você deseja incluir na exportação.
2. Selecione o formato no qual os dados devem ser exportados a partir do menu suspenso Tipo de dados.
3. Insira o nome do campo a ser utilizado no arquivo exportado na caixa Nome do atributo.
4. Clique no ícone de mais ( + ) para adicionar mais campos personalizados e mapeá-los para campos no arquivo exportado, se necessário.
5. Clique em Seguinte.

Etapa 8: Especificar filtro (opcional) e limite de registros

1. Na página Indicar filtro, você pode definir uma condição de filtro para um job para exportar somente registros que cumpram o mesmo (opcional).
   
   Qdica: Para obter mais informações sobre a aplicação de um filtro, consulte Filtro de conector.
2. Você pode indicar um limite de registros na caixa Indicar limite de registros. Como alternativa, você pode deixar o limite de registros como padrão Tudo se quiser que todos os registros sejam exportados em um único push.
   Qdica: O limite de registros é um limite por execução da tarefa. Se você defini-lo como 1.000, o trabalho será executado em qualquer programação definida e será interrompido após a exportação de 1.000 registros. Se você defini-lo como diário, isso significa que ele será executado uma vez por dia e você receberá até 1.000 registros exportados para cada dia.
   Qdica: Para dados conversacionais, o limite é aplicado com base em conversas em vez de linhas.
3. Clique em Seguinte.

Etapa 9: Configuração de notificação (opcional)

1. Na página Configuração de notificação, você pode selecionar as notificações que os observadores de um trabalho devem receber se ocorrer qualquer um dos eventos listados abaixo.
   • Os registros zero são exportados.
   • Foram encontrados valores em falta consecutivos.
   • Uma execução de job falha.
   • Uma execução de job tem êxito parcial.
   • Um job termina com um timeout.
   • Um trabalho falha.
     Qdica: você pode selecionar qualquer combinação de notificações ou decidir não escolher nenhuma notificação. Neste caso, as observações de um job não recebem notificações. Para mais informações sobre definições de configuração de notificação, consulte Notificações de job.
     Qdica: o tempo limite padrão para tarefas de conector de saída de arquivos é 48 horas.
2. Clique em Seguinte.

Etapa 10: Configurar opções adicionais para job

1. Na página Configurar opções adicionais para job, na seção Programar job histórico/incremental, selecione uma das seguintes opções:
   • Programar execuções incrementais para configurar uma programação para exportações de dados incrementais.
     Qdica: as tarefas de conector de saída de arquivos definidas como Carregar registros novos e atualizados ou Carregar registros atualizados só podem ser agendadas para execução em uma frequência semanal ou mensal.
     Qdica: use a opção Criar tarefa, mas não extrair dados se quiser validar a tarefa e suas configurações antes de os dados serem exportados. Para mais informações sobre o escalonamento de execuções incrementais, consulte Escalonamento do job.
   • Configurar pull único para executar uma exportação de dados única.
     Qdica: você pode alterar as configurações de programação mais tarde; consulte Recuperando dados para execuções únicas e Programação de tarefas para execuções regulares.
2. Na seção Dados incrementais adicionais, você pode indicar quantos dados adicionais (em dias ou horas) devem ser chamados durante uma execução incremental para garantir que todos os dados históricos relevantes estão disponíveis para transferência de saída (opcional).
   Qdica: o valor máximo para este campo é 30 dias.
3. Clique em Seguinte.

Etapa 11: confirmar todas as configurações de job

1. Na página Confirmar todas as configurações do trabalho, você pode visualizar um resumo de todas as configurações de um trabalho e editar as configurações, se necessário, antes de executar a exportação de dados. Para executar a exportação de dados, clique no botão Concluir quando estiver pronto para executar a exportação de dados. Será exibida uma mensagem de confirmação confirmando que a tarefa foi enviada com êxito.
2. Quando você clica em Concluir, acontece o seguinte: As exportações únicas são executadas imediatamente. A menos que você tenha ativado a opção “Criar tarefa, mas não extrair dados”, as exportações programadas são executadas imediatamente e, em seguida, definidas para serem executadas de acordo com a programação definida.

Para mais informações sobre a monitorização de jobs, consulte Síntese de página de jobs.

Adicionando novas credenciais SFTP

1. Selecione Adicionar novo.
2. Insira o nome do novo conjunto de credenciais na caixa NOME DA CONEXÃO.
   
3. Insira o nome de usuário do SFTP na caixa NOME DO USUÁRIO SFTP.
4. Digite a senha do SFTP na caixa SENHA DO SFTP.
5. Digite o endereço do servidor SFTP na caixa HOST SFTP.
6. Insira a porta SFTP na caixa SFTP PORT.
   Qdica: A porta padrão é 22.
7. Você pode definir suas credenciais para expirar após um determinado período de tempo (opcional). Para definir uma data de vencimento para este conjunto de credenciais e definir um lembrete para todos os observadores de trabalho, marque a caixa de seleção Enviar notificações de vencimento. Isso ativa a caixa Dias de vencimento anterior.
8. Insira um valor na caixa Dias antes da expiração para definir quantos dias antes do vencimento as notificações devem começar. Os valores possíveis variam de 1 a 100 dias.
   Qdica: este lembrete é acionado sempre que a tarefa é executada quando a data de vencimento é inferior ao número de dias definido na caixa Dias de vencimento anterior.
9. Selecione a Data de vencimento a partir do selecionador de data de calendário. A data de expiração será adicionada à caixa Data de vencimento.