Automate Tasks in Power Automate Using the CData API Server
Power Automate (Microsoft Flow) makes it easy to automate tasks that involve data from multiple systems, on premises or in the cloud. With the CData API Server, line-of-business users have a native way to create actions based on Excel triggers in Power Automate; the API Server makes it possible for SaaS applications like Power Automate to integrate seamlessly with Excel data through data access standards like Swagger and OData. This article shows how to use wizards in Power Automate and the API Server for Excel to create a trigger -- entities that match search criteria -- and send an email based on the results.
Set Up the API Server
Follow the steps below to begin producing secure and Swagger-enabled Excel APIs:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to Excel
After you deploy, provide authentication values and other connection properties by clicking Settings -> Connections in the API Server administration console. You can then choose the entities you want to allow the API Server access to by clicking Settings -> Resources.
Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) Excel Files
CData Drivers let you work with Excel files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.
Setting connection properties for local files
Set the URI property to local folder path.
Setting connection properties for files stored in Amazon S3
To connect to Excel file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended Excel files exist. In addition, at least set these properties:
- AWSAccessKey: AWS Access Key (username)
- AWSSecretKey: AWS Secret Key
Setting connection properties for files stored in Box
To connect to Excel file(s) within Box, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Box.
Dropbox
To connect to Excel file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.
SharePoint Online (SOAP)
To connect to Excel file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. Set User, Password, and StorageBaseURL.
SharePoint Online REST
To connect to Excel file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.
Google Drive
To connect to Excel file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.
You will also need to enable CORS and define the following sections on the Settings -> Server page. As an alternative, you can select the option to allow all domains without '*'.
- Access-Control-Allow-Origin: Set this to a value of '*' or specify the domains that are allowed to connect.
- Access-Control-Allow-Methods: Set this to a value of "GET,PUT,POST,OPTIONS".
- Access-Control-Allow-Headers: Set this to "x-ms-client-request-id, authorization, content-type".
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted by IP address; access is restricted to only the local machine by default.
For simplicity, we will allow the authtoken for API users to be passed in the URL. You will need to add a setting in the Application section of the settings.cfg file, located in the data directory. On Windows, this is the app_data subfolder in the application root. In the Java edition, the location of the data directory depends on your operation system:
- Windows: C:\ProgramData\CData
- Unix or Mac OS X: ~/cdata
[Application] AllowAuthtokenInURL = true
Add Excel Data to a Flow
You can use the built-in HTTP + Swagger connector to use a wizard to design a Excel process flow:
- In Power Automate, click My Flows -> Create from Blank.
- Select the Recurrence action and select a time interval for sending emails. This article uses 1 day.
- Add an HTTP + Swagger action by searching for Swagger.
- Enter the URL to the Swagger metadata document:
https://MySite:MyPort/api.rsc/@MyAuthtoken/$oas
- Select the "Return Sheet" operation.
Build the OData query to retrieve Excel data. This article defines the following OData filter expression in the $filter box:
Name eq 'Bob'
See the API Server help documentation for more on filtering and examples of the supported OData.
Trigger an Action
You can now work with Sheet entities in your process flow. Follow the steps to send an automated email:
- Add an SMTP - Send Email action.
- Enter the address and credentials for the SMTP server and name the connection. Be sure to enable encryption if supported by your server.
- Enter the message headers and body. You can add Excel columns in these boxes.