XML File Format for Planning Mode

In a planning Mode, Manager checks that some values and Ids are available within the .XML configuration file:

• The 'siteName' value is one of the expected values.

• The 'mainStatus' value is one of the expected values.

• The 'startDate' and the 'endDate' of the mission. The Manager will display only the mission when the current date of the Manager is included between these dates, with a tolerance defined by the 'time of transition' setting for the 'endDate'. Missions in the past are automatically removed.

• The 'missionId' is available.

• The 'deviceId' or the 'otherDeviceId(s)' are available. 

Reference .XML file

By default, the Manager can parse the following xml template with the default settings (in red):

<?xml version="1.0" encoding="UTF-8"?>
<MissionStandardXML timestamp="2022-01-24T15:20:31.742" id="template">
      <Origin>
          <siteName>MyMainSite</siteName><!-- SiteName: Mandatory value ></-->
      </Origin>
      <Titles>
          <Title>
               <mainStatus>valid</mainStatus><!-- MyMissionStatus: (Mandatory value) ></-->
               <name>MyMissionName</name><!-- MyMissionName (Mandatory)></-->
               <assets>
                        <StringAssetInfo><!-- Mandatory -->
                                <attrName>Mission ID</attrName>
                                <attrTagName>missionId</attrTagName><!-- Mandatory tag value -->
                                <value>MyMissionId</value><!-- MyMissionId (Mandatory)></-->
                    </StringAssetInfo>
                    <TimeDateAssetInfo><!-- Mandatory -->
                               <attrName>Event Start Date</attrName>
                               <attrTagName>startDate</attrTagName><!-- Mandatory tag value -->
                               <value>2022-05-11T22:00:00.000</value><!-- MyStartDate (Mandatory)></-->
                    </TimeDateAssetInfo>
                    <TimeDateAssetInfo><!-- Mandatory -->
                          <attrName>Event End Date</attrName>
                          <attrTagName>endDate</attrTagName><!-- Mandatory tag value -->
                          <value>2022-09-30T22:00:00.000</value><!-- MyEndDate -->
                    </TimeDateAssetInfo>
                          <StringAssetInfo><!-- Mandatory -->
                          <attrName>Device ID</attrName>
                          <attrTagName>deviceId</attrTagName><!-- Mandatory tag value -->
                          <value>MyDeviceId</value><!-- MyDeviceId -->
                   </StringAssetInfo>
                   <TextAssetInfo><!-- Optional but displayed on device -->
                          <attrName>Description</attrName>
                          <attrTagName>description</attrTagName><!-- Mandatory tag value -->
                          <value>My Mission Description</value><!-- My Mission Description -->
                  </TextAssetInfo>
                   <TextAssetInfo><!-- Optional -->
                          <attrName>Location</attrName>
                          <attrTagName>location</attrTagName><!-- Mandatory tag value -->
                          <value>MyLocation</value><!-- MyLocation -->
                   </TextAssetInfo>
                   <StringAssetInfo><!-- Optional -->
                          <attrName>Entity</attrName>
                          <attrTagName>entity</attrTagName><!-- Mandatory tag value -->
                          <value>MyEntity</value><!-- MyEntity -->
                   </StringAssetInfo>
             </assets>
        </Title>
</Titles>
</MissionStandardXML>

To get great flexibility, the planning settings are included in a planningSettings.conf file. 

This is a .JSON file that includes mandatory settings to run properly the Story Centric Workflow in planning mode:

• siteName_XPath: XPath expression to retrieve 'siteName' from the XML file.

• siteName: array of valid site names the Manager checks. This array should include at least 1 element.

• mainStatus_XPath: XPath expression to extract 'mainStatus' from the XML file.

• mainStatus: array of valid site name the Manager checks. This array should include at least 1 element.

• missionName_XPath: XPath expression to extract 'missionName' from the XML file.

• missionId_XPath: XPath expression to extract 'missionId' from the XML file.

• missionStart_XPath: XPath expression to extract the start date of the mission from the XML file.

• missionEnd_XPath: XPath expression to extract the end date of the mission from the XML file.

• device_id_XPath: XPath expression to extract the main targeted device identifier from the XML file.

• device_id_others_XPath: XPath expression to extract the secondary transmitters.

• maxOtherDevices: Maximum number of device identifier the Manager attempts to get using the device_id_others_XPath expression.

You can customize the .JSON configuration file:

1. Click on admin, and on REST API doc. The Manager RESTful API interface opens.

2. Under the 1_system menu, you can use the GET /metadata/planningSettings and POST /metadata/planningSettings functions to adapt the configuration .JSON file.