Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2023-06-23
Planningsgegevens exporteren met Scripted Planning Exporter

Planningsgegevens exporteren met Scripted Planning Exporter

U kunt de Scripted Planning Exporter (SPE), een aangepaste Pentaho-plug-in, gebruiken om planningsgegevens naar externe systemen te exporteren. Voor meer informatie over:
Adaptive Planning
 gebruik van Pentaho, zie Een scripted gegevensbron instellen.

De SPE begrijpen

De SPE werkt door een aanroep te doen naar de
Adaptive Planning
 export REST API en slaat de resultaten van die API-aanroep vervolgens op in een bestand dat u opgeeft. De SPE ondersteunt uitvoer naar CSV- en XML-bestandsindelingen. Niet alle exportgegevens kunnen worden omgezet in een CSV-indeling.
De SPE is een plug-in die bij de Data Agent wordt geleverd vanaf versie v51.17.0734. U kunt controleren welke versie van Data Agent Service Manager u hebt door het programma te openen. Het versienummer wordt weergegeven bij de informatie op het tabblad Info. Zie De Data Agent Service Manager installeren voor informatie over het installeren van de Data Agent. Wanneer de SPE is geïnstalleerd, wordt de Adaptive Planning-plug-in weergegeven in de map Input op het tabblad Design van Spoon.
De terminologie rond de Scripted Planning Exporter Adapter kan enigszins verwarrend zijn. Omdat de gegevens van Planning naar het script en vervolgens naar een externe bestemming stromen, gaat het om een gegevensexport vanuit Planning en een gegevensimport naar de externe bestemming. Vanuit Spoon is de SPE echter een invoerstap, omdat deze stap invoer in het script levert. In Spoon heet het daarom Adaptive Planning Input.
U kunt de SPE rechtstreeks vanuit de Spoon-omgeving starten of op afstand starten door deze op te nemen in een scripted lader. Het algemene proces voor het gebruik van de SPE is het schrijven van een script dat een XML-aanvraag maakt in de indeling die door de Planningsserver wordt geaccepteerd, deze wordt doorgegeven aan de SPE en verwerkt vervolgens de resultaten. Hieronder ziet u een voorbeeldscript met de minimumvereisten voor een SPE-script:

      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
Aanbevolen procedures voor dit script zijn:
  • Alle namen van invoervelden zijn hoofdlettergevoelig. Definieer ze dienovereenkomstig in het Kettle-script.
  • requestXMLString:
    elke export-API heeft een eigen XML-indeling voor aanvragen. Zie de
    Adaptive Planning
     REST-API voor meer informatie.
  • targetResponseFormat:
    vanaf API v11 kan alleen de payload van de exportData-API worden omgezet in een CSV-indeling. Alle andere exports moeten XML zijn.
  • TargetFolder:
     schakel in het algemeen niet het selectievakje Restrict Runner Access to Files in Agent Service Managerin. De doelmap kan zich overal in het bestandssysteem bevinden.
  • responseFileName:
    de naam van het antwoordbestand heeft de volgende notatie:
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Voorbeeld:
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess:
     als de exportaanvraag wordt uitgevoerd op de Planningsserver heeft de requestSuccess de waarde true (Y). Als de exportaanvraag mislukt op basis van de resultaten van een aanroep van planning, genereert de SPE een uitzondering met de foutberichten die door de Planningsserver worden geretourneerd.
De algemene werkstroom voor het extraheren van de informatie uit de planning en het verzenden naar een uitvoerbestand:
  1. Voer het XML-bestand voor de aanvraag in.
  2. Converteer bestandsinhoud naar String.
  3. Stel doelindeling (CSV | XML) en map in.
  4. Adaptive Scripted Planning Exporter.
  5. Blokkeringsstap.
  6. Voeg Adapter-uitvoer aan logboek toe.

De planningsexport-API's uit het Kettle-script gebruiken

De SPE gebruikt
Adaptive Planning
API's v11 of hoger. U kunt de volgende API's gebruiken met de SPE:
  • customReportValues:
    retourneert een set gegevens voor de aangevraagde rapportcriteria in de aangevraagde instance
  • exportData:
     een set waarden ophalen uit een opgegeven versie
Zie Inzicht in de
Adaptive Planning
 API voor meer informatie.

De SPE Kettle-plug-in configureren

Voer de volgende stappen uit om de SPE Kettle-plug-in te configureren:
  1. Klik op
    Adaptive Planning Input
     op het tabblad Ontwerp van Spoon.
  2. Voer de gegevens van de SPE in:
    • Actieve agent:
       wordt automatisch ingevuld door de SPE.
    • Instancehost:
      wordt automatisch ingevuld door de SPE.
    • Instancecode:
       wordt automatisch ingevuld door de SPE.
    • Aanmelding:
       waarde van de parameter voor aanmeldingscontext.
    • Aanmeldingswachtwoord:
      waarde van de wachtwoordcontextparameter.
    • Landinstelling:
       standaard ingesteld op
      en_US.
  3. Klik op
    OK.
U moet een script maken dat de invoer en uitvoer voor de SPE-bewerking definieert. Zie het voorbeeldscript in dit artikel.

De SPE configureren binnen
Adaptive Planning
 Integratiecloud-gebruikersinterface

Het algemene proces voor het maken van een scripted lader met de cloud-UI van Integratie is als volgt:
  • een scripted lader maken
  • een invoerpunt selecteren
  • vereiste parameters configureren
Begin met het maken van een nieuwe scripted lader. Zie Scripted laders maken voor meer informatie. U moet ook een invoerpunt selecteren in de vervolgkeuzelijst Invoerpunt. Het invoerpunt wordt ingesteld op de naam van het script dat moet worden uitgevoerd wanneer de scripted lader wordt uitgevoerd.
U moet de lokale en gedeelde contextparameters die in de scripted lader zijn gedefinieerd, toewijzen en weergeven als omgevingsvariabelen in de Kettle/Spoon-omgeving. Voorbeeld: als een contextparameter met de naam login is gedefinieerd in het configuratiescherm van de lader in de sectie 'Parameters', wordt deze weergegeven als de variabele ${login} in de Kettle-omgeving. De definitie van twee contextparameters in een scripted lader wordt vervolgens gebruikt in de SPE voor beide bijbehorende Kettle-variabelen.
U kunt de Kettle-variabelen tijdens het ontwerpen bijwerken met de huidige standaardwaarden voor contextparameters door de Adaptive Script Editor te starten en een vernieuwing te activeren door op
Configuratie vernieuwen
 te klikken.