Documentation

Parameter history

Track changes and manage versions for parameter sets and receipt template sets in the InStore Center.

Versioning overview

When you edit a parameter set or template set, the InStore Center creates a new version of that set. Any change, such as updating a date or modifying a parameter or template value, results in a new version. You can view all versions in the Parameter History section of the InStore Center.
Parameter history is most reliable for sets created after the feature became available. Older sets may not reflect changes accurately. InStore tracks changes to template set dates and structure, not the internal content of each template.

View versions

  1. In the InStore Center, select Parameter History.
  2. In the Search Criteria pane, enter the full or partial set name in the Name field.
  3. (Optional) Select the set type: Parameter or Template.
  4. (Optional) Select Start Date and End Date to filter versions by active date range.
  5. Select Search. Results appear in the History pane.
  6. In the Version column, review the version number for each row with the same Name. The currently active version is labeled. If the set is not in effect, the Current label shows which version would be current if the set were active. Deleted sets that match the search criteria are also displayed.

View version details

  1. In the InStore Center, select the Actions icon for a listed version.
  2. In Version Details, review the following information:
    • Version: version number and the Current tag, if applicable.
    • Name: set name.
    • Description: set description.
    • Type: 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.
    • End Date: date the set is scheduled to stop.
    • Date Changed: date this version was created.
    • Changed By: email of the user who created this version.
  3. In the Parameters section, view the list of parameters and their values for this version. If no change is visible, check the start and end dates for differences.

Receipt templates are referred to as parameters in this feature because their underlying structure matches parameters.

Revert to a previous version

The most recently added version of a set is automatically marked as Current. You can override this and activate a different date-conforming version:
  1. In the InStore Center, select Parameter History.
  2. In the Search Criteria pane, enter the full or partial set name in the Name field.
  3. Select Search.
  4. For a listed version, select the Actions icon.
  5. On the details page, select Make Current. The selected version takes effect the next time users log in to the InStore colleague app.
The Current label on a version does not always mean the version is in effect. The version is only in effect if the set is specified for use at the environment, location, or (for parameter sets) workstation level, and the date range includes today's date.

Delete sets

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