Skip to main content

Creating and Managing Flags

Setting up the flags your rules and instructions can use

This guide walks through creating a flag in Main menu → Flagging and managing it afterward by changing its color, renaming, reordering, moving, or deleting it. Each flag belongs to one organization, and becomes available to that organization's Transformations, Rejection Rules, and Instruction Builds.


Prerequisites

  • Create access to Flagging to add flags, Update to rename, recolor, or reorder them, and Delete to remove them.

  • Access to the organization the flag belongs to. You can change only the flags of organizations you work in; admins and managers can change every flag across the Docupath tenant.

  • The Flagging feature enabled for your tenant


Steps

Create a Flag

  1. Navigate to Flagging in the main menu. This page is the master list of all flags you can see in your tenant.

  2. Click + Add New.

  3. Enter the flag name, following the naming rules: no spaces, no commas or semicolons, and a maximum of 24 characters. Names are not case-sensitive, so "HighValue" and "highvalue" are the same name, and an organization cannot have two flags with the same name.

  4. Click the color swatch under Flag color and select a color.

  5. Choose the organization the flag belongs to:

    • If you work in several organizations, select one under Organization. Each sub-organization has its own flags, so another sub-organization can have a flag with the same name.

    • If you work in one organization, the popup shows which organization the flag will belong to, and there is nothing to choose.

  6. Click Add. The flag is added to the end of the master list and becomes available to that organization's Transformations, Rejection Rules, and Instruction Builds.

Reorder Flags

The order of the list sets the priority of each flag, and flags appear in this order across the platform.

Note: Reordering flags requires write access to Flagging.

  1. On the Flagging page, clear the search box if it contains text, and clear any organizations selected in Filters. Flags cannot be reordered while a search or an organization filter is active.

  2. Drag a flag by its handle to its new position. The handles of flags that belong to another organization are grayed out, and those flags keep their places.

  3. Release the flag. The new order is saved automatically.

Edit or Delete a Flag

  1. On the Flagging page, locate the flag in the list. To narrow the list, use Filters to select one or more organizations, and the search box to search by flag name; the two work together. Each flag shows its Organization and usage counters for the Transformations, Rejection Rules, and Instructions that reference it.

    The Flagging page with the Search box and the Filters button, listing flags with their colors, the organization each belongs to, usage counters in the Transformations, Rejections and Instructions columns, a drag handle on each row, and the Action menu
  2. To rename the flag or change its color, open the Actions menu, click Edit, update the name or color, and click Update.

  3. To delete the flag, open the Actions menu, click Delete, and click Yes, Delete to confirm.

  4. If the flag is currently used by any rule or instruction, you can still change its color, but not its name: when you click Edit, the name is grayed out and a message explains why. Delete is grayed out. To rename or delete the flag, remove the references first; click a usage counter to navigate to them.

  5. If the flag belongs to an organization you do not work in, Edit and Delete are grayed out. Hover over them to see whose flag it is.

Move a Flag to Another Organization

Note: Moving a flag to another organization requires Update access to Flagging. Admins and managers can move any flag; users with a custom role can move only the flags of organizations they work in, and only to another organization they work in.

  1. On the Flagging page, open the flag's Actions menu and click Edit.

  2. Under Organization, select the organization the flag should belong to. A hint explains that rules and instructions of the organization the flag leaves have to stop using it first.

  3. Click Update.

If rules or instructions of the organization the flag would leave still use it, the move is refused with an error naming that organization. Point those rules and instructions at another flag first, then move the flag. If the sub-organization you choose already has a flag with the same name, ignoring capitals, the move is refused and an alert tells you why. A flag always belongs to exactly one organization, so moving it takes it away from the organization it leaves.


Expected Outcome

The new flag appears at the end of the master list on the Flagging page with its color and organization, and is available to apply to that organization's documents through Transformations, Rejection Rules, and Instruction Builds. Its pill tags appear in that color across the platform. Reordered, renamed, recolored, moved, or deleted flags update across the system.


Common Issues

Issue

Resolution

Flag name rejected

Remove any spaces, commas, or semicolons, and keep the name within 24 characters

"A flag with this name already exists for this organization"

The organization already has a flag with this name, possibly with different capitals. Use the existing flag, or choose another name

No organization to choose, with the message "There is no organization you can add a flag to"

You do not have access to any organization where flags can be created. Ask an administrator to give you access to one

Cannot edit or delete a flag

The flag is in use by a rule or instruction, so its name and delete are locked. Remove the references first; click a usage counter to find them. If Edit and Delete are grayed out with a tooltip, the flag belongs to an organization you do not work in

Cannot drag a flag

The flag belongs to another organization, so its handle is grayed out, or a search or an organization filter in Filters is active. Clear the search box and the organizations selected in Filters

Moving a flag is refused

Rules or instructions of the organization the flag would leave still use it. Point them at another flag, then try the move again

Moving a flag is refused with an alert about a duplicate name

The sub-organization you chose already has a flag with the same name, possibly with different capitals. Rename one of the two flags, or use the flag that already exists in that sub-organization

Flagging page not visible, or no option to add

The Flagging feature may be disabled (the page is hidden), or your role may not hold the level a control needs, which grays that control out with the tooltip "You do not have the required permissions to do this action". Adding a flag requires Create on Flagging, renaming one requires Update, and deleting one requires Delete


Notes

  • Flag names are not case-sensitive, so "HighValue" and "highvalue" are the same name and one sub-organization cannot have both. Several sub-organizations can each have their own flag with the same name.

  • A flag must exist in this master list before an organization's rule or instruction can use it; saves are blocked if they name a flag the organization does not have. Global and country rules and instructions are different: you can add a flag to them without first adding it here.

  • A flag that is in use can still have its color changed, but it cannot be renamed or deleted until its references are removed.

  • Deleting a flag does not remove it from documents that already carry it. Those documents show it without color, after their other flags, until they are reprocessed.

  • If you add a flag with the same name as a deleted flag of the same organization, the deleted flag is restored with the name and color you entered, at the end of the list.

  • Flags created before colors were introduced appear with black text on a light gray background until a color is selected.

  • The flag order applies to all users in the tenant.

  • Create, rename, color change, reorder, move, and delete actions are recorded in the Settings activity log.

Did this answer your question?