How to create an RPA flow for Outlook Data in UiPath Studio
UiPath is a Robotic Process Automation (RPA) platform with rich features and an easy-to-use UI that enables non-developers to create process automation. By using UiPath Studio, you can build an RPA program just like drawing a diagram. With the CData API Driver for ODBC, users can embed Outlook data in the workflow.
This article explains how to use the Outlook ODBC Driver in UiPath Studio to create an RPA program that accesses Outlook data.
Configure the Connection to Outlook
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
Using OAuth Authentication
Microsoft Graph API uses OAuth 2.0 for authentication. You must register an application in the Microsoft Azure Portal to obtain OAuth credentials (Client ID and Client Secret).
Obtaining OAuth Credentials
- Log in to the Azure Portal.
- Navigate to Azure Active Directory > App registrations.
- Click New registration to create a new application.
- Enter an application name and select the appropriate account types.
- Set the Redirect URI to your application's callback URL (e.g., http://localhost:33333 for desktop apps).
- Click Register to create the application.
- On the application overview page, copy the Application (client) ID - this is your OAuthClientId.
- Navigate to Certificates & secrets and create a new client secret.
- Copy the client secret value - this is your OAuthClientSecret.
- Navigate to API permissions and add the required Microsoft Graph API permissions:
- Mail.Read - For accessing email messages
- Contacts.Read - For accessing contacts
- Calendars.Read - For accessing calendar events
- Tasks.Read - For accessing To Do tasks
- offline_access - For obtaining refresh tokens
- Click Grant admin consent to grant these permissions.
Connecting with OAuth
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Outlook will automatically walk through the OAuth process in order to obtain the access token.
- OAuthClientId: Set this to the Application (client) ID from Azure Portal.
- OAuthClientSecret: Set this to the client secret value from Azure Portal.
- TenantId: Set this to your Azure AD tenant identifier (GUID or domain name like 'contoso.onmicrosoft.com').
- CallbackURL: Set this to the Redirect URI you specified in your app registration (e.g., http://localhost:33333 for desktop apps).
Example connection string
Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
Connect UiPath Studio to Outlook Data
Now you are ready to use Outlook data ODBC DSN in UiPath Studio with the following steps.
- From the Start page, click Blank to create a New Project.
- Click Manage Packages then search for and install UiPath.Database.Activities.
- Navigate to the Activities and drop a Flowchart (Workflow -> Flowchart -> Flowchart) onto the process.
- Drop a database Connect activity (App Integration -> Datbase -> Connect) after the Start activity.
- Double-click the Connect activity and configure the Connection.
- Click the Connection Wizard
- Select "Microsoft ODBC Data Source"
- In Connection Properties, select your DSN (CData API Source) and click OK
- To store Connection info, create a variable and bind to Output in the Properties section. Choose DatabaseConnection in Output.
Create an Execute Query Activity
With the connection configured, we are ready to query Outlook data in our RPA.
- From the Activities navigation, select Execute Query and drop it on the Flowchart.
- Double-click the Execute Query activity and set the properties as follows:
- ExistingDbConnection: Your Connection variable
- Sql: SELECT statement like SELECT , FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'
- DataTable: Create and use a variable with the Type System.Data.DataTable
Create Write CSV Activity
With the Connection and Execute Query activities configured, we are ready to add a Write CSV activity to the Flowchart to replicate the Outlook data.
- From the Activities navigation, select Write CSV and drop it after the Execute Query activity.
- Double-click the Write CSV activity and set the properties as follows:
- FilePath: Set to a file (new or existing) on disk (i.e.: C:\UiPath[id]-data.csv
- DataTable: Set to the DataTable variable you created earlier
Connect the Activities and Run the Flowchart
If they are not already connected, connect each Activity that you created to complete the RPA project for extracting Outlook data and exporting it to CSV.
Click Run to extract Outlook data and create a CSV file.
In this article, we used the CData API Driver for ODBC to create an automation flow that accesses Outlook data in UiPath Studio. Download a free, 30-day trial of the ODBC Driver and start working with live Outlook data in UiPath Studio today!