This page provides a guide to Establishing a Connection to Act-On in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Act-On

Establishing a Connection shows how to authenticate to Act-On and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Act-On through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Act-On by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Authenticating to Act-On

Act-On uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom application. See Creating a Custom OAuth App for information on creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connection properties, you are ready to connect:

• OAuthClientId: (custom applications only) Set to the Client ID in your application settings.
• OAuthClientSecret: (custom applications only) Set to the Client Secret in your application settings.

When you connect, the Cloud opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The Cloud then completes the OAuth process as follows:

Web Applications

When connecting via a web application, you need to register a custom OAuth application with Act-On. See Creating a Custom OAuth App for more information. You can then use the driver to get and manage the OAuth token values.

First, get an OAuthAccessToken by setting the following connection properties:

• OAuthClientId: Set to the client Id in your application settings.
• OAuthClientSecret: Set to the client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the callback URL you specified in your application settings. If necessary, set the Scope parameter to request custom permissions. The stored procedure returns the URL of the OAuth endpoint.
2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Scope parameter to request custom permissions.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the location where the Cloud saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the Cloud on a machine with a browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

2. Then configure the Cloud to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application click Act-On OAuth endpoint to open the endpoint in your browser.
   • If you are using a Custom OAuthd Application, create the Authorization URL by setting the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

2. Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values.

• InitiateOAuth: Set this to REFRESH.
• OAuthVerifier: Set this to the verifier code.
• OAuthClientId: (custom applications only) Set this to the client Id in your custom OAuth application settings.
• OAuthClientSecret: (custom applications only) Set this to the client secret in the custom OAuth application settings.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

After you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.

Password Grant Authentication

When there is a trust relationship between the user and the application, the user can use the Password grant type to authenticate from either a Desktop application or the web. To enable this authscheme, set AuthScheme to OAuthPassword.

Authentication by password grant is similar to OAuth -- in fact, it requires that you have already set up a custom OAuth application, as described in Creating a Custom OAuth App -- but once it's set up it does not require user interaction.

To connect, set these properties:

• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.
• AuthScheme: Set the AuthScheme to OAuthPassword to perform authentication with the password grant type.
• User: The Username of the user specified in your custom OAuth application.
• Password: The Password of the user specified in your custom OAuth application.
• OAuthClientId: The Client Id specified in your custom OAuth application.
• OAuthClientSecret: The Client Secret specified in your custom OAuth application.

When to Create a Custom OAuth App

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via either a Desktop Application or from a Headless Machine. Creating a custom OAuth application is, however, required when using a web application.

You may choose to create your own OAuth Application Credentials when you want to

• control branding of the Authentication Dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

Follow the steps below to create a custom OAuth app and obtain the connection properties in a specific OAuth authentication flow.

Create a Custom OAuth App: Desktop

Sign up to https://developer.act-on.com/provision/. After registering your account on Act-On you will get an email with the following connection properties:

• OAuthClientId
• OAuthClientSecret

The default value for the callback URL is http://localhost:80. If you would like to change it you need to contact the API support for Act-On.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models entities in the Act-On API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
Lists in Act-On are exposed as views with the convention List_ListName. For each list there is another view List_ListName_Score where you can see the score of the people in the list.
Same logic for Segments in Act-On, they are exposed as views as Segment_SegmentName. And have an equivalent view Segment_SegmentName_Score.
Any changes you make to your Act-On account, such as adding a new list, adding new columns, or changing the data type of a column, will immediately be reflected
when you connect using the driver.

Using Query Processing

The Cloud offloads as much of the SELECT statement processing as possible to the Act-On APIs and then processes the rest of the query within the Cloud. The following sections document API limitations and requirements.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Cloud models the data in Act-On as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Act-On Tables

Name	Description
List_MyList	Create, update, delete, and query records of a List.
Optout	Upsert, delete and query records of a Optout list.

Create, update, delete, and query records of a List.

Table Specific Information

Every list that is created in your Act-On account is represented by a new table that is dynamically retrieved from your Act-On account. The name of the table has the following format:

List_nameOfTheList

For example, if the list in the Act-On UI is called 'MyList', the name of the table in the driver would be 'List_MyList'.

This is an example on how a list is exposed as table.

Select

Query records of the specified table.:

SELECT * FROM [List_MyList]

INSERT

Create a new record in the table.

Note: The ListId is required to insert a new record into a table.

All the fields that are not read-only can be specified.

INSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('John', 'Doe', '[email protected]', 'l-000d')

Update

Update details of a specific record.

Note: To update a record from a table, the ListId and E-mail Address must be specified.

All the fields that are not read-only can be specified.

UPDATE [List_MyList] SET [First Name] = 'Mohit', [Last Name] = 'Chaturvedi', [E-mail Address] = '[email protected]' WHERE [ListId] = 'l-000d' AND [E-mail Address] = '[email protected]'

Upsert

Update details of a specific record if it exists, else will insert a new record.

Note: To upsert a record from a table, the ListId and E-mail Address must be specified.

All the fields that are not read-only can be specified.

UPSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('Shubham', 'Prakash', '[email protected]', 'l-000a')

Delete

Delete a record of a table.

Note: To Delete a record the ListId and _contact_id_ must be specified.

All the fields that are not read-only can be specified.

DELETE FROM List_MyList WHERE [ListId] = 'l-000d' AND [_contact_id_] = 'l-000d:10'

Columns

Name	Type	ReadOnly	Description
_contact_id_ [KEY]	String	False	The _contact_id_ of the List_MyList.
First Name	String	False	The First Name of the List_MyList.
Last Name	String	False	The Last Name of the List_MyList.
E-mail Address	String	False	The E-mail Address of the List_MyList.
_FORM	String	False	The _FORM of the List_MyList.
_CAMPAIGN	String	False	The _CAMPAIGN of the List_MyList.
_IPADDR	String	False	The _IPADDR of the List_MyList.
_BROWSER	String	False	The _BROWSER of the List_MyList.
_JSTZO	String	False	The _JSTZO of the List_MyList.
_TIME	String	False	The _TIME of the List_MyList.
_REFERRER	String	False	The _REFERRER of the List_MyList.
_EMAIL_REFERRER	String	False	The _EMAIL_REFERRER of the List_MyList.
_FORM_URL	String	False	The _FORM_URL of the List_MyList.
_SEARCH	String	False	The _SEARCH of the List_MyList.
_GEO_NAME	String	False	The _GEO_NAME of the List_MyList.
_GEO_COUNTRY_CODE	String	False	The _GEO_COUNTRY_CODE of the List_MyList.
_GEO_COUNTRY	String	False	The _GEO_COUNTRY of the List_MyList.
_GEO_STATE	String	False	The _GEO_STATE of the List_MyList.
_GEO_CITY	String	False	The _GEO_CITY of the List_MyList.
_GEO_POSTAL_CODE	String	False	The _GEO_POSTAL_CODE of the List_MyList.
__created_date	Datetime	False	The __created_date of the List_MyList.
__modified_date	Datetime	False	The __modified_date of the List_MyList.
ListId	String	False	The ListId of the List_MyList.

Upsert, delete and query records of a Optout list.

Table Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Optout WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Optout WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Upsert

Upsert can be executed by specifying the Email column. Following is an example of how to insert a single email into this table

UPSERT INTO Optout(Email) VALUES ('[email protected]')

Multiple emails can also be added or updated. Following is an example of how to insert multiple emails into this table

UPSERT INTO Optout(Email) VALUES ('[email protected];[email protected]')

DELETE

Delete can be executed by specifying the Email column in the WHERE Clause. Following is an example of how to delete a single email from this table

DELETE FROM Optout WHERE Email = '[email protected]'

Multiple emails can also be deleted. Following is an example of how to delete multiple emails into this table

DELETE FROM Optout WHERE Email = '[email protected];[email protected]'

Columns

Name	Type	ReadOnly	Description
Email	String	False	Email of the user.
Origin	String	True	Origin.
Timestamp	Timestamp	True	When the user joined the list.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Act-On Views

Name	Description
Campaigns	Query the available campaigns ActOn.
Categories	Query the available categories of subscription in ActOn.
DrilldownReports	Query detailed reports about messages in ActOn.
Hardbounce	Query records of a Hardbounce list.
Images	Query the available images on your ActOn account.
Media	Query the available media on your ActOn account.
Messages	Query the available messages in ActOn.
OtherLists	Query the hardbounce, spam complaint and optout lists on ActOn. This view has been deprecated.
Programs	Query the available programs on ActOn.
Reports	Query the available reports in ActOn.
ReportsByPeriod	Query the reports related to messages in ActOn.
ScoreDetails	Query the score details of a contact.
Spamcomplaint	Query records of a Spamcomplaint list.
SubscriptionOptOuts	Query the available subscriptions in ActOn.
Users	Query the email senders for the current account in ActOn.

Query the available campaigns ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Campaigns WHERE Id = 0001
SELECT * FROM Campaigns WHERE Id IN (0001, 0002)

Columns

Name	Type	Description
Id [KEY]	String	The Id of the campaign.
Name	String	The name of the campaign.
Created	Datetime	When the campaign was created.
AssetIds	String	Asset ids of the campaigns.
Description	String	Description of the campaign.
Modified	Datetime	When the campaign was last modified.
Urls	String	Urls related to the campaign.

Query the available categories of subscription in ActOn.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
Id [KEY]	String	The Id of the category.
Name	String	The name of the category.
Description	String	Description of the category.
HeaderId	String	Header id.
HeaderName	String	Header name.

Query detailed reports about messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• MessageId supports the '=' operator.
• Drilldown supports the '=' operator.

MessageId and Drilldown are required to select from this view and will be filtered by the Act-On API.

SELECT * FROM DrilldownReports WHERE MessageId = 's-0003-1803' AND Drilldown = 'SENT'

Columns

Name	Type	Description
MessageId	String	The id of the message.
Drilldown	String	Type of message. The allowed values are SENT, SUPPRESSED, OPENED, CLICKED, BOUNCED, OPT_OUT, SPAM.
Email	String	The receiver email.
Name	String	Name of the receiver.
ListId	String	Id of the list the receiver belongs to.
RecId	String	The id of the receiver.
Timestamp	Datetime	When the message was sent.

Query records of a Hardbounce list.

View Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Hardbounce WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Hardbounce WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Columns

Name	Type	Description
Email	String	Email of the user.
Origin	String	Origin.
Timestamp	Timestamp	When the user joined the list.

Query the available images on your ActOn account.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• FolderName supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Images WHERE FolderName = 'New Folder'
SELECT Name, FolderName FROM Images WHERE FolderName IN ('New Folder', 'Default Folder')

Columns

Name	Type	Description
Id [KEY]	String	Id of the image.
FolderName	String	Name of the folder that contains the image.
Name	String	Name of the image.
CreationTime	Datetime	When the image was created.
LastModified	Datetime	When the image was last modified.
ImageUrl	String	Link to the image.
ThumbUrl	String	Link to the image.
Size	Int	Size of the image.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Type	String	Identifier for the next page of results. Do not set this value manually.

Query the available media on your ActOn account.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
Id [KEY]	String	Id of the image.
FolderName	String	Name of the folder that contains the image.
Name	String	Name of the image.
CreationTime	Datetime	When the image was created.
LastModified	Datetime	When the image was last modified.
Url	String	Link to the media.
Size	Int	Size of the image.

Query the available messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '='operator.

For example, the following query is processed server side:

SELECT * FROM Messages WHERE Type = 'SENT'

Type can be one of: SENT, DRAFT, TEMPLATE, TRIGGERED, FAILED, SCHEDULED

Columns

Name	Type	Description
Id [KEY]	String	The Id of the message.
Timestamp	Datetime	When the message has been sent.
Title	String	Title of the message.
FolderName	String	The folder where the message is contained.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Type	String	Used as a filter to retrieve different types of messages. The allowed values are SENT, DRAFT, TEMPLATE, TRIGGERED, FAILED, SCHEDULED.

Query the hardbounce, spam complaint and optout lists on ActOn. This view has been deprecated.

View Specific Information

To query data from this view, you must specify Type.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '=' operator.
• CreatedAfter supports the '=' operator.
• CreatedBefore supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM [OtherLists] WHERE Type = 'OPTOUT'
SELECT * FROM [OtherLists] WHERE Type = 'OPTOUT' AND CreatedAfter = '2018-08-28T14:37:48.923+02:00' AND CreatedBefore = '2018-08-28T14:37:48.925+02:00'
SELECT * FROM [OtherLists] WHERE Type = 'HARDBOUNCE' AND CreatedBefore = '2019-09-28T14:39:48.924+02:00'

Columns

Name	Type	Description
Email	String	Email of the user.
Timestamp	Datetime	When the user joined the list.
Origin	String
Type	String	The type of list. The allowed values are HARDBOUNCE, SPAMCOMPLAINT, OPTOUT.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CreatedBefore	String	Only records created before the supplied value will be returned.
CreatedAfter	String	Only records created after the supplied value will be returned.

Query the available programs on ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Programs WHERE Type = 'RACK'

Columns

Name	Type	Description
Id [KEY]	String	The id of the program.
Name	String	The name of the program.
IsFavorite	Bool	Flag denoting if the program is among the 'favorite' ones.
Description	String	The description of the program.
SrcIds	String	Ids of the lists involved in the program.
SrcNames	String	Name of the lists involved in the program.
MessageIds	String	Ids of the messages sent within the program.
Created	Datetime	When the program was created.
Modified	Datetime	When the program was last modified.
NextRun	Datetime	When the program is going to run again.
State	String	The state of the program.
Running	Bool	Flag denoting if the program is running or not.
Active	Int	Flag denoting if the program is active or not.
Scheduled	Bool	Flag denoting if the program is scheduled or not.
TagNames	String	List of tags related to the program.
Valid	Bool	Flag denoting if the program is valid or not.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Type	String	Type of the program, used for filtering. The allowed values are RACK, EVENT, LIST_MAINT.

Query the available reports in ActOn.

View Specific Information

To query data from this view, you must specify MessageId.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• MessageId supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Reports WHERE MessageId = 'd-0008'
SELECT * FROM Reports WHERE MessageId IN ('d-0008', 's-0004-1809')

Columns

Name	Type	Description
MessageId [KEY]	String	The Id of the message.
Title	String	The title of the message.
Status	String	The status of the message.
Bounced	Int	The number of times the message generated a bounce.
Clicked	String	The number of times the message has been clicked.
Delivered	Int	The number of times the message has been delivered.
EffectiveOpened	String	.
HardBounced	Int	The number of times the message generated hard bounce.
LastClick	Datetime	The timestamp of the last click.
LastOpen	Datetime	The timestamp of the last opening.
NotOpened	Int	The number of times the message has not been opened.
NotSent	String	The number of times the message has not been sent.
Opened	String	The number of times the message was opened.
OptOut	Int	The number of times the receiver opted out.
RedbroadcastClick	Int	.
Sent	Int	The number of times the message has been sent.
SentTo	String	The ids of the people who received the email.
SoftBounced	Int	The number of times the message generated soft bounce.
Spam	Int	The number of times has been considered as spam.
Subject	String	The subject of the message.
SuppressedOn	String	.

Query the reports related to messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Period supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM ReportsByPeriod WHERE Period = 'January 2018'
SELECT * FROM ReportsByPeriod WHERE Period IN ('January 2018', 'March 2018')

If not specified, the period will be the current month.

Columns

Name	Type	Description
Period	String	The period defined in the format '{month} yyyy' used to filter the reports. If not specified, report for the current month will return.
DayOfMonth	Int	The day of the month the report is about.
DayOfWeek	Int	The day of the week the report is about.
Sent	Int	The number of sent messages.
Bounced	Int	The number of bounced messages.
Clicked	Int	The number of clicked messages.
Opened	Int	The number of opened messages.
OptedOut	Int	Th number of opted out.

Query the score details of a contact.

View Specific Information

To query data from this view, you must specify ContactId.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• ContactId supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM ScoreDetails WHERE ContactId = 'l-0004:2'
SELECT * FROM ScoreDetails WHERE ContactId IN ('l-0004:2', 'l-0004:3')

Columns

Name	Type	Description
ContactId [KEY]	String	Unique identifier of the contact.
ActivityId	String	Unique identifier of the activity.
Action	String	Brief description of the action.
IdType	String	Type of the activity.
Profile	Boolean	Whether or not the user has a profile.
Score	Integer	Score of the activity.
Specific	Boolean	Whether or not the activity is specific.
Ago	Integer	Days ago that activity happened.
InScoreRange	Boolean	Whether or not the activity is in score range.
What	String	Object of the activity.
When	Datetime	When the activity happened.
Bin	String	Subject of the activity.
Verb	String	Description of the activity.

Query records of a Spamcomplaint list.

View Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Spamcomplaint WHERE Timestamp >= '2022-09-15 08:53:50.111' AND Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Spamcomplaint WHERE Timestamp > '2022-09-15 08:53:50.111' AND Timestamp < '2022-09-16 00:30:33.14'

Columns

Name	Type	Description
Email	String	Email of the user.
Origin	String	Origin.
Timestamp	Timestamp	When the user joined the list.

Query the available subscriptions in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Category supports the '=' operator.

Category is required to select from this view. For example, the following query is processed server side:

SELECT * FROM SubscriptionOptOuts WHERE Category = 'test'

Columns

Name	Type	Description
Email	String	The email of the subscribed user.
Timestamp	Datetime	The time when the user subscribed.
Category	String	The category of the subscription. This attribute is required for select operations.

Query the email senders for the current account in ActOn.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
UserId [KEY]	String	The universally unique identifier of the user.
Email	String	The email of the user.
Name	String	The name of the user.
Title	String	The title of the user.
Cell	String	The mobile phone of the user.
Phone	String	The phone number of the user.
Fax	String	The fax of the user.
isVerified	Bool	Flag denoting if the user has been verified or not.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Act-On.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Act-On, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Act-On Stored Procedures

Name	Description

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Act-On:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Images table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Images' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Images table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Images' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Act-On.
User	Specifies the user ID of the authenticating Act-On user account.
Password	Specifies the password of the authenticating user account.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Act-On, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TypeDetectionScheme	Determines how to determine the data type of columns.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Act-On.
User	Specifies the user ID of the authenticating Act-On user account.
Password	Specifies the password of the authenticating user account.

The type of authentication to use when connecting to Act-On.

Possible Values

OAuth, OAuthPassword

Data Type

string

Default Value

"OAuth"

Remarks

• OAuth: Set this to perform OAuth with the code grant type.
• OAuthPassword: Set this to perform OAuth with the password grant type.

Specifies the user ID of the authenticating Act-On user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Act-On, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TypeDetectionScheme	Determines how to determine the data type of columns.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the maximum number of results to return from Act-On, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

1000

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

50

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Determines how to determine the data type of columns.

Possible Values

None, RowScan

Data Type

string

Default Value

"RowScan"

Remarks

None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.