HUE Datagate (Preview)

Datagate is a Software-as-a-Service data management platform from Works Applications that provides users with a streamlined method for storing, managing, and generating insights from their business data. This connector allows you to leverage your business data on Datagate from the Power Platform.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	@SUPPORT
URL	https://support.worksap.co.jp/
Email	marketing-info@worksap.co.jp

Connector Metadata
Publisher	Works Applications Co., Ltd.
Website	https://www.worksap.co.jp/
Privacy policy	https://www.worksap.co.jp/privacypolicy/
Categories	Business Intelligence;Data

Datagate is a Software-as-a-Service data management platform from Works Applications that provides users with a streamlined method for storing, managing, and generating insights from their business data. It can serve as a centralized platform for storing data and managing

This connector provides an API for you to access your business data on Datagate from the Power Platform.

Prerequisites

To use this connector, you would need the following items:

• a Datagate API Key with access to OData API.
• a Datagate role's credentials (role ID, role secret) with access to the desired table.
• Datagate user account, to access the query builder on Datagate.

How to get credentials

There are two layers of authentication and authorization to access a table on Datagate, namely the Datagate API Key and Datagate role. Below are simplified steps to obtain the Datagate API Key and Datagate role credentials. For more information please refer to the Datagate manual on @SUPPORT, or contact our consultants.

To obtain Datagate API Key:

1. Log into Datagate screen.
2. Head to the API Key Management Page. The API Key button would be available on the left navigation bar of the page. Click on the key icon and select “API Key Management” to navigate to the API Key Management Page.
3. Click on the create API key button on the top right side of the page.
4. The Edit API Page will be shown with empty fields.
5. In the API Key info section, fill in the desired description.
6. Select the desired permissions to give the API Key.
7. Click on the ‘Save API Key’ button on the top right of the page to create the desired API Key.

To obtain Datagate role credentials:

1. Log into Datagate screen.
2. Head to the Role Management Page. The Role Management link would be available on the left navigation bar of the page. Click on the table icon and select “Role Management” to navigate to the Role Management Page.
3. Click on the create role button on the top right side of the page.
4. The Create Role Page will be shown.
5. In the role info section, fill in the desired role name and select permission type.
6. Select the desired permissions to give the role from the schema or table list.
7. Click on the ‘Save Role’ button on the top right of the page to create a new role and obtain the desired role credentials.

Get started with your connector

There is currently one API available for usage, the OData API, which would allow read access to table data on Datagate. Through the Datagate OData query, you can set the columns to be selected, sort order, The required parameters are the query string, and role credentials of a role which has access to the table. Refer to the previous section "How to get credentials" for the steps to acquire the required API Key and role credentials. To obtain a query string, do refer to the following steps.

1. On Datagate screen, search for the desired table on the Tables List Page.
2. Open the desired table's Data Viewer Page.
3. Set the desired parameters, and copy the resulting query string.

Send Daily Report through Email

Using Datagate's connector, create a Power flow that automatically sends a sales report daily

1. Prepare the API key to be used. (Refer to the previous section "How to get credentials")
2. Prepare role(role ID and role secret). (Refer to the previous section "How to get credentials")
3. Obtain the query for the output table.
4. Create a scheduled cloud flow.
5. Set the desired schedule.
6. Verify that the schedule set is correct.
7. Add step to get current date time, and convert from UTC time zone to the desired time zone.
8. Add OData API step. It is possible to generate dynamic query strings by inserting variables in the query string.
9. Add JSON Conversion step. Generate the schema by using a sample JSON payload.
10. Add step to create a HTML table.
11. Add step to send out email, and input the desired email body, then save the connector. You may choose to test the flow by running it manually.
12. The email would be sent in the following format on the defined schedule.

Known issues and limitations

Maximum size of returnable data is 6MB per API call.

If the requested dataset size is larger than 6MB, the API call will return with an error, "413 Payload Too Large".

Common errors and remedies

There is currently only one API on the connector, the OData API. The following are some of the possible errors that can be faced while using the API.

200 OK

"relation "public_view.table_name" does not exist"

The table might not exist anymore. Do check whether the table is accessible through Datagate's data viewer.

""failed to parse filter (XXX)" (line X, column X)"

There is some issue with the query supplied. Do confirm whether the query has been copied from Datagate screen correctly.

413 Payload Too Large

There is a limit of 6MB for the payload size from OData API. Do set a lower limit to the row count by setting the "limit" parameter in the OData query.

500 Internal Server Error

Connection to the server could not be established. Do check with our consultants if the issue persists.

FAQ

The following are common questions from Datagate users. For questions not covered here or for more details, please refer to the Datagate manual available on Works Applications' @SUPPORT platform, else do contact our consultants.

How do I get external table data from the connector?

Access the desired external table's data viewer page, and obtain the relevant query string from the query builder.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Datagate API Key	securestring	API Key from Datagate	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

OData API

Use this API to get data from Datagate using OData query. Get the OData query from the Data Viewer page.

OData API

Operation ID:

odata

Use this API to get data from Datagate using OData query. Get the OData query from the Data Viewer page.

Parameters

Name	Key	Required	Type	Description
OData Query	query	True	string	OData query for Datagate data. You can get this from Datagate's query builder.
Datagate Host URL	host_url	True	string	The host URL of your Datagate service, for example: https://tenant-name.datagate.worksap.com/
Datagate Role ID	role-id	True	string	Role ID of your Datagate role
Datagate Role Secret	role-secret	True	string	Role Secret of your Datagate role

Returns