Adding a Connection to Streak

To add a connection to Streak:

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

For required properties, see the Settings tab.

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

Use the BASIC Authentication standard to connect to Streak. BASIC Auth requires the authenticating user to interact with Streak using the browser. The Sync App facilitates this in various ways as described below.

Authenticate a Streak Account

A (BASIC) authentication key must be created for your Streak account.

• If Streak hasn't been fully installed, navigate to the Streak website and click Add to Chrome at the top of the page. Install the extension. Note that Google Chrome and Safari are the only browsers supported by Streak.
• In your Gmail inbox, click the Streak icon at the top of the page for a dropdown, and select Integrations.
• Under Integrations, navigate to Streak API section.
• Select Get API Key to retrieve the API Key from Streak.
• Set the ApiKey connection property to the retrieved API Key to connect to data.

This section details a selection of advanced features of the Streak 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 Streak 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.

Overview

This section shows the available API objects and provides more information on executing SQL to Streak APIs.

Key Features

• The Sync App models Streak entities like contacts, organizations, and tasks as relational views, allowing you to write SQL to query Streak data.
• Stored procedures allow you to execute operations to Streak, including adding contacts to a box.
• Live connectivity to these objects means any changes to your Streak account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model Contacts and Meetings.

Stored Procedures

Stored Procedures are function-like interfaces to Streak. Stored procedures allow you to execute operations to Streak, including adding contacts to box.

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

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

Streak Connector for CData Sync Views

Name	Description
Boxes	This call lets you get all boxes contained in the specified pipeline.
BoxesContacts	This call lists the contacts defined in a box.
BoxesOrganizations	This call lists the organizations defined in a box.
Comments	Retrieve comments.
Contacts	Retrieve contacts.
EmailFilters	Retrieves an array of email filters within a box.
Files	Retrieve Streak files from a specific box.
Meetings	Retrieve mettings for a specific box.
Newsfeeds	This endpoint will give you historical changes for boxes and pipelines. It is limited to the 50 most recent events.
Organizations	Retrieve organizations from Streak.
Pipelines	Gets list of pipelines and also retrive a single pipeline
Snippets	This call lets you get all the snippets for a user, also you can get a single snippet
Stages	This call gives you a specific stage defined in a pipeline.
Tasks	Retrieves tasks from Streak.
TeamMembers	Retrieve members of teams. Users can be on 0 or more teams.
Teams	Retrieve teams from Streak. Users can be on 0 or more teams.
Threads	Retrieve threads from Streak.
Users	Retrieve users details.
Webhooks	Retrieves webhoods from Streak.

This call lets you get all boxes contained in the specified pipeline.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Boxes are BoxKey and PipelineKey. For example:

SELECT * FROM Boxes WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuabphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

SELECT * FROM Boxes WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphdabvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'

Columns

Name	Type	References	Description
BoxKey [KEY]	String		Key of Box
LastSavedTimestamp	Timestamp		Time stamp saved last in ePoch format
PipelineKey	String	Pipelines.PipelineKey	Key of the pipeline the box is in
CreatorKey	String	Users.UserKey	Key of a creator
CreationTimestamp	Timestamp		Time stamp when box was created
LastUpdatedTimestamp	Timestamp		Timestamp of the last time the box was updated
LastStageChangeTimestamp	Timestamp		Time stamp when box was updated
TotalNumberOfEmails	Integer		Count of total number of emails
TotalNumberOfSentEmails	Integer		Count of total number of emails sent
TotalNumberOfReceivedEmails	Integer		Count of total number of emails received
Name	String		Name of the box found
Notes	String		Sample notes for description of box
AssignedToSharingEntries	String		Details of number of user assigned to
CreatorSharingEntry	String		Details of number of user created
FollowerSharingEntries	String		Details of number of user followers
FollowerKeys	String		Key of the followers of this box
LinkedBoxKeys	String		Any key linked to the particular box
EmailAddressesAutoExtracted	String		List of email which can be auto extracted
EmailAddressesBlacklist	String		List of email address which is blacklist by user
EmailAddresses	String		List of email addresses
TaskCompleteCount	Integer		Count of task which is completed
TaskIncompleteCount	Integer		Count of task which is incompleted
TaskOverdueCount	Integer		Count of task which is overdue
TaskAssigneeKeySet	String		List of key set the task is assigned to
OverdueTaskAssigneeKeySet	String		List of key set the overdue task is assigned to
IncompleteTaskAssigneeKeySet	String		List of key set the incomplete task is assigned to
TaskAssigneeSharingEntrySet	String		Set of users whom task is assigned to
OverdueTaskAssigneeSharingEntrySet	String		Set of users whom task is assigned to but overdue
IncompleteTaskAssigneeSharingEntrySet	String		Set of users whom task is assigned to but is incomplete
TaskTotal	Integer		List of total number of tasks
CallLogCount	Integer		List of call log count
MeetingNotesCount	Integer		List of meeting notes
TotalCallLogDuration	Integer		List of total call log duration
TotalMeetingNotesDuration	Integer		Lost of total meeting duration notes
FollowerCount	Integer		Count of number of followers
CommentCount	Integer		Count of number of comments
GmailThreadCount	Integer		Count of number of gmail threads
FileCount	Integer		Count of number of files
Fields	String		Number of fields
Freshness	Double		Amount of freshness
StageKey	String	Stages.StageKey	A unique identifier for the containing folder. Set this in the filter to retreive only files under the specified parent folder.

This call lists the contacts defined in a box.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for BoxesContacts is PipelineKey. For example:

SELECT * FROM BoxesContacts WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

Columns

Name	Type	References	Description
BoxKey	String	Boxes.BoxKey	Key of the box the contact is in.
ContactKey	String	Contacts.ContactKey	Key of the Contact.
IsAutoboxed	String		If the organization is auto boxed.
IsStarred	String		If the contact is starred or not.

This call lists the organizations defined in a box.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for BoxesOrganizations is PipelineKey. For example:

SELECT * FROM BoxesOrganizations WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA';

Columns

Name	Type	References	Description
BoxKey	String	Boxes.BoxKey	Key of the box the organization is in.
OrganizationKey	String	Organizations.OrganizationKey	Key of the Organization.
IsAutoboxed	String		If the organization is auto boxed.
IsStarred	Boolean		If the organization is starred.

Retrieve comments.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Comments is CommentKey. For example:

SELECT * FROM Comments WHERE CommentKey = 'agxzfm1haWxmb29nYWVyLabSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSB0NvbW1lbnQYgIDsyJ_29gsM'

Columns

Name	Type	References	Description
CommentKey [KEY]	String		Key of the comment.
BoxKey	String	Boxes.BoxKey	Box associated with the comment.
PipelineKey	String	Pipelines.PipelineKey	Pipeline associated with the comment.
CreatorKey	String	Users.UserKey	User that created the comment.
NewsfeedEntryKey	String	Newsfeeds.NewsfeedEntryKey	News feed entry key for this comment.
Timestamp	Timestamp		When this comment was created.
Message	String		The value of the comment.
LastSavedTimestamp	Timestamp		When the comment was last saved.

Retrieve contacts.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Contacts is ContactKey. For example:

SELECT * FROM Contacts WHERE ContactKey = 'VGVhbUNvbabhY3Qsfn5zdHJlYWtsb25naWR-fjYyMzUwNzEzOTk1MjY0MDA'

Columns

Name	Type	References	Description
ContactKey [KEY]	String	BoxesContacts.ContactKey	Key of the contact.
TeamKey	String	Teams.TeamKey	Key of the team.
GivenName	String		The contact's name.
FamilyName	String		The family name of the contact.
Other	String		Extra description for the contact.
Title	String		Title of contact.
EmailAddresses	String		List of email addresses for the contact.
PhoneNumbers	String		List of email phone numbers for the contact.
Addresses	String		List of addresses for the contact.
TwitterHandle	String		Link to the contact's twitter profile.
FacebookHandle	String		Link to the contact's facebook profile.
LinkedinHandle	String		Link to the contact's twitter profile.
PhotoUrl	String		URL to the profile picture of the contact.
OrgLinksKey	String		Organizations the contact is assocated with.
LastEnrichmentTimestamp	Datetime		When the contact was last enriched.
LastSavedUserKey	String	Users.UserKey	User who last saved the contact record.
CreatorKey	String	Users.UserKey	Creator of the contact record.
CreationDate	Datetime		Creation date for the contact record.
VersionTimestamp	Datetime		Datetime associated with this version of the contact.
LastSavedTimestamp	Datetime		When the contact record was last saved.

Retrieves an array of email filters within a box.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for EmailFilters is BoxKey. For example:

SELECT * FROM EmailFilters WHERE BoxKey = 'agxzfm1haWxmb29nYWabLAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'

Columns

Name	Type	References	Description
EmailFilterKey [KEY]	String		Key of the email filter.
CreatorKey	String	Users.UserKey	Key of the creator of the email filter.
BoxKey	String	Boxes.BoxKey	Box key.
Type	String		Type of email filter.
Value	String		Value of email filter.
Domain	String		The domain name.
CreationTimestamp	Timestamp		When the email filter was created.
LastSavedTimestamp	Timestamp		When the email filter was last saved.

Retrieve Streak files from a specific box.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Files are FileKey and BoxKey. For example:

SELECT * FROM Files WHERE FileKey = 'agxzfm1haWxmb29nYWVyLAsabE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBEZpbGUYgIDs8PiumAkM'

SELECT * FROM Files WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FabXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'

Columns

Name	Type	References	Description
FileKey [KEY]	String		Key of the file.
FileType	String		Type will be either GMAIL_API or DRIVE. GMAIL_API means the information was scraped from email attachments in a box. DRIVE means the user added a drive file to the box directly.
FileOwner	String	Users.UserKey	Each file comes from a particular email that was added to a box. This property is the key of the user that added the email to the box.
BoxKey	String	Boxes.BoxKey	Key of the box.
CreationTimestamp	Timestamp		When the file was created.
LastUpdatedTimestamp	Timestamp		When the file was last updated.
Size	String		The size of the file in bytes.
MimeType	String		The mime type of the file.
FileName	String		The filename with the extension.
MainFileName	String		The filename without the extension.
DriveUrl	String		Google drive URL of attachment.
DriveFileId	String		Google drive File Id of attachment.
DriveIconUrl	String		Google drive URL of Icon of attachment.
DriveOwnerId	String		Google drive Owner Id of attachment.
DriveBoxKey	String		Google drive Box key of attachment.
IsCurrentUserOwnerInDrive	Boolean		Whether the user is the owner of the file in google drive.
LastSavedTimestamp	Timestamp		When the file was last saved.

Retrieve mettings for a specific box.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Meetings is BoxKey. For example:

SELECT * FROM Meetings WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXabdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICsv6fs-ggM'

Columns

Name	Type	References	Description
MeetingKey [KEY]	String		Key of the meeting.
MeetingType	String		The type of meeting. This is either CALL_LOG or MEETING_NOTES.
BoxKey	String	Boxes.BoxKey	Key of the box.
PipelineKey	String	Pipelines.PipelineKey	Key of the pipeline.
OrgKey	String		It is a unique encrypted code that identifies the team that you are on.
CreatorKey	String	Users.UserKey	The key of the user who created the meeting. When creating from the API, this will be the userkey of the user whose API key is being used.
CreationDate	Timestamp		When the meeting was created.
StartTimestamp	Timestamp		When the meeting starts.
Duration	Integer		The duration of the meeting in milliseconds.
Notes	String		The unicode content of the meeting note or call log.
LastSavedTimestamp	Timestamp		When the meeting was last updated.

This endpoint will give you historical changes for boxes and pipelines. It is limited to the 50 most recent events.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Newsfeeds are BoxKey and PipelineKey. For example:

SELECT * FROM Newsfeeds WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICsv6fs-ggM' AND detailLevel = 'ALL'

SELECT * FROM Newsfeeds WHERE PipelineKey = 'agxzfm1haWxmb29nYWabMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

Columns

Name	Type	References	Description
NewsfeedItemKey [KEY]	String		The news feed item key.
NewsfeedEntryKey	String		The news feed entry key.
CreatorKey	String	Users.UserKey	The key of the user that created this newsfeed item.
Timestamp	Timestamp		When this event occurred.
NewsfeedEntryScope	String		What this event applies to - either a BOX or PIPELINE.
NewsfeedEntryOperation	String		Whether this event refers to a CREATE, UPDATE, or DELETE.
NewsfeedEntrySpecific	String		What specifically happened to cause this event.
SpecificVariablesAssignedTo	String		Member assigned to the particular newsfeed.
SpecificVariablesStoryAuthorDisplayName	String		Display name of the story author.
SpecificVariablesBoxName	String		Name of the box.
SpecificVariablesOldStageName	String		Name of an old stage.
SpecificVariablesLastStageChangeTimestamp	Timestamp		Last time the stage was chagned.
SpecificVariablesStageName	String		Name of the stage.
SpecificVariablesStageKey	String	Stages.StageKey	Key of the stage.
SpecificVariablesPipelineName	String		Name of the pipeline.
SpecificVariablesOldStageKey	String	Stages.StageKey	Key of the old stage.
BoxKey	String	Boxes.BoxKey	Key of the box.
PipelineKey	String	Pipelines.PipelineKey	Key of the pipeline.
Moved	Boolean		Whether the news feed is moved or not.
StoryTextGlobal	String		Global story text used for the news feed.
StoryTextPipeline	String		Pipeline story text used for the news feed.
StoryTextBox	String		Box story text used for the news feed.
UserText	String		A user entered description.
ExpandedUserText	String		Details like full name and email id of the user.
DetailText	String		A more detailed description.
UserImageUrl	String		URL of the user profile photo.
CollapsedEntries	String		List of collapsed entries.
LastSavedTimestamp	Timestamp		When the item was last saved.
detailLevel	String		This is similar to the specifics parameter but uses a predetermined set of specifics to filter on. The possible values for this parameter are ALL or CONDENSED. The CONDENSED value limits the results to only certain important specific parameters determined by Streak. The allowed values are ALL, CONDENSED.

Retrieve organizations from Streak.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Organizations is OrganizationKey. For example:

SELECT * FROM Organizations WHERE OrganizationKey = 'VGVhbU9yZ2FuaXphdGlvbix-fnN0cmVab2xvbmdpZH5-NDkyMjAwNDI3MDE1MzcyOA'

Columns

Name	Type	References	Description
OrganizationKey [KEY]	String	BoxesOrganizations.OrganizationKey	Key of the organization.
TeamKey	String	Teams.TeamKey	Key of the team.
Name	String		Full name of the organization.
Other	String		Extra information about the organization.
Domains	String		List of domains.
NormalizedDomains	String		List of domains normalized.
Industry	String		The industry of the organization.
PhoneNumbers	String		List of phone numbers.
Addresses	String		List of addresses.
EmployeeCount	String		Number of employees.
LogoURL	String		The logo URL.
TwitterHandle	String		The Twitter URL.
FacebookHandle	String		The Facebook URL.
LinkedinHandle	String		Linked-in Handle URL.
LastEnrichmentTimestamp	Timestamp		When the organizations was enriched.
ContactLinks	String		List of contact links.
LastSavedUserKey	String	Users.UserKey	Key of the user who last modified the organization.
CreatorKey	String	Users.UserKey	Key of the user who created the organization.
CreationDate	Timestamp		When the organization was created.
VersionTimestamp	Timestamp		Version of the time stamp.
LastSavedTimestamp	Timestamp		When the organization was last saved.

Gets list of pipelines and also retrive a single pipeline

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Pipelines is PipelineKey. For example:

SELECT * FROM Pipelines WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2abaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

Columns

Name	Type	References	Description
PipelineKey [KEY]	String		Key of the pipeline.
TeamKey	String	Teams.TeamKey	Key of the team.
CreatorKey	String	Users.UserKey	The user key of the user that created the pipeline.
Name	String		The name of this pipeline.
OrgWide	Boolean		Whether the organization is wide.
SharingRestrictedToOrg	Boolean		Whether the sharing is restricted to organization only or not.
TeamWide	Boolean		Whether this pipeline is shared with all users in the organization (same domain in email address).
SharingRestrictedToTeam	Boolean		Whether sharing is restricted to your team only or not.
StageOrder	String		Editable array which allows you to reorder the stages. This modifies the order of the stages that appear in the web UI.
StageColorTheme	String		Color theme of the stage.
CreationTimestamp	Timestamp		When the pipeline was created.
LastUpdatedTimestamp	Timestamp		When the pipeline was last updated.
CustomPermissionSets	String		Custom permission sets.
DefaultPermissionSetName	String		Default permission set name.
AclEntries	String		An array of ACL objects (with properties: fullName, email, isOwner, image) which determines a list of users who have access to this pipeline.
CreationSourceType	String		Source type used to create the pipeline.
BoxCountHint	Integer		Box count hint.
BoxCount	Integer		Number of boxes for this pipeline.
LastSavedTimestamp	Timestamp		When the pipeline was last saved.

This call lets you get all the snippets for a user, also you can get a single snippet

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Snippets is SnippetKey. For example:

SELECT * FROM Snippets WHERE SnippetKey = 'agxzfm1haWxmb29nYWVyLwsSDE9yZ2FuaXphdGlvbgvJY2RhdGEuY29tDAsSB1NuaXBwZXQYgIDsmPfxwAsM'

Columns

Name	Type	References	Description
SnippetKey [KEY]	String		Key of the snippet.
UserKey	String	Users.UserKey	The key of the user that created the snippet.
CreationDate	Timestamp		The date and time the snippet was created.
PipelineKey	String	Pipelines.PipelineKey	Key of the pipeline.
PartOfPipeline	Boolean		Whether this snippet is part of a pipeline or not.
SnippetText	String		The text of the snippet.
SnippetName	String		The name of the snippet.
SnippetKeyShortcut	String		Shortcut of the snippet key.
Subject	String		Subject of the snippets.
SnippetType	String		The type of the snippet, can be TEXT or HTML.
LastSavedTimestamp	Timestamp		When the snippet was last saved.

This call gives you a specific stage defined in a pipeline.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Stages are PipelineKey and StageKey. For example:

SELECT * FROM Stages WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSab9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

SELECT * FROM Stages WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJabRhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA' AND StageKey = '5001'

Columns

Name	Type	References	Description
StageKey [KEY]	String		Key of the stage.
PipelineKey	String	Pipelines.PipelineKey	The key of the pipeline.
Name	String		Name of the stage.
ForegroundColor	String		Foreground color of the stage.
BackgroundColor	String		Background color of the stage.
BoxCount	Integer		Number of boxes this stage is applied to.
IsColorFromTheme	Boolean		Whether the color is from a theme.

Retrieves tasks from Streak.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Tasks are TaskKey and BoxKey. For example:

SELECT * FROM Tasks WHERE TaskKey = 'agxzfm1haWxmb29nYWVabAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBFRhc2sYgIDs0NySvQsM'

SELECT * FROM Tasks WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphablvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'

Columns

Name	Type	References	Description
TaskKey [KEY]	String		Key of the task.
BoxKey	String	Boxes.BoxKey	The box the task is in.
PipelineKey	String	Pipelines.PipelineKey	The pipeline the task is in.
CreatorKey	String	Users.UserKey	The user who created the task.
CreationDate	Timestamp		When the task was created.
LastStatusChangeDate	Timestamp		When the status last changed.
DueDate	Timestamp		When the task is due and a reminder is sent.
SortOrder	String		Sort order of the task.
Text	String		The text of a task.
Status	String		Whether the task is DONE or NOT_DONE.
ReminderStatus	String		Gets the status of the reminder if this task has to be done. Can be: NONE, SCHEDULED, REMINDED or ERROR_ON_REMINDER.
AssignedToSharingEntries	String		Who the task is assigned to.
CreatorSharingEntry	String		User who created the sharing entries.
LastSavedTimestamp	Timestamp		When the task was last saved.

Retrieve members of teams. Users can be on 0 or more teams.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for TeamMembers is TeamKey. For example:

SELECT * FROM TeamMembers WHERE TeamKey = 'agxzfm1haWxmb29nYWVabQsSBFRlYW0YgICsv_OxuAoM'

Columns

Name	Type	References	Description
TeamKey [KEY]	String	Teams.TeamKey	Key of the team.
UserKey [KEY]	String	Users.UserKey	Key of the user on the team.
DisplayName	String		Display name of the team member.
FullName	String		Full name of the team member.
Role	String		Role of the team member.
InviteDate	Timestamp		When the member was invited.
InviteStatus	String		Status of the invitation.
OrgKey	String		It is a unique encrypted code that identifies the team that you are on.
Email	String		Email address for the team member.
Image	String		Url to an image of the member.

Retrieve teams from Streak. Users can be on 0 or more teams.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Teams is TeamKey. For example:

SELECT * FROM Teams WHERE TeamKey = 'agxzfm1haWxmb29nYWVyEabSBFRlYW0YgICsv_OxuAoM'

Columns

Name	Type	References	Description
TeamKey [KEY]	String		Key of the team.
Name	String		Name of the team.
CreationDate	Timestamp		When the team was created.
Creator	String		The creator of the team.
PlanInstanceKey	String		Key of the instance plan.
PlanInstance	String		Name of the instance plan.
SharingRestrictedToTeam	Boolean		Whether sharing is restricted to this team or not.
LastSavedTimestamp	Timestamp		When the team record was last saved.

Retrieve threads from Streak.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Threads are BoxKey and ThreadKey. For example:

SELECT * FROM Threads WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9ab2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'

SELECT * FROM Threads WHERE ThreadKey = 'agxzfm1haWxab29nYWVyMwsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSC0dtYWlsVGhyZWFkGICAnP6JrfsJDA'

Columns

Name	Type	References	Description
ThreadKey [KEY]	String		Key of the thread.
BoxKey	String	Boxes.BoxKey	Key of the box the thread is in.
CreatorKey	String	Users.UserKey	Creator of the thread.
PipelineKey	String	Pipelines.PipelineKey	Pipeline the thread is in.
CreationTimestamp	Timestamp		When the thread was created.
LastUpdatedTimestamp	Timestamp		When the thread was updated.
LastEmailTimestamp	Timestamp		Datetime of the last email in the thread.
LastEmailFrom	String		Email address of last email.
NumberOfEmails	Integer		List of number of emails.
SenderEmailSendTimestampPairs	String		Whether the sender email can send timestamp pairs or not.
MessageSentTimestamps	String		When the message was sent.
Subject	String		The subject of the first email in the thread.
Names	String		The senders and recipients on the gmail thread.
EmailAddresses	String		The senders and recipients on the gmail thread.
ThreadGmailId	String		Gmail's key for the thread.
FileKeys	String		List of file keys, such as attachments in the thread.
GmailThreadKey	String		Key of Gmail thread.
LastSavedTimestamp	Timestamp		When the thread was saved last.

Retrieve users details.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Users is UserKey. For example:

SELECT * FROM Users WHERE UserKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2abaXphdGlvbiIJY2RhdGEuY29tDAsSBFVzZXIYgICs35ruuwkM'

Columns

Name	Type	References	Description
UserKey [KEY]	String		Key of a user.
Email	String		The email address of the the user.
OrgKey	String		It is a unique encrypted code that identifies the team that you are on.
CreationTimestamp	Timestamp		When the user was created.
LastUpdatedTimestamp	Timestamp		When the user was last updated.
LastSeenTimestamp	Timestamp		When the user last logged into Streak.
TimezoneId	String		Id of current time zone.
UsedPlatforms	String		List of platforms that are being used.
GoogleProfileId	String		ID of the user's google profile.
GoogleProfilePhotoUrl	String		Profile Photo URL on the user's google profile.
GoogleProfileLink	String		Link to the user's google profile.
GoogleProfileFullName	String		Full Name on the user's google profile.
GoogleProfileFirstName	String		First Name on the user's google profile.
GoogleProfileLastName	String		Last Name on the user's google profile.
GoogleProfileGender	String		Gender on the user's google profile.
GoogleProfileLocale	String		Locale on the user's google profile.
GoogleAnalyticsClientId	String		Analytics Client Id on the user's google profile.
IsOauthComplete	Boolean		Whether the user has completed the OAuth process. Useful to determine whether they can successfully share emails.
DisplayName	String		A display friendly name, usually the users full name if it exists in their profile.
Experiments	String		List of experiments.
TourId	String		The tour id.
UserSettingsKey	String		Key to the user's settings information.
LastTrialLength	Integer		Length of a last trial.
OnTrialWithoutCreditCard	Boolean		Whether the trial is without credit card or not.
CanceledTrial	Boolean		Whether the trial is cancelled or not.
FirstOauthTimestamp	Timestamp		When the first OAuth connection was done.
WantsTaskDigestEmail	Boolean		Whether task digest email is required or not.
LastSavedTimestamp	Timestamp		When the user was last saved.

Retrieves webhoods from Streak.

Table Specific Information

Select

Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Webhooks are PipelineKey, TeamKey, and WebhookKey. For example:

SELECT * FROM Webhooks WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuabphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'

SELECT * FROM Webhooks WHERE TeamKey = 'agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICsv_OxuAoM'

SELECT * FROM Webhooks WHERE WebhookKey = 'agptYIDA'

Columns

Name	Type	References	Description
WebhookKey [KEY]	String		Key of the webhook.
PipelineKey	String	Pipelines.PipelineKey	Key of the pipeline the webhook is in.
CreationDate	Timestamp		Creation date of webhook.
Event	String		The type of webhook event.
LastSavedTimestamp	Timestamp		When the webhook was last saved.
TargetUrl	String		URL to POST the updated object to.
UserKey	String	Users.UserKey	User key assoicated with this webhook.
TeamKey	String	Teams.TeamKey	Team key associated with this webhook.

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
ApiKey	The required User Name of the role to use when authenticating.

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.
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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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
ApiKey	The required User Name of the role to use when authenticating.

The required User Name of the role to use when authenticating.

Remarks

Authenticating Provider Streak with ApiKey instead of "user"

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

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

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

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

Remarks

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

If left unspecified, the default location is "%APPDATA%\\CData\\Streak Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

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

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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

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

Note that the specified path is not embedded in quotation marks.