Skip to main content
Learning
Managing Reporting Connectors

To manage reporting connectors, go to the Manage > Reporting Connectors.

A Reporting Connector connects an approval to Power BI or Excel. You need this connector to create a Power BI Dashboard, generate a Report, or extract data into Excel.

Creating reporting connectors

Click the "add" button in the toolbar    More Options

image

This will open up the New Reporting Connector dialog.

image

Search for your Approval. Add a Name and an optional Description, then click Save. You should see your new connector in the connectors table. Click the connector to view its details.

image

The connector is disabled by default. To enable it, click the "more" button next to connector Name    More Options    and select the Enable option from the menu.

Below are the columns in the Reporting Connectors table:

ColumnDescription
NameThe connector's name.
StatusIndicates if the connector is Enabled or Disabled.
ApprovalThe approval linked to this connector.
CreatedThe date and time the connector was created.

When you select a connector, the Details panel shows the following properties:

Property                Description
Data URLUse this URL to connect Power BI and Excel to the report data.
Columns URLUse this URL to connect Power BI and Excel to the column labels.
Values URLUse this URL to connect Power BI and Excel to the value substitutions.
Authorization KeyThis key protects your report data from unauthorized access.
tip

You can easily customize the view using the toolbar, including selecting which columns to display and adjusting row spacing.

tip

You can sort any column to organize the connectors as you prefer. You can also rearrange the columns by dragging them left or right.

Setting column mappings

To access Column Mappings, click the "more" button next to connector Name    More Options    and select the Column Mappings option from the menu. You will then see the following panel:

image

The report data is organized into groups. Expand each group to see its data items. If a data item has a Label, it will show up in the connector data. To add, edit or delete a Label, double-click the edit (pencil) icon.

tip

Using the toolbar you can adjust row spacing. You can also rearrange the columns by dragging them left or right.

Here are the columns in the Column Mappings panel:

ColumnDescription
GroupA name that organizes the data in the approval.
DatatypeThe type of each data item.
LabelThe name given to the data item.
DescriptionA brief explanation of the data item.
IdAn alphanumeric identifier for user-defined data.

Setting value mappings

To access Value Mappings, click the "more" button next to connector Name    More Options    and select the Value Mappings option from the menu. You will then see the following panel:

image

To add, edit or delete a Value, double-click the edit (pencil) icon.

tip

Using the toolbar you can adjust row spacing. You can also rearrange the columns by dragging them left or right and sort any column to organize the items as you prefer.

Here are the columns in the Value Mappings panel:

ColumnDescription
Step TypeIndicates whether the step is a Trigger or an End.
Step IdA unique alphanumeric code for the step.
Step NameThe name given to the step in the approval.
Display ValueThe name that will appear in reports or data extracts.

Standard reporting data

This section lists all data available for every approval run. These data do not depend on what you add to steps in your approval. They are the standard data provided for each run.

Run data

The standard data associated with the approval run.

Property                                      DescriptionDatatype
RunIdThe unique id of the runText
RunNumberThe sequential number of the runNumber
AutomationIdThe unique id of the automationText
AutomationNameThe name of the automationText
AutomationVersionThe version number of the automationNumber
AutomationPatchThe patch number of the automationNumber
StartedOnThe date and time the run startedDatetime
StartedBy > Source > IdThe id of the source that triggered the runText
StartedBy > Source > TypeThe type of the source that triggered the runText
StartedBy > Person > IdThe id of the person that triggered the runText
StartedBy > Person > NameThe name of the source that triggered the runText
StatusReflects the status of the run, one of Running, Completed, Terminated, Errored or FailedText
EndedOnThe date and time the run endedDatetime
EndStep > IdThe id of the end step that was reachedText
EndStep > ColourThe colour of the end stepText
EndStep > ScoreThe score of the end stepNumber

Trigger data

The standard data associated with the trigger that starts the approval run.

Property                    DescriptionDatatype
IdThe unique id of the triggerText
SubmittedOnThe date and time the trigger was submittedDatetime
SubmittedBy > Source > IdThe id of the source from where the trigger was submittedText
SubmittedBy > Source > TypeThe type of the source from where the trigger was submittedText
SubmittedBy > Person > IdThe id of the person who submitted the triggerText
SubmittedBy > Person > NameThe name of the person who submitted the triggerText

Activity data

The standard data available for each activity in the approval run.

Property                                                DescriptionDatatype
CreatedOnThe datetime when the activity was createdDatetime
OfferOnThe datetime when the activity became ready to startDatetime
DueOnThe datetime when the activity is expected to completeDatetime
ReportDueThe number of minutes before DueOn when the activity is marked as dueNumber
ExpireOnThe datetime when the activity expiresDatetime
ReportExpireThe number of minutes before ExpireOn when the activity is marked as expiringNumber
MaxRetainThe maximum number of minutes a user may retain the activityNumber
CountThe number of times the activity has completed (for activities that loop back and repeat)Number
StatusThe status of the activity, one of Pending, Ready, Started, Completed, Cancelled, Expired, Errored or WithdrawnText
CompletedBy > IsMultipleIndicates multiple people completed the activityLogical
CompletedBy > CountThe number of people who completed the activityNumber
CompletedBy > Source > IdThe id of the source from where activity was completedText
CompletedBy > Source > TypeThe type of the source from where activity was completedText
CompletedBy > Person > IdThe id of the person who completed the activityText
CompletedBy > Person > NameThe name of the person who completed the activityText