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

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

Connecting to Basecamp

In addition to authenticating, set the following connection properties to access Basecamp tables.

• Schema: Set this to "V2" or "V3" to connect to a Basecamp 2 or Basecamp 3 account.
• ProjectId: This is a required parameter for most table operations. You can query the Projects table to obtain this value.

  If you do not specify the ProjectId connection property, the Sync App will use the first project Id returned from the Projects table in your first authentication to Basecamp.

• AccountId: You can find the AccountId in the URL after you log in to Basecamp in a web browser:
  

  http://basecamp.com/<AccountId>

Authenticating to Basecamp

Basecamp 2 uses basic or OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to log into their own accounts.

Basecamp 3 requires OAuth 2.0.

Basic

In basic authentication, you use your login credentials to connect. Set the following properties:

• User: This is the username you use to log in to Basecamp.
• Password: This is the password you use to log in to Basecamp.
• AuthScheme: Set this to Basic.

OAuth

AuthScheme must be set to OAuth in all user account flows.

Web Applications

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

First, get an OAuthAccessToken by setting the following connection properties:

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

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the callback URL you specified in your application settings. If necessary, set the Scope parameter to request custom permissions. The stored procedure returns the URL of the OAuth endpoint.
2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Scope parameter to request custom permissions.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the path where the Sync App saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

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

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

This section details a selection of advanced features of the Basecamp 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 Basecamp 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 Basecamp 2 and Basecamp APIs as relational tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

The available entities, as well as any API limitations and requirements for querying these entities, are documented in Basecamp 2 Data Model and Basecamp 3 Data Model. You can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Overview

The Data Models illustrate an example of what your Basecamp environment might look like. The actual data model will be obtained dynamically based on your Basecamp account.

Key Features

• Tables and Views are dynamically defined to model calendars, documents, and projects on Basecamp.
• Stored procedures allow you to execute operations to Basecamp, including downloading and uploading objects.
• Live connectivity to these objects means any changes to your Basecamp account are immediately reflected when using the Sync App.

Basecamp 2 Data Model

Basecamp 2 Data Model describes the schemas available to connect to Basecamp 2 accounts. You can use tables to work with live Basecamp data. You can use stored procedures provided by CData Sync App to automate working with Basecamp data.

Basecamp 3 Data Model

Basecamp 3 Data Model describes the schemas available to connect to Basecamp 3 accounts. You can use tables to work with live Basecamp data. You can use stored procedures provided by CData Sync App to automate working with Basecamp data.

This section documents the Tables, Views, and Stored Procedures available to connect to Basecamp 2 accounts.

The Sync App models the data in Basecamp into a list of tables that can be queried using standard SQL statements.

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

Basecamp Connector for CData Sync Tables

Name	Description
Accesses	Retrieve, grant, and deny access permissions to Projects and Calendars on Basecamp.
CalendarEvents	Retrieve, create, update, and delete Calendar Events on Basecamp.
Calendars	Retrieve, create, update, and delete Calendars on Basecamp.
Documents	Retrieve, create, update, and delete Documents on Basecamp.
People	Retrieve and delete People on Basecamp.
Projects	Retrieve, create, update, and delete Projects on Basecamp.

Retrieve, grant, and deny access permissions to Projects and Calendars on Basecamp.

Table Specific Information

Select

You need to specify a ProjectId or CalendarId to retrieve Accesses. These columns are also the only columns supported by Basecamp as filter criteria; they can be used with the '=' operator.

SELECT * FROM Accesses WHERE ProjectId = '11111111'
SELECT * FROM Accesses WHERE CalendarId = '11111111'

Insert

You can give someone access to a Project or Calendar using their Email Addresses or Ids (if they are part of the organization already).

INSERT INTO Accesses (ProjectId, EmailAddresses) VALUES ('11111111', '[email protected], [email protected]')

INSERT INTO Accesses (CalendarId, Ids) VALUES ('11111111', '123456789, 987654321')

Update

Update is not a supported operation for the table Accesses.

Delete

To revoke access to someone from a Project or Calendar, specify the ProjectId or CalendarId and the Person's Id.

DELETE FROM Accesses WHERE ProjectId = '11111111' AND Id = '123456789'
DELETE FROM Accesses WHERE CalendarId = '11111111' AND Id = '123456789'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier of the person with access to the project or calendar.
Admin	Boolean	True		Boolean value to show if the current person is an admin or not.
AppUrl	String	True		The app URL.
AvatarUrl	String	True		The avatar URL of the person.
CanCreateProjects	Boolean	True		Whether the person can create projects or not.
CreatedAt	Datetime	True		The date and time when the record was created.
EmailAddress	String	True		The email address of the person with access to the project or calendar.
FullsizeAvatarUrl	String	True		The full-size avatar URL of the person.
IdentityId	String	True		The identity Id of the person with access to the project or calendar.
IsClient	Boolean	False		Is the returned user a client or not.
Name	String	True		The name of the person with access to the project or calendar.
Trashed	Boolean	False		Boolean value for deleted people.
UpdatedAt	Datetime	True		The date and time when the record was last updated.
URL	String	True		The URL of the person.
Ids	String	False		A comma separated list of user Ids to be granted access to a project or calendar.
EmailAddresses	String	False		A comma separated list of user email addresses to be granted access to a project or calendar.

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
ProjectId	String	The Project Id associated with the access.
CalendarId	String	The Calendar Id associated with the access.

Retrieve, create, update, and delete Calendar Events on Basecamp.

Table Specific Information

Select

Basecamp supports only a limited subset of columns to be used as filter criteria in the WHERE clause. All Boolean columns for this table can be used with the '=' operator. ProjectId, CalendarId, StartsAt, and EndsAt can also be used with the "=" operator. Additionally, the StartsAt column can be used with the '>=' operator.

The following query filters on a particular time range.

SELECT * FROM CalendarEvents WHERE StartsAt = '2016-01-01' AND EndsAt = '2016-02-01'

The following queries get CalendarEvents for a certain Project or Calendar.

SELECT * FROM CalendarEvents WHERE ProjectId= '123456768'
SELECT * FROM CalendarEvents WHERE CalendarId = '123456768'

Insert

Specify the ProjectId or CalendarId and StartsAt when creating a new CalendarEvent.

INSERT INTO CalendarEvents (ProjectId, Summary, Description, AllDay, StartsAt) VALUES ('12345678', 'My single, all-day Project event', 'Details to follow', 'true', 2016-02-01)

Update and Delete

Specify the ProjectId or CalendarId and the CalendarEvent Id when updating or deleting CalendarEvents.

UPDATE CalendarEvents SET Summary = 'Updated, two-day Project event', Description = 'Details to follow', AllDay = 'true', StartsAt = '2016-01-01', EndsAt = '2016-01-03' WHERE ProjectId = '12345678' AND Id = '12345678'

DELETE FROM CalendarEvents WHERE ProjectId = '12345678' AND Id = '12345678'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the calendar event.
AllDay	Boolean	False		Whether the calendar event is an all-day event.
AppUrl	String	True		The app URL.
BucketAppUrl	String	True		The calendar event bucket app url.
BucketColor	String	True		The calendar event bucket color.
BucketId	String	True		The calendar event bucket Id.
BucketName	String	True		The calendar event bucket name.
BucketType	String	True		The calendar event bucket type.
BucketUrl	String	True		The calendar event bucket URL.
CommentsCount	Integer	True		The number of comments on this calendar event.
CreatedAt	Datetime	True		The date and time when the calendar event was created.
CreatorAvatarUrl	String	False		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String	False		Creator full-size avatar URL.
CreatorId	String	False		The Id of the creator of the calendar event.
CreatorName	String	False		The name of the creator of the calendar event.
Description	String	False		The description for the calendar event.
EndsAt	Datetime	False		The end date and time for the calendar event.
Past	Boolean	False		Boolean value for past calendar events.
Private	Boolean	False		Whether this calendar event is private.
RemindAt	Datetime	False		The date and time for the calendar event reminder.
StartsAt	Datetime	False		The start date and time for the calendar event.
SubscribersId	String	False		The Id of the subscriber to the calendar event.
SubscribersName	String	False		The name of the subscriber to the calendar event.
Summary	String	False		The summary for the calendar event.
Trashed	Boolean	False		Boolean value for deleted calendar events.
UpdatedAt	Datetime	True		The date and time when the calendar event was updated.
Url	String	True		The URL of the calendar event.

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
ProjectId	String	The Id of the Project associated with the calendar event.
CalendarId	String	The calendar Id associated with the calendar event.

Retrieve, create, update, and delete Calendars on Basecamp.

Table Specific Information

Select

Select all from Calendars or specify an Id to retrieve more detail on a certain Calendar (Id is the only column supported as search criteria by Basecamp).

SELECT * FROM Calendars WHERE Id = '123456789'

Insert

Specify (at least) the Name property to create a new Calendar under the organization.

INSERT INTO Calendars (Name) VALUES ('New Test Calendar')

Update and Delete

Specify a Calendar Id to update or delete Calendars. Set the Name property again if you are updating.

UPDATE Calendars SET Name = 'This is a new name for the Test Calendar.' WHERE Id = '123456789'

DELETE FROM Calendars WHERE Id = '123456789'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the calendar.
AccessesAppUrl	String	True		The accesses app URL.
AccessesCount	Integer	True		The accesses count.
AccessesUpdatedAt	Datetime	True		The time when accesses were updated.
AccessesUrl	String	True		The accesses URL.
AppUrl	String	True		The app URL.
CalendarEventsCount	Integer	True		Number of calendar events.
CalendarEventsUpdatedAt	Datetime	True		The date and time when the calendar event was last updated.
CalendarEventsUrlsPast	String	True		URL of the past calendar event.
CalendarEventsUrlsUpcoming	String	True		The date and time when the calendar was last updated.
Color	String	True		The color of the calendar.
CreatedAt	Datetime	True		The date and time when the document was created.
CreatorAvatarUrl	String	False		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String	False		Creator full-size avatar Url.
CreatorId	String	False		The Id of the creator of the calendar.
CreatorName	String	False		The name of the creator of the calendar.
Name	String	False		The name of the calendar.
UpdatedAt	Datetime	True		The date and time when the calendar was last updated.
Url	String	True		The URL of the calendar.

Retrieve, create, update, and delete Documents on Basecamp.

Table Specific Information

Select

You can retrieve all Documents (for all Projects), select Documents belonging to a certain Project only, or specify a Project and a certain Document at the same time (ProjectId and Id are the only columns supported as search criteria by Basecamp).

You can also sort Documents by UpdatedAt, CreatedAt, or Title.

SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'

SELECT * FROM Documents ORDER BY UpdatedAt

SELECT * FROM Documents ORDER BY Title DESC

Insert

To add a new Document to a major Project, specify the ProjectId and provide the Document's title or some Content.

INSERT INTO Documents (ProjectId, Title, Content) VALUES ('11111111', 'Memo', 'This is our document content')

Update and Delete

Specify the ProjectId and the Document Id to update or delete a Document.

UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'

DELETE FROM Documents WHERE ProjectId = '11111111' AND Id = '12345678'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the document.
AppUrl	String	True		The app URL.
BucketAppUrl	String	True		The topic bucket app url.
BucketColor	String	True		The to-do bucket color.
BucketId	String	True		The to-do bucket Id.
BucketName	String	True		The to-do bucket name.
BucketType	String	True		The to-do bucket type.
BucketUrl	String	True		The to-do bucket URL.
Content	String	False		The content of the document.
CreatedAt	Datetime	True		The date and time when the document was created.
CreatorAvatarUrl	String	False		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String	False		Creator full-size avatar URL.
CreatorId	String	False		The Id of the creator of the document.
CreatorName	String	False		The name of the creator of the document.
LastUpdaterId	String	False		The Id of the person who last updated the document.
LastUpdaterName	String	False		The name of the person who last updated the document.
Private	Boolean	False		Whether this to-do is private.
SubscribersId	String	False		The Id of the subscriber to the document.
SubscribersName	String	False		The name of the subscriber to the document.
Title	String	False		The title of the document.
Trashed	Boolean	False		Boolean value for deleted to-dos.
UpdatedAt	Datetime	True		The date and time when the document was last updated.
URL	String	True		The URL of the document.

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
ProjectId	String	The Id of the Project associated with the document.

Retrieve and delete People on Basecamp.

Table Specific Information

Select

Retrieve all People from the organization, specify an Id to get more info, or see who has been deleted (admin access is required). Id and Trashed are the columns supported by Basecamp as search criteria.

SELECT * FROM People WHERE Id = '123456789'

SELECT * FROM People WHERE Trashed = true

Insert

New People can be invited directly to Projects via the Accesses table.

Update

Update is not a supported operation for the table People.

Delete

Specify the Person's Id to delete the record from the organization.

DELETE FROM People WHERE Id = '123456789'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the person.
AccountOwner	Boolean	True		Boolean value to show if the current person is the account owner.
Admin	Boolean	True		Boolean value to show if the current person is an admin or not.
AssignedTodosCount	Integer	True		Number of assigned to-dos.
AssignedTodosUpdatedAt	Datetime	True		The date and time when the record was updated.
AssignedTodosUrl	String	True		The URL of the assigned to-do.
AppUrl	String	True		The app URL.
AvatarUrl	String	True		The avatar URL of the person.
CalendarEventsTodayCount	Integer	True		Number of events for today.
CanCreateProjects	Boolean	True		Whether the person can create projects or not.
CreatedAt	Datetime	True		The date and time when the record was created.
EmailAddress	String	True		The email address of the person.
EventsAppUrl	String	True		The events app URL.
EventsCount	Integer	True		Number of events.
EventsUpdatedAt	Datetime	True		The date and time when the event was updated.
EventsUrl	String	True		The URL of the assigned to-do.
FullsizeAvatarUrl	String	True		The full-size avatar URL of the person.
HasBasecampSiblings	Boolean	False		Boolean value for Basecamp siblings.
IdentityId	String	True		The identity Id of the person.
Name	String	True		The name of the person.
OutstandingTodosCount	Integer	True		Number of outstanding to-dos.
Trashed	Boolean	False		Boolean value for deleted people.
UpdatedAt	Datetime	True		The date and time when the record was last updated.
Url	String	True		The URL of the person.

Retrieve, create, update, and delete Projects on Basecamp.

Table Specific Information

Select

You can retrieve all active Projects from the organization, filter records by Drafts and Archived Projects, or simply set a Project Id for more information. Drafts, Archived, and Id are the columns supported as search criteria by Basecamp.

SELECT * FROM Projects WHERE Drafts = True
SELECT * FROM Projects WHERE Advanced = True
SELECT * FROM Projects WHERE Id = '11111111'

Insert

Specify the Name and Description properties at a minimum to create a new Project.

INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')

Update and Delete

Simply set the Project Id to update or delete a project you have access to.

UPDATE Projects SET Name = 'Updated Proj', Description = 'This is an updated test project.' WHERE Id = '11111111'

DELETE FROM Projects WHERE Id = '11111111'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier of the project.
AccessesAppUrl	String	True		The accesses app URL.
AccessesCount	Integer	True		The accesses count.
AccessesUpdatedAt	Datetime	True		Time when accesses were updated.
AccessesUrl	String	True		The accesses URL.
AppUrl	String	True		The app URL.
Archived	Boolean	False		When user archives a project, this value will be set to true.
AttachmentsAppUrl	String	True		The attachments app URL.
AttachmentsCount	Integer	True		The attachments count.
AttachmentsUpdatedAt	Datetime	True		Time when attachments were updated.
AttachmentsUrl	String	True		The attachments URL.
CalendarEventsAppUrl	String	True		The calendar events app URL.
CalendarEventsCount	Integer	True		The calendar events count.
CalendarEventsUpdatedAt	Datetime	True		Time when calendar events were updated.
CalendarEventsUrl	String	True		The calendar events URL.
Color	String	True		Color.
CreatedAt	Datetime	True		The creation time of the project.
CreatorAvatarUrl	String	False		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String	False		Creator full-size Avatar URL.
CreatorId	String	False		The Id of the creator.
CreatorName	String	False		The name of the creator.
Description	String	False		The description of the project.
DocumentsAppUrl	String	True		The documents app URL.
DocumentsCount	Integer	True		The documents count.
DocumentsUpdatedAt	Datetime	True		Time when documents were updated.
DocumentsUrl	String	True		The documents URL.
Drafts	Boolean	False		Boolean value for a draft project.
ForwardsAppUrl	String	True		The forwards app URL.
ForwardsCount	Integer	True		The forwards count.
ForwardsUpdatedAt	Datetime	True		Time when forwards were updated.
ForwardsUrl	String	True		The forwards URL.
IsClientProject	Boolean	False		Whether the project is related to clients or not.
LastEventAt	Datetime	False		Time when the project was last modified.
Name	String	False		The name of the project.
Starred	Boolean	False		Boolean value for a starred project.
Template	Boolean	False		Boolean value for a template project.
TodolistsAppUrl	String	True		The todolists app URL.
TodolistsCompletedCount	Integer	True		The todolists completed count.
TodolistsRemainingCount	Integer	True		The todolists remaining count.
TodolistsUpdatedAt	Datetime	True		Time when todolists were updated.
TodolistsUrl	String	True		The todolists URL.
TopicsAppUrl	String	True		The topics app URL.
TopicsCount	Integer	True		The topics count.
TopicsUpdatedAt	Datetime	True		Time when topics were updated.
TopicsUrl	String	True		The topics URL.
Trashed	Boolean	False		Boolean value for a trashed project.
UpdatedAt	Datetime	True		Time when the project was updated.
URL	String	True		The URL of the project.

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.

Basecamp Connector for CData Sync Views

Name	Description
Attachments	Retrieve Attachments on Basecamp.
Comments	Retrieve, create, update, and delete Calendars on Basecamp.
Events	Retrieve activity Events on Basecamp.
Forwards	Retrieve Forwards on Basecamp.
ToDoLists	Retrieve ToDoLists on Basecamp.
ToDos	Retrieve ToDos on Basecamp.
Topics	Retrieve Topics on Basecamp.

Retrieve Attachments on Basecamp.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the attachment.
Key	String		The key of the attachment.
Name	String		The name of the attachment.
ByteSize	Int		The size of the attachment in bytes.
CreatedAt	Datetime		The date when the attachment was created.
UpdatedAt	Datetime		The date when the attachment was last updated.
Url	String		The Url of the attachment.
AppUrl	String		The AppUrl of the attachment.
ThumbnailUrl	String		The Thumbnail Url of the attachment.
Private	Boolean		Indicates if the attachemtn is private.
Trashed	Boolean		Indicates if the attachment is trashed.
Tags	String		The tags of the attachment.
CreatorId	String		The Id of the attachment creator.
CreatorName	String		The name of the attachment creator.
CreatorAvatarUrl	String desc=
CreatorFullsizeAvatarUrl	String desc=
AttachableId	String		The Id of the attachable.
AttachableType	String		The type of the attachable.
AttachableUrl	String		The Url of the attachable.
AttachableAppUrl	String		The AppUrl of the attachable.

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
ProjectId	String		The id of the project

Retrieve, create, update, and delete Calendars on Basecamp.

Table Specific Information

Select

You can retrieve all active Comments on the platform, and any field of the table can filter the result.

SELECT * FROM Comments

SELECT * FROM Comments WHERE ProjectId = '1111111' AND ItemType = 'Message'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier for the comment.
ProjectId [KEY]	String		The unique identifier for the project where the comment is contained.
ItemId	String		The unique identifier for the topic containing the comment.
ItemType	String		Type of the object containing the comment. Valid values are: Message, Document, Forward, CalendarEvent, Upload, Todolist, Todo.
AttachmentsAggregate	String		The attachments related to the comment.
Content	String		The content of the comment.
Private	Boolean		Privacy of the comment
Trashed	Boolean		If the comment was trashed or not.
CreatedAt	Datetime		The date and time when the document was created.
CreatorAvatarUrl	String		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String		Creator full-size avatar Url.
CreatorId	String		The Id of the creator of the comment.
CreatorName	String		The name of the creator of the comment.
UpdatedAt	Datetime		The date and time when the comment was last updated.

Retrieve activity Events on Basecamp.

Table Specific Information

Select

You can retrieve all activity Events or filter data by the created date. The columns and operators supported by Basecamp as search criteria are shown below.

Column	Operators
ProjectId	=
PersonId	=
CreatedAt	>, >=

For example, the following query retrieves activity occurring after the specified date for the specified person:

SELECT * FROM Events WHERE CreatedAt >= '2016-01-01' AND PersonId = '1111111'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the event.
Action	String		The action description for the event.
BucketAppUrl	String		The calendar events app URL.
BucketColor	String		The bucket event color.
BucketId	String		The bucket event Id.
BucketName	String		The bucket event name.
BucketType	String		The bucket event type.
BucketUrl	String		The bucket event URL.
CreatedAt	Datetime		The date and time when the event was created.
CreatorAvatarUrl	String		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String		Creator full-size avatar URL.
CreatorId	String		The Id of the event creator.
CreatorName	String		The name of the event creator.
EventableAppUrl	String		Eventable App URL.
EventableId	String		Eventable Id.
EventableType	String		Eventable type.
EventableUrl	String		Eventable URL.
Excerpt	String		The type of excerpt for this event.
HtmlUrl	String		The HTML URL of the event.
Private	Boolean		Whether the event is private.
RawExcerpt	String		The raw excerpt type for this event.
Summary	String		The summary for the event.
Target	String		The target project of this event.
UpdatedAt	Datetime		The date and time when the event was last updated.
URL	String		The URL of the event.

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
ProjectId	String		The Id of the Project associated with this event.
PersonId	String		The Id of the Person associated with this event.

Retrieve Forwards on Basecamp.

Columns

Name	Type	References	Description
Id [KEY]	String		The id of the forward.
Subject	String		The subject of the forward.
From	String
CreatedAt	Datetime		The date when the forward was created.
UpdatedAt	Datetime		The date when the forward was last updated.
Url	String		The Url of the forward.
AppUrl	String		The AppUrl of the forward.
Private	Boolean		Indicates if the forward is private.
Trashed	Boolean		Indicates if the forward is trashed.
BucketId	String		The bucket Id of the forward.
BucketName	String		The bucket name of the forward.
BucketType	String		The bucket type of the forward.
BucketUrl	String		The bucket Url of the forward.
BucketAppUrl	String		The bucket app url of the forward.

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
ProjectId	String		The Id of the project

Retrieve ToDoLists on Basecamp.

Table Specific Information

Select

The following columns are supported by Basecamp as search criteria:

• ProjectId
• Id
• PersonId
• Completed
• Trashed
• CreatedAt

CreatedAt can be used with the '>' or '>=' operators.

The following query retrieves only completed ToDoLists belonging to a certain Project since a certain date.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND Completed = True AND CreatedAt > '2016-01-01'M

The following query retrieves a single ToDoList from a certain Project.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND Id = '123456789'

The following query retrieves ToDoLists that are assigned to a certain Person.

SELECT * FROM ToDoLists WHERE PersonId = '11111111'

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the topic.
AppUrl	String		The app URL.
AssignedTodos	String		Assigned to-dos.
BucketAppUrl	String		The topic bucket app URL.
BucketColor	String		The to-do bucket color.
BucketId	String		The to-do bucket Id.
BucketName	String		The to-do bucket name.
BucketType	String		The to-do bucket type.
BucketUrl	String		The to-do bucket URL.
Completed	Boolean		Whether the to-do list is completed.
CompletedCount	Integer		Number of completed to-dos.
CreatedAt	Datetime		The date and time when the record was created.
CreatorAvatarUrl	String		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String		Creator full-size avatar URL.
CreatorId	String		The Id of the creator.
CreatorName	String		The name of the creator.
Description	String		The to-do list description.
Name	String		The name of the to-do list.
Position	Integer		Position number of the current to-do list.
Private	Boolean		Whether the to-do list is private.
RemainingCount	Integer		Number of unfinished to-dos.
SubscribersId	String		The Id of the subscriber.
SubscribersName	String		The name of the subscriber.
ToDos	String		To-dos list.
Trashed	Boolean		Boolean value for deleted to-do lists.
UpdatedAt	Datetime		The date and time when the record was last updated.
URL	String		The URL of the to-do list.

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
ProjectId	String		The Id of the Project associated with the to-do list.
PersonId	String		The Id of the Person associated with the to-do list.

Retrieve ToDos on Basecamp.

Table Specific Information

Select

The following are columns supported as search criteria by Basecamp:

• ProjectId
• ToDoListId
• Id
• Completed
• Remaining
• Trashed
• DueAt
• DueOn

DueAt and DueOn can be used with the '>' or'>=' operators.

The following query retrieves only completed ToDos belonging to a certain Project.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND Completed = True

The following query filters ToDos that are due since a certain date.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND DueAt > '2016-01-01'

The following query lists the remaining ToDos that belong to a ToDo list.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '123456789' AND Remaining = true

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the topic.
AppUrl	String		The app URL.
AssigneeId	String		Id of the person assigned to.
AssigneeName	String		Name of the person assigned to.
AssigneeType	String		Type of assignee.
CommentsCount	Integer		Number of comments on this to-do.
Completed	Boolean		Whether the to-do is completed.
Content	String		Description of the to-do.
CreatedAt	Datetime		The date and time when the record was created.
CreatorAvatarUrl	String		Creator Avatar URL.
CreatorFullsizeAvatarUrl	String		Creator full-size avatar URL.
CreatorId	String		The Id of the creator.
CreatorName	String		The name of the creator.
DueAt	Datetime		The date and time when the to-do is set due.
DueOn	Datetime		The date and time when the to-do is set due.
Position	Integer		Position number of the current to-do on the list.
Private	Boolean		Whether this to-do is private.
Remaining	Boolean		Boolean value for remaining to-dos.
SubscribersId	String		The Id of the subscriber.
SubscribersName	String		The name of the subscriber.
ToDoList	String		To-do list.
ToDoListId	String		The to-do list Id.
Trashed	Boolean		Boolean value for deleted to-dos.
UpdatedAt	Datetime		The date and time when the record was last updated.
URL	String		The URL of the to-do.

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
ProjectId	String		The Id of the Project associated with the to-do.

Retrieve Topics on Basecamp.

Table Specific Information

Select

You can retrieve all active Topics, sort Topics that belong to a Project, or only list archived Topics (ProjectId and Archived are the only columns supported as search criteria by Basecamp).

SELECT * FROM Topics WHERE ProjectId = '1111111' ORDER BY UpdatedAt ASC

SELECT * FROM Topics WHERE ProjectId = '1111111' AND Archived = True

Columns

Name	Type	References	Description
Id [KEY]	String		The unique identifier of the topic.
Archived	Boolean		Boolean value for archived topics.
Attachments	Integer		The number of attachments to the topic.
BucketAppUrl	String		The topic bucket app URL.
BucketColor	String		The bucket topic color.
BucketId	String		The bucket topic Id.
BucketName	String		The bucket topic name.
BucketType	String		The bucket topic type.
BucketUrl	String		The bucket topic URL.
CreatedAt	Datetime		The date and time when the record was created.
Excerpt	String		The excerpt from the latest comment on the topic.
LastUpdaterId	String		The Id of the person who made the last comment.
LastUpdaterName	String		The name of the person who last updated the topic.
Private	Boolean		Whether the topic is private.
Title	String		The title of the topic.
TopicableAppUrl	String		The URL of the topicable Basecamp entity.
TopicableId	String		The Id of the topicable Basecamp entity.
TopicableType	String		The type of the topicable Basecamp entity.
TopicableUrl	String		The URL of the topicable Basecamp entity.
Trashed	Boolean		Boolean value for deleted topics.
UpdatedAt	Datetime		The date and time when the record 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
ProjectId	String		The Project Id.

This section documents the Tables, Views, and Stored Procedures available to connect to Basecamp 3 accounts.

The Sync App models the data in Basecamp into a list of tables that can be queried using standard SQL statements.

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

Basecamp Connector for CData Sync Tables

Name	Description
CalendarEvents	Retrieve calendar events on Basecamp 3.
Comments	Retrieve comments on a Basecamp 3 recording.
Documents	Retrieve, create, update, and delete Documents on Basecamp 3.
Messages	Retrieve messages on Basecamp 3.
Projects	Retrieve, create, update, and delete Projects on Basecamp 3.
ToDoLists	Retrieve ToDoLists on Basecamp 3.
ToDos	Retrieve ToDos on Basecamp 3.
Vaults	Retrieve Vaults(folders) on Basecamp 3 folders.

Retrieve calendar events on Basecamp 3.

Table Specific Information

You can query Calendar Events in the specified project.

Select

The following columns are supported as search criteria by Basecamp:

• ProjectId
• CalendarId
• Status (by default only active events are retrieved)

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM CalendarEvents WHERE ProjectId = '11111111' AND CalendarId = '22222222' AND Status = 'active'

You can also retrieve a single calendar event by specifying the Id.

SELECT * FROM CalendarEvents WHERE  ProjectId = '11111111' AND Id = '33333333'

Insert

You can insert a new Calendar Event by providing the ProjectId, CalendarId, StartsAt, EndsAt, and Summary as required parameters.

INSERT INTO CalendarEvents (ProjectId, CalendarId, Summary, StartsAt, EndsAt, Description, Notify, ParticipantsIds ) VALUES ( '1111111', '2222222', 'summary test', '2017-11-11 09:00Z', '2017-11-11 11:00Z', 'description', 'false', '3333333, 4444444')

Update

You can also change the Calendar Event by providing the ProjectId and event Id.

UPDATE CalendarEvents SET Summary = 'Updated summary',  StartsAt =  '2017-11-12', EndsAt = '2017-11-12', AllDay = 'true' WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

Calendar Events cannot be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the calendar event.
ProjectId	Long	True	Projects.Id	The Project Id associated with the schedule.
CalendarId	Long	True	Projects.CalendarId	The Calendar Id that the event belongs to.
Status	String	True		The status of the calendar event.
Type	String	True		The type of the returned record.
CreatedAt	Datetime	True		The date and time when the calendar event was created.
UpdatedAt	Datetime	True		The date and time when the calendar event was last updated.
Description	String	False		Provided description for the calendar event.
AllDay	Boolean	False		Indicates that the event is an all day event.
StartsAt	Datetime	False		The date and time when the calendar event starts.
EndsAt	Datetime	False		The date and time when the calendar event ends.
Summary	String	False		Provided summary for the calendar event.
ParticipantsIds	String	False		A list of comma separated participant ids.
ParticipantsNames	String	True		A list of comma separated participant names.
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
BucketName	String	True		Name of the containing bucket.
BucketType	String	True		Type of the containing bucket.
CreatorId	Long	True	People.Id	The Id of the creator.
CreatorName	String	True		The name of the creator.
CommentsCount	Integer	True		Number of comments the document has.

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
Notify	String	When set to true, will notify the participants about the event.

Retrieve comments on a Basecamp 3 recording.

Table Specific Information

Select

The columns in Comments are filtered client side. You can either get all comments for a recording by specifying the RecordingId or you can get a certain comment by specifying its Id.

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Comments WHERE ProjectId = '11111111' AND RecordingId = '222222222' AND Content = 'Exempli gratia' AND CreatedAt < '2017-04-18T15:53:38.040-06:00'

You can also retrieve a single comment by specifying the Id (given that you've specified the ProjectId in the connection)

SELECT * FROM Comments WHERE Id = '1234567'

Insert

You can insert a new comment, by providing the required ProjectId, RecordingId, and Content.

INSERT INTO Comments (Content, ProjectId, RecordingId) VALUES ('Very informative document. Thanks!', 114857506, 392946856)

Update

You can change the columns that are not read-only by providing the Id, ProjectId, and new values.

UPDATE Comments SET Content='I like this better now' WHERE ProjectId='18061798' AND Id='1308746423'

Delete

Comments cannot be deleted (unsupported by the API).

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The ID of the comment.
Content	String	False		The conent of the comment.
Title	String	True		The title of the comment.
Status	String	True		The status of the comment.
CreatedAt	Datetime	True		The time the comment was created.
UpdatedAt	Datetime	True		The time the comment was last updated.
InheritsStatus	Boolean	True		Whether this comment inherits its status or not.
URL	String	True		The URL of the comment.
VisibleToClients	Boolean	True		Whether this comment is visible to clients or not.
ProjectId	Long	False	Projects.Id	The ID of the project this comment is a child of. A project contains recordings.
ProjectName	String	True		The name of the project this comment is a child of.
RecordingId	Long	False	Recordings.Id	The ID of the recording the comment is written on. A recording can be a comment, document, message, question::answer, schedule::entry, todo, todolist or upload.
CommenterId	String	True		The ID of the commenter.
CommenterName	String	True		The name of the commenter.
CommenterIsAdmin	Boolean	True		Whether the commenter is an admin or not.
CommenterIsOwner	Boolean	True		Whether the commenter is the owner of the recording or not.
CommenterTitle	String	True		The commenter's title.
CommenterEmail	String	True		The email address of the commenter.
CommenterAvatarURL	String	True		The URL of the avatar of the commenter.
CommenterCompanyId	String	True		The company ID of the commenter.
CommenterCompanyName	String	True		The name of the company of the commenter.
AppURL	String	True		The URL of the app this comment belongs to.
BookmarkURL	String	True		The URL of the bookmark.
CommenterAttachableSGID	String	True		Te attachable SGID of the commenter.

Retrieve, create, update, and delete Documents on Basecamp 3.

Table Specific Information

Select

You can retrieve all documents belonging to a certain Project and Vault only, or specify a Project and a certain Document at the same time (ProjectId, VaultId and Id are the only columns supported as search criteria by Basecamp).

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Documents WHERE ProjectId = '11111111' AND VaultId = '222222222'

SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'

Insert

To add a new document to a major project, you need to specify the ProjectId, Vaultid, Title, Content, and Status (optional).

INSERT INTO Documents (ProjectId, Vaultid, Title, Content, Status) VALUES ('11111111', '222222222', 'Memo', 'This is our document content', 'active')

Update

Specify the ProjectId and the document Id to update a document.

UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

DELETE is not supported for this table.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier for the document.
ProjectId	Long	True	Projects.Id	The Id of the Project associated with the document.
VaultId	Long	True	Vaults.Id	The Vault Id associated with the document.
Status	String	False		The status of the vault.
Title	String	False		The title of the document.
Content	String	False		The content of the Document
Type	String	True		The type of the returned record.
CreatedAt	Datetime	True		The date and time when the document was created.
UpdatedAt	Datetime	True		The date and time when the document was last updated.
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
BucketName	String	True		Name of the containing bucket.
BucketType	String	True		Type of the containing bucket.
CreatorId	Long	True	People.Id	The Id of the creator.
CreatorName	String	True		The name of the creator.
CommentsCount	Integer	True		Number of comments the document has.

Retrieve messages on Basecamp 3.

Table Specific Information

You can query messages posted on the message board of the specified project.

Select

The columns supported as search criteria by Basecamp are ProjectId, MessageBoardId.

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Messages WHERE ProjectId = '11111111' AND MessageBoardId = '22222222'

You can also retrieve a single message by specifying the Id.

SELECT * FROM Messages WHERE  ProjectId = '11111111' AND Id = '33333333'

Insert

You can insert a new message, by providing the required ProjectId, MessageBoardId, and Subject in addition to the message related parameters.

INSERT INTO Messages (ProjectId, MessageBoardId, Content, Subject, Status ) VALUES ('1111111', '2222222', 'Content test', 'Subject test',  'active')

Update

You can also update messages by providing the ProjectId and message Id.

UPDATE Messages SET subject = 'Updated subject', content = 'Updated content'  WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

Messages cannot be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the message.
ProjectId	Long	True	Projects.Id	The Project Id associated with the schedule.
MessageBoardId	Long	True	Projects.MessageBoardId	The Message Board Id that the message belongs to.
Status	String	False		The status of the message
Type	String	True		The type of the returned record.
CreatedAt	Datetime	True		The date and time when the message was created.
UpdatedAt	Datetime	True		The date and time when the message was last updated.
Content	String	False		Provided content for the message
Subject	String	False		Subject of the message
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
BucketName	String	True		Name of the containing bucket.
BucketType	String	True		Type of the containing bucket.
CreatorId	Long	True	People.Id	The Id of the creator.
CreatorName	String	True		The name of the creator.
CategoryId	Long	False		The Id of the category.
CategoryName	String	True		The name of the category.
CommentsCount	Integer	True		Number of comments the document has.

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
IncludeReplies	Boolean	Set this to true to retrieve replies for each message.

Retrieve, create, update, and delete Projects on Basecamp 3.

Table Specific Information

Select

You can retrieve all active Projects from the organization, or set a project Id to retrieve a single project. Id is the only column supported as search criteria by Basecamp.

SELECT * FROM Projects
SELECT * FROM Projects WHERE Id = '11111111'

Insert

Specify at least the Name and optionally Description properties to create a new Project.

INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')

Update and Delete

Set the Project Id to update or delete a project you have access to.

UPDATE Projects SET Name = 'Updated Project', Description = 'This is an updated test project.' WHERE Id = '11111111'

DELETE FROM Projects WHERE Id = '11111111'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the project.
Status	String	True		The status of the project.
Purpose	String	True		The purpose of the project.
CreatedAt	Datetime	True		The creation time of the project.
UpdatedAt	Datetime	True		Time when the project was updated.
Description	String	False		The description of the project.
Name	String	False		The name of the project.
Bookmarked	Boolean	False		Boolean value for a bookmarked project.
CalendarId	Long	True		Id of the project's Calendar.
ChatId	Long	True		Id of the project's Chat.
ToDoSetId	Long	True		Id of the project's ToDo Set.
MessageBoardId	Long	True		Id of the project's Message Board.
QuestionnaireId	Long	True		Id of the project's Questionnaire.
VaultId	Long	True		Id of the project's Vault.
InboxId	Long	True		Id of the project's Inbox.
KanbanBoardId	Long	True		Id of the project's Kanban Board.

Retrieve ToDoLists on Basecamp 3.

Table Specific Information

Select

The following columns are supported by Basecamp as search criteria:

• ProjectId
• ToDoSetId and Status
• ProjectId and Id

ToDoSetId can be retrieved in the Projects table.

The following query retrieves only completed to-do lists belonging to a certain Project and a certain Status. If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ToDoSetId = '2222222' AND Status = 'active'

The following query retrieves a single ToDoList from a certain Project.

SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND Id = '123456789'

Insert

Specify the Name, ProjectId, Description (optional), and the ToDoSetId to insert a to-do list.

INSERT INTO ToDoLists (Name, Description, ProjectId, ToDoSetId ) VALUES ('Name', 'desc', '11111111', '2222222')

Update

Basecamp allows changing the name and description of the to-do list, provided that the ProjectId and to-do list Id are included in the query:

UPDATE ToDoLists Set Name = 'Updated Name', Description = 'Updated desc' WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

To-do lists cannot be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the topic.
ProjectId	Long	True	Projects.Id	The Id of the Project associated with the to-do list.
ToDoSetId	Long	True	Projects.ToDoSetId	The Id of the To Do Set the to-do list belongs to.
Status	String	True		The to-do status.
Type	String	True		The record type.
Name	String	False		The to-do name.
Completed	Boolean	True		The to-do state.
CompletedRatio	String	True		The to-do state in ratio.
Description	String	False		The to-do list description.
CreatedAt	Datetime	True		The date and time when the event was created.
UpdatedAt	Datetime	True		The date and time when the record was last updated.
BucketName	String	True		The to-do list bucket name.
BucketType	String	True		The to-do list bucket type.
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
CreatorId	Long	True	People.Id	Event creator Id.
CreatorAttachableSgid	String	True		Event creator Attachable SGID.
CreatorName	String	True		Event creator Name.
CreatorEmailAddress	String	True		Event creator Email Address.
CreatorTitle	String	True		Event creator Title.
CreatorBio	String	True		Event creator Bio.
CreatorCreatedAt	Datetime	True		Event creator creation date and time.
CreatorUpdatedAt	Datetime	True		Event creator update date and time.
CreatorAdmin	Boolean	True		Boolean indicationg if the event creator is an admin.
CreatorOwner	Boolean	True		Boolean indicationg if the event creator is an owner.
CreatorTimeZone	String	True		Event creator's timezone.
CreatorCompanyId	Long	True		Event creator's company Id.
CreatorCompanyName	String	True		Event creator's company name.
CommentsCount	Integer	True		Number of coments the document has.

Retrieve ToDos on Basecamp 3.

Table Specific Information

Select

The following columns are supported as search criteria by Basecamp:

• ProjectId
• ToDoListId
• Id
• Completed
• Status

By default, only active to-dos will be retrieved.

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '222222222' AND Status = 'active' AND Completed = True

You can also retrieve a single to-do by specifying the Id.

SELECT * FROM ToDos WHERE ProjectId = '11111111' AND Id = '33333333'

Insert

You can insert a new to-do by providing the required ProjectId, ToDoListId, and Content in addition to the to-do related parameters.

INSERT INTO ToDos (Content, Description , DueOn, StartsOn, AssigneeIds, ProjectId, ToDoListId ) VALUES ('What to do','description','2017-11-11', '2017-11-12' , '333333333','1111111111', '22222222')

Update

You can change the columns that are not read-only by providing the ProjectId, to-do Id, and new values.

UPDATE ToDos Set Content = 'Updated content' WHERE ProjectId = '11111111' AND Id = '1234567689'

You can change the Completed state of the to-do by providing the ProjectId and to-do Id. The Completed column can only be updated standalone, and other columns cannot be updated in the same query.

UPDATE ToDos Set Completed = True WHERE ProjectId = '11111111' AND Id = '1234567689'

Delete

To-dos cannot be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the todo.
ProjectId	Long	True	Projects.Id	The Id of the Project associated with the to-do list.
ToDoListId	Long	True	ToDoLists.Id	The Id of the To Do list the to-do belongs to.
Status	String	True		The state the todo.
CreatedAt	Datetime	True		The date and time when the event was created.
UpdatedAt	Datetime	True		The date and time when the record was last updated.
StartsOn	Date	False		The date and time when the todo should start.
DueOn	Date	False		The date and time when the todo is due.
CommentsCount	Integer	True		Number of coments the document has.
Description	String	False		The to-do list description.
Content	String	False		What to do.
AssigneesIds	String	False		List of assigned user Ids.
Completed	Boolean	False		The to-do state.
CompletedAt	Datetime	True		The tdate and time when the todo was completed.
CompletionCreatorId	String	True		The id of the user who completed the todo.
CompletionCreatorName	String	True		The name of the user who completed the todo.
BucketName	String	True		The to-do list bucket name.
BucketType	String	True		The to-do list bucket type.
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
CreatorId	Long	True	People.Id	Event creator Id.
CreatorAttachableSgid	String	True		Event creator Attachable SGID.
CreatorName	String	True		Event creator Name.
CreatorEmailAddress	String	True		Event creator Email Address.
CreatorTitle	String	True		Event creator Title.
CreatorBio	String	True		Event creator Bio.
CreatorCreatedAt	Datetime	True		Event creator creation date and time.
CreatorUpdatedAt	Datetime	True		Event creator update date and time.
CreatorAdmin	Boolean	True		Boolean indicationg if the event creator is an admin.
CreatorOwner	Boolean	True		Boolean indicationg if the event creator is an owner.
CreatorTimeZone	String	True		Event creator's timezone.
CreatorCompanyId	String	True		Event creator's company Id.
CreatorCompanyName	String	True		Event creator's company name.

Retrieve Vaults(folders) on Basecamp 3 folders.

Table Specific Information

All projects have a primary Vault (folder). Additional Vaults may be nested under the primary Vault or any child Vault.

Select

The columns supported as search criteria by Basecamp are ProjectId, VaultId, and Id. If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Vaults WHERE  ProjectId = '11111111' AND VaultId = '222222222'

You can also retrieve a single To-do by specifying the Id.

SELECT * FROM Vaults WHERE  ProjectId = '11111111' Id = '333333333'

Insert

You can insert a new Vault by providing the ProjectId, VaultId, and Title, which are required parameters.

INSERT INTO Vaults (Title, ProjectId, Vaultid) VALUES ('InsertedVault', '11111111', '222222222')

Update

You can update the Vault title by providing the ProjectId, VaultId, and the new title.

UPDATE Vaults SET Title = 'Updated title' WHERE ProjectId = '11111111' AND Id = '333333333'

Delete

Vaults cannot be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique identifier of the topic.
ProjectId	Long	True	Projects.Id	The Project Id associated with the vault.
Status	String	True		The status of the vault.
Title	String	False		The title of the returned record.
Type	String	True		The type of the returned record.
CreatedAt	Datetime	True		The date and time when the record was created.
UpdatedAt	Datetime	True		The date and time when the record was last updated.
ParentId	Long	True		Id of the parent.
ParentTitle	String	True		Title of the parent.
ParentType	String	True		Type of the parent.
BucketId	Long	True		Id of the containing bucket.
BucketName	String	True		Name of the containing bucket.
BucketType	String	True		Type of the containing bucket.
CreatorId	Long	True	People.Id	The Id of the creator.
CreatorName	String	True		The name of the creator.
DocumentsCount	Integer	True		Number of documents the vault contains.
UploadsCount	Integer	True		Number of uploads the vault contains.
VaultsCount	Integer	True		Number of vaults the vault contains.

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
VaultId	Long	The Vault Id that the record belongs to.

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.

Basecamp Connector for CData Sync Views

Name	Description
Assignments	Retrieve Assignments on Basecamp 3.
Calendars	Retrieve calendars on Basecamp 3.
Events	Retrieve activity Events on Basecamp 3.
People	Retrieve People on Basecamp 3.
ProjectTools	Retrieve project tools on Basecamp 3.
Recordings	Retrieve recordings on Basecamp 3 folders.
Uploads	Retrieve Uploads on Basecamp 3.

Retrieve Assignments on Basecamp 3.

Columns

Name	Type	References	Description
Id [KEY]	Long		The unique identifier for the person.
TodoListId	Long	ToDoLists.Id	The unique identifier for the todolist.
ProjectId	Long	Projects.Id	Use filter to retrieve active people on the project with the given ID.
Name	String		The name of the person.
Owner	Boolean		Boolean value to show if the current person is the account owner.
Admin	Boolean		Boolean value to show if the current person is an admin or not.
Title	String		The title of the person.
Bio	String		Bio description of the person.
CreatedAt	Datetime		The date and time when the record was created.
UpdatedAt	Datetime		The date and time when the record was last updated.
EmailAddress	String		The email address of the person.
AttachableSgid	String		The attachable Set Group ID.
PersonableType	String		Type of the person.
TimeZone	String		Human readable timezone for the user.
CompanyId	Long		Id of users company.
CompanyName	String		Name of users company.

Retrieve calendars on Basecamp 3.

Table Specific Information

There is only one Calendar (Schedule) in each Basecamp project.

Select

Retrieve more detail on a specific Calendar (ProjectId and Id are the only columns supported as search criteria by Basecamp). If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Calendars WHERE ProjectId = '111111111' AND Id = '123456789'

Columns

Name	Type	References	Description
Id [KEY]	Long	Projects.CalendarId	The unique identifier of the calendar.
ProjectId	Long	Projects.Id	The Project Id associated with the calendar.
Status	String		The status of the calendar.
Type	String		The type of the returned record.
CreatedAt	Datetime		The date and time when the calendar was created.
UpdatedAt	Datetime		The date and time when the calendar was last updated.
Title	String		Title of the calendar.
EntriesCount	Integer		Number of calendar events.
BucketId	Long		Id of the containing bucket.
BucketName	String		Name of the containing bucket.
BucketType	String		Type of the containing bucket.
CreatorId	Long	People.Id	The Id of the creator.
CreatorName	String		The name of the creator.

Retrieve activity Events on Basecamp 3.

View Specific Information

An event is created any time a recording changes.

Select

You can retrieve all activity Events in the specified project and recording. The columns supported as search criteria by Basecamp are ProjectId and RecordingId.

If ProjectId is not specified in the query, the default ProjectId will be used.

SELECT * FROM Events WHERE ProjectId = '1111111' AND RecordingId = '22222222'

Columns

Name	Type	References	Description
Id [KEY]	Long		The unique identifier of the event.
ProjectId	Long	Projects.Id	The Id of the Project associated with the document.
RecordingId	Long	Recordings.Id	The Id of the Recording associated with this event.
Action	String		The action description for the event.
Details	String		Details on the event.
CreatedAt	Datetime		The date and time when the event was created.
CreatorId	Long	People.Id	Event creator Id.
CreatorAttachableSgid	String		Event creator Attachable SGID.
CreatorName	String		Event creator Name.
CreatorEmailAddress	String		Event creator Email Address.
CreatorTitle	String		Event creator Title.
CreatorBio	String		Event creator Bio.
CreatorCreatedAt	Datetime		Event creator creation date and time.
CreatorUpdatedAt	Datetime		Event creator update date and time.
CreatorAdmin	Boolean		Boolean indicationg if the event creator is an admin.
CreatorOwner	Boolean		Boolean indicationg if the event creator is an owner.
CreatorTimeZone	String		Event creator's timezone.
CreatorCompanyId	Long		Event creator's company Id.
CreatorCompanyName	String		Event creator's company name.

Retrieve People on Basecamp 3.

View Specific Information

Select

Retrieve all People visible to the current user, list people by Project, or specify an Id to get more information. Id and ProjectId are the columns supported by Basecamp as search criteria.

SELECT * FROM People

SELECT * FROM People WHERE Id = '123456789'

SELECT * FROM People WHERE ProjectId = '5168618'

Columns

Name	Type	References	Description
Id [KEY]	Long		The unique identifier for the person.
Name	String		The name of the person.
Owner	Boolean		Boolean value to show if the current person is the account owner.
Admin	Boolean		Boolean value to show if the current person is an admin or not.
Title	String		The title of the person.
Bio	String		Bio description of the person.
CreatedAt	Datetime		The date and time when the record was created.
UpdatedAt	Datetime		The date and time when the record was last updated.
EmailAddress	String		The email address of the person.
AttachableSgid	String		The attachable Set Group ID.
PersonableType	String		Type of the person.
TimeZone	String		Human readable timezone for the user.
CompanyId	Long		Id of users company.
CompanyName	String		Name of users company.

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
ProjectId	Long		Use filter to retrieve active people on the project with the given ID.

Retrieve project tools on Basecamp 3.

Table Specific Information

Select

No filters are supported server side for this table. All criteria will be handled client side within the Sync App.

For example, the following queries are processed server side:

	
	SELECT * FROM ProjectTools

Columns

Name	Type	References	Description
Id	Long		The id of the tool associated with the project.
Name	String		The name of the tool associated with the project.
AppUrl	String		The app url of the tool associated with this project.
Enabled	Boolean		Boolean value for a tool of the project.
Position	Int		The postion of the tool associated with this project.
Title	String		The title of the tool associated with this project.
Url	String		The url of the tool associated with this project.
ProjectId	Long		The unique identifier of the project.

Retrieve recordings on Basecamp 3 folders.

View Specific Information

Retrieve most of the data structures in the Basecamp 3, which are represented as "Recordings."

Select

The columns supported as search criteria by Basecamp are Type (required parameter), Bucket, and Status.

SELECT * FROM Recordings WHERE type = 'Upload' AND Bucket = '1111111, 22222222' AND Status = 'active'

Columns

Name	Type	References	Description
Id [KEY]	Long		The unique identifier of the topic.
Status	String		The status of the vault. The allowed values are active, archived, trashed.
Type	String		The type of the vault. The allowed values are Comment, Document, Message, Question::Answer, Schedule::Entry, Todo, Todolist, Upload.
CreatedAt	Datetime		The date and time when the event was created.
UpdatedAt	Datetime		The date and time when the event was last modified.
CreatorId	Long	People.Id	Event Creator.
CreatorName	String		Event Creator.

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
Bucket	String		Single or comma separated list of project IDs. Default: All active projects visible to the current user

Retrieve Uploads on Basecamp 3.

Columns

Name	Type	References	Description
Id [KEY]	Long		The unique identifier for the file uploaded.
ProjectId	Long	Projects.Id	The Id of the Project associated with the file uploaded.
VaultId	Long	Vaults.Id	The Vault Id associated with the file uploaded.
Status	String		The status of the vault.
Title	String		The title of the file uploaded.
ContentType	String		The content type of the file uploaded
Type	String		The type of the returned record.
CreatedAt	Datetime		The date and time when the file uploaded was created.
UpdatedAt	Datetime		The date and time when the file uploaded was last updated.
ParentTitle	String		Title of the parent.
ParentType	String		Type of the parent.
BucketName	String		Name of the containing bucket.
BucketType	String		Type of the containing bucket.
CreatorId	Long	People.Id	The Id of the creator.
CreatorName	String		The name of the creator.
CommentsCount	Integer		Number of comments the file uploaded has.
DownloadURL	String		Number of comments the file uploaded has.
ByteSize	Integer		Number of comments the file uploaded has.

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	The type of authentication to use when connecting to Basecamp.
Schema	Specify the Basecamp version to connect with.
User	Username of the currently authenticated user.
Password	Password of the currently authenticated user.
AccountId	Account Id of the currently authenticated user.
ProjectId	The Project Id 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	The type of authentication to use when connecting to Basecamp.
Schema	Specify the Basecamp version to connect with.
User	Username of the currently authenticated user.
Password	Password of the currently authenticated user.
AccountId	Account Id of the currently authenticated user.
ProjectId	The Project Id of the currently authenticated user.

The type of authentication to use when connecting to Basecamp.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• Basic: Set this to use BASIC user / password authentication.
• OAuth: Set to this to perform OAuth authentication.

Specify the Basecamp version to connect with.

Remarks

The schemas available are V2 (to use the Basecamp 2 API) andV3 (to use the Basecamp 3 API).

Username of the currently authenticated user.

Remarks

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

Password of the currently authenticated user.

Remarks

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

Account Id of the currently authenticated user.

Remarks

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

The Project Id of the currently authenticated user.

Remarks

The Project Id of the currently authenticated user. By default it will be set to the first Project Id of your projects list.

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

Note: Given that this Sync App supports multiple schemas, the structure for Basecamp custom schema files is as follows:

• Each schema is given a folder corresponding to that schema name.
• These schema folders are contained in a parent folder.
• The parent folder should be set as the Location, not an individual schema's folder.

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