Using Report Builder
With Cogynt's Report Builder application, analysts can export events or collections created in Workstation.
Events
- An advanced (DOC) collection report.
Collections
- A basic (PDF) collection report.
- An advanced (DOC) collection report.
These customizable reports are ideal for distribution outside the Cogynt platform, or for keeping physical records. A variety of layouts are possible, and finished reports can be saved as templates for replication.
Accessing Report Builder
Accessing Report Builder requires the following permissions:
- Workstation: Report Builder: View and Edit
To access Report Builder:
- At the top of Workstation, click the Settings tab.
- In the left side navigation panel, click the Report Builder icon.
Building Report Templates
Templates help simplify creation of future reports, or standardize formats within an organization.
After accessing report builder, the steps to create a Basic (PDF) or Advanced (DOC) template slightly differ.
Creating Basic (PDF) Collection Reports
A PDF can only be exported for collections.
To create a basic (PDF) collection report:
- At the top of the table, click the PDF Exports tab.
- Click + New PDF Export Template.
- Type in a Report Name.
- Provide a description if desired.
- From the Object Type menu, select "Collection Object".
- From the Report Type menu, select "Basic (PDF)".
- Click Ok. The page changes to build mode, which appears as a blank white page.
- Style the report as needed.
- When finished, at the top left of the screen, click the File menu and select Save.
The report is saved as a template that is exportable as a PDF for any collection in Workstation.
Creating Advanced (DOC) Reports
Both events and collections can be exported to an advanced DOC template. Advanced (DOC) collection report templates are created from .docx files edited outside Cogynt and imported into Report Builder.
Prerequisite: Before you can create an Advanced DOC export, you must already have a DOC template created ahead of time. This is done outside of Workstation in a word processing application (e.g., Microsoft Word or Google Docs).
To create an advanced (DOC) collection report template:
- At the top of the table, click the Doc Exports tab.
- Upload your desired
.docxfile into the Uploaded Advanced Doc Templates accordion. - Click + New Doc Export Template.
- Type in a Report Name.
- Provide a description if desired.
- From the Object Type menu, select either "Event Object" or "Collection Object".
- From the Report Type menu, select "Advanced (DOCX)".
- A Template File menu will appear. Select the desired
.docxtemplate that you uploaded from step 2. - Click Ok. The new Report Template option now appears on the Export Data menu on a collection.
You can quickly test and preview a .docx template file before before creating a Report Template by utilizing the Export to DOCX template option found in the Export Data menu of a collection.
Managing Report Templates
Editing Basic (PDF) Templates
PDF templates can be edited and modified as necessary.
To edit a basic (PDF) template:
- Click the PDF Exports tab at the top of the table.
- Click the Edit icon at the end of a row to open a modal to modify the name or description.
- Click the More (⋮) button at the end of the row to access the following functions:
- Modify PDF Template: Access the drag-and-drop editor to modify the actual template.
- Export: Export this template to a .ZIP file that can be imported in other Workstation environments.
- Duplicate: Duplicate this template.
- Delete: Delete this template.
Editing Advanced (DOC) Templates
Advanced (DOC) templates can be modified as needed. There are different procedures to follow depending on whether you wish to make basic edits to the template's name and description or modify the entire template.
Making Basic Edits
To modify a template's name or description:
- At the top of the table, click the Doc Exports tab.
- Click the Edit icon at the end of a row to open a modal to modify the name or description.
- Click the More (⋮) icon to access the Delete option.
Modifying Templates
Template modifications to any Advanced DOC Templates can only be done by uploading a new .docx template file and replacing the old templates and Advanced Reports:
- Download the desired
.docxtemplate file that you wish to modify from the Uploaded Advanced Report Templates accordion. - Modify the template in Microsoft Word or anothe word processing application as desired.
- Delete the old
.docxtemplate from the Uploaded Advanced Report Templates accordion. Any Report Template that previously linked to this.docxfile will automatically be deleted. (You may need to refresh the screen to see it removed.) - Follow the instructions under Creating Advanced (DOC) Reports.
Importing and Exporting Report Templates
Both basic (PDF) and advanced (DOC) collection report templates can be imported and exported as needed.
Exporting Templates
- Basic PDF Template: Access the Export button in the More (⋮) menu.
- Advanced Doc Template: Download the desired template from the Uploaded Advanced Report Templates accordion.
Importing Templates
There are separate import procedures for the two types of templates.
Importing Basic (PDF) Templates
To import a basic PDF template:
- At the top of the table, click the PDF Exports tab.
- Click + New PDF Export Template.
- Click the ▼ icon and select "Import Basic (PDF) Template".
- Select the
.zipfile you wish to import.
Importing Advanced (DOC) Reports
The advanced (DOC) collection report template is based on an uploaded .docx file. Follow the same steps under Creating Advanced (DOC) Reports.