Cogito Style Guide

Below are style guidelines on Cogito report names, SlicerDicer components/sessions, and Cogito columns (RWB and RWBSQL).  

Cogito Report Display Name and Description

• Format: Application Specialty – Report Name (Record ID)

  • • Example: ED Patients – Past 30 days (136206)

• The Template Description should include the Area Council/Working Group that is responsible for governance (see the screenshot for an example).

SlicerDicer Dashboards and Sessions

• The Governance Description or Notes can be entered in the Analytics Catalog. Add as much metadata as possible (see the screenshot for an example).

Cogito Columns

RWSQL Reporting Workbench Column (PAF) Name

• Format: RWSQL_Column_Name

  • • Example: RWSQL_Lab_Turn_Around_Time 

• Display names (Captions) should be kept succinct since long values are cut off in the column details for reports.   

• Include description in PAF record and the report template and ID where column is used.

• The SQL Column Name in the PAF column record needs to match the field value returned from the SQL server query. It’s the developer’s choice regarding how they name their query in the SQL server.  

Regular Reporting Workbench Column (PAF) Name

If copying Epic Released Columns, ensure the new AHS record name is unique beyond simply adding AHS to the title.

• Format: AHS Column Name

  • • Example: AHS Code Blue Event Start Time

• Add the prefix AHS. 

• Add unique record name with unique description and caption.

  • • Add unique description.

    • Add unique caption.

Build Process for Documentation of New Reporting Content

To document new reporting content, the Builder must complete a report overview form, which is then the source of truth and added as a link to CCCIR or SN tickets.