Module Revisions Dashboard Tool

The Module Revisions Dashboard tool helps you track all your module changes. You find many similarities between the module Save History and the Module Revisions Dashboard tool. Both display revision history, which includes new or deleted components. The module Save History is useful if you want an overview of a single module's history. The Module Revisions Dashboard tool lets you view the module in greater detail.

One of the most powerful features of the Module Revisions Dashboard tool is the ability to compare any two modules side by side. You can also view all previous component edits and setting changes, as well as star priorities and create notes.

Module Revisions Dashboard Tool Access

This tool requires Creators to have specific role access in Environment Role RBAC (role-based access control) or WSRBAC (Workspaces Role-Based Access Control).

If using Environment Roles (not using WSRBAC):

Creator roles can view all data in this tool.

If using WSRBAC:

Creators can view data related to modules and workflows inside Workspaces where they have access.
If a Creator cannot access specific data, it likely means they do not have access to the Workspace containing the module.

Navigating and Filtering the Module Revisions Dashboard

You’ll access the Module Revisions Dashboard tool from the UDLC Toolkit. Navigate to your environment and click on Resources to access the UDLC Toolkit:

A static image displaying the Resources section of the UDesigner to access the UDLC Toolkit.

Under the Build and Test section of the UDLC Toolkit, locate the Module Revisions tool and click the Use this tool button:

A static image displaying the Module Revisions tool in the UDLC Toolkit.

In the Module Revisions Dashboard, you can view the revisions of all the modules in your environment. By default, the table displays 10 entries. Click the pagination buttons below the table to display more entries.

The dashboard has four filters to help you locate a module. The module ID is required, but you can use any or all other filters, depending on how specific you want to be. After setting your filters, click Apply Filters to view matching results. To clear all fields, click Reset Filters.

Let's take a look at the filters:

Filter	Description
Module ID	The first half of the module ID string value is the title you gave your module. The second half is your unique module Number generated by Unqork. This field is required. Your module ID looks like this in the drop-down menu: `Title - 123456789a123456789e`. You can search the module with the module ID copied from your module’s URL.
Date From	Excludes all revisions with revision dates before the selected date.
Date To	Excludes all revisions with revision dates after the selected date.
Save Type	You can select from one of the following save types: All Revisions: Displays all revisions. Starred: Only displays revisions that are starred. Promoted: Displays any revisions that have a recorded promotion. Restored: Displays revisions where the module was restored. Named: Displays revisions based on the Archive Name given to your revision. Contains Notes: Displays revisions with notes added. All Actions: Retrieves revisions that have any Action Type associated with it. For example, starred, promoted, restored, named, or notes.

Managing Module Revisions

Comparing Module Revisions

Navigating the Module Revisions Diff Dashboard

Exporting and Sharing Chart Data

Managing your Module Revisions

After locating your module and applying filters, use the Details option to add helpful information about your revision. To see a specific record in the Module Revisions table, click Details to the right of any module revision record.

Below is an example of what you might see:

A static image displaying the Revision Dashboard's Details button.

The following sections describe each area:

Attribute	Description
Module Title	The name of your module.
Revision ID	The unique identifier associated with the specific module revision.
Star	Click the star icon to bookmark your revision for easy access.
Archive Name	The name you can give to your revision.
Notes	Any notes you want others to see about your revision.
Save	Saves any changes to the UPDATE Revision section.
Cancel	Cancels any changes you made to the Update Revision section.
Promotions Out	Displays the environment level where a module was promoted.
Promotions In	Displays the environment level from where the module was promoted.

Comparing Module Revisions

You can compare up to two modules on the Module Revisions Dashboard.

To begin a comparison:

Click the + Add Module button.
Select a second module from the drop-down menu. You can also add any other filters you want.
A best practice is to add the older module first and the newer module second. They display left to right, respectively.
Select the first revision for comparison in the Module One Revisions table. The cell highlights blue when selected.
Select the second revision for comparison in the Module Two Revisions table. Again, the cell highlights blue when selected.
Click Compare Revisions.

Here is an example of what you might see:

Navigating the Module Revisions Diff Dashboard

After comparing two modules, navigate to the Module Revisions Diff page to compare common elements side by side.

A static image displaying the module comparision.

These fields display at the top of the Left and Right Module columns:

Attribute	Description
ID	The unique identifier for your module.
Title	The title you gave your module.
path	The unique path of your module.
Revision ID	A unique identification number assigned to your module revision.
User Name	The name of the person who created the module revision.
Last Modified	The last date the module revision was edited.

You also see widgets displaying data for each module:

Attribute	Description
Number of Components	A bar graph displaying how many components are contained in each module.
Added / Deleted / Edited Components	A pie chart displaying how many components were added, deleted, or edited. Added components are blue in color. Edited components are green in color. Deleted components are black in color.

Attribute

Description

Number of Components

A bar graph displaying how many components are contained in each module.

Added / Deleted / Edited Components

A pie chart displaying how many components were added, deleted, or edited.

Added components are blue in color.
Edited components are green in color.
Deleted components are black in color.

Components Section

Below the Left and Right comparison, you can explore your component revisions to see which components changed.

A static image displaying the Components section of the Revisions Dashboard.

The Component section displays the following:

Attribute	Description
Change	Type of change made. Changes may include New Component, Edited Properties, or Deleted Component.
Component ID	The Property ID you gave the component. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API calls.
Component Type	The type of component.
Details	Lets you view details of the changes made to the component. You only see this button for Edit-type changes. The button does not display for New or Deleted-type component changes.

Settings Section

Like the Components section, you can view more information about your settings revisions.

The Settings section displays the following:

Attribute	Description
Change	Type of change made. Changes may include Added, Edited, or Deleted Property.
Setting	The name of the setting.
Old Value	Displays the setting's previous value.
New Value	Displays the new setting value after it was changed.

The final feature of the Module Revisions Dashboard tool is the ability to export and share data from the pie charts. When you expand the Charts tab, you see a hamburger () button at the top right of each chart widget. When you click this button, you GET the following options:

A static image displaying the Number of components in the Revisions Dashboard.

Print chart
Download CSV
Download xls
Download xlsx
Download PDF document
View data table

The following sections describe each option in more detail:

Hamburger Option	Description
Print Chart	The Print Chart option lets you print data from each chart. To print a chart: Click the (Hamburger) button to the right of the chart. Select Print Chart. At the print dialog, set your Destination: Save as PDF. A connected printer device. Set the Layout to Portrait or Landscape. Under More Settings, set the Scale as either Default or Custom. The Custom option lets you adjust the chart size to fit the full page. Click Save/Print. The button updates based on the destination selected earlier.
Download CSV	A CSV file is a plain text file that contains a list of data. To download your chart as a CSV file: Click the (Hamburger) button to the right of the chart. Select Download CSV. Open your Downloads folder to locate the .`csv` file. Your file name is similar to that of the chart name. For example, the Number of Components chart downloads as `number-of-components.csv`.
Download XLS	XLS is a file extension created by Microsoft for use with Microsoft Excel. To download your chart as an XLS file: Click the (Hamburger) button to the right of the chart. Select Download XLS. Open your Downloads folder to locate the `xls` file. Your file name is similar to that of the chart name. For example, the Number of Components chart downloads as `number-of-components.xls`.
Download XLSX	XLSX is a file extension created by Microsoft for use with Microsoft Excel. To download your chart as an XLS file: Click the (Hamburger) button to the right of the chart. Select Download XLS. Open your Downloads folder to locate the `.xlsx` file. Your file name is similar to that of the chart name. For example, the Number of Components chart downloads as `number-of-components.xlsx`.
Download PDF Document	A PDF format prevents modification of your chart file while still allowing sharing and printing. To download your chart as a PDF file: Click the (Hamburger) button to the right of the chart. Select Download PDF Document. Open your Downloads folder to locate the `.pdf` file. Your file name is similar to that of the chart name. For example, the Number of Components chart downloads as `number-of-components.pdf`.
View data table	The data table option lets you view the chart in the form of a table: