Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

How do I use field add-on IDs?

Use Addon IDs on Shift Note fields to fill in roster details such as site, staff names, times and hours automatically, plus image preview options.

Key Points

  • Addon IDs are special field identifiers that automatically transfer information from a rostered shift into a Shift Note. When a Shift Note is created from a rostered shift, any field with the matching Addon ID is filled in with the roster information.

  • This removes the need for staff to re-enter common shift details, improves data accuracy and helps standardise documentation.

  • To use one, enter the Addon ID in the field's Addon ID property on your Shift Note form, then save and publish the form.

  • Roster Addon IDs cover details such as the shift ID, site, positions, employees, start and end dates and times, and shift duration. Image preview Addon IDs show uploaded images with a round or square preview.

  • Only use Addon IDs on fields that should be filled from roster data, and choose a field type that suits the data.

Available Roster Addon IDs

The following Addon IDs can be assigned to fields within a Shift Note form:

  • roster-shift-id: The unique ID of the rostered shift.
  • roster-shift-site-id: The unique ID of the site where the shift is scheduled.
  • roster-shift-site-name: The name of the scheduled site.
  • roster-shift-free-busy: Indicates the shift availability or status.
  • roster-shift-position-uids: The unique IDs of the rostered positions.
  • roster-shift-position-names: The names of the rostered positions.
  • roster-shift-employee-uids: The unique IDs of the assigned employees.
  • roster-shift-employee-names: The names of the assigned employees.
  • roster-shift-dateid: The internal date identifier for the shift.
  • roster-shift-start: The full shift start date and time.
  • roster-shift-start-date: The shift start date only.
  • roster-shift-start-time: The shift start time only.
  • roster-shift-end: The full shift end date and time.
  • roster-shift-end-date: The shift end date only.
  • roster-shift-end-time: The shift end time only.
  • roster-shift-hours: The total hours worked.
  • roster-shift-minutes: The total minutes worked.
  • roster-shift-total-time: The total duration of the shift.
  • roster-shift-total-time-formatted: The formatted shift duration (e.g. 7h 30m).

Image Preview Addon IDs

The following Addon IDs can be used to automatically display image previews:

  • image-preview-round: Displays uploaded images with a circular preview.
  • image-preview-square: Displays uploaded images with a square preview.

How to Use

  1. Create or edit a field within your Shift Note form.
  2. Enter the required Addon ID into the field's Addon ID property.
  3. Save and publish the form.
  4. When a Shift Note is created from a rostered shift, FlowLogic will automatically populate the field with the matching roster information.

Example

If a text field has the Addon ID roster-shift-site-name, it will automatically display the name of the site from the rostered shift, eliminating the need for staff to enter it manually.

Similarly, assigning roster-shift-employee-names to a field will automatically populate it with the names of the employees assigned to that shift.

Best Practice

Only use Addon IDs on fields that should be automatically populated from roster data. Ensure the field type is appropriate for the data being transferred (for example, using a text field for names or a date/time field where applicable). This helps maintain accurate and consistent shift documentation while reducing manual data entry.

Related articles