Referência: atributos de integração do Studio da API de exportação de dados
Atributos de integração
Vários atributos controlam o comportamento da integração do Data Export API Studio. Você pode configurar esses atributos individualmente ou em mapas chaveados por um valor enumerado chamado Sistema de origem. O sistema de origem permite que os valores de atributo associados a uma fonte de dados específica sejam armazenados na integração e reutilizados sempre que a integração é executada para essa fonte. Para adicionar novos valores de sistema de origem à integração, você deve usar a tarefa
Editar definição de enumeração de integração
e selecionar INT Studio Prism Data Export API Outbound - Enumeration - Source System
.A tabela descreve os atributos da integração do Data Export API Studio.
Serviço de atributos | Nome do atributo | Descrição |
|---|---|---|
Geral | Formato de arquivo de exportação de dados
| Formato dos arquivos de exportação. O Workday oferece suporte apenas a CSV (GZIP). |
Geral | Incluir cabeçalhos de arquivo
| Se esta opção for habilitada, os arquivos de exportação incluirão cabeçalhos. |
Geral | Método de download de arquivo de exportação de dados
| Método usado para baixar arquivos de exportação. Exemplo: em série, simultânea. |
Geral | Tamanho total máximo da solicitação de exportação (bytes)
| Tamanho máximo em bytes dos arquivos de exportação baixados em um único evento de integração. |
Geral | Máximo de solicitações de download de arquivo simultâneas
| Número máximo de solicitações simultâneas de download de arquivo iniciadas pela integração. |
Geral | Intervalo de consulta inicial (segundos)
| Número de segundos a aguardar antes de verificar o status das solicitações de API e/ou dos eventos de download de arquivos. |
Geral | Intervalo de nova tentativa de consulta (s)
| Número de segundos de espera entre a verificação do status da solicitação de API e/ou os eventos de download de arquivo. |
Geral | Número máximo de novas tentativas de consulta
| Número máximo de verificações de status para solicitações de API e/ou eventos de download de arquivos. |
Geral | Opção de origem da exportação de dados (somente mapa)
| Consulta usada para a fonte selecionada. Selecione Fonte de dados Prism ou Texto de consulta WQL. |
Geral | Fonte de dados Prism de exportação de dados (somente mapa)
| A fonte de dados Prism para a origem selecionada. Obrigatório se a opção de origem de exportação de dados é Fonte de dados Prism. |
Geral | Texto da consulta WQL de exportação de dados (somente mapa)
| Consulta WQL usada na solicitação de API de exportação de dados. Obrigatório se a opção Texto de consulta de WQL é selecionada. |
Geral | Cláusula Onde da consulta WQL da exportação de dados (somente mapa)
| Cláusula Onde da consulta usada na solicitação de API de exportação de dados Aplica-se somente se a Opção de origem de exportação de dados selecionada for Texto de consulta WQL. |
Opções de API | URL do ponto de extremidade de autenticação da API
| URL do ponto de extremidade para a API de autenticação usada para acessar a API de dados. |
Opções de API | URL do ponto de extremidade da API de exportação de dados
| URL do ponto de extremidade para a API de exportação de dados. |
Opções de API | URL do ponto de extremidade para download do arquivo da API de exportação de dados
| URL do ponto de extremidade para a API usada para baixar arquivos. |
Opções de API | URL de ponto de extremidade da API de fontes de dados WQL
| URL de ponto de extremidade para a API WQL para recuperar fontes de dados do Prism. |
Opções de API | URL de ponto de extremidade da API de campos de fonte de dados WQL
| URL de ponto de extremidade para a API WQL usada para recuperar os campos para uma fonte de dados Prism. |
Opções de API | Obter URL de ponto de extremidade de API de tabela
| URL de ponto de extremidade da API usada para recuperar a tabela associada a uma fonte de dados Prism. |
Opções de API | Descrever o URL do ponto de extremidade da API de tabela
| URL do ponto de extremidade para a API usada para recuperar o esquema da tabela. |
Opções de API | Nome do arquivo de saída da exportação de dados (somente mapa)
| Nome do arquivo de saída dos arquivos de exportação baixados para a origem selecionada. |
Opções de registro | Retenção de arquivo de saída (dias)
| Número de dias em que os documentos gerados pela integração ficam disponíveis para download. |
Opções de registro | Gerar documentos de diagnóstico
| Se habilitada, a integração gerará documentos adicionais para diagnósticos. |
Processamento simultâneo | Número máximo de threads simultâneos (atributo e mapa)
| Número máximo de threads simultâneos usados pela integração. |
Processamento simultâneo | Tempo limite máximo de thread
| Tempo limite máximo (segundos) que cada thread paralelo pode estar ativo. |
Processamento simultâneo | Tempo limite máximo do processo
| Tempo limite máximo (segundos) que cada processo pode estar ativo. |
Processamento simultâneo | Consolidar dados de thread de exportação simultânea
| Se esta opção está habilitada, os arquivos de saída de cada thread paralelo são consolidados. |
Prism | Nome do host da API Prism
| Nome do host do conector da API Prism. Os valores podem ser obtidos no relatório/tarefa View API Clients. |
Prism | ID de cliente
| ID de cliente do conector da API Prism usada para autenticação no Prism. |
Prism | Chave secreta cliente
| Segredo (senha) do conector da API do Prism. |
Prism | Token de atualização
| Token para a integração atual usada pelo conector da API Prism. |
Adicionar sistemas de origem
Você pode associar valores de atributo da integração a uma fonte de dados específica usando a enumeração Sistema de origem.
A tabela lista os mapas que você precisa revisar ou configurar após adicionar um novo valor à enumeração.
Nome do atributo/mapa | Descrição |
|---|---|
Opção de origem da exportação de dados
| Se você quer baixar todos os campos da fonte de dados, selecione Fonte de dados Prism .
Se você quer selecionar campos individuais, selecione WQL Query Text . |
Fonte de dados Prism de exportação de dados
| Configure essa entrada se Fonte de dados Prism estiver selecionada para a opção de origem. |
Texto da consulta de WQL de exportação de dados
| Configure essa entrada se Texto de consulta de WQL estiver selecionado. Deve ser uma instrução WQL válida. |
Cláusula Onde de consulta de WQL para exportação de dados
| Configure para limitar os dados exportados. Deve ser uma sintaxe WQL válida. |
Método de download de arquivo de exportação de dados
| Configure para selecionar Simultânea ou permita Número de série por padrão. |
Tamanho total máximo da solicitação de exportação (bytes)
| Configure para especificar um tamanho de solicitação diferente do valor por padrão. |
Máximo de solicitações de download de arquivo simultâneas
| Configure para especificar um número de solicitações de download simultâneas diferente do valor por padrão. |
Nome do arquivo de saída da exportação de dados
| Configure para especificar o nome do arquivo de saída.
Usar palavras-chave <currentDate> e/ou <currentTime> para incluir data e hora no nome do arquivo. |
Compactar arquivo de saída
| Configure e habilite para compactar os arquivos de saída (GZIP). |
Número máximo de threads simultâneos
| Configure para especificar um número de threads paralelos diferente do valor por padrão. |
Consolidar dados de thread de exportação simultânea
| Configure e habilite para consolidar arquivos de saída de threads individuais em um único arquivo. |
Parâmetros de inicialização
A integração disponibiliza estes parâmetros de inicialização que podem ser usados para controlar o comportamento do:
Parâmetro | Descrição |
|---|---|
Sistema de origem (obrigatório)
| Especifica a origem dos dados a serem exportados. Atributos e valores do mapa associados à origem selecionada são aplicados durante o evento. |
WID do evento de exportação de dados
| A ID Workday de um evento de exportação de dados anterior. Se a opção estiver preenchida, a integração realizará os downloads dos arquivos do evento especificado, gerando novos eventos de download de arquivo, se necessário. Se este parâmetro está em branco por padrão, a integração enviará uma nova solicitação de API de exportação de dados. |
Data e hora do evento de exportação de dados
| A data e a hora de um evento de exportação de dados anterior. O valor é preenchido automaticamente para eventos gerados a partir de um evento de exportação de dados principal. |
Lista de arquivos para download da exportação de dados
| Uma lista de arquivos de exportação no formato XML a serem baixados pelo evento atual. O valor é preenchido automaticamente para eventos gerados a partir de um evento de exportação de dados principal. |
Resumo da solicitação de download do arquivo de exportação de dados
| Documento de solicitação de download de arquivo passado como entrada para eventos de exportação de dados gerados de um evento de exportação de dados principal. Se a opção estiver preenchida, o evento atual gerará novos eventos de download de arquivo e monitorará sua execução. |
Calcular somente estatísticas de exportação (sem download de arquivo)
| Se habilitada, a integração iniciará somente a solicitação de API de exportação de dados, monitorará sua execução e calculará o número total de solicitações de exportação e download de arquivo para concluir a solicitação de exportação. Nenhum arquivo será baixado. |
Gerar eventos de download de arquivo adicional
| Se estiver habilitado por padrão, o evento de exportação de dados gerará eventos de download de arquivo. Se esta opção está desabilitada, toda a exportação deve ser baixada dentro do evento atual ou uma mensagem de erro será exibida. |