Documentation

Parameter history

Learn about change tracking and versioning for parameter sets and receipt template sets.

History and versioning

Editing an existing parameter set or template set, creates a new version of that set. For example, changing a date or the value of one parameter or template in the set will generate a new version. Versions are displayed in the Parameter History menu option in the InStore Center.

The Parameter history feature works best with parameter and template sets created after the feature was introduced. Results may differ for pre-existing sets. InStore tracks changes in the dates or composition of template sets. Content changes within an individual template are not tracked by the InStore Center.

View versions of a parameter set or template set

  1. In the InStore Center, select Parameter History on the left menu.
  2. In the Search Criteria pane, complete the Name field with the full or partial set name.
  3. Optional. Select whether the set type is Parameter or Template.
  4. Optional. Select Start Date and End Date to see only versions that were active for the selected time period.
  5. Select Search. The results are displayed in the History pane.
  6. In the Version column, view the version number for each row that shares the Name. The currently active version is labeled. If the set is not in effect due to dates or because it hasn't been selected for use, then the Current label indicates which version would be current if the set were active. Deleted sets that meet the search criteria are also displayed.

View details of a version

  1. For a listed version, in the InStore Center, select the Actions icon.
  2. In the Version Details, view the following:
  • Version: current version number and Current tag, if appropriate.
  • Name: set name.
  • Description: set description.
  • Type: type of set, either parameter or template.
  • Temporary: true or false, depending on whether the set has an end date.
  • Start Date: date the set is scheduled to take effect, if the set is selected.
  • End Date: date the set is scheduled to stop, if the set was selected.
  • Date Changed: date this version was created.
  • Changed By: email of the user who created this version.
  1. In the Parameters section, you can view the list of parameters and their values that were saved in this version. If no change is apparent, check the start and end dates for changes.

Receipt templates are referred to as parameters in this feature because their underlying structure is the same as parameters.

Revert to a previous version

The most recently added version of a set is automatically marked as Current. You can override the current selection and activate a different date-conforming version. To do this, complete the following steps:
  1. In the InStore Center, select Parameter History on the left menu.
  2. In the Search Criteria pane, complete the Name field with the full or partial set name.
  3. Select Search.
  4. For a listed version, select the Actions icon.
  5. On the resulting page, select Make Current. The newly current set takes effect the next time users log into the colleague app.
The Current label on a version does not mean that the version is currently in effect. It indicates the version that is used or will be used if the set is in effect or takes effect. To be in effect, the current version must belong to a set that has been specified for use at the environment or location level, or for parameter sets, at a workstation level, and whose date range conforms with today's date.

Deleting a set

You can delete all versions of a parameter set or template set but you cannot delete a single version only. For more information, see Delete parameters or sets or Delete templates or sets.
After you delete a set, its versions appear in history search results with a status of Deleted.