How To: Reference Data Versioning

Overview

This knowledge base article provides the necessary information for the Reference Data Versioning feature in Pitram when managing reference data such as people, location, and equipment.

Reference Data

Whether changes are made to a reference data group i.e. people, location, equipment or the simply checking out/in reference data, a new reference data major version is associated with the publishing which is used by the Pitram System. 

Pitram modules such as Data Acquisition, Event Editor, and the Pitram Portal System all record the latest reference data version.  The reference data version is a collection of all the available reference data tokens i.e. people, location, equipment etc. that is currently available for data capture.

Reference Data Versioning Configuration

Reference data versioning was introduced to better manage data as it relates to shift processing within the Pitram Reporting database. When a token has been removed from reference data and the action of publishing has been completed, the new reference data version is now available, the token which was removed is no longer available in this version.

For example, the haul truck token TRZ01 is removed from the equipment reference data group, publishing is actioned, and the new reference data version is now 8547.  TRZ01 is no longer available for any data capture from version 8547 onwards.

Historically, TRZ01 and all related data associated with it is still available in the Pitram Reporting database and when preforming reprocessing of historical shifts, to maintain the data availability reference data versioning has been introduced.

When performing shift reprocessing, there are three configurable options.  The following table provides detailed information along with how to configure it.

Reference Data Versioning	Description
Historic	If Historic is selected, by default, the last reference data version used within that particular shift is used
Current	If Current is selected, by default, the current reference data version is used
Prompt for version	If Prompt for version is selected, you will be prompted to select either Historic or Current

The setting can be configured in Pitram Portal by navigating to the Pitram Service module, select "Configuration" and select the required option.

How to apply Reference Data Versioning to Shift Reprocessing

In the previous example, TRZ01 has been decommissioned and no longer onsite.  TRZ01 is removed from the Equipment reference data group, checked-in and published.  In the event a historical shift needs to be updated and re-processed so it's up to date, when selecting the shift and presented with the option of which reference data version is to be applied than historical should be used in this instance.  It the "Current" reference data version was to be applied than events related to TRZ01 would be removed from the reporting database.

Want to learn more?

Online Help Manuals - Click here for the latest version

Learning Management System - Click here to login or here to request access