Adding Conditional Document Statuses


How do I add a new document status for my Commitment that will appear in the Status drop-down only when the Commitment is Pending?


You will need to add a new code to the DocStatus code set in the Code Maintenance tool, and also set up a NextDocStatus rule for that code. In addition, you should consider whether the new code should be a “pending” status. If so, you’ll need to add the new code to a DocPending rule.

First, add a code to the DocStatus code set:

Spitfire uses the codes internally. The descriptions of the codes are what appear in the Status drop-down menu.

If the document window is open:
  1. Click the Status field to give it focus.
  2. At the bottom of the document, click the Field Properties icon. (Note: if the icon is not available to you, see the next set of instructions.)
  3. Click on the diamond to open the Code Maintenance tool.
  4. Continue with the section “In either case” below.
If you are accessing the Code Maintenance tool directly:
  1. Go to the Code Maintenance tool on the Manage Dashboard and expand the DocStatus code set.
  2. In the filters, select the desired Doc Type. The current codes for that Doc type will appear.
In either case:
  1. Add a new code and description, for example, W for “Reviewed.”
  2. Remember the code you just added because you will need it in the NextDocStatus rule. Also, make note of the code for the status that will allow the new status (for example, P for Pending).
  3. Save your changes (and, if in the pop-up Manage Codes window, close the window).

Second, add to your NextDocStatus rules:

The NextDocStatus rules determine which choices show up on the drop-down when you are already at a particular status. This allows you to control status flow and to prevent users from selecting inappropriate statuses.

  1. Go to the Rules Maintenance tool on the System Admin Dashboard and expand the NextDocStatus rule group.
  2. Uncheck the Site Only checkbox. Spitfire distributes several NextDocStatus rules.
  3. Select your Doc Type in the filter.  Any NextDocStatus rules already set up for your Doc type will appear.
  4. In the Rule column, look for the code (e.g., P) that will allow the new code.
  5. If it already exists, either
    1. Edit that row or
    2. Copy that row in order to configure it
  6. If it does not exist,
    1. Use the “Add New” icon to add a row then
    2. Enter the older code as the Rule.
  7. Enter all the statuses that should be available, including the new one you just added to the Code Maintenance tool, as the Result Value. Enter codes within single quotes and separated by commas. As an alternative, if you want to include most Doc statuses, use the not:’D‘ format to indicate the Doc statuses that should not be included.  (See KBA-01118 for more information.)  For example, the distributed rule for P of not:’D’ will include any new status codes that you have added to the code set, but not D (for Completed). If that is what you want, you do not need to change anything. Otherwise, you might enter a rule such as this:
  8. Make sure that you include the rule code in the result value!  For example, P must include P in the result value.
  9. Save your changes.
  10. Click the Reload Configuration button on the left side of the System Admin Dashboard.
  11. The next time you open a document of that Doc type with the configured Doc status (Pending in our example), you will see the new status on the drop-down:

Note: A Next Doc Status Matrix Report is available.

(Optional) Third, add the code to a DocPending rule:

If the new status should place or keep the document in a “pending” state, the code will need to be added to the Doc Pending rule group, for example:

Note: your site may be set up to have P (Pending) not be a pending status, reserving M (Committed) as the only pending status (as shown in the example above.  If that is the case, you do not need to add your new code to the DocPending rule group.