The CData Sync App provides a straightforward way to continuously pipeline your Act-On data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Act-On connector can be used from the CData Sync application to pull data from Act-On and move it to any of the supported destinations.
The Sync App leverages V1 of the Act-On API to enable bidirectional access to Act-On data.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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.
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:
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:
First, get an OAuthAccessToken by setting the following connection properties:
Then call stored procedures to complete the OAuth exchange:
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:
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:
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.
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.
On the headless machine, set the following connection properties to obtain the OAuth authentication values.
After the OAuth settings file is generated, you need to re-set the following properties to connect:
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:
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:
This section details a selection of advanced features of the Act-On Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
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.
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 are tables that cannot be modified. Typically, read-only data are shown as views.
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.
| Name | Description |
| Footer | Query the available footer of the mail on your Act-On account. |
| Header | Query the available headers of the email on your Act-On account. |
| List_MyList | Create, update, delete, and query records of a List. |
| Optout | Upsert, delete and query records of a Optout list. |
Query the available headers of the email on your Act-On account.
Each email header present on your Act-On Account.
Get a list of headers in the account:
SELECT * FROM Header
Add a new header to your account.
Note: The fields Title, Text, and HTML are required to create a record. The Title of the header must be unique.
INSERT INTO Header(Title, Text, HTML) VALUES('Test Value', 'hello', 'html text');Update the specified header.
Note: To update the header, the Id must be specified.
UPDATE Header SET HTML = 'made some changes' where id=9;
Delete the specified header from your account.
Note: You must specify the Id to delete the header.
DELETE FROM Header where id = 8
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Id of the header. |
| Title | String | False |
The title of the header. |
| Text | String | False |
The text version of the header. |
| Html | String | False |
The HTML for the header. |
Create, update, delete, and query records of a List.
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 a table.
Query records of the specified table:
SELECT * FROM [List_MyList]
Create a new record in the table.
Note: The ListId is required to insert a new record into a table.
You can specify any field that is not read-only.
INSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('John', 'Doe', '[email protected]', 'l-000d')Update details of a specific record. If the email address already exists in the list, only the first record matching that email address is updated with the data you provide.
If the email address is not already in the list, a new record is added.
Note: Any duplicate records are NOT updated. To update a record from a table, both the ListId and E-mail Address must be specified.
You can specify any field that is not read-only.
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]'
Update details of a specific record if it exists. Otherwise, upsert inserts a new record.
Note: To upsert a record from a table, both the ListId and E-mail Address must be specified.
You can specify any field that is not read-only.
UPSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('Shubham', 'Prakash', '[email protected]', 'l-000a') Delete a record of a table.
Note: To delete a record, both the ListId and _contact_id_ must be specified.
You can specify any field that is not read-only.
DELETE FROM List_MyList WHERE [ListId] = 'l-000d' AND [_contact_id_] = 'l-000d:10'
| 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.
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.
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 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 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]'
| Name | Type | ReadOnly | Description |
| 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.
| Name | Description |
| Campaigns | Query the available campaigns ActOn. |
| Categories | Query the available categories of subscription in ActOn. |
| ContactList | Retrieve contact lists in your ActOn account. |
| DrilldownReports | Query detailed reports about messages in ActOn. |
| Hardbounce | Query records of a Hardbounce list. |
| Images | Query the available images on your Act-On account. |
| LandingPages | Retrieve landing-page messages (msgresult) from your Act-On account. |
| Media | Query the available media on your Act-On account. |
| Messages | Query the available messages in ActOn. |
| OtherLists | Query the hardbounce, spam complaint and optout lists on ActOn. This view has been deprecated. |
| Pages | Query the available page on your Act-On account. |
| 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.
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.
For example, the following queries are processed server side:
SELECT * FROM Campaigns WHERE Id = 0001 SELECT * FROM Campaigns WHERE Id IN (0001, 0002)
| 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.
| 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. |
Retrieve contact lists in your ActOn account.
Retrieve contact lists in your Act-On account.
SELECT * FROM ContactList;
| Name | Type | Description |
| Id [KEY] | String | The unique Id of the contact list. |
| Name | String | The display name of the contact list. |
| FolderName | String | The folder under which this list is stored. |
| SourceId | String | The Id of the source list. |
| BaseId | String | The Base Id used for inheritance or replication. |
| Description | String | A textual description of the contact list. |
| SourceSize | Integer | The number of entries in the source list. |
| SourceName | String | The name of the source from which this list originates. |
| TsLastModified | Datetime | The last modified timestamp (in Unix milliseconds). |
| TsLastCounted | Datetime | The date and time when the list size was last calculated. |
| TsSource | Datetime | The timestamp of the list source. |
| SourceTS | Datetime | A human-readable version of the source timestamp. |
| BIsSingleton | Boolean | Indicates whether this is a singleton list. |
| BIsList | Boolean | Indicates whether this is a standard list. |
| BIsSforce | Boolean | Indicates whether the list is based on Salesforce data. |
| BIsSforceReport | Boolean | Indicates whether the list is from a Salesforce report. |
| BIsSforceAvailable | Boolean | Indicates whether Salesforce list data is available. |
| BIsMSDyn | Boolean | Indicates whether the list uses Microsoft Dynamics. |
| BIsMSDynAvailable | Boolean | Indicates whether Microsoft Dynamics list data is available. |
| BIsSugar | Boolean | Indicates whether the list is linked to SugarCRM. |
| BIsSugarAvailable | Boolean | Indicates whether SugarCRM list data is available. |
| BIsSL | Boolean | Indicates whether the list is based on SalesLogix. |
| BIsSLAvailable | Boolean | Indicates whether SalesLogix list data is available. |
| BIsNsuite | Boolean | Indicates whether the list is linked to NetSuite. |
| BIsNsuiteAvailable | Boolean | Indicates whether NetSuite list data is available. |
Query detailed reports about messages in ActOn.
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 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'
| 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. |
| 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.
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.
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'
| Name | Type | Description |
| String | Email of the user. | |
| Origin | String | Origin. |
| Timestamp | Timestamp | When the user joined the list. |
Query the available images on your Act-On account.
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.
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')
SELECT * FROM Images WHERE Id = '001'
| Name | Type | Description |
| Id [KEY] | String | The Id of the image. |
| FolderName | String | The name of the folder that contains the image. |
| Name | String | The name of the image. |
| CreationTime | Datetime | The date/time the image was created. |
| LastModified | Datetime | The date/time the image was last modified. |
| ImageUrl | String | The image's URL. |
| ThumbUrl | String | The image's ThumbURL. The ThumbURL shortens a long URL and tracks clicks. |
| Size | Int | The size of the image. |
| Width | String | The width of the image. |
| Height | String | The height of the image. |
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 | The identifier for the next page of results. Do not set this value manually. |
Retrieve landing-page messages (msgresult) from your Act-On account.
Retrieve landing-page messages (msgresult) from your Act-On account.
SELECT * FROM LandingPages;
| Name | Type | Description |
| MsgId [KEY] | String | The unique Id of the page message (for example, p-0002). |
| Name | String | The name of the landing page asset. |
| FolderName | String | The folder in which this page resides. |
| MsgType | String | The message type returned by Act-On (for example, PAGE). |
| ModifiedAt | Datetime | The Epoch timestamp (milliseconds since 1970-01-01) of last modification. |
| TimeWhen | String | The human-readable date/time string (timezone local to server). |
| IsBeeComposer | Boolean | Indicates whether the message was created in the BEE composer. |
| ShowComposerIndicator | Boolean | Indicates whether the user interface should show the composer indicator. |
Query the available media on your Act-On account.
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.
For example, the following queries are processed server side:
SELECT * FROM Images WHERE Id = '001'
| Name | Type | Description |
| Id [KEY] | String | The Id of the image. |
| FolderName | String | The name of the folder that contains the image. |
| Name | String | The name of the image. |
| CreationTime | Datetime | The date and time the image was created. |
| LastModified | Datetime | The date and time the image was last modified. |
| Url | String | The URL of the media. |
| Size | Int | The size of the image. |
Query the available messages in ActOn.
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.
SELECT * FROM Messages WHERE Type = 'SENT'Type can be one of: SENT, DRAFT, TEMPLATE, TRIGGERED, FAILED, SCHEDULED
| Name | Type | Description |
| Id [KEY] | String | The Id of the message. |
| Timestamp | Datetime | The date/time the message was sent. |
| Title | String | The title of the message. |
| FolderName | String | The folder where the message is contained. |
| MsgType | String | The message type. |
| TimeWhen | String | The human-readable time indicating when the page was modified. |
| SenderName | String | The name of the sender. |
| SenderId | String | The Id of the sender. |
| IsTextOnly | Boolean | Indicates whether the message only contains text. |
| SenderEmail | String | The email of the sender. |
| IsBeeComposer | Boolean | Indicates whether Bee Composer is used. |
| ShowComposerIndicator | Boolean | Indicates whether the composer indicator should be shown. |
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.
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.
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'
| Name | Type | Description |
| 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 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 page on your Act-On account.
Query the available page on your Act-On account.
SELECT * FROM Pages;
| Name | Type | Description |
| Id [KEY] | String | The Id of the Landing page. |
| Title | String | The title of the Landing page. |
| Url | String | The text version of the Landing page. |
| Modified | Datetime | The date/time when the landing page Id was modified. |
| CreationTime | Datetime | The date/time when the landing page Id was created, |
| Tags | String | The Landing page tag Act-On uses to identify visitors and track visitor behavior. |
| Folder | String | The folder of the Landing page. |
Query the available programs on ActOn.
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.
For example, the following queries are processed server side:
SELECT * FROM Programs WHERE Type = 'RACK'
| 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 | String | 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. |
| CreatorId | String | CreatorId for the program. |
| HasActOnContactList | Bool | Indicates whether the program is associated with an Act-On contact list. |
| LastDoneTS | String | LastDoneTS for the program. |
| ReportingTooLarge | Bool | Indicates whether the program’s reporting data exceeds Act-On’s allowable size limits and cannot be fully generated. |
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.
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.
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')
| 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. |
| RebroadcastClick | 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.
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.
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.
| 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.
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.
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')
| 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.
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.
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'
| Name | Type | Description |
| String | Email of the user. | |
| Origin | String | Origin. |
| Timestamp | Timestamp | When the user joined the list. |
Query the available subscriptions in ActOn.
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 is required to select from this view.
For example, the following query is processed server side:
SELECT * FROM SubscriptionOptOuts WHERE Category = 'test'
| Name | Type | Description |
| 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.
Act-On does not support any column for filtering this view.
| Name | Type | Description |
| UserId [KEY] | String | The universally unique identifier of the user. |
| 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 Sync App 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.
| Name | Description |
Gets an authentication token from ActOn.
| Name | Type | Description |
| AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | The list of permissions to request from the user. Please check the ActOn API for a list of available permissions.
The default value is PRODUCTION. |
| CallbackURL | String | Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the settings for the app (including the HTTP or HTTPS schemes, capitalization, and trailing '/'). |
| Verifier | String | The verifier returned from ActOn after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL in GetOAuthAuthorizationURL. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to ActOn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with ActOn. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
| OAuthTokenTimeStamp | String | The access token created time. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
| Name | Type | Description |
| CallbackUrl | String | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the ActOn app settings. |
| Scope | String | A comma-separated list of permissions to request from the user. Please check the ActOn API for a list of available permissions.
The default value is PRODUCTION. |
| State | String | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to ActOn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with various Basecamp services.
| Name | Type | Description |
| OAuthRefreshToken | String | The refresh token returned with the previous access token. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Basecamp. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
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.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Act-On. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Act-On. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| 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. |
| TypeDetectionScheme | Determines how to determine the data type of columns. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
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 authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
The type of authentication to use when connecting to Act-On.
Specifies the authenticating user's user ID.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the authenticating user's password.
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, 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.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: 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.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Act-On. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Act-On. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Act-On. If the SOCKS 5 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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: 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, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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 | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Act-On. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| 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. |
| TypeDetectionScheme | Determines how to determine the data type of columns. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| 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=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Act-On.
When processing a query, instead of requesting all of the queried data at once from Act-On, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App 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.
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 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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: 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.
| 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. |
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.