Skip to main content
Skip table of contents

Pattern Sequencing

Gimmal Physical offers options to create field values in a new record which are based on a pattern defined by other fields in the item being created. For example, requirements may include a descriptive field that reflects the sequence number of that box for that year in that organization.

Once enabled, the configuration options for the sequence pattern field are accessible via the ‘Configure Sequence Pattern’ option in the Configuration section of the Administration page. Existing values from any required field can be used to render the pattern for the new value. Additionally, a special field called ‘Sequence’ is available as a numeric increment for any unique pattern created by the selected tab fields. Once set, these options are used to create the sequence field value when a tab item (e.g. box or file) is created via UI or import.

  • Once set, a pattern sequence value does not change, even if the underlying values are changed.

  • There can be only one Pattern Sequence field per tab.

  • Advanced configuration is needed to enable the Pattern Sequence tab.

  • The {Sequence} token must be present to populate a value in the sequenced pattern field.

image-20240428-155628.png

To set a new pattern, or revise an existing pattern:

  1. Choose the tab that contains the pattern field you wish to add or update from the ‘Select Tab’ dropdown field (A). This list will only contain tabs that have been configured (via advanced configurations) to have pattern sequence fields.

  2. If a pattern has already been configured for the selected tab, it will appear in the Current Sequence section (B).

  3. Text and fields can be entered in the ‘New Pattern’ box (D) to create a new pattern.

    1. Add text or characters by entering them directly into the ‘New Pattern’ text box. In the example above, ‘BOX-’ will appear on every new value created in this pattern sequence field.

    2. Additional text characters can be entered at any point in the pattern. In the example above, hyphens are used to delineate all field and sequence values.

    3. To enter a field value into the new pattern, double-click on the field in the list box (C). The field name will show up in the new pattern box with curly brackets, (e.g. {Box Year}) indicating the placement of that field value in the pattern for any sequence value created in a new record.

    4. To enter a sequence,

      1. Double-click the ‘Sequence’ option in the list box. This adds the sequence to the pattern.

      2. A field will appear for ‘Sequence Length’. This determines the total length of the sequence value using zeros as padding. For example, a length of 6 and a sequence of 38 will result in a sequence value of 000038.

    5. To include the numeric sequence only (without associated field values), choose the checkbox entitled ‘Sequence Only’. The numeric value will be based on the selected fields, but they will not be shown as part of the field.

  4. Click the ‘Update’ button to save the new pattern. All new records for this tab from this point forward will use the new pattern.

  • When updating an existing pattern, only day forward records will reflect the new pattern.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.