Open topic with navigation

Data Feed Out

Data feed out allows XECUTE data to be published to the RPMGlobal EPF enterprise system for integration with other data systems. Examples include activity area export, closing balances of stockpiles and dumps and Weekly schedule data.

Each type of data feed out (Category) has a subset of XECUTE reporting fields that can be used to publish data to EPF. The available XECUTE fields can be previewed in the XECUTE client reporting tab and are listed in the XECUTE field reference topic.

Before you can publish data from a particular data feed out type, you must create a data source and dataset definition (DSD) in EPF. The DSD fields you create must have the correct data types to hold the XECUTE data.

The DSD fields shown at each data feed out configuration screen are based on the DSD selected in the Definition list. The names of the DSD fields can take any value but are restricted to letter, number or underscore characters. Spaces are not allowed. XECUTE will perform data type validation when you map XECUTE fields to the DSD field. It is recommended that the DSD field names align closely to the XECUTE field names to facilitate mapping.

Prerequisites

The XECUTE data, when uploaded to EPF, is stored in a pre-defined location and data source. The locations and data sources must be set up using Integration Management Studio (IMS). See the IMS help for more information.

The XECUTE data fields are mapped to an EPF DSD. The DSD comprises a set of fields with specific data types and field types that must be set up using IMS. All data sent from XECUTE will be grouped on any key type EPF definition field.

Only non-editable dataset definition types are supported by XECUTE. In IMS, the Editable option of a DSD should be set to No (the default).

Categories

Data Feed out types include;

• Schedule Results - Schedule data from the last successfully run schedule.
• Design Request - Activity area attributes including spatial data (excludes schedule data), legacy feature to publish activity area data.
• Activity Areas - Activity area attributes including spatial data (excludes schedule data) .
• Storage Locations - The closing balances and qualities (per period) of Stockpiles, Staged Stockpiles and Dumps.

Setup procedure

1. Click the Data Feed Out icon .
2. To add a new data feed out, click  , then enter a unique Name for the data feed.

3. Select whether the Data Feed Is activeby selecting Yes. An inactive data feed will not send data to XECUTE.

4. Select Category for the type of trigger that will push data to EPF (Schedule Results, Design Request, Activity Areas or Storage Locations).

5. Select a Data Source (location) and Data Set Definition (field layout) to send the data to.

6. For Data Feed Out containing spatial data fields, set the Radius to apply.

7. Map the relevant XECUTE field (Value Expression column) to each EPF data set definition field (Definition Field column).

   All Definition fields must be mapped to an XECUTE field (this is an EPF requirement).

   Click the Value Expression cell then click the fx icon to open the expression builder. The available XECUTE fields are grouped under tabs and can be used in the expression directly or modified to return the desired value.

   

   XECUTE data is grouped by Data Set Definition key type fields. Numeric XECUTE data is typically mapped to numeric Data Set Definition field type fields and can be aggregated into these groups by setting the relevant Aggregation Type and applicable Weighting Expression in the Mappings grid.

8. [OPTION] Metadata are custom fields that provide additional information about the data in the Data Feed Out. They act like tags to allow management and grouping of datasets as data is forwarded to other systems from EPF. If the dataset definition contains metadata fields, they will be listed under the collapsible Metadata section. Values for the metadata are set in the Value Expression column. The value type must match the expected return type of either text, numeric or date. System fields such as UserName and SiteName are available in the Metadata tab in the expression builder. Metadata differs from published data in that only one set of metadata is recorded for each table of dataset rows.

   

9. For numeric data, set the number of decimals for the field in the Decimals column.

10. Set the Schedule Window to Publish options and add any filters to limit the data published to EPF.

11. Click Save. The data feed is now available to publish to EPF when any of the triggers are fired. See Data Feed Out triggers.

Schedule window to publish

A schedule window can be specified to filter the task data used by the report for Schedule Results and Closing Balance type data feed out.

The window can be either:

• All Time (default).
• Start Point (schedule start time) plus an offset (Periods, Days or Hours), for a duration of (Periods, Days or Hours).

The filter limits the source schedule data for the published plan to only include portions of tasks that fall within the schedule window.

Note, when the option is to offset the schedule start by a number of days:

• the schedule start will be the period either on or after but nearest to the offset start time.
• if the duration is set as a number of days, tasks that are scheduled for the last period starting on, or prior to, the nearest duration finish time will be included. This will be the case even if the period finishes after the schedule offset finish time.

Filter expression

The Filter Editor allows fine grain control of which items are to be included in the Data Feed Out. Any report field can be used in the filter expression.

Data publish actions in XECUTE

Once the Data Feed Out is correctly configured and saved, you can trigger the publish the data by right-clicking the scene in XECUTE Client and selecting Publish from the radial menu.

Or in the Gantt grid, right-click to open the context menu and click Publish