The CData Sync App provides a straightforward way to continuously pipeline your Act! CRM data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Act! CRM connector can be used from the CData Sync application to pull data from Act! CRM and move it to any of the supported destinations.
Create a connection to Act! CRM by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Act! CRM icon is not available, click the Add More icon to download and install the Act! CRM connector from the CData site.
Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.
You can connect to either Act! CRM or Act! Premium Cloud. Set the following to connect:
This section details a selection of advanced features of the Act! CRM Sync App.
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.
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.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Act! CRM and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
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.
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.
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.
Set the following properties:
CData Sync App models entities in the Act! CRM Premium APIs as relational Views. The Sync App models Act! Premium on-premises and Act! Premium Cloud accounts as relational databases, surfacing Contacts, Activities, Opportunities, and other objects as database tables. Act! Premium for Desktop is also supported; however, a subscription is required to use the API.
The views are defined in schema files, .rsd files with a simple format that makes them easy to edit. Set the Location property to the path to the folder containing the .rsd files.
The Sync App models the data in Act! CRM into a list of tables that can be queried using standard SQL statements.
Generally, querying Act! CRM tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
Name | Description |
Activities | Create, update, delete and query the Activities in your Act! CRM database. |
Companies | Create, update, delete and query the Companies created in your Act! CRM database. |
ContactNotes | Query and delete the Notes for a given Act! CRM Contact. |
Contacts | Create, update, delete and query the Contacts in your Act! CRM database. |
GroupContacts | Query and delete the Contacts belonging to a Group. |
Groups | Create, update, delete and query the Groups participating in your Act! CRM database. |
Notes | Create, update, delete and query the Notes in your Act! CRM database. |
Opportunities | Create, update, delete and query the Opportunities in your Act! CRM database. |
OpportunityCompanies | Query and delete the Companies related to an Act! CRM opportunity. |
OpportunityContacts | Query and delete the Contacts associated with an Opportunity. |
OpportunityGroups | Query and delete the Act! CRM Groups associated with an Opportunity. |
OpportunityProducts | Update, delete and query the Products associated with an Opportunity. |
Products | Create, update, delete and query the Products in your Act! CRM database. |
Create, update, delete and query the Activities in your Act! CRM database.
SELECT * FROM Activities WHERE Location = 'London' SELECT * FROM Activities WHERE Subject = 'Team meeting'
To insert a activity, you must specify atleast one contact, start time and end time.
INSERT INTO Activities(ContactsAggregate, StartTime, EndTime) VALUES ('123456', '2020-01-27 10:00:000', '2020-01-31 10:00:00')
Any column where ReadOnly=False can be updated. Specify the Activity Id when updating a group
UPDATE Activities SET ActivityPriorityId = 1, isPrivate = false WHERE Id = '12345'
Activities can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Activities WHERE Id = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
A unique identifier that represents the activity. |
ActivityPriorityId | Integer | False |
Activity Priority value |
ActivityPriorityName | String | False |
Displays the priority of the activity. |
ActivityTypeName | String | True |
Displays the type of the activity. |
AttachmentDisplayName | String | False |
Gets presentation name of the attachment. |
AttachmentFileExtension | String | False |
Gets the extension of the Attachment |
AttachmentFileName | String | False |
Gets a string representing the directory's full path. |
AttachmentFileSize | Int | False |
Gets the size (bytes) of the attachments. |
AttachmentFileSizeDisplay | String | False |
Gets the displayable text representation of the attachment |
AttachmentFileType | String | False |
Gets the registered system file type name of the attachment |
AttachmentLastModified | Datetime | False |
Gets the last modified date of the attachment |
AttachmentPersonal | Bool | False |
Indicates whether the attachment is bound for the personal supplemental files or the workgroup supplemental files. |
CompaniesAggregate | String | False |
List of companies that are associated to this activity. |
ContactsAggregate | String | False |
List of contacts that are associated to this activity. |
Created | Datetime | True |
The date and time the activity was created. |
Details | String | False |
Additional detailed information about the activity. |
Edited | Datetime | True |
The date and time the activity was last updated. |
EndTime | Datetime | False |
The time the activity is to end |
GroupsAggregate | String | False |
List a groups that are associated to this activity. |
IsCleared | Bool | False |
Indicates that the activity has been cleared. |
IsPrivate | Bool | False |
Indicates elevated security that only the creator/owner has access to this activity. |
IsTimeless | Bool | False |
Indicates whether a specifies action is to be completed at a specific time-of-day. |
Location | String | False |
Describes the physical location that the activity is to take place. |
OpportunitiesAggregate | String | False |
List a opportunities that are associated to this activity. |
RecurSpecDayDayAsInt | Int | False |
An integer representation of the day of the week portion of a recurrence pattern. |
RecurSpecDayDaysOfWeek | String | False |
Representation of the day of the week portion of a recurrence pattern. |
RecurSpecDayDayType | String | False |
Describing the day-portion of the recurrence pattern. |
RecurSpecDayOrdinal | String | False |
Describes recurrence in relative terms for certain recurrence patterns (i.e. First, Third, Last) . |
RecurSpecDayTypedDay | String | False |
Describing the TypedDay (Day, WeekDay or Weekend Day) for the recurrence pattern when DayType is |
RecurSpecFrequency | Int | False |
Represents how often for the recurrence patterns |
RecurSpecIsEndless | Bool | False |
Flag denoting whether an end date has been specified for the pattern. Note: If false, the following defaults are used: For Daily and Weekly: 2 years beyond the start date For Monthly and Yearly: June 6, 2073. |
RecurSpecMonth | Int | False |
Represents the specific month for certain recurrence patterns |
RecurSpecRecurType | String | False |
Represents a unit of time used to separate recurences (i.e. Daily, Weekly, Monthly, Yearly). |
RecurSpecSeriesEnd | Datetime | False |
Specifiying the ending time for a given day. |
RecurSpecSeriesStart | Datetime | False |
Specifiying the starting time for a given day. |
ScheduledBy | String | True |
The contact who created this activity. |
ScheduledFor | String | False |
The name of the activity's organizer. |
SeriesID | String | True |
A unique identifier that represents the activity. The id that is returned is based on if it is a recurring or not. Recurrent activity: RecurSourceActivityId or Single Occurence activity: ActivityID |
StartTime | Datetime | False |
The time the activity is to begin |
Subject | String | False |
A description of the action to be completed. |
Create, update, delete and query the Companies created in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to the supported fields.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are
processed server side:
SELECT * FROM Companies WHERE Id = '12345' SELECT * FROM Companies WHERE Name = 'TSS company'
To insert a company, you need to specify the Company Name
INSERT INTO Companies (Name) VALUES ('New Company')
Any column where ReadOnly=False can be updated. Specify the Company Id when updating a group
UPDATE Companies SET AddressCity = 'Bangalore', AddressCountry = 'India' WHERE Id = '12345'
Companies can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Companies WHERE Id = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The unique identifier (id) for this company. |
Created | Datetime | True |
Created date of the company. |
Name | String | False |
The company's given name. |
AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
AddressLine1 | String | False |
Primary street address |
AddressLine2 | String | False |
Secondary street address |
AddressLine3 | String | False |
Miscellaneous street address |
AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
BillingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
BillingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
BillingAddressLine1 | String | False |
Primary street address |
BillingAddressLine2 | String | False |
Secondary street address |
BillingAddressLine3 | String | False |
Miscellaneous street address |
BillingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
BillingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
Description | String | False |
A brief written representation or account of this company. |
Division | String | False |
The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
Edited | Datetime | True |
Edited data of the company. |
EditedBy | String | True |
User who edited the company record. |
Fax | String | False |
The company's fax phone number. |
FaxExtension | String | False |
The company's fax phone number extension. |
HierarchyLevel | Int | False |
The positional level of where this company lays within a company hierarchy. |
IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
Industry | String | False |
Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
NumberOfEmployees | Int | False |
The total number of employees that this company operates with. |
ParentID | String | True |
The unique identifier (id) of the parent company. |
Phone | String | False |
The company's phone number. |
PhoneExtension | String | False |
The company's phone number extension. |
RecordOwner | String | True |
Owner of the company record. |
ReferredBy | String | False |
Mention or allude to. |
Region | String | False |
A part of a country, of the world, etc., that is different or separate from other parts in some way. |
Revenue | Decimal | False |
The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
ShippingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
ShippingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
ShippingAddressLine1 | String | False |
Primary street address |
ShippingAddressLine2 | String | False |
Secondary street address |
ShippingAddressLine3 | String | False |
Miscellaneous street address |
ShippingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
ShippingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
SicCode | String | False |
Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
Territory | String | False |
Geographical area. |
TickerSymbol | String | False |
An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
TollFreeExtension | String | False |
The company's toll free phone number. |
TollFreePhone | String | False |
The company's toll free phone number. |
Website | String | False |
The company's website. |
Query and delete the Notes for a given Act! CRM Contact.
SELECT * FROM ContactNotes WHERE ContactId = '12345'
ContactNotes can be deleted by providing ContactId and Id (Note Id) and issuing a DELETE statement.
DELETE FROM ContactNotes WHERE ContactId = '12345' AND Id = '56789'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier (id) for a given note. |
ContactId [KEY] | String | False |
The unique identifier (id) for the contact included in the note. |
ManageUserID | String | False |
The unique identifier (id) of the user managing the note. |
CreateUserID | String | False |
The unique identifier (id) of the user who created the note. |
IsPrivate | Boolean | False |
Indicator if the note is private. |
NoteText | String | False |
Descriptive text of the note. |
NoteTypeID | Long | False |
The id of the type of the note. |
DisplayDate | Datetime | False |
Display date of the note. |
Created | Datetime | False |
Datetime of the note creation. |
Edited | Datetime | False |
Datetime of the last edit of the note. |
AttachmentDisplayName | String | False |
Display name of the attachment. |
AttachmentFileExtension | String | False |
File extension of the attachment. |
AttachmentFileName | String | False |
File name of the attachment. |
AttachmentFileSize | Long | False |
File size of the attachment. |
AttachmentFileSizeDisplay | String | False |
Display file size of the attachment. |
AttachmentFileType | String | False |
Type of the attachment file. |
AttachmentLastModified | Datetime | False |
Last modified datetime of the attachment. |
AttachmentPersonal | Boolean | False |
Indicator if the attachment is personal. |
Create, update, delete and query the Contacts in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to the supported fields.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM Contacts WHERE Id = '12345' SELECT * FROM Contacts WHERE FullName = 'Full contact name'
To insert a contact, you need to specify the contact name.
INSERT INTO Contacts (FirstName) VALUES ('Contact First Name')
Any column where ReadOnly=False can be updated. Specify the Contact Id when updating a group
UPDATE Contacts SET Company = 'User Company' Website = 'UserWebsite.com' WHERE Id = '12345'
Contacts can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Contacts WHERE Id = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The unique identifier (id) for this contact. |
Created | Datetime | True |
Created date of the contact. |
FullName | String | True |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
Company | String | False |
The organization that this contact is associated with. |
AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
AlternateExtension | String | False |
The contact's alternate phone number extension. |
AlternatePhone | String | False |
The contact's alternate phone number. |
Birthday | String | False |
The anniversary of the day on which a person was born. |
BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
BusinessAddressLine1 | String | False |
Primary street address |
BusinessAddressLine2 | String | False |
Secondary street address |
BusinessAddressLine3 | String | False |
Miscellaneous street address |
BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
BusinessExtension | String | False |
The contact's business phone number extension. |
BusinessPhone | String | False |
The contact's business phone number. |
CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
ContactType | String | True |
The type of contact: Contact, Secondary, or User. |
Department | String | False |
An area of special expertise or responsibility. |
Edited | Datetime | True |
Edited date of the contact. |
EditedBy | String | True |
User who edited the contact. |
EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
FaxExtension | String | False |
The contact's fax phone number extension. |
FaxPhone | String | False |
The contact's fax phone number. |
FirstName | String | False |
A personal given name. |
HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
HomeAddressLine1 | String | False |
Primary street address |
HomeAddressLine2 | String | False |
Secondary street address |
HomeAddressLine3 | String | False |
Miscellaneous street address |
HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
HomeExtension | String | False |
The contact's home phone extension. |
HomePhone | String | False |
The contact's home phone number. |
IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
IsUser | Bool | True |
An indicator if this contact is also a user within the system. |
JobTitle | String | False |
The title or position this contact holds. |
LastName | String | False |
The family name or surname. |
LastResults | String | False |
Identifies last communication or action with a contact. |
Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
MessengerID | String | True |
An online identifier alias. |
MiddleName | String | False |
A name between one's first name and surname. |
MobileExtension | String | False |
The contact's mobile phone extension. |
MobilePhone | String | False |
The contact's mobile phone number. |
NamePrefix | String | False |
A patronymic prefix. |
NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
PagerExtension | String | False |
The contact's pager phone number extension |
PagerPhone | String | False |
The contact's pager phone number. |
PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
RecordOwner | String | True |
Owner user of the contact. |
ReferredBy | String | False |
Indiciates how this contact came about. |
Salutation | String | True |
A gesture or utterance made as a greeting or acknowledgment. |
Website | String | False |
The contact's web site. |
Query and delete the Contacts belonging to a Group.
SELECT * FROM GroupContacts WHERE GroupId = '12345' SELECT * FROM GroupContacts WHERE FullName = 'Contact name'
GroupContacts can be deleted by providing GroupId and Id (Contact Id) and issuing a DELETE statement.
DELETE FROM GroupContacts WHERE GroupId = '12345' AND Id = '56789'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier (id) for this contact. |
GroupId [KEY] | String | False |
The unique identifier (id) of the group to retrieve contacts from. |
Created | Datetime | False |
Created date of the group. |
FullName | String | False |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
AlternateExtension | String | False |
The contact's alternate phone number extension. |
AlternatePhone | String | False |
The contact's alternate phone number. |
Birthday | String | False |
The anniversary of the day on which a person was born. |
BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
BusinessAddressLine1 | String | False |
Primary street address |
BusinessAddressLine2 | String | False |
Secondary street address |
BusinessAddressLine3 | String | False |
Miscellaneous street address |
BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
BusinessExtension | String | False |
The contact's business phone number extension. |
BusinessPhone | String | False |
The contact's business phone number. |
Company | String | False |
The organization that this contact is associated with. |
CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
ContactType | String | False |
The type of contact: Contact, Secondary, or User. |
Department | String | False |
An area of special expertise or responsibility. |
Edited | Datetime | False |
Edited date of the group. |
EditedBy | String | False |
User who edited the group. |
EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
FaxExtension | String | False |
The contact's fax phone number extension. |
FaxPhone | String | False |
The contact's fax phone number. |
FirstName | String | False |
A personal given name. |
HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
HomeAddressLine1 | String | False |
Primary street address |
HomeAddressLine2 | String | False |
Secondary street address |
HomeAddressLine3 | String | False |
Miscellaneous street address |
HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
HomeExtension | String | False |
The contact's home phone extension. |
HomePhone | String | False |
The contact's home phone number. |
IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
IsUser | Bool | False |
An indicator if this contact is also a user within the system. |
JobTitle | String | False |
The title or position this contact holds. |
LastName | String | False |
The family name or surname. |
LastResults | String | False |
Identifies last communication or action with a contact. |
Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
MessengerID | String | False |
An online identifier alias. |
MiddleName | String | False |
A name between one's first name and surname. |
MobileExtension | String | False |
The contact's mobile phone extension. |
MobilePhone | String | False |
The contact's mobile phone number. |
NamePrefix | String | False |
A patronymic prefix. |
NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
PagerExtension | String | False |
The contact's pager phone number extension |
PagerPhone | String | False |
The contact's pager phone number. |
PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
RecordOwner | String | False |
Owner user of the record. |
ReferredBy | String | False |
Indiciates how this contact came about. |
Salutation | String | False |
A gesture or utterance made as a greeting or acknowledgment. |
Website | String | False |
The contact's web site. |
Create, update, delete and query the Groups participating in your Act! CRM database.
SELECT * FROM Groups WHERE Name = 'Group name'
To insert a group, you need to specify the Group Name
INSERT INTO Groups (Name, Description) VALUES ('Group Name', 'This is sample group')
Any column where ReadOnly=False can be updated. Specify the Group Id when updating a group
UPDATE Groups SET isPrivate = false, AddressCity = 'Group City', AddressCountry = 'Group Country' WHERE Id = '12345'
Groups can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Groups WHERE Id = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The unique identifier (id) for a group. |
Created | Datetime | True |
A timestamp when this group was created |
Name | String | False |
The name of the group. |
AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
AddressLine1 | String | False |
Primary street address |
AddressLine2 | String | False |
Secondary street address |
AddressLine3 | String | False |
Miscellaneous street address |
AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
AddressLatitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
AddressLongitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
Description | String | False |
A brief written respresentation of a group. |
Edited | Datetime | True |
Edited date of the group. |
EditedBy | String | True |
User who edited the group. |
HierarchyLevel | Int | False |
The level this group appears in its hierarchy. |
ParentID | String | True |
The group's parent entity. |
HasSubgroups | Bool | False |
An indicator if this group contains subgroups. |
RecordOwner | String | False |
Owner user of the record. |
RecordManager | String | True |
Manager user of the record. |
IsPrivate | Boolean | False |
Indicator if the group is private. |
Create, update, delete and query the Notes in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to Id. (Note that the Id is a required criteria to query the Notes view)
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM Notes WHERE Id = '2413d3d1-2345-6578-4859-792664d177af'
To insert a note, you must specify atleast one of the contacts, groups, companies or opportunities.
INSERT INTO Notes (NoteText, Contacts) VALUES ('This is sample note', ['123456'])
Any column where ReadOnly=False can be updated.
UPDATE Notes SET isPrivate = false WHERE Id = 123456
Notes can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Notes WHERE Id = 123456You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The unique identifier (id) for a given note. |
ManageUserID | String | True |
The unique identifier (id) of the user managing the note. |
CreateUserID | String | True |
The unique identifier (id) of the user who created the note. |
IsPrivate | Boolean | False |
Indicator if the note is private. |
NoteText | String | False |
Descriptive text of the note. |
NoteTypeID | Long | True |
The id of the type of the note. |
DisplayDate | Datetime | True |
Display date of the note. |
Created | Datetime | True |
Datetime of the note creation. |
Edited | Datetime | True |
Datetime of the last edit of the note. |
AttachmentDisplayName | String | False |
Display name of the attachment. |
AttachmentFileExtension | String | False |
File extension of the attachment. |
AttachmentFileName | String | False |
File name of the attachment. |
AttachmentFileSize | Long | False |
File size of the attachment. |
AttachmentFileSizeDisplay | String | False |
Display file size of the attachment. |
AttachmentLastModified | Datetime | False |
Last modified datetime of the attachment. |
AttachmentFileType | String | False |
Type of the attachment file. |
AttachmentPersonal | Boolean | False |
Indicator if the attachment is personal. |
Companies | String | False |
List of companies that are associated to this note entity. |
Contacts | String | False |
List of contacts that are associated to this note entity. |
Groups | String | False |
List of groups that are associated to this note entity. |
Opportunities | String | False |
List of opportunities that are associated to this note entity. |
Create, update, delete and query the Opportunities in your Act! CRM database.
SELECT * FROM Opportunities WHERE Name = 'Opportunity name'
To insert a Opportunity, you must specify the Name and EstimatedCloseDate
INSERT INTO Opportunities (Name, EstimatedCloseDate) VALUES ('Sample Opportunity', '2020-01-30')
Any column where ReadOnly=False can be updated.
UPDATE Opportunities SET ContactsAggregate = '123456' WHERE Id = 'f3fd9661-8fab-4fe3-8321-225f2b770f60'
Opportunities can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Opportunities WHERE Id = 'f3fd9661-8fab-4fe3-8321-225f2b770f60'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
A unique identifier that represents the opportunity. |
Created | Datetime | True |
Created date of the opportunity. |
Name | String | False |
The opportunity name. |
ActualCloseDate | Datetime | False |
The date that the opportunity as closed. |
CompaniesAggregate | String | False |
List of companies that are associated to this opportunity entity. |
Competitor | String | False |
Gets the name of the competitor for this opportunity. |
ContactNames | String | False |
The names of the contacts associated with this opportunity. |
ContactsAggregate | String | False |
The names of the contacts associated with this opportunity. |
Creator | String | False |
Indicates elevated security that only the creator has access to this opportunity. |
DaysOpen | Int | True |
The number of days this opportunity has been opened. |
Edited | Datetime | True |
The date that this record was edited. |
EditedBy | String | True |
The user's name that last editied this record. |
EstimatedCloseDate | Datetime | False |
The date the opportunity is expected to be closed. |
GrossMargin | Decimal | False |
Represents the net sales less the cost of goods and services sold. |
GroupsAggregate | String | False |
List a groups that are associated to this opportunity entity. |
IsPrivate | Bool | False |
Indicates whether this opportunity is private |
Manager | String | False |
The name of the record manager of this opportunity. |
OpenDate | Datetime | False |
The date the opportunity was opened. |
Probability | Int | False |
The likelihood this opportunity will will be won by the close date. |
ProductTotal | Decimal | False |
The total cost of the product or services. |
Reason | String | False |
Describs why the opportunity status changed. |
RecordOwner | String | False |
The user's name that owners this record. |
RelatedEntitiesResolver | Bool | False |
If true prevents related entities from serializing. |
Source | String | False |
Describs the source of the opportunity. |
StageDescription | String | False |
Gets or sets the description of the stage. |
StageId | String | False |
Gets the unique identifier of the stage. |
StageName | String | False |
The name of the stage. |
StageNumber | Int | False |
The ordinal number of the stage. |
StageProbability | Int | False |
The probability of the stage. |
StageProcessDescription | String | False |
The description of the stage process. |
StageProcessId | String | False |
The unique identifier of the stage process. |
StageProcessName | String | False |
The name of the stage process. |
Status | Int | False |
The status of the opportunity. |
TotalPerCompany | Decimal | False |
The average total per associated company. |
TotalPerContact | Decimal | False |
The average total per associated contact. |
TotalPerGroup | Decimal | False |
The average total per associated group. |
WeightedTotal | Decimal | False |
The weight of the product. |
Query and delete the Companies related to an Act! CRM opportunity.
SELECT * FROM OpportunityCompanies WHERE OpportunityId = '12345' SELECT * FROM OpportunityCompanies WHERE Name = 'Company name'
OpportunityCompanies can be deleted by providing an OpportunityId and Id (Company Id) and issuing a DELETE statement.
DELETE FROM OpportunityCompanies WHERE OpportunityId = '123456' AND Id = '345678'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier (id) for this company. |
OpportunityId [KEY] | String | False |
The unique identifier of the opportunity the companies are related to. |
Created | Datetime | False |
Created date of the company. |
Name | String | False |
The company's given name. |
AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
AddressLine1 | String | False |
Primary street address |
AddressLine2 | String | False |
Secondary street address |
AddressLine3 | String | False |
Miscellaneous street address |
AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
BillingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
BillingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
BillingAddressLine1 | String | False |
Primary street address |
BillingAddressLine2 | String | False |
Secondary street address |
BillingAddressLine3 | String | False |
Miscellaneous street address |
BillingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
BillingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
Description | String | False |
A brief written representation or account of this company. |
Division | String | False |
The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
Edited | Datetime | False |
Edited date of the company. |
EditedBy | String | False |
User who edited the company. |
Fax | String | False |
The company's fax phone number. |
FaxExtension | String | False |
The company's fax phone number extension. |
HierarchyLevel | Int | False |
The positional level of where this company lays within a company hierarchy. |
IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
Industry | String | False |
Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
NumberOfEmployees | Int | False |
The total number of employees that this company operates with. |
ParentID | String | False |
The unique identifier (id) of the parent company. |
Phone | String | False |
The company's phone number. |
PhoneExtension | String | False |
The company's phone number extension. |
RecordOwner | String | False |
Owner user of the record. |
ReferredBy | String | False |
Mention or allude to. |
Region | String | False |
A part of a country, of the world, etc., that is different or separate from other parts in some way. |
Revenue | String | False |
The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
ShippingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
ShippingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
ShippingAddressLine1 | String | False |
Primary street address |
ShippingAddressLine2 | String | False |
Secondary street address |
ShippingAddressLine3 | String | False |
Miscellaneous street address |
ShippingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
ShippingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
SicCode | String | False |
Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
Territory | String | False |
Geographical area. |
TickerSymbol | String | False |
An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
TollFreeExtension | String | False |
The company's toll free phone number. |
TollFreePhone | String | False |
The company's toll free phone number. |
Website | String | False |
The company's website. |
Query and delete the Contacts associated with an Opportunity.
SELECT * FROM OpportunityContacts WHERE OpportunityId = '12345' SELECT * FROM OpportunityContacts WHERE FullName = 'Contact name'
OpportunityContacts can be deleted by providing an OpportunityId and Id (Contact Id) and issuing a DELETE statement.
DELETE FROM OpportunityContacts WHERE OpportunityId = '12345' AND Id = '34567'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The unique identifier (id) for this contact. |
OpportunityId [KEY] | String | False |
The unique identifier (id) for the opportunity to query contacts from. |
Created | Datetime | False |
Created date of the contact. |
FullName | String | False |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
AlternateExtension | String | False |
The contact's alternate phone number extension. |
AlternatePhone | String | False |
The contact's alternate phone number. |
Birthday | String | False |
The anniversary of the day on which a person was born. |
BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
BusinessAddressLine1 | String | False |
Primary street address |
BusinessAddressLine2 | String | False |
Secondary street address |
BusinessAddressLine3 | String | False |
Miscellaneous street address |
BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
BusinessExtension | String | False |
The contact's business phone number extension. |
BusinessPhone | String | False |
The contact's business phone number. |
Company | String | False |
The organization that this contact is associated with. |
CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
ContactType | String | False |
The type of contact: Contact, Secondary, or User. |
Department | String | False |
An area of special expertise or responsibility. |
Edited | Datetime | False |
Edited date of the contact. |
EditedBy | String | False |
User who edited the contact. |
EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
FaxExtension | String | False |
The contact's fax phone number extension. |
FaxPhone | String | False |
The contact's fax phone number. |
FirstName | String | False |
A personal given name. |
HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
HomeAddressLine1 | String | False |
Primary street address |
HomeAddressLine2 | String | False |
Secondary street address |
HomeAddressLine3 | String | False |
Miscellaneous street address |
HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
HomeExtension | String | False |
The contact's home phone extension. |
HomePhone | String | False |
The contact's home phone number. |
IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
IsUser | Bool | False |
An indicator if this contact is also a user within the system. |
JobTitle | String | False |
The title or position this contact holds. |
LastName | String | False |
The family name or surname. |
LastResults | String | False |
Identifies last communication or action with a contact. |
Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
MessengerID | String | False |
An online identifier alias. |
MiddleName | String | False |
A name between one's first name and surname. |
MobileExtension | String | False |
The contact's mobile phone extension. |
MobilePhone | String | False |
The contact's mobile phone number. |
NamePrefix | String | False |
A patronymic prefix. |
NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
PagerExtension | String | False |
The contact's pager phone number extension |
PagerPhone | String | False |
The contact's pager phone number. |
PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
RecordOwner | String | False |
Owner user of the record. |
ReferredBy | String | False |
Indiciates how this contact came about. |
Salutation | String | False |
A gesture or utterance made as a greeting or acknowledgment. |
Website | String | False |
The contact's web site. |
Query and delete the Act! CRM Groups associated with an Opportunity.
SELECT * FROM OpportunityGroups WHERE OpportunityId = '123456' SELECT * FROM OpportunityGroups WHERE Name = 'Group name'
OpportunityGroups can be deleted by providing an OpportunityId and Id (Group Id) and issuing a DELETE statement.
DELETE FROM OpportunityGroups WHERE OpportunityId = '123456' AND Id = '345678'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The unique identifier (id) for a group. |
OpportunityId [KEY] | String | False |
The unique identifier (id) for the opportunity to retrieve groups from. |
Created | Datetime | True |
A timestamp when this group was created |
Name | String | True |
The name of the group. |
AddressCity | String | True |
An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | True |
A nation with its own government, occupying a particular territory. |
AddressLine1 | String | True |
Primary street address |
AddressLine2 | String | True |
Secondary street address |
AddressLine3 | String | True |
Miscellaneous street address |
AddressPostalCode | String | True |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | True |
A nation or territory considered as an organized political community under one government. |
Description | String | True |
A brief written respresentation of a group. |
Edited | Datetime | True |
Edited date of the group. |
EditedBy | String | True |
User who edited the group. |
HierarchyLevel | Int | True |
The level this group appears in its hierarchy. |
ParentID | String | True |
The group's parent entity. |
RecordOwner | String | True |
Owner user of the record. |
Update, delete and query the Products associated with an Opportunity.
SELECT * FROM OpportunityProducts WHERE OpportunityId = '12345' SELECT * FROM OpportunityProducts WHERE Name = 'Product name'
Any column where ReadOnly=False can be updated.
UPDATE OpportunityProducts SET ItemNumber = 'Product Item Number', Price = 40 WHERE OpportunityId = '12345' AND Id = '34567'
OpportunityProducts can be deleted by providing an OpportunityId and Id (Product Id) and issuing a DELETE statement.
DELETE FROM OpportunityProducts WHERE OpportunityId = '12345' AND Id = '34567'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
A unique identifier (id) for a given product. |
OpportunityId [KEY] | String | True |
A unique identifier (id) of the opportunity containing the products. |
Created | Datetime | True |
A timestamp when this group was created |
CreateDate | Datetime | True |
The date that the product was created. |
Cost | String | False |
The cost of the product. |
EditDate | Datetime | True |
The date that the opportunity product was lasted modified. |
ItemNumber | String | False |
A item number assigned to this opportunity product. |
Name | String | False |
The name of the product. |
Price | String | False |
The price of the opportunity product. |
Create, update, delete and query the Products in your Act! CRM database.
SELECT * FROM Products WHERE Name = 'Product name'
To insert a product, you need to specify the Product Name, Cost, Item Number and Price.
INSERT INTO Products (Name, Cost, ItemNumber, Price) VALUES ('Product 1', 10, 'PROD_1', 20)
Any column where ReadOnly=False can be updated.
UPDATE Products SET Cost = 20, Price = 30 WHERE Id = 12345
Products can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Products WHERE Id = 12345You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
A unique identifier (id) for a given product. |
CreateDate | Datetime | True |
The date that the product was created. |
Name | String | False |
The name of the product. |
Cost | Decimal | False |
The cost of the product. |
EditDate | Datetime | True |
The date that the opportunity product was lasted modified. |
ItemNumber | String | False |
A item number assigned to this opportunity product. |
Price | Decimal | False |
The price of the opportunity product. |
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.
Name | Description |
ActivityCompanies | Query the Companies participating in an Act! CRM Activity. |
CompanyContacts | Query the Contacts belonging to a Company. |
CompanyNotes | Query the Notes for a given Act! CRM Company. |
ContactActivities | Query the Activities for a given Act! CRM Contact. |
ContactGroups | Query the Act! CRM Groups the Contact belongs to. |
GroupNotes | Query the Notes for a given Act! CRM Group. |
OpportunityNotes | Query the Notes for a given Act! CRM Opportunity. |
Query the Companies participating in an Act! CRM Activity.
SELECT * FROM ActivityCompanies WHERE ActivityId = '12345' SELECT * FROM ActivityCompanies WHERE Name = 'TSS Company'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for this company. |
ActivityId [KEY] | String | A unique identifier that represents the activity the companies are part of. |
Created | Datetime | Created date and the activity. |
Name | String | The company's given name. |
AddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | A nation with its own government, occupying a particular territory. |
AddressLine1 | String | Primary street address |
AddressLine2 | String | Secondary street address |
AddressLine3 | String | Miscellaneous street address |
AddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | A nation or territory considered as an organized political community under one government. |
BillingAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
BillingAddressCountry | String | A nation with its own government, occupying a particular territory. |
BillingAddressLine1 | String | Primary street address |
BillingAddressLine2 | String | Secondary street address |
BillingAddressLine3 | String | Miscellaneous street address |
BillingAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
BillingAddressState | String | A nation or territory considered as an organized political community under one government. |
Description | String | A brief written representation or account of this company. |
Division | String | The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
Edited | Datetime | Edited date of the activity. |
EditedBy | String | User that edited the activity. |
Fax | String | The company's fax phone number. |
FaxExtension | String | The company's fax phone number extension. |
HierarchyLevel | Int | The positional level of where this company lays within a company hierarchy. |
IdStatus | String | The relative social or professional position of an individual within a group or organization. |
Industry | String | Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
NumberOfEmployees | Int | The total number of employees that this company operates with. |
ParentID | String | The unique identifier (id) of the parent company. |
Phone | String | The company's phone number. |
PhoneExtension | String | The company's phone number extension. |
RecordOwner | String | Owner of the activity. |
ReferredBy | String | Mention or allude to. |
Region | String | A part of a country, of the world, etc., that is different or separate from other parts in some way. |
Revenue | Decimal | The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
ShippingAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
ShippingAddressCountry | String | A nation with its own government, occupying a particular territory. |
ShippingAddressLine1 | String | Primary street address |
ShippingAddressLine2 | String | Secondary street address |
ShippingAddressLine3 | String | Miscellaneous street address |
ShippingAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
ShippingAddressState | String | A nation or territory considered as an organized political community under one government. |
SicCode | String | Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
Territory | String | Geographical area. |
TickerSymbol | String | An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
TollFreeExtension | String | The company's toll free phone number. |
TollFreePhone | String | The company's toll free phone number. |
Website | String | The company's website. |
Query the Contacts belonging to a Company.
SELECT * FROM CompanyContacts WHERE Fullname = 'Contact name'
CompanyContacts can be deleted by providing CompanyId and Id and issuing a DELETE statement.
DELETE FROM CompanyContacts WHERE CompanyId = '12345' AND Id = '56789'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for this contact. |
CompanyId [KEY] | String | The unique identifier (id) of the company to retrieve contacts from. |
Created | Datetime | Created data of the contact. |
FullName | String | The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
AltEmailAddress | String | A unique electronic address that an individual can be contacted. |
AlternateExtension | String | The contact's alternate phone number extension. |
AlternatePhone | String | The contact's alternate phone number. |
Birthday | String | The anniversary of the day on which a person was born. |
BusinessAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
BusinessAddressCountry | String | A nation with its own government, occupying a particular territory. |
BusinessAddressLine1 | String | Primary street address |
BusinessAddressLine2 | String | Secondary street address |
BusinessAddressLine3 | String | Miscellaneous street address |
BusinessAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
BusinessAddressState | String | A nation or territory considered as an organized political community under one government. |
BusinessExtension | String | The contact's business phone number extension. |
BusinessPhone | String | The contact's business phone number. |
Company | String | The organization that this contact is associated with. |
ContactType | String | The type of contact: Contact, Secondary, or User. |
Department | String | An area of special expertise or responsibility. |
Edited | Datetime | Edited date of the contact. |
EditedBy | String | User who edited the contact. |
EmailAddress | String | A unique electronic address that an individual can be contacted. |
FaxExtension | String | The contact's fax phone number extension. |
FaxPhone | String | The contact's fax phone number. |
FirstName | String | A personal given name. |
HomeAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
HomeAddressCountry | String | A nation with its own government, occupying a particular territory. |
HomeAddressLine1 | String | Primary street address |
HomeAddressLine2 | String | Secondary street address |
HomeAddressLine3 | String | Miscellaneous street address |
HomeAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
HomeAddressState | String | A nation or territory considered as an organized political community under one government. |
HomeExtension | String | The contact's home phone extension. |
HomePhone | String | The contact's home phone number. |
IdStatus | String | The relative social or professional position of an individual within a group or organization. |
IsUser | Bool | An indicator if this contact is also a user within the system. |
JobTitle | String | The title or position this contact holds. |
LastName | String | The family name or surname. |
LastResults | String | Identifies last communication or action with a contact. |
Latitude | Decimal | The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
Longitude | Decimal | The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
MessengerID | String | An online identifier alias. |
MiddleName | String | A name between one's first name and surname. |
MobileExtension | String | The contact's mobile phone extension. |
MobilePhone | String | The contact's mobile phone number. |
NamePrefix | String | A patronymic prefix. |
NameSuffix | String | Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
PagerExtension | String | The contact's pager phone number extension |
PagerPhone | String | The contact's pager phone number. |
PersonalEmailAddress | String | A unique electronic address that an individual can be contacted. |
RecordOwner | String | Owner user of the record. |
ReferredBy | String | Indiciates how this contact came about. |
Salutation | String | A gesture or utterance made as a greeting or acknowledgment. |
Website | String | The contact's web site. |
Query the Notes for a given Act! CRM Company.
SELECT * FROM CompanyNotes WHERE CompanyId = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for a given note. |
CompanyId [KEY] | String | The unique identifier (id) for the company included in the note. |
ManageUserID | String | The unique identifier (id) of the user managing the note. |
CreateUserID | String | The unique identifier (id) of the user who created the note. |
IsPrivate | Boolean | Indicator if the note is private. |
NoteText | String | Descriptive text of the note. |
NoteTypeID | Long | The id of the type of the note. |
DisplayDate | Datetime | Display date of the note. |
Created | Datetime | Datetime of the note creation. |
Edited | Datetime | Datetime of the last edit of the note. |
AttachmentDisplayName | String | Display name of the attachment. |
AttachmentFileExtension | String | File extension of the attachment. |
AttachmentFileName | String | File name of the attachment. |
AttachmentFileSize | Long | File size of the attachment. |
AttachmentFileSizeDisplay | String | Display file size of the attachment. |
AttachmentFileType | String | Type of the attachment file. |
AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
Query the Activities for a given Act! CRM Contact.
SELECT * FROM ContactActivities WHERE ContactId = '12345' SELECT * FROM ContactActivities WHERE Subject = 'Team meeting' SELECT * FROM ContactActivities WHERE Location = 'My Location'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | A unique identifier that represents the activity. |
ContactId | String | A unique identifier that represents the contact related to the activities. |
Created | Datetime | The date and time the activity was created. |
Subject | String | A description of the action to be completed. |
Location | String | Describes the physical location that the activity is to take place. |
ActivityPriorityName | String | Displays the priority of the activity. |
ActivityTypeName | String | Displays the type of the activity. |
AttachmentDisplayName | String | Gets presentation name of the attachment. |
AttachmentFileExtension | String | Gets the extension of the Attachment |
AttachmentFileName | String | Gets a string representing the directory's full path. |
AttachmentFileSize | Int | Gets the size (bytes) of the attachments. |
AttachmentFileSizeDisplay | String | Gets the displayable text representation of the attachment |
AttachmentFileType | String | Gets the registered system file type name of the attachment |
AttachmentLastModified | Datetime | Gets the last modified date of the attachment |
AttachmentPersonal | Bool | Indicates whether the attachment is bound for the personal suppplemental files or the workgroup supplemental files. |
CompaniesAggregate | String | List of companies that are associated to this activity. |
Details | String | Additional detailed information about the activity. |
Edited | Datetime | The date and time the activity was last updated. |
EndTime | Datetime | The time the activity is to end |
GroupsAggregate | String | List a groups that are associated to this activity. |
IsCleared | Bool | Indicates that the activity has been cleared. |
IsPrivate | Bool | Indicates elevated security that only the creator/owner has access to this activity |
IsTimeless | Bool | Indicates whether a specifies action is to be completed at a specific time-of-day. |
OpportunitiesAggregate | String | List a opportunities that are associated to this activity. |
RecurSpecDayDayAsInt | Int | An integer representation of the day of the week portion of a recurrence pattern. |
RecurSpecDayDaysOfWeek | String | Representation of the day of the week portion of a recurrence pattern. |
RecurSpecDayDayType | String | Describing the day-portion of the recurrence pattern. |
RecurSpecDayOrdinal | String | Describes recurrence in relative terms for certain recurrence patterns (i.e. First, Third, Last). |
RecurSpecDayTypedDay | String | Describing the TypedDay (Day, WeekDay or Weekend Day) for the recurrence pattern when DayType is |
RecurSpecFrequency | Int | Represents how often for the recurrence patterns |
RecurSpecIsEndless | Bool | Flag denoting whether an end date has been specified for the pattern. Note: If false, the following defaults are used: For Daily and Weekly: 2 years beyond the start date For Monthly and Yearly: June 6, 2073. |
RecurSpecMonth | Int | Represents the specific month for certain recurrence patterns |
RecurSpecRecurType | String | Represents a unit of time used to separate recurences (i.e. Daily, Weekly, Monthly, Yearly). |
RecurSpecSeriesEnd | Datetime | Specifiying the ending time for a given day. |
RecurSpecSeriesStart | Datetime | Specifiying the starting time for a given day. |
ScheduledBy | String | The contact who created this activity. |
ScheduledFor | String | The name of the activity's organizer. |
SeriesID | String | A unique identifier that represents the activity. The id that is returned is based on if it is a recurring or not. Recurrent activity: RecurSourceActivityId or Single Occurence activity: ActivityID |
StartTime | Datetime | The time the activity is to begin |
Query the Act! CRM Groups the Contact belongs to.
SELECT * FROM ContactGroups WHERE ContactId = '12345' SELECT * FROM ContactGroups WHERE Name = 'Contact name'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for a group. |
ContactId [KEY] | String | The unique identifier (id) for the contact included in the group. |
Created | Datetime | A timestamp when this group was created |
Name | String | The name of the group. |
AddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
AddressCountry | String | A nation with its own government, occupying a particular territory. |
AddressLine1 | String | Primary street address |
AddressLine2 | String | Secondary street address |
AddressLine3 | String | Miscellaneous street address |
AddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
AddressState | String | A nation or territory considered as an organized political community under one government. |
Description | String | A brief written respresentation of a group. |
Edited | Datetime | Edited date of the contact. |
EditedBy | String | User who edited the contact. |
HierarchyLevel | Int | The level this group appears in its hierarchy. |
ParentID | String | The group's parent entity. |
RecordOwner | String | Owner user of the record. |
Query the Notes for a given Act! CRM Group.
SELECT * FROM GroupNotes WHERE GroupId = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for a given note. |
GroupId [KEY] | String | The unique identifier (id) for the group included in the note. |
ManageUserID | String | The unique identifier (id) of the user managing the note. |
CreateUserID | String | The unique identifier (id) of the user who created the note. |
IsPrivate | Boolean | Indicator if the note is private. |
NoteText | String | Descriptive text of the note. |
NoteTypeID | Long | The id of the type of the note. |
DisplayDate | Datetime | Display date of the note. |
Created | Datetime | Datetime of the note creation. |
Edited | Datetime | Datetime of the last edit of the note. |
AttachmentDisplayName | String | Display name of the attachment. |
AttachmentFileExtension | String | File extension of the attachment. |
AttachmentFileName | String | File name of the attachment. |
AttachmentFileSize | Long | File size of the attachment. |
AttachmentFileSizeDisplay | String | Display file size of the attachment. |
AttachmentFileType | String | Type of the attachment file. |
AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
Query the Notes for a given Act! CRM Opportunity.
SELECT * FROM OpportunityNotes WHERE OpportunityId = '12345'You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.
Name | Type | Description |
Id [KEY] | String | The unique identifier (id) for a given note. |
OpportunityId [KEY] | String | The unique identifier (id) for the opportunity included in the note. |
ManageUserID | String | The unique identifier (id) of the user managing the note. |
CreateUserID | String | The unique identifier (id) of the user who created the note. |
IsPrivate | Boolean | Indicator if the note is private. |
NoteText | String | Descriptive text of the note. |
NoteTypeID | Long | The id of the type of the note. |
DisplayDate | Datetime | Display date of the note. |
Created | Datetime | Datetime of the note creation. |
Edited | Datetime | Datetime of the last edit of the note. |
AttachmentDisplayName | String | Display name of the attachment. |
AttachmentFileExtension | String | File extension of the attachment. |
AttachmentFileName | String | File name of the attachment. |
AttachmentFileSize | Long | File size of the attachment. |
AttachmentFileSizeDisplay | String | Display file size of the attachment. |
AttachmentFileType | String | Type of the attachment file. |
AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
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 |
ActCloudName | The handle assigned to the Act! Premium Cloud account. |
ActDatabase | The Act! Database to connect to. |
URL | The URL of the ActCRM account. |
ActEdition | The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud. |
User | The Act! CRM user account used to authenticate. |
Password | The password used to authenticate the user. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
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. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
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 . |
Property | Description |
LogModules | Core modules to be included in the log file. |
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. |
Property | Description |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Act! CRM. |
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 | Enables scanning Act! CRM Contact entities to determine unique columns. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
ActCloudName | The handle assigned to the Act! Premium Cloud account. |
ActDatabase | The Act! Database to connect to. |
URL | The URL of the ActCRM account. |
ActEdition | The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud. |
User | The Act! CRM user account used to authenticate. |
Password | The password used to authenticate the user. |
The handle assigned to the Act! Premium Cloud account.
ActCloudName is assigned to the account when it is created in Act! Premium Cloud.
It is found in the browser's address field when opening the online account, in the form https://eup1-iis-04.eu.hosted.act.com/ActCloudName.
This property is only applied for Act! Premium Cloud connections, and must not be used if attempting to connect to an on-premise Act! Premium (Web) database.
The Act! Database to connect to.
If you are using Act! Premium for Desktop, the database name is shown at the top of the page, as Act! Premium - {DatabaseName}. If you are using Act! Premium Cloud, click the ? icon in the top right and select About Act! Premium. You will find the Database Name in the window that appears.
The URL of the ActCRM account.
The ActCRM URL is in the form http://{act crm instance}.com.
For Premium On-Premise this property should look like http://serverName/.
The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud.
ActCloudName property is mandatory and needs to be filled only in Case of [Act Premium Cloud].
The Act! CRM user account used to authenticate.
Together with Password, this field is used to authenticate against the Act! CRM server.
The password used to authenticate the user.
The User and Password are together used to authenticate with the server.
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.
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.
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! CRM 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.
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.
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.
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.
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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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.
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.
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.
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:
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.
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.
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.
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 .
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.
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.
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\\ActCRM Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
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.
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.
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 |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Act! CRM. |
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 | Enables scanning Act! CRM Contact entities to determine unique columns. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
A boolean indicating if you would like to include custom fields in the column listing.
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
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.
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! CRM.
The Pagesize property affects the maximum number of results to return per page from Act! CRM. 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.
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.
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.
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.
Enables scanning Act! CRM Contact entities to determine unique columns.
In the Act! CRM API, Contact entities can have different sets of associated attributes in addition to the standard columns.
To access these unique columns, set the following connection properties:
RowScan | Setting TypeDetectionScheme to RowScan will scan objects (rows) to heuristically determine additional columns when you connect. The RowScanDepth determines the number of objects to be scanned. |
None | Setting TypeDetectionScheme to None will return only the standard columns. |
A filepath pointing to the JSON configuration file containing your custom views.
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:
For example:
{ "MyView": { "query": "SELECT * FROM Activities 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"