Create a connection to Highrise by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Highrise icon is not available, click the Add More icon to download and install the Highrise connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

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.

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with Highrise. You can then use the Sync App to get and manage the OAuth token values. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

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

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. If necessary, set the Permissions parameter to request custom permission.

   The stored procedure returns the URL to the OAuth endpoint.

2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

See Query Processing for more information.

Logging

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

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

The CData Sync App models 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 into a list of tables that can be queried using standard SQL statements.

Generally, querying Highrise 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.

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.

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.

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, or 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.

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

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.

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.

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.

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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

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

Firewall

---

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

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. 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 .

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned 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.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
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
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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

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

Remarks

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

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

Remarks

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

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

---

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

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

The protocol used by a proxy-based firewall.

Remarks

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

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

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

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

Remarks

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

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

The TCP port for a proxy-based firewall.

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. 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.

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

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

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

Remarks

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

If left unspecified, the default location is "%APPDATA%\\CData\\Highrise 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.

Remarks

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

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

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

---

Property	Description
MaxRows	Limits the number of rows returned 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.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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.

Remarks

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.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

Remarks

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

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

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

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

{
	"MyView": {
		"query": "SELECT * FROM People 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"