KBA-01200: Overview of the ComplianceConfig Rules


The ComplianceConfig (formerly ComplianceNotificationText) rules provide the text for the introduction, notification and action paragraphs on the Compliance Notification document, as well as provide other configurations for compliance tracking.

The ComplianceConfig rule group is found in the Rules Maintenance tool on the System Admin Dashboard. Each rule in the rule group consists of a rule name, a filter value (which can be blank) and a result value.

Filter Values:

Any Compliance type

Most ComplianceConfig rules accept a Compliance type (as defined in the Compliance Type tool and appearing on the filter drop-down) as the filter value.

Result Values:

Any text

Certain ComplianceConfig rules (described below) accept any text as the result value. Note: there is a 196-character limit in the Result Value field. If your text is longer than 196 characters you will need to:

  1. Split your text into smaller segments, each of any length up to 194 characters,
  2. Append $+ to the end of each segment, except the last one.
  3. Add a rule row for each segment. These rules should have names that indicate they are a continuation of the first rule, for example: Introduction, Introduction.01, Introduction.02, etc.

Your text can also include the following placeholders:

  • \n = a new line.
  • $$ComplianceAmount$ = the compliance item amount, if any (see \?…\? below).
  • $$ComplianceCarrier$ = the compliance item carrier, if any (see \?…\? below).
  • $$ComplianceDescription$ =  the compliance item description.
  • $$ComplianceDue$ = the compliance item “required by” date and time.
  • $$ComplianceExpiration$ = the compliance item expiration date, if any (see \?…\? below)
  • $$ComplianceName$ = the compliance type name
  • $$ComplianceRoute$ = the text in the WorkflowRouting rule (below).
  • \?…\? = remove this section if it contains any empty replacements.

Configuration Rules:


[V2020+] Specifies (in the result value) the Role (that has a Responsibility) for the project team member that should be assigned as Responsible Party and originator of generated Compliance Summary documents.  If not specified, Spitfire looks for a role with the AltPM Responsibility.


[V2020+] Specifies (in the result value) the generic day of the month to generate compliance summaries.  The generic month starts on Sunday the 1st.  So, for example: 2 is first Monday, 9 the 2nd Monday,  21 the third Saturday.  The default is 0, which disables the automatic generation. This rule has no effect if the Compliance Summary document type is not Site Active. When the documents are created, the default predefined route is applied.  Hint: You also likely require an email body template that uses the qCompliance Query Alias.

“Any Text” Rules:


Specifies (in the result value) the text used in the Action field (third paragraph) on the Compliance Notification document. (This text is stored in xsfDocRevisionNoteB.) The default is We reserve the right to withhold payment from your firm until all issues are resolved.\nContact our office if you have any questions.


Specifies (in the result value) the text used in the Introduction field (first paragraph) on the Compliance Notification document. (This text is stored in xsfDocRevision.Notes.) The default is We have not yet received the item described below. Timely receipt is critical to the schedule of the project.


Specifies (in the result value) the text used in the Notification field (second paragraph) on the Compliance Notification document. (This text is stored in xsfDocRevision.NoteA.) The default is $$ComplianceName$\n$$ComplianceDescription$\n\?Carrier: $$ComplianceCarrier$\n\?\?In the amount of $$ComplianceAmount$\n\?\?Expiring on: $$ComplianceExpiration$\n\?\?Compliance required by: $$ComplianceDue$\n\?.


Specifies (in the result value) the option(s) for the ATC: ROUTE command used in the default Compliance Notification workflow script, by way of the $$ComplianceRoute$ placeholder (above). The default is AUTO; AUTOACCEPTED FROM FINAL. Any valid ATC: ROUTE option can be indicated. (For more information about the ATC: ROUTE command, see the ATC Scripts and Automatic Workflow technical white paper.)

Additional Comments:

Instead of using these rules, you can create Attachment templates for the Compliance Notification document and have workflow scripts use your templates. Additionally, you can design your notification routing so that an appropriate staff member has the opportunity to refine the generated text before sending the notification on to the vendor. You can design your own notification report for SQL Reporting Services and configure it as the print format for compliance notifications.  See KBA-01088.

KBA-01200; Last updated: June 2, 2021 at 14:42 pm; 
Keywords:  rules, How do I customize the messages generated for Compliance Notifications?