Subscribe

UiPath Insights

The UiPath Insights Guide

Export Data via Deploying an SSIS Package

Overview


In this topic you can learn how to to export data that retains the Insights data model structure by deploying a SQL Server Integration Services (SSIS) package. Unless scheduled to run more frequently, this is a one-time export to flat files that can be used as data sources for reporting tools. There will be a file generated for each month per table (jobs, queues, etc).

📘

Note

Custom variables from robot logs and queues are not yet supported.

Prerequisites


Integration Services (SSIS) must be installed on your SQL Server (see Install Integration Services (SSIS)).

Aggregated metrics


The following metrics are aggregated and cannot be exported at runtime, but can be computed from other data in the export. Please use the query/aggregate function in your destination tool to surface these metrics as they are found in Insights.

MetricQuery/aggregate functionDescription
Processes Ransum ( job id)The number of processes that have been executed.
Successful Jobssum ( job_state = “successful“)The number of jobs that have been successfully executed.
Faulted Jobssum ( job_state = “faulted“)Processes executed with faulted jobs.
Success Rate1.0 * ${sum ( job_state = "successful")} / NULLIF($sum ( job id),0)The percentage of successfully executed jobs.
Faulted Rate1.0 * ${sum ( job_state = "faulted")} / NULLIF($sum ( job id),0)The percentage of faulted jobs compared to all jobs.
Total Run Time in Secondssum (RuntimeInSeconds)The total processing time of all jobs in seconds.
Total Suspended Time in Secondssum (SuspendedTimeInSeconds)The time of jobs, in seconds, spent in a suspended state (see Job States). You can use this measure to calculate the total time spent on a particular process by subtracting the time spent in a suspended state, in long-running workflows.
Time in Pending in Secondssum (PendingTimeinSeconds)The amount of time all jobs spent in the Pending and Resumed states, meaning how long it took from the moment the job was queued until it ran on the robot (see Job States).
Queue Item Countsum (queue id)The number of queue items processed on the tenant.
Queue Countsum (distinct (queue id))The number of queues with data processed on the tenant.

Deploy SSIS package to SQL Server


Deploy the SSIS package to SQL to export Insights data.
The SSIS package UiPathInsightsDataExport.zip is bundled with the Insights release files (see Insights installation). It contains 3 files: a manifest file, and 2 XML files.

  1. Create the manifest file that comes with the release packages (see Insights installation).
  2. Click on the manifest file to start the installation wizard.
  3. Choose SQL Server deployment.
    Alternatively, you can choose the File System deployment option if that is preferable.
695695
  1. Specify the target SQL Server (e.g., (local)). To deploy it to remote machines, select Use SQL Server Authentication.
694694
  1. Select the location where you want to deploy the SSIS package. You may want to create a new folder for this purpose. Please create the folder prior to this step and then select it as the destination.
  2. In the Configure Packages step, fill in the connection string for the source database and the root destination path where you'd like to export the data.
14171417

Execute SSIS package to export Insights data


To export Insights data you need to execute the package utility.

  1. Sign in to SQL Server Integration Services.
  2. Navigate to the folder from step 5 above where you deployed the package.
  3. Find the package that you have deployed and select Run Package.
397397

Schedule SSIS package to export Insights data


If you would like to run the data export on a periodic basis, you can schedule the execution of the SSIS package using various options. For instructions on how to do so please visit the Microsoft documentation

Updated about a month ago


Export Data via Deploying an SSIS Package


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.