F Sample Orchestrations

This appendix describes the prerequisite for using sample orchestrations and describes how to use the following sample orchestrations which are intended for testing purposes only:

F.1 Prerequisite

If you have not already done so, download the Sample Orchestrations package. See Section 2.1, "Downloading and Installing Orchestrator Studio" for download instructions.

F.2 Running the Sample Orchestrations

Use the EnterpriseOne Orchestrator Client to run each of the sample orchestrations. Before you can run the sample orchestrations, copy the XML files for each sample to the appropriate folder in the Orchestration directory, as shown in Figure F-1.

Figure F-1 Orchestration Directory Folders and Files

Surrounding text describes Figure F-1 .

After the XML files are in the directory, use the Orchestration Client to enter inputs and test the sample orchestrations. The following sections in this appendix describe the inputs, or name-value pairs, in the sample orchestration XML files. You enter these inputs in the Orchestration Client to test the sample orchestrations. See Chapter 10, "Testing Orchestrations in the EnterpriseOne Orchestrator Client" for instructions on how to test the sample orchestrations.

F.3 Add Conditioned Based Maintenance Alert Sample Orchestration

The "Add Conditioned Based Maintenance Alert" sample orchestration conditionally creates conditioned based alerts based on vibration and temperature readings from a device. The orchestration is defined in the JDE_ORCH_Sample_AddConditionBasedAlert.xml located in the Orchestrations folder. This sample orchestration includes:

  • A cross reference that converts the incoming SensorID into EquipmentNumber and MeasurementLocation defined in the JDE_XREF_Sample_SensorLocation.xml file in the CrossReferences folder.

  • An orchestration step to find the WarningRecipient and AlarmRecipient from the EquipmentNumber, which is also a cross reference defined in JDE_XREF_Sample_AlertNotificationRecipients.xml.

  • A series of rules to determine if an alert is needed and if so, whether it is an alarm or warning. The rules used for this orchestration are defined in the following XML files in the Rules folder:

    • JDE_RULE_Sample_CBMAlarm_1.xml

    • JDE_RULE_Sample_CBMAlarm_2.xml

    • JDE_RULE_Sample_CBMAlarm_3.xml

    • JDE_RULE_Sample_CBMWarning.xml

  • If necessary, the alert is created using either the JDE_SREQ_Sample_AddCBAlert_Alarm.xml or JDE_SREQ_Sample_AddCBAlert_Warning.xml defined in the ServiceRequests folder. These service requests invoke the edit form (W1311B) of P1311 application to create the conditioned based alert.

F.3.1 Sample Input

In the Orchestrator Client, use the following inputs to test the Add Conditioned Based Maintenance Alert orchestration.

     "inputs": [
         {
             "name": "SensorID",
             "value": "1-345285J"
         },
         {
             "name": "Date",
             "value": "1433311200000"
         },
         {
             "name": "Time",
             "value": "12:15:15"
         },
         {
             "name": "VibrationReading",
             "value": "100"
         },    
         {
             "name": "TemperatureReading",
             "value": "350"
         }   
     ]
}

F.4 Update Equipment Location Sample Orchestration

The "Update Equipment Location" sample orchestration creates a new equipment location to store the current latitude and longitude of the asset. The orchestration is defined in the JDE_ORCH_Sample_UpdateEquipmentLocation.xml file located in the Orchestrations folder. This sample orchestration includes:

  • A cross reference orchestration step that converts the incoming DeviceID into EquipmentNumber. This cross reference is defined in the JDE_XREF_Sample_Equipment.xml file in the CrossReferences folder.

  • A final orchestration step that includes the service request JDE_SREQ_Sample_UpdateEquipmentLocation.xml. This service request runs a series of applications using the application stack service to create the equipment location details. The application stack service flow performs the following tasks:

    1. Accesses P1704 application - Work with Equipment Locations.

    2. Invokes the Add button to create a new equipment location header record.

    3. After the record is created, the record is queried back in the Work With Equipment Locations form.

    4. It then accesses the Details form and saves the latitude, longitude, and elevation in this form.

F.4.1 Sample Input

{
    "inputs": [
        {
            "name": "CustomerNumber",
            "value": "4244"
        },
        {
            "name": "SiteNumber",
            "value": "4244"
        },
        {
            "name": "DeviceID",
            "value": "1-345213A"
        },
        {
            "name": "Latitude",
            "value": "39.649844"
        },
        {
            "name": "Longitude",
            "value": "-104.856342"
        },
        {
            "name": "Elevation",
            "value": "5642"
        }        
    ]
}

F.5 Update Meter Reading Sample Orchestration

The "Update Meter Reading" sample orchestration updates meter readings of a piece of equipment. The orchestration is defined in the JDE_ORCH_Sample_UpdateMeterReadings.xml file located in the Orchestrations folder. This sample orchestration includes:

  • An initial white list orchestration step that validates that the incoming EquipmentNumber is allowed to run the orchestration.

  • A final orchestration step that includes the service request JDE_SREQ_Sample_UpdateMeterReadings.xml. This service request runs the Speed Meter Readings application (P12120U) to update the fuel meter reading and the hour meter reading of the passed in equipment number.

F.5.1 Sample Input

{
     "inputs": [
         {
             "name": "EquipmentNumber",
             "value": "34665"
         },
         {
             "name": "NewFuelMeterReading",
             "value": "13.2"
         },
         {
             "name": "NewHourMeterReading",
             "value": "101.7"
         }
     ]
}