Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Exportar dados do Planning com o Scripted Planning Exporter

Exportar dados do Planning com o Scripted Planning Exporter

Você pode usar o Scripted Planning Exporter (SPE), um plug-in personalizado do Pentaho, para exportar dados do Planning para sistemas externos. Para obter informações adicionais sobre
Adaptive Planning
 sobre o uso do Pentaho, consulte Como definir fontes de dados com script.

Sobre o SPE

O SPE faz uma chamada para o
Adaptive Planning
 export REST API e, em seguida, armazena os resultados dessa chamada de API em um arquivo que você especifica. O SPE tem suporte para os formatos de arquivo CSV e XML. Nem todos os dados para exportação podem ser transformados no formato CSV.
O SPE é um plug-in incorporado ao pacote do agente de dados a partir da versão v51.17.0734. Para verificar e versão do seu gerenciador de serviços do agente de dados, abra o programa. O número da versão aparece nas informações da guia Sobre. Para obter informações sobre como instalar o agente de dados, consulte Instalar o gerenciador de serviços do agente de dados. Quando o SPE é instalado, o plug-in do Adaptive Planning aparece na pasta Input, na guia Design do Spoon.
A terminologia do Scripted Planning Exporter Adapter pode ser um pouco confusa. Como os dados fluem do Planning para o script e, em seguida, para algum destino externo, trata-se de uma exportação de dados do Planning e uma importação de dados do destino externo. No entanto, sob o ponto de vista do Spoon, o SPE é uma etapa de entrada, pois fornece entrada para o script. Por isso ele é rotulado como Adaptive Planning Input no Spoon.
Você pode iniciar o SPE diretamente no Spoon ou remotamente, incluindo-o em um carregador de scripts. Em linhas gerais, o processo para usar o SPE é escrever um script que cria uma solicitação XML no formato aceito pelo servidor do Planning, passar isso para o SPE e processar os resultados. Confira abaixo um script de amostra com os requisitos mínimos de um script do SPE:

      Scripted Planning Exporter
-------------------------------------------
Input:
      requestXMLString: request in XML format
      targetResponseFormat: CSV or XML
      targetFolder: target folder to store result file generated by
         this plugin

Output: The type of output fields is String, except
    requestSuccess, which is boolean
      requestSuccess: Boolean, Y' or N'
      planningMsgs: concatenate Planning messages in a string,
    delimited by ###'
      responseFileName: complete path of the response file name
      fieldNames: column name in CSV header, or NULL if
    targetResponseFormat is XML
      numberRecReturned: String, number of records returned by
    Planning, or NULL if targetResponseFormat is XML
As práticas recomendadas para esse script incluem:
  • Todos os nomes de campo de entrada devem diferenciar maiúsculas de minúsculas. Defina-os corretamente no script Kettle.
  • requestXMLString
    : cada API de exportação deve ter seu próprio formato XML de solicitação. Consulte o
    Adaptive Planning
     API REST para obter mais informações.
  • targetResponseFormat
    : a partir da API v11, somente a carga da API 'exportData' pode ser transformada no formato CSV. Todas as outras exportações devem ser XML.
  • TargetFolder:
     em geral, não marque a caixa de seleção Restrict Runner Access to Files no gerenciador de serviços do agente. A pasta de destino pode estar em qualquer lugar do sistema de arquivos.
  • responseFileName:
    o nome do arquivo de resposta está no seguinte formato:
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Exemplo:
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess
    : se a solicitação de exportação é processada no lado do servidor do Planning, o requestSuccess tem o valor verdadeiro ('Y'). Se a solicitação de exportação falha em uma chamada do Planning, o SPE lança uma exceção com as mensagens de erro retornadas pelo servidor do Planning.
O fluxo de trabalho geral para extrair as informações do Planning e enviá-las para um arquivo de saída é:
  1. Solicitar arquivo XML de entrada.
  2. Converter o conteúdo do arquivo para cadeia de caracteres.
  3. Definir o formato de destino (CSV | XML) e a pasta.
  4. Executar o Scripted Planning Exporter do Adaptive.
  5. Etapa de bloqueio.
  6. Registrar saída do Adapter.

Como usar as APIs de exportação do Planning no script do Kettle

O SPE usa
Adaptive Planning
APIs v11 ou superior Você pode usar as seguintes APIs com o SPE:
  • customReportValues
     :retorna um conjunto de dados conforme os critérios de relatório solicitados na instância solicitada
  • exportData
    : obtém um conjunto de valores de uma versão especificada
Consulte Sobre o
Adaptive Planning
 API para obter mais informações.

Como configurar o plug-in do Kettle para oSPE

Para configurar o plug-in do Kettle para o SPE:
  1. Clique em
    Adaptive Planning Input
     na guia Design do Spoon.
  2. Insira as informações do SPE:
    • Active Agent
      : preenchido automaticamente pelo SPE.
    • Instance Host
      : preenchido automaticamente pelo SPE.
    • Instance Code
      : preenchido automaticamente pelo SPE.
    • Logon:
       valor do parâmetro de contexto de logon.
    • Login Password
      : valor do parâmetro de contexto da senha.
    • Locale
      : en_US
       como valor padrão.
  3. Clique em
    OK.
Você precisa criar um script que defina as entradas e saídas para a operação do SPE. Consulte o script de amostra neste artigo.

Como configurar o SPE no
Adaptive Planning
 Integration Cloud UI

Em linhas gerais, o processo de criação de um carregador com script com a interface de usuário na nuvem em Integração é:
  • criar um carregador com script
  • selecionar um ponto de entrada
  • configurar os parâmetros obrigatórios
Comece criando um carregador com script. Para obter mais informações, consulte Como criar carregadores de scripts . Você também precisa selecionar um ponto de entrada na lista suspensa Ponto de entrada. O ponto de entrada é definido com o nome do script a ser executado no momento em o carregador é executado.
Você deve mapear e expor os parâmetros de contexto locais e compartilhados definidos no carregador com script como variáveis de ambiente no ambiente do Kettle/Spoon. Exemplo: se um parâmetro de contexto denominado "login" é definido na tela de definição do carregador, na seção Parâmetros, ele é exposto como a variável "${login}" no ambiente do Kettle. Então, se dois parâmetros de contexto são definidos em um carregador com script, eles são usados no SPE para ambas as variáveis correspondentes do Kettle.
Para atualizar as variáveis do Kettle em tempo de design com os valores por padrão atuais do parâmetro de contexto, inicie o Adaptive Script Editor e acione uma atualização clicando em
Atualizar configuração.