Passa al contenuto principale
Documentazione
Documentazione
Adaptive Planning
Esportare dati di Planning con Scripted Planning Exporter

Esportare dati di Planning con Scripted Planning Exporter

È possibile utilizzare Scripted Planning Exporter (SPE), un plug-in Pentaho personalizzato, per esportare i dati di Planning in sistemi esterni. Per ulteriori informazioni su
Adaptive Planning
 per l'utilizzo di Pentaho, consultare Configurazione di un'origine dati con script.

Informazioni su SPE

La SPE funziona effettuando una chiamata a
Adaptive Planning
 esportare l'API REST e quindi archiviare i risultati della chiamata API in un file specificato. SPE supporta l'output nei formati CSV e XML. Non tutti i dati di esportazione possono essere convertiti in formato CSV.
SPE è un plug-in integrato in bundle con l'agente dati a partire dalla versione v51.17.0734. Per verificare quale versione del gestore servizi agente dati si sta utilizzando, aprire il programma. Il numero di versione viene visualizzato nella scheda Informazioni. Per informazioni sull'installazione dell'agente dati, consultare Installare il gestore servizi agente dati. Una volta installato SPE, il plug-in Adaptive Planning viene visualizzato nella cartella Input della scheda Design di Spoon.
La terminologia relativa a Scripted Planning Exporter Adapter potrebbe non essere chiara. Poiché i dati passano da Planning allo script e quindi a una destinazione esterna, si tratta di un'esportazione di dati da Planning e di un'importazione di dati nella destinazione esterna. Tuttavia, dal punto di vista di Spoon, SPE, si tratta di uno step di input, perché fornisce input per lo script. Per tale motivo in Spoon è denominato "Adaptive Planning Input".
È possibile avviare SPE direttamente dall'ambiente di Spoon o in remoto, includendolo in un caricatore con script. Il processo generale per l'utilizzo di SPE è costituito dalla creazione di uno script che crea una richiesta XML nel formato accettato dal server di pianificazione, la passa a SPE e quindi elabora i risultati. Lo script di esempio riportato di seguito mostra i requisiti minimi per uno script 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
Le best practice per questo script sono le seguenti:
  • Tutti i nomi dei campi di input fanno distinzione tra maiuscole e minuscole. Definire i nomi di conseguenza nello script Kettle.
  • requestXMLString:
    ogni API di esportazione ha il proprio formato XML di richiesta. Consultare
    Adaptive Planning
     API REST per ulteriori informazioni.
  • targetResponseFormat:
     a partire dalla versione API v11, solo il payload dell'API "exportData" può essere convertito in formato CSV. Tutte le altre esportazioni devono essere in formato XML.
  • TargetFolder:
     in generale, non selezionare la casella di controllo Limita accesso runner ai file in Agent Service Manager. La cartella di destinazione può trovarsi in qualsiasi punto del file system.
  • responseFileName:
    il nome del file di risposte è nel formato seguente:
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Esempio:
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess:
     se la richiesta di esportazione viene completata sul lato del server di Planning, il valore di requestSuccess è vero ("Y"). Se la richiesta di esportazione non riesce nei risultati di una chiamata a Planning, SPE genera un'eccezione con i messaggi di errore restituiti dal server di Planning.
Il workflow generale per estrarre le informazioni dalla pianificazione e inviarle a un file di output è il seguente:
  1. Inserire il file XML di richiesta.
  2. Convertire il contenuto del file in formato stringa.
  3. Impostare il formato (CSV | XML) e la cartella di destinazione.
  4. Eseguire Adaptive Scripted Planning Exporter.
  5. Eseguire lo step di blocco.
  6. Registrare l'output di Adapter.

Utilizzare le API Planning Export dallo script Kettle

La SPE utilizza
Adaptive Planning
API v11 o successive È possibile utilizzare le seguenti API con SPE:
  • customReportValues:
    restituisce un insieme di dati per i criteri di report richiesti nell'istanza richiesta.
  • exportData:
     recupera un insieme di valori da una versione specificata.
Consultare Informazioni su
Adaptive Planning
 API per ulteriori informazioni.

Configurazione del plug-in SPE Kettle

Per configurare il plug-in SPE Kettle:
  1. Fare clic su
    Adaptive Planning Input
     nella scheda Design di Spoon.
  2. Immettere le informazioni di SPE:
    • Active Agent:
       popolato automaticamente da SPE.
    • Instance Host:
      popolato automaticamente da SPE.
    • Instance Code:
       popolato automaticamente da SPE.
    • Login:
       valore del parametro di contesto login.
    • Login Password:
      valore del parametro di contesto password.
    • Locale:
       il valore predefinito è
      en_US.
  3. Fare clic su
    OK.
È necessario creare uno script che definisca gli input e gli output per il funzionamento di SPE. Consultare lo script di esempio in questo articolo.

Configurazione della SPE all'interno di
Adaptive Planning
 UI di Integration Cloud

Il processo generale per la creazione di un caricatore con script con l'interfaccia utente cloud dell'integrazione è il seguente:
  • Creare un caricatore con script.
  • Selezionare un punto di ingresso.
  • Configurare i parametri obbligatori.
Per iniziare, creare un nuovo caricatore con script. Per ulteriori informazioni, consultare Creazione di caricatori con script . È inoltre necessario selezionare un punto di ingresso nell'elenco a discesa Punto di ingresso. Il punto di ingresso è impostato sul nome dello script da eseguire quando viene eseguito il caricatore con script.
È necessario mappare e visualizzare i parametri di contesto locali e condivisi definiti nel caricatore con script come variabili di ambiente nell'ambiente Kettle/Spoon. Esempio: se nella sezione Parametri della schermata di configurazione del caricatore viene definito un parametro di contesto "login", il parametro viene visualizzato nell'ambiente Kettle come variabile "${login}". La definizione di due parametri di contesto in un caricatore con script viene quindi utilizzata in SPE per entrambe le variabili Kettle corrispondenti.
È possibile aggiornare le variabili Kettle in fase di progettazione con i valori dei parametri di contesto predefiniti correnti avviando Adaptive Script Editor e attivando un aggiornamento tramite un clic su
Refresh Configuration
.