Configured Tags Report

Configured Tags Reports are a report type that runs on configuration databases. The validation step reports immediate status from the time the report is created. Only the report results are stored for comparison. Each report is an individual 'snapshot'.

Additional features include:

Collection of All Tags that the Given Module Exposes - The Providers will expose the function to provide translation from path to point name
Tag Collection via Static Collection from Configuration Databases - which are immediately validated.
Automatic Report Storage Upon Generation - Report results are stored in the same database as Data Source Usage data, but within different tables
Can Used for Asset Catalog, BACnet Data - Every item type is in its own table. BACnet builds upon an already prepared interface (aggregates Runtime and database information)

The Configured Tag Report Wizard is part of ProjectWorX in the Workbench. See 'About ProjectWorX' for background information on ProjectWorX and Configured Tags Reports.

The tool itself can be found in the Tools section of the Home ribbon in the Workbench, as shown below.

Configured Tags Report Button in the Tools Section of the Home Ribbon in the Workbench

To Open the Configured Tags Report Wizard:

Click on the Configured Tags Report button in the Tools section of the Home ribbon in the Workbench.

Configured Tags Report Button

This opens the first screen of the Configured Tags Report Wizard window, as shown below. Upon first use, you can read through the description of the wizard. Click Next to continue.

Configured Tags Report Wizard First Screen

This opens the General Settings/Validation Settings/Layout Custom Values section of the Configured Tags Report Wizard, as shown below.

General Settings/Validation Settings/Layout Custom Values Section of the Configured Tag Report Wizard

General Settings

Task Description - Enter a description for this immediate task in the text entry field.
Select Report Format - You can choose from CSV, Excel or PDF formats.
Select Report Template - Use the pulldown menu to select from existing report templates (including [AssetWorX] All Properties, [AssetWorX] Dynamic Tags, [AssetWorX] Expressions, [AssetWorX] Polled Dynamic Tags, [AssetWorX] Static Values and [BACnet] All Objects). Or, you can click on the ellipsis button [...] to open a file browser to navigate to any other existing report template (.rdl) file.

Validation Settings

Validate collected tags - Clicking this checkbox activates the remainder of the settings, including:

Max concurrent points - Enter the maximum number of concurrent points in the batch to be validated in the text entry field directly or use the up/down arrows.
Timeout - Enter your desired duration for timeout (in seconds) in the text entry field directly or use the up/down arrows.

Please set the custom values for the layout

In this section, you can set custom values for each listed component in the layout (e.g. Project Name, Project Version, Author, etc.).

Click Next when you are ready to proceed.

The Configured Tags Report Wizard then progresses to the next properties to set.

'Please select the configurations whose tags will be collected' Section of the Configured Tags Report Window

Place a checkmark to the left of the configurations whose tags will be collected for use in the Collected Tags Report.

When you have completed your settings, click Finish to proceed.

The Configured Tags Report Wizard then proceeds to create your requested report. Reports are generated asynchronously on the server. You will see the report's status appear in the Recent Tasks panel on the right side of the Workbench, as highlighted below.

Report Status Listed in the Recent Tasks Panel in the Workbench

The Recent Tasks panel allows you to perform multiple actions related to the generated reports.

You can right-click on the completed Configured Tags Report task in the Recent Tasks panel for additional options, including Download PDF File, Download and Open PDF File, Open PDF File, Download Excel, Download and Open Excel, Download CSV, Download and Open CSV, Show task explorer, View Log, Download Log, Cancel, Retry and Delete Task(s). [Note: The same right-click options are available when viewing the task within the Task Explorer.]

Right-Click Options for Configured Tag Report Task in the Recent Tasks Panel

Click Download PDF File to download a PDF version of the Configured Tags Report. You can also Download and Open the PDF File or Open the PDF file directly. The image below shows a PDF opened within the Workbench. Other PDF readers will allow for different/additional options.

Report PDF Opened Within the Workbench (in a Popped Out Window)

Click Download Excel to download an Excel version of the Configured Tags Report. Once selected, you'll have the option of opening the Excel file directly, saving it in the default location, or saving it with your desired file name in your desired location.

Configured Tags Report Opened in Excel

Click Task Explorer to see the status and additional information regarding the selected Configured Tags Report task, as shown below. Your task may be listed in either the Queued tab (if still running) or Completed tab.

Task Explorer Containing Queued Configured Tag Report Task

Click View Log to see the log for the Configured Tag task (whether running or completed), as shown below. You also have the option of saving the log to the clipboard or as a PDF document.

Log of the Project Documentation Task

Runtime Collection

Note that it is possible to pause the report generation by clicking on the Runtime Collection button in the Project Reporting section of the ProjectWorX ribbon, as shown below.

Runtime Collection Button in Project Reporting Section of the ProjectWorX Ribbon

Runtime Collection Button in Stop and Start Modes

Generating a report may require additional time for larger configurations.

The task runs in the background so you can continue to work within the Workbench during report generation.