Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Exportación de datos de Planning con Scripted Planning Exporter

Exportación de datos de Planning con Scripted Planning Exporter

Puede usar el plugin personalizado Scripted Planning Exporter (SPE) de Pentaho para exportar datos de Planning a sistemas externos. Para obtener información adicional sobre
Adaptive Planning
 uso de Pentaho, consulte Definición de un origen de datos con secuencia de comandos.

Introducción a SPE

El SPE funciona realizando una llamada al
Adaptive Planning
 export API de REST y, a continuación, almacena los resultados de esa llamada API en un archivo que especifique. SPE admite datos de salida en formatos de archivo CSV y XML. No todos los datos de exportación se pueden transformar al formato CSV.
SPE es un plugin que se incluye en el paquete del agente de datos a partir de la versión v51.17.0734. Puede verificar su versión del gestor del servicio de agente de datos al abrir el programa. El número de versión aparece en la información de la ficha Acerca de. Para obtener información sobre cómo instalar el agente de datos, consulte Instalación del gestor del servicio de agente de datos. Cuando se instala SPE, el plugin de Adaptive Planning aparece en la carpeta Entrada, en la ficha Diseño de Spoon.
La terminología relacionada con Scripted Planning Exporter Adapter puede resultar confusa. Dado que los datos fluyen desde Planning a la secuencia de comandos y luego a un destino externo, se trata de una exportación de datos desde Planning y una importación de los datos al destino externo. Sin embargo, visto desde Spoon, SPE es un paso de entrada de datos, ya que introduce datos en la secuencia de comandos. Por este motivo, se etiqueta como "Adaptive Planning Input" en Spoon.
Puede iniciar SPE directamente desde el entorno de Spoon o de forma remota incluyéndolo en un cargador de secuencia de comandos. El proceso general para usar SPE es escribir una secuencia de comandos que crea una solicitud XML en el formato que acepte el servidor de Planning, la pasa a SPE y luego procesa los resultados. A continuación podrá ver una secuencia de comandos de muestra que permite ver los requisitos mínimos de una secuencia de comandos de 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
Las prácticas recomendadas para esta secuencia de comandos son las siguientes:
  • Todos los nombres de los campos de entrada distinguen entre mayúsculas y minúsculas. Téngalo en cuenta a la hora de definir la secuencia de comandos de Kettle.
  • requestXMLString:
    cada API de exportación tiene su propio formato XML de solicitud. Consulte la
    Adaptive Planning
     API de REST para obtener más información.
  • targetResponseFormat:
    a partir versión 11 de la API, solo se puede transformar al formato CSV la carga útil de la API "exportData". Todas las demás exportaciones deben ser en XML.
  • TargetFolder:
     en general, no seleccione la casilla Restringir acceso de ejecutor a archivos en el Gestor de servicios de agente. La carpeta de destino puede estar en cualquier lugar del sistema de archivos.
  • responseFileName:
    el nombre del archivo de respuestas tiene el siguiente formato:
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Ejemplo:
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess:
     si la solicitud de exportación se realiza en el servidor de Planning, el valor de requestSuccess es verdadero ('Y'). Si la solicitud de exportación falla en los resultados de una llamada a Planning, SPE genera una excepción con los mensajes de error que devuelve el servidor de Planning.
El flujo de trabajo general para extraer la información de Planning y enviarla a un archivo de resultado es el siguiente:
  1. Archivo XML de solicitud de entrada.
  2. Convertir contenido de archivo a cadena.
  3. Definir el formato (CSV|XML) y la carpeta de destino.
  4. Adaptive Scripted Planning Exporter.
  5. Paso de bloqueo.
  6. Datos de salida de Log Adapter.

Uso de las API de exportación de Planning desde la secuencia de comandos de Kettle

El SPE utiliza
Adaptive Planning
API v11 o superior Puede usar las siguientes API con SPE:
  • CustomReportValues:
    devuelve un conjunto de datos para los criterios de informe solicitados en la instancia solicitada
  • exportData:
     recupera un conjunto de valores de una versión especificada
Consulte Comprensión de
Adaptive Planning
 API para obtener más información.

Configuración del plugin de Kettle para SPE

Para configurar el plugin de Kettle para SPE, siga estos pasos:
  1. Haga clic en
    Adaptive Planning Input
     en la ficha Diseño en Spoon.
  2. Introduzca la siguiente información de SPE:
    • Active Agent:
       SPE lo rellena automáticamente.
    • Instance Host:
      SPE lo rellena automáticamente.
    • Instance Code:
      SPE lo rellena automáticamente.
    • Login:
       valor del parámetro de contexto de inicio de sesión.
    • Login Password:
      valor del parámetro de contexto de la contraseña.
    • Locate:
       el valor por defecto es
      en_US.
  3. Haga clic en
    Aceptar.
Debe crear una secuencia de comandos que defina los datos de entrada y de salida de la operación de SPE. Consulte la secuencia de comandos de muestra de este artículo.

Configuración de SPE en
Adaptive Planning
 Interfaz de usuario de Integration Cloud

El proceso general de crear un cargador con secuencia de comandos con la interfaz de usuario de integración en la nube es el siguiente:
  • Crear un cargador con secuencia de comandos
  • Seleccionar un punto de entrada
  • Configurar los parámetros obligatorios
Comience creando un nuevo cargador con secuencia de comandos. Consulte Creación de cargadores con secuencia de comandos para obtener más información. También debe seleccionar un punto de entrada en el menú desplegable Punto de entrada. El punto de entrada se define como el nombre de la secuencia de comandos que se ejecutará cuando se ejecute el cargador con secuencia de comandos.
Debe asignar y exponer los parámetros de contexto locales y compartidos definidos en el cargador con secuencia de comandos como variables de entorno en el entorno Kettle/Spoon. Ejemplo: si se define un parámetro de contexto llamado "inicio de sesión" en la pantalla de configuración del cargador en la sección Parámetros, se expone como la variable "${login}" en el entorno de Kettle. La definición de dos parámetros de contexto en un cargador con secuencia de comandos se utiliza en SPE para las dos variables de Kettle correspondientes.
Puede actualizar las variables de Kettle en tiempo de diseño con los valores de los parámetros de contexto por defecto actuales iniciando el Editor de secuencia de comandos y activando una actualización haciendo clic en
Refresh Configuration.