Documentation

Parameter sets

Customize administrative parameters by creating one or more parameter sets.

Administrative parameters are settings that reflect business rules and change how the InStore colleague app behaves.

InStore administrative parameters have values that are assigned to your environment by default. For more information, see the list of administrative parameters.

You can keep the default values or customize them to fit your needs. To customize parameters, create one or more parameter sets. In the environment, assign a parameter set that is used as a fallback by all locations. You can create override sets and assign them to the environment, to locations, or to workstations to supersede the fallback settings, if allowed.

Parameter set assignments are evaluated and updated whenever the InStore colleague app is invoked.

To learn more about the concepts relating to fallback and override parameter sets, see Inheritance.

Create a fallback parameter set

A fallback set can be assigned to the environment. To learn more about fallback sets, see Inheritance.

  1. Access the Parameters menu option.

  2. On the Parameter Sets page, click Add Parameter Set.

  3. On the Edit Parameter Set page, complete this information on the Parameter Set pane:

    • Parameter Set Name: provide a short, recognizable name for the parameter set, which is displayed when you are selecting a set—for example, Environment Fallback.
    • Parameter Set Description: provide an explanation of this set's purpose—for example, Fallback environment-level parameters.
    • Start Date: leave this blank for the fallback parameter set.
    • End Date: leave this blank for the fallback parameter set.

You must add parameters to the set before you can save. To do this:

  1. On the Parameter Values pane, click Add Parameter.
  2. On the Select Parameters page, move selected parameters to the right, then click Add Parameter(s).
  3. On the Parameter Values pane, click the Edit icon to change any parameter value that must change to suit your business practices.
  4. On the Edit Parameter Setting page, select or specify the preferred value for most locations and at most times.
  5. Optionally, enable the Immutable toggle to prevent the value of this parameter from ever being overridden at the location or workstation level.
  6. Scroll up and click Save Changes.
  7. Repeat steps 6-9 until all parameters reflect the company's default policies.
  8. On the Environment page, select this set in the Default Parameter Set field and save.

Create a parameter set override

An override set can be assigned to the environment, a location, or a workstation. To learn more about override sets, see Inheritance.

  1. Access the Parameters menu option.

  2. On the Parameter Sets page, click Add Parameter Set.

  3. On the Edit Parameter Set page, complete this information on the Parameter Set pane:

    • Parameter Set Name: provide a short, recognizable name for the parameter set—for example, "2024-25 Holiday Season Zone 8."

      If this set is part of a series that will replace another specific set, then give it the same name so that the application can evaluate it accurately. For more information, see Inheritance.

    • Parameter Set Description: provide an explanation about why this set is needed—for example, "Sets holiday on-hand cash for all Zone 8 locations." It is possible to create an override set that replaces the fallback set at the environment level and affects all locations.

    • Start Date: optionally, provide a date when you want this set to take effect.

      If this set is part of a series, the set with the later start date takes priority over sets with an earlier start date. For more information, see Inheritance.

    • End Date: optionally, provide a date when you want this set to stop taking effect. When the end date arrives, the application reverts to the fallback set if no other set has a Start Date that has taken effect. If you want the set to apply to a location indefinitely, leave this blank.

    You must add parameters to the set before you can save.

  4. On the Parameter Values pane, click Add Parameter.

  5. On the Select Parameters to Add to the Set page, select only parameter(s) that should not inherit the fallback values, based on whatever special need led you to create this temporary set.

  6. Click Add Parameter(s). The Parameter Values pane lists only the parameters you selected.

  7. Click the Edit icon to change the value for each parameter that is listed.

  8. On the Edit Parameter Setting page, select or specify the new value.

  9. Optionally, enable the Immutable toggle to prevent the value of this parameter from being overridden at a location or workstation.

  10. Scroll up and click Save Changes.

  11. In the settings for the Environment, one or more Locations, or one or more Workstations, select this override set and save.

Edit values in a parameter set

  1. On the Parameter Values pane, click the Edit icon in the Actions column.
  2. On the Edit Parameter Setting page, select or specify the new value.
  3. Enable the Immutable toggle to prevent the value from being overridden at a location or workstation level.
  4. Click Save Changes. To understand whether your change can take effect, see Inheritance.

Deletions

To delete a parameter set, click Delete in the Actions column.

  • Do not delete your global fallback set without having a replacement set up.
  • If you delete one parameter set, all parameter sets with the same name are deleted.