KBA-01445: Overview of the ReportConfig Rules

Overview:

The ReportConfig rules allow customization of SQL Server Reporting Services (SSRS) RDL paths and provides default report parameters.

The ReportConfig rule group is found in the Rules Maintenance tool on the System Admin Dashboard. Each rule in the group consists of a rule name and result value.


Filter Value:

Any Doc type

The ReportConfig rules accept any Doc type (as defined in the Doc Types tool and appearing on the filter drop-down) as the result value.


Result Value:

Any path and report parameters

The ReportConfig reuls accept a freeform string with the path to the report in SSRS as the result value. The result value can include report parameters. Use %20 for spaces and %25 for percent signs (%).

Each report parameter should begin with an ampersand (&) followed by the report parameter name defined in the report, followed by an equal sign (=) and value. The value can include a placeholder. The report viewer will lock down any parameters passed into the report in this way. The user will not see or be able to change the value passed. Common placeholders are:

  • $$DocNo$$ = the document number.
  • $$Duration$$ = the Duration field of the document.
  • $$FDate$$ = the From date filter on the Site Condition’s history window.
  • $$PK$$ = the document key (GUID).
  • $$Project$$ = the Project ID.
  • $$RejectCode$$ = the Reject/Reason code of the document.
  • $$SourceContact$$ = the Source Contact.
  • $$TDate$$ = the To date filter on the Site Condition’s history window.

Rules:

CILOG

Specifies (in the result value) the report point for the CI Log. The default is _Library/Change Item Register and automatically adds &pProject=$$Project$$.

CIPAYLOG

Specifies (in the result value) the report point for the CI Payment Log. The default is _Library/Change Item Payment Log Inquiry and automatically adds &pProject=$$Project$$&pDocMasterKey=$$PK$$.

DocPrintMenuText

Specifies (in the result value) the text that should appear on the Document Options menu for the document’s report, as defined through the Report rule (below). The default is Report.

KBA01445_01

EquipPrint

Specifies (in the result value) the report point for the Equipment report. The default is _Library/Equipment%20Profitability and automatically adds &pProject=$$Project$$.

MenuList

Specifies (in the result value) the reports to be added to the Document Options drop-down menu in the form of ID1=menulabel1; ID2=menulabel2; ID3=menulabel3, etc. Each ID must also correspond and be defined in its own rule (such as CILOG, CIPAYLOG, SCPAYHIST, etc.) The system automatically adds &pProject=$$Project$$&pDocMasterKey=$$PK$$. Note: We recommend using ZC as a prefix for your custom report definitions, for example: MenuList  =  SCPAYHIST=Payment History; ZCYourReport=Custom Report.

KBA01445_02

NextDocStatusMatrix

Specifies (in the result value) the report point for the Next Doc Status Matrix report. The default is _Library%2fNext+Doc+Status+Matrix and automatically adds &pDocTypeKey=$$DTK$$.

Report

Specifies (in the result value) the path and the report name in SQL Server Reporting Services (SSRS) to customize the default document print format for a Doc type (and what the icon on the Document Options drop-down menu will show). The output of this report will be included in routed content. If this is not your intent, see the MenuList rule, or add an XmitItems rule with 0 as the result value to override and disable routed content. The rule automatically adds &pProject=$$Project$$&pDocno=$$Docno$$ as parameters to your report. See also KBA-01088.

SCCOMPLOG

Specifies (in the result value) the report point for the Compliance log. The default is _Library/Compliance%20Exception%20Log and automatically adds &pProject=$$Project$$&pSubcontractor=$$SourceContact$$.

SCOLOG

Specifies (in the result value) the report point for the CCO Log. The default is _Library/CCO%20Log and automatically adds &pProject=$$Project$$&pSubcontract=$$Docno$$&pVendor=%25&GroupBy=0.

SCPAYHIST

Specifies (in the result value) the report point for the Payment History report. The default is _Library/Commitment%20Payment%20Detail and automatically adds &pProject=$$Project$$&pCommitment=$$Docno$$&pVendor=%25.

SCPAYREQ

Specifies (in the result value) the report point for the Payment Request report. The default is _Library/Pay%20Request%20Log and automatically adds &pProject=$$Project$$&pSubcontract=$$Docno$$&pVendor=%25&GroupBy=0.

SITECOND

Specifies (in the result value) the report point for the Site Conditions log. The default is _Library%2fSite+Conditions+Log and automatically adds &pProject=$$Project$$&pFDate=$$FDate$$&pTDate=$$TDate$$.

SUBMITLOG

Specifies (in the result value) the report point for the Submittal Item log. The default is SUBMITLOG – Defaults to _Library/Submittal%20Item%20Log and automatically adds &pProject=$$Project$$.

USERLOG

Specifies (in the result value) the report point for the User log. The default is _Library%2fLogin%20History and automatically adds &pUserKey=$$PK$$&pFDate=$$FDate$$&pTDate=$$TDate$$.

XmitItems

Specifies (in the result value) an alternate report to be used when a document is routed via e-mail or fax. The result value accepts the path and the report name in SQL Server Reporting Services (SSRS). This rule overrides the Report rule (above). See also KBA-01088.

ZCcustom

Specifies (in the result value) the report point for your custom report. There is no default, but automatically adds &pProject=$$Project$$&pDocMasterKey=$$PK$$.


Additional Comments:

For more information, see the Focus on System Administration guide.


KBA-01445; Last updated: September 19, 2017 at 9:00 am;