Adding a Connection to Act-On

To add a connection to Act-On:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Act-On icon is not available, click the Add More icon to download and install the Act-On connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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 Sync App opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App. 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 Sync App 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 Sync App to enable the automatic refreshing of the access token.

This section details a selection of advanced features of the Act-On Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Act-On and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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 Sync App 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 Sync App 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 Sync App. 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 Sync App models the data in Act-On as a list of tables in a relational database that can be queried using standard SQL statements.

Act-On Connector for CData Sync 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 Sync App 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 Sync App.

• 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.

Act-On Connector for CData Sync 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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.

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.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Act-On.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

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

---

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

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

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 Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Act-On and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\ActOn Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Act-On.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from Act-On.

Remarks

The Pagesize property affects the maximum number of results to return per page from Act-On. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

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

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.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Determines how to determine the data type of columns.

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.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Images WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.