Conceito: solicitação de API de exportação de dados
A solicitação de API REST de exportação de dados é a base da integração do Workday Studio para exportações de dados. A integração inicia uma solicitação de API com base em uma consulta específica da Workday Query Language (WQL) para exportar dados do Prism. Você pode configurar como essa consulta é gerada de duas maneiras: selecionando uma fonte de dados Prism para a criação automática de consultas ou fornecendo o texto de consulta WQL diretamente.
Opções de configuração:
Você pode definir a origem da consulta usando o atributo
Opção de origem de exportação de dados do
e escolhendo entre a fonte de dados Prism
ou o texto de consulta WQL
.Se você seleciona
Fonte de dados Prism
, precisa especificar também o atributo Fonte de dados Prism para exportação de dados
. Com isso, a integração cria automaticamente uma consulta WQL que inclui todos os campos dessa fonte de dados. Fontes de dados com (Inativa)
no nome não podem ser usadas para exportações. Para ativá-las, você deve editar o esquema da tabela associada no Prism e marcar a opção Habilitado para análise
. Se você seleciona
Texto de consulta de WQL
, deve fornecer uma instrução WQL válida no atributo Texto de consulta de WQL de exportação de dados
. Você pode testar a validade da instrução WQL usando o relatório View WQL Query Result
. Essa opção é obrigatória se sua consulta precisar usar alguma função no WQL, pois a opção Fonte de dados Prism
cria somente uma consulta simples de todos os campos. Para limitar o número de linhas na exportação, você pode configurar uma cláusula
Onde
usando o atributo Cláusula Onde da consulta WQL da exportação de dados
. Essa configuração se aplica a exportações geradas usando a opção Fonte de dados Prism
ou Texto de consulta WQL
.Como monitorar a solicitação de API de exportação de dados
Após iniciar a solicitação, a integração monitora ativamente a execução usando estes atributos:
- Intervalo de consulta inicial: define o tempo de espera em segundos antes de ser executada a primeira verificação de status.
- Repetir intervalo de consulta: determina o tempo entre todas as verificações de status subsequentes.
- Número máximo de tentativas de consulta: especifica o número máximo de vezes que a integração verificará o status da solicitação.
Conclusão da solicitação de API de exportação de dados
Quando a solicitação de exportação de dados é concluída com êxito, a resposta da API contém links para download dos arquivos de exportação. A integração também enviará uma mensagem de resumo indicando o número total de arquivos criados e o tamanho total dos arquivos exportados em gigabytes.