Adding a Connection to Highrise

To add a connection to Highrise:

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

For required properties, see the Settings tab.

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

Authenticating to Highrise

Highrise supports OAuth and API token authentication schemes.

OAuth

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL.

In all OAuth flows, you must set AuthScheme to OAuth. The following sections assume you have done so.

API Token

To authenticate to Highrise with an API token, set the following:

• AuthScheme: Set AuthScheme to APIToken.
• APIToken: The APIToken of the user. To obtain your API token, log in to your Highrise account and click the My Info link. If you are an admin or a user, this is located under the "Settings" section of the account. See Find Your API Token in the Highrise documentation for more information.
• AccountId: The Account Id of the user.

This section details a selection of advanced features of the Highrise Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The CData Sync App models the Highrise API as relational tables, views, and stored procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The CData Sync App models writable Highrise APIs as easy-to-access Tables. Most tables are defined in simple, text-based schema files. However, some tables, such as Companies, Deals, and People, are dynamic. When you connect, the Sync App gets the metadata for dynamic tables by calling the appropriate Web services.

Views

Views are read-only tables. Typically, data that cannot be modified is represented in views.

Stored Procedures

The Sync App also surfaces Stored Procedures, function-like interfaces to Highrise that surface additional capabilities of the API.

The Sync App models the data in Highrise as a list of tables in a relational database that can be queried using standard SQL statements.

Highrise Connector for CData Sync Tables

Name	Description
Cases	Create, update, delete, and query Cases that are visible to the authenticated user.
Comments	Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user.
Companies	Create, update, delete, and query Highrise Companies. This table is dynamic.
CustomFields	Return all custom fields used in the account.
DealCategories	Create, update, delete, and query Deal Categories.
Deals	Create, update, delete, and query Highrise Deals. This table is dynamic.
Groups	Query, create, update and delete your account's groups
Notes	Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.
People	Create, update, delete, and query Highrise People. This table is dynamic.
TaskCategories	Create, update, delete, and query Task Categories.

Create, update, delete, and query Cases that are visible to the authenticated user.

Table Specific Information

Insert

To insert a new Case, provide at least the Name:

INSERT INTO Cases (Name) VALUES ('my case') 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier for the case.
Name	String	False		The name of the case.
IsClosed	Boolean	True		Whether the case is closed. The default is open.
ClosedAt	Datetime	False		The date and time when the case was closed.
VisibleTo	String	False		Who the case is visible to: Everyone, Owner, or NamedGroup.
OwnerId	Integer	False		The unique identifier of the owner.
GroupId	Integer	False		The unique identifier of the group.
AuthorId	Integer	False		The unique identifier of the author.
CreatedAt	Datetime	True		The date and time when the case was created.
UpdatedAt	Datetime	True		The date and time when the case was last updated.
Parties	String	True		The parties of the case.

Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user.

Table Specific Information

Select

To retrieve Comments, provide a SubjectType that the Note belongs to, such as Notes or Emails, and the Subject Id.

SELECT * FROM Comments WHERE SubjectType = 'notes' AND SubjectId = '351922361'

Insert

The following query inserts a Comment. At least the Comment Body and ParentId must be provided.

INSERT INTO Comments (Body, ParentId) VALUES ('me comment', '351199012') 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the comment.
Body	String	False		The body of the comment.
ParentId	Integer	False		The Id of the parent of the comment.
SubjectId	Integer	True		The Id of the subject of the comment.
SubjectType	String	True		The subject type of the comment.
SubjectName	String	True		The subject name of the comment.
CollectionId	Integer	True		The Id of the collection.
CollectionType	String	True		The type of the collection.
VisibleTo	String	True		Who the comment is visible to: Everyone, Owner, or NamedGroup.
GroupId	Integer	True		The Id of the group.
OwnerId	Integer	True		The Id of the owner.
AuthorId	Integer	True		The Id of the author of the comment.
CreatedAt	Datetime	True		The date and time when the comment was created.
UpdatedAt	Datetime	True		The date and time when the comment was last updated.

Pseudo-Columns

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

Name	Type	Description
ParentType	String	Whether the comment is associated with a note or email. The allowed values are note, email. The default value is note.

Create, update, delete, and query Highrise Companies. This table is dynamic.

Table Specific Information

Select

For datetime columns only the '>' and '>=' operators are supported.

SELECT * FROM Companies WHERE UpdatedAt > '2012-01-12' 

Insert

To insert a new Company, provide at least a Company Name and a Background for the Company.

INSERT INTO Companies (Name, Background) VALUES ('Company name', 'The description') 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id column for the table Companies.
Name	String	False		The Name column for the table Companies.
Background	String	False		The Background column for the table Companies.
EmailAddressAggregate	String	False		The EmailAddressAggregate column for the table Companies.
PhoneNumberAggregate	String	False		The PhoneNumberAggregate column for the table Companies.
AddressAggregate	String	False		The AddressAggregate column for the table Companies.
InstantMessengerAggregate	String	False		The InstantMessengerAggregate column for the table Companies.
TwitterAccountAggregate	String	False		The TwitterAccountAggregate column for the table Companies.
WebAddressAggregate	String	False		The WebAddressAggregate column for the table Companies.
AvatarURL	String	False		The AvatarURL column for the table Companies.
VisibleTo	String	False		The VisibleTo column for the table Companies.
OwnerId	String	False		The OwnerId column for the table Companies.
GroupId	String	False		The GroupId column for the table Companies.
AuthorId	String	True		The AuthorId column for the table Companies.
CreatedAt	String	True		The CreatedAt column for the table Companies.
UpdatedAt	String	True		The UpdatedAt column for the table Companies.
PartyCustomField1	String	False		A CustomField of type party.
PartyCustomField2	String	False		A CustomField of type party.
SubjectData	String	False		A Subject Dat for the table Companies.

Return all custom fields used in the account.

Table Specific Information

Select

Retrieve Custom Fields created for your account.

SELECT * FROM CustomFields

You can also retrieve Custom Fields by type.

SELECT * FROM CustomFields WHERE type = 'deal'

Insert

To insert a new Custom Field, provide the Label. Only Custom Fields of type 'party' can be created.

INSERT INTO CustomFields (Label) VALUES ('My new Custom Field')

Update

Change the Label of a field by providing its Id.

UPDATE CustomFields SET Label = 'Test' WHERE Id = '4321'

Delete

Delete a Custom Field by specifying its Id.

DELETE FROM CustomFields WHERE Id = '4321'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the custom field.
Label	String	False		The label for the custom field.
Type	String	True		The type for the custom field. The allowed values are party, deal.

Create, update, delete, and query Deal Categories.

Table Specific Information

Insert

To insert a new Deal Category, at least a Category Name and a Color must be provided.

INSERT INTO DealCategories (Name, Color) VALUES ('A unique deal category', '5df4b5')  

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier for the category.
Name	String	False		The name of the category.
Color	String	False		The color as a hex value.
AccountId	Integer	True		A reference to the account.
ElementsCount	Integer	True		The number of elements in the category.
CreatedAt	Datetime	True		The date and time when this record was created.
UpdatedAt	Datetime	True		The date and time when this record was last updated.

Create, update, delete, and query Highrise Deals. This table is dynamic.

Table Specific Information

Select

For datetime columns only the '>' and '>=' operators are supported in the WHERE clause. The following query selects Deals that were updated after a given date.

SELECT * FROM Deals WHERE UpdatedAt > '2012-01-12'

Insert

Name, CategoryId, Background, Currency, Price, PriceType, Duration, and PartyId are required to create a new Deal.

INSERT INTO Deals (Name, CategoryId, Background, Currency, Price, PriceType, Duration, PartyId) VALUES ('deal with someone', 4195389, 'black', 'usd', 500, 'fixed', 123545, 149760370)  

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id column for the table Deals.
Name	String	False		The Name column for the table Deals.
AccountId	String	False		The AccountId column for the table Deals.
AuthorId	String	False		The AuthorId column for the table Deals.
Background	String	False		The Background column for the table Deals.
CategoryId	String	False		The CategoryId column for the table Deals.
Currency	String	False		The Currency column for the table Deals.
Duration	String	False		The Duration column for the table Deals.
VisibleTo	String	False		The VisibleTo column for the table Deals.
GroupId	String	False		The GroupId column for the table Deals.
OwnerId	String	False		The OwnerId column for the table Deals.
PartyId	String	False		The PartyId column for the table Deals.
Price	String	False		The Price column for the table Deals.
PriceType	String	False		The PriceType column for the table Deals.
ResponsiblePartyId	String	False		The ResponsiblePartyId column for the table Deals.
Status	String	False		The Status column for the table Deals.
StatusChangedOn	String	True		The StatusChangedOn column for the table Deals.
CreatedAt	String	True		The CreatedAt column for the table Deals.
UpdatedAt	String	True		The UpdatedAt column for the table Deals.
DealCustomField1	String	False		A Custom Field of type deal.
DealCustomField2	String	False		A Custom Field of type deal.

Query, create, update and delete your account's groups

Table Specific Information

Select

Retrieve the list of groups created in your Highrise account.

SELECT * FROM Groups

Insert

Create a new group by providing its name.

INSERT INTO Groups (Name) VALUES ('ABC123')

Update

Modify a group's name by providing the group's Id

UPDATE Groups SET Name = 'ABC' WHERE Id = '123'

Delete

Delete a group by providing the group's Id

DELETE FROM Groups WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the group.
Name	String	False		The name of the group.

Create, update, delete, and query Notes that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.

Table Specific Information

Select

To retrieve Notes, provide a SubjectType that the Note belongs to, such as People, Companies, Cases, or Deals, and the Subject Id.

SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370

To retrieve information related to a specific note, provide the Id of the note.

SELECT * FROM Notes WHERE Id = 351922361

To retrieve all the notes from all the companies, you can use a subquery with IN operator.

SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId IN (SELECT Id FROM Companies)

For datetime columns only the '>' and '>=' operators are supported in the WHERE clause.

SELECT * FROM Notes WHERE SubjectType = 'Companies' AND SubjectId = 149760370 AND UpdatedAt > '2012-01-12'

Insert

The Note's Body, Subject Id, and Subject Type are required to create a new Note.

INSERT INTO Notes (Body, SubjectId, SubjectType) VALUES ('my note', 149760370, 'Companies') 

Update

To update an existing Note, you must provide its Id.

UPDATE NOTES SET Body = 'updated note' WHERE Id = 499468019

Delete

To delete an existing Note, you must provide its Id.

DELETE FROM NOTES WHERE Id = 499929021

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the note.
Title	String	True		The title of the note.
Body	String	False		The body of the note.
AuthorId	Integer	True		The Id of the author of the note.
SubjectId	Integer	True		The Id of the subject of the note. This can be a reference to a person, company, case, or deal.
SubjectType	String	True		The subject type of the note: Person, Company, Case, Deal.
SubjectName	String	True		The subject name of the note.
CollectionId	Integer	True		The Id of the collection associated with the note.
CollectionType	String	True		The type of the collection associated with the note.
VisibleTo	String	True		Who the note is visible to: Everyone, Owner, or NamedGroup.
OwnerId	Integer	True		The Id of the owner associated with the note.
GroupId	Integer	True		The Id of the group associated with the note.
CreatedAt	Datetime	True		The date and time when the note was created.
UpdatedAt	Datetime	True		The date and time when the note was last updated.
Attachments	String	False		The attachments attached with the notes.

Create, update, delete, and query Highrise People. This table is dynamic.

Table Specific Information

Select

For datetime columns only the '>' and '>=' operators are supported.

SELECT * FROM People WHERE UpdatedAt > '2016-04-18' 

Insert

To insert a Person provide at least First Name, Last Name, and the Job Title.

INSERT INTO People (FirstName, LastName, Title) VALUES ('FirstName', 'LastName', 'CEO') 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id column for the table People.
FirstName	String	False		The FirstName column for the table People.
LastName	String	False		The LastName column for the table People.
Title	String	False		The Title column for the table People.
Background	String	False		The Background column for the table People.
EmailAddressAggregate	String	False		The EmailAddressAggregate column for the table People.
PhoneNumberAggregate	String	False		The PhoneNumberAggregate column for the table People.
AddressAggregate	String	False		The AddressAggregate column for the table People.
InstantMessengerAggregate	String	False		The InstantMessengerAggregate column for the table People.
TwitterAccountAggregate	String	False		The TwitterAccountAggregate column for the table People.
WebAddressAggregate	String	False		The WebAddressAggregate column for the table People.
CompanyID	String	False		The CompanyID column for the table People.
CompanyName	String	False		The CompanyName column for the table People.
LinkedInURL	String	False		The LinkedInURL column for the table People.
AvatarURL	String	False		The AvatarURL column for the table People.
VisibleTo	String	False		The VisibleTo column for the table People.
OwnerId	String	False		The OwnerId column for the table People.
GroupId	String	False		The GroupId column for the table People.
AuthorId	String	True		The AuthorId column for the table People.
CreatedAt	String	True		The CreatedAt column for the table People.
UpdatedAt	String	True		The UpdatedAt column for the table People.
PartyCustomField1	String	False		A CustomField of type party.
PartyCustomField2	String	False		A CustomField of type party.

Create, update, delete, and query Task Categories.

Table Specific Information

Insert

To insert a new Task Category, provide at least a Category Name and a Color.

INSERT INTO TaskCategories (Name, Color) VALUES ('A unique task category', '5df4b5')  

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		The unique identifier of the task category.
Name	String	False		The name of the task category.
Color	String	False		The color as a hex value.
AccountId	Integer	True		The Id of the account associated with the task category.
ElementsCount	Integer	True		The number of task categories.
CreatedAt	Datetime	True		The date and time when the task category was created.
UpdatedAt	Datetime	True		The date and time when the task category was last updated.

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

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

Highrise Connector for CData Sync Views

Name	Description
Account	Retrieve information about the current user's account.
Deletions	Query deleted resources.
Emails	Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.
GroupUsers	Query the groups created in your account and the users that are associated with the groups.
Memberships	Query information about your account's memberships.
Tags	Query information about your account's tags.
Tasks	Retrieve Tasks created in the account.
Users	Return information about your account's active users.

Retrieve information about the current user's account.

Table Specific Information

Select

Retrieve information about current user's account

SELECT * FROM Account

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the account in Highrise.
Name	String		The name the account is registered for.
Subdomain	String		The account's subdomain.
Plan	String		The plan the account was opened with.
OwnerId	Integer		The identifier of the account's user.
PeopleCount	Integer		The number of persons maintained in the account.
Storage	Integer		The bytes taken up in the account.
SSLEnabled	Boolean		Whether SSL is enabled for the account.
CreatedAt	Datetime		The date and time when the account was created.
UpdatedAt	Datetime		The date and time when the task category was last updated.
ColorTheme	String		The ColorTheme for the account.

Query deleted resources.

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the deleted resource.
Type	String		The type of resource.
DeletedAt	Datetime		The date and time when the resource was deleted.

Query Emails that are visible to the authenticated user and related to a specific Person, Company, Case, or Deal.

Table Specific Information

Select

To retrieve Emails, provide a SubjectType that the Email belongs to, such as People, Company, Case, or Deal, and the Subject Id.

SELECT * FROM Emails WHERE SubjectType = 'People' AND SubjectId = '1234567' 
SELECT * FROM Emails WHERE SubjectType = 'Company' AND SubjectId = '1234567' 

To retrieve information related to a specific email, provide the Id of the email.

SELECT * FROM Emails WHERE Id = '1234567'

To retrieve all the emails from all the companies, you can use a subquery with IN operator.

SELECT * FROM Emails WHERE SubjectType = 'Company' AND SubjectId IN (SELECT Id FROM Companies)

For datetime columns only the '>' and '>=' operators are supported.

SELECT * FROM Emails WHERE SubjectType = 'People' AND SubjectId = '1234567' AND UpdatedAt > "2016-01-01"

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the email.
Title	String		The title of the email.
Body	String		The body of the email.
AuthorId	Integer		The Id of the author of the email.
SubjectId	Integer		The Id of the subject of the email.
SubjectType	String		The subject type of the email. The allowed values are People, Company, Case, Deal.
SubjectName	String		The subject name of the email.
CollectionId	Integer		The Id of the collection.
CollectionType	String		The type of the collection.
VisibleTo	String		Who the email is visible to: Everyone, Owner, or NamedGroup.
OwnerId	Integer		The Id of the owner associated with the email.
GroupId	Integer		The Id of the group associated with the email.
CreatedAt	Datetime		The date and time when the email was created.
UpdatedAt	Datetime		The date and time when the email was last updated.
Attachments	String		The attachments attached with the email.

Query the groups created in your account and the users that are associated with the groups.

Table Specific Information

Select

Retrieve all the groups of your account and all the users in each group

SELECT * FROM GroupUsers 

You can also retrieve all users that belong to one group

SELECT * FROM GroupUsers WHERE GroupId = '123'

Columns

Name	Type	References	Description
GroupId [KEY]	Integer		The unique identifier of the group.
GroupName	String		The name of the group.
UserId [KEY]	Integer		Id of the user belonging to the group.
Username	String		Name of the user belonging to the group.
UserEmailAddress	String		Name of the user belonging to the group.

Query information about your account's memberships.

Table Specific Information

Select

Retrieve all group memberships in your account

SELECT * FROM Memberships

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the membership.
GroupId	Integer		The group identifier of this membership.
UserId	Integer		The user identifier of this membership.
CreatedAt	Datetime		The date and time when the user was added to the group.
UpdatedAt	Datetime		The date and time when the membership was last updated.

Query information about your account's tags.

Table Specific Information

Select

Retrieve all tags in your account

SELECT * FROM Tags

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the tag.
Name	String		The name of the tag.

Pseudo-Columns

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

Name	Type	Description
SubjectType	String		The subject type of the tag. The allowed values are People, Company, Case, Deal.
SubjectId	Integer		The Id of the subject of the tag.

Retrieve Tasks created in the account.

Table Specific Information

Select

Retrieve all tasks that are visible to the current user

SELECT * FROM Tasks

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the task.
AuthorId	Integer		The Id of the user that created the task.
OwnerId	Integer		The Id of the user owning the task.
Body	String		The instructions of the task.
Frame	String		The description for the deadline of the task, such as today,tomorrow,this_week,next_week,later, overdue.
CategoryId	Integer		The category id of the task.
DoneAt	Datetime		The date and time when the task was completed.
DueAt	Datetime		The date and time when the task is due for completion.
AlertAt	Datetime		The date and time when the user will be alerted next about the task.
SubjectId	Integer		The Id of the subject the task is created for.
SubjectName	String		The Name of the subject the task is created for.
SubjectType	String		The subject's type. The types are Case,People,Deal,Company
CreatedAt	Datetime		The date and time when the task category was created.
UpdatedAt	Datetime		The date and time when the task category was last updated.
RecordingId	Integer		The recording Id for the task.

Return information about your account's active users.

Table Specific Information

Select

Retrieve all users of your account

SELECT * FROM Users

Columns

Name	Type	References	Description
Id [KEY]	Integer		The unique identifier of the user.
Name	String		The name of the user.
EmailAddress	String		The email address of the user.
Admin	Boolean		Whether the user has admin privileges
CreatedAt	Datetime		The date and time when the user was created.
UpdatedAt	Datetime		The date and time when the user was last updated.

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

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

Authentication

---

Property	Description
AuthScheme	Whether to connect to Highrise with OAuth2 or APIToken.
AccountId	Account Id of the currently authenticated user.
APIToken	APIToken of the currently authenticated user.

OAuth

---

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

SSL

---

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

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

---

Property	Description
AuthScheme	Whether to connect to Highrise with OAuth2 or APIToken.
AccountId	Account Id of the currently authenticated user.
APIToken	APIToken of the currently authenticated user.

Whether to connect to Highrise with OAuth2 or APIToken.

Remarks

• OAuth2: Set this to perform OAuth2 authentication.
• APIToken: Set this to perform APIToken authentication.

Account Id of the currently authenticated user.

Remarks

Account Id of the currently authenticated user. This property is required to execute commands.

APIToken of the currently authenticated user.

Remarks

APIToken of the currently authenticated user.

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

---

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

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

Remarks

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

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

Remarks

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

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

---

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

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Highrise. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Highrise. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Highrise. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

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

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

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

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Highrise Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

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

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

Remarks

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

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

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

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

Remarks

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

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

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

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

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

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

Remarks

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

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

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

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

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

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.