Establishing a Connection

Create a connection to Microsoft Project by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Microsoft Project icon is not available, click the Add More icon to download and install the Microsoft Project 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 Microsoft Project

In order to connect to the Microsoft Project data source, you will first need to specify the below connection properties.

Url: (Required) Set this to a valid Microsoft Project Web App URL. For example:
```
http://contoso.com/sites/pwa/
```
Schema: (Optional) There are two available schemas, "ODataV1" and "ODataV2". The "ODataV2" schema (default) can be used for full CRUD operations. However, for reporting purposes, the "ODataV1" schema is superior, since it provides more granular data and exposes the custom fields. See Data Model for more information about the available functionality in each Schema.
ProjectId: (Optional) If the "ODataV2" schema is specified, you can additionally set this property to a specific Project Id, in order to define the default project for all the operations that require one.

Authenticating to Project Online

There are several authentication methods available for connecting to Microsoft Project including the SharePoint Online Cookie Service to connect on SharePoint Online, OAuth and SSO. The supported SSO identity providers are: Azure Active Directory, OneLogin, and OKTA.

SharePoint Online Cookie Service

To connect to Microsoft Project on SharePoint Online using your login credentials, set the AuthScheme to SharePointOnlineCookies, the User and Password to your user credentials.

OAuth

To use the OAuth 2.0 authentication standard you should first create a custom OAuth app to obtain the OAuthClientId, OAuthClientSecret. In addition to those properties, set CallbackURL. See Using OAuth2 Authentication for more information.

You should set the AuthScheme to OAuth to enforce the OAuth Authentication scheme.

ADFS

Set the AuthScheme to ADFS. The following connection properties need to be set:

User: Set this to your ADFS username.
Password: Set this to your ADFS password.
SSOLoginURL: Set this to the login URL used by the SSO provider.

Below is an example connection string:

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';

ADFS Integrated

To use the ADFS Integrated flow, specify the SSOLoginURL and leave the username and password empty.

Okta

Set the AuthScheme to Okta. The following connection properties are used to authenticate through Okta:

User: Set to your Okta user.
Password: Set to your Okta password.
SSOLoginURL: Set to the login URL used by the SSO provider.

If you are:

using a trusted application or proxy that overrides the Okta client request
configuring MFA

then you need to use combinations of SSOProperties input parameters to authenticate using Okta. Otherwise, you do not need to set any of these values.

In SSOProperties when required, set these input parameters:

APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
MFAType: Set this if you have configured the MFA flow. Currently we support the following types: OktaVerify, Email, and SMS.
MFAPassCode: Set this only if you have configured the MFA flow. If you set this to empty or an invalid value, the Sync App issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
MFARememberDevice: Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the Sync App sends a device token to extend MFA authentication lifetime. This property is, by default, set to True. Set this to False only if you do not want MFA to be remembered.

Example connection string:

AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;

OneLogin

Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:

User: Set this to the OneLogin user.
Password: Set this to OneLogin password for the user.

The following SSOProperties are needed to authenticate to OneLogin:

OAuthClientId: Set to the OAuthClientId, which can be obtained by selecting Developers > API Credentials > Credential > ClientId.
OAuthClientSecret: Set to the OAuthClientSecret, which can be obtained by selecting Developers > API Credentials > Credential > ClientSecret.
Subdomain: Set to the subdomain of the OneLogin user accessing the SSO app. For example, if your OneLogin URL is splinkly.onelogin.com, enter splinkly as the subdomain value.
AppId: Set to the Id of the SSO app.
Region (optional): Set to the region your OneLogin account resides in. The OneLogin API operates in multiple regions and this property is used to find the correct domain. It can take one of the following values:
- US (default)
- EU

The following is an example connection string: The following connection string uses an API key to connect to OneLogin:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;SSOProperties='OAuthClientID=3fc8394584f153ce3b7924d9cd4f686443a52b;OAuthClientSecret=ca9257fd5cc3277abb5818cea28c06fe9b3b285d73d06;Subdomain=OneLoginSubDomain;AppId=1433920';

AzureAD

Set the AuthScheme to AzureAD. The following connection properties are used to connect to AzureAD:

Note that this configuration requires two AAD applications: the "Microsoft Project" application used for single sign-on, and a separate "connector" application with user_impersonation permission on the "Microsoft Project" application. You must also specify the OAuth connection properties:

OAuthClientId: The application Id of the connector application, listed in the Overview section of the app registration.
OAuthClientSecret: The client secret value of the connector application. Azure AD displays this when you create a new client secret.

The following SSOProperties are used to authenticate to AzureAD:

Resource: The application Id URI of the Microsoft Project application, listed in the Overview section of the app registration. In most cases this is the URL of your custom Microsoft Project domain.
AzureTenant: The Id of the Azure AD tenant where the applications are registered.

The following is an example connection string:

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;SSOProperties='Resource=';

CSOM Deprecation

There have been some changes made to the Sync App in the 2020 edition that should be taken into consideration.

CSOM Support Discontinued

Prior to the 2020 edition of the Sync App, connections to Microsoft Project using both the CSOM and OData interface were supported, which lead to difficulties in maintaining the two schemas concurrently.

By removing support for the CSOM, connections to Microsoft Project are streamlined due to the lack of special connection properties made specifically for each schema. Also, the OData interface can now perform all of the same CRUD operations that the CSOM is capable of. Lastly, the CSOM is poorly documented and more error-prone than OData.

For these reasons, the decision was made to deprecate support for the CSOM in favor of exclusively supporting the OData interface.

Advanced Features

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

SSL Configuration

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.

Firewall and Proxy

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.

Data Model

Overview

The CData Sync App models Microsoft Project objects as relational tables and views. A Microsoft Project object has relationships to other objects; in the tables, these relationships are expressed through foreign keys.

Connecting with the ODataV2 Schema

The ODataV2 Data Model (default) can be used for full CRUD operations. Main columns metadata is dynamically retrieved for each entity, but the schema is fixed and custom fields are not included.

Tables and Views describe a sample the tables available in the ODataV2 API.

Connecting with the ODataV1 Schema

The ODataV1 Data Model can only be used for reading data. Metadata is dynamically retrieved, including the custom fields for this schema.

Views describe a sample the views available in the ODataV1 API.

Key Features

The Sync App models Microsoft Project entities as relational tables and views, allowing you to write SQL to query Microsoft Project data.
Stored procedures allow you to execute operations to Microsoft Project.
Live connectivity to these objects means any changes to your Microsoft Project account are immediately reflected when using the Sync App.

ODataV2 Data Model

The ODataV2 schema implements the ProjectServer service endpoints, which has support for full CRUD operations.

Tables

Tables are retrieved dynamically from the authenticated Microsoft Project account.

Views

Read-only Views are retrieved dynamically from the authenticated Microsoft Project account.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Project. Stored procedures allow you to execute operations to Microsoft Project.

ODataV2 advantages compared to ODataV1

Supports write operations (INSERT, UPDATE and DELETE) on the exposed tables.

ODataV2 limitations

In order to query some tables and views, such as Assignments, ProjectResources, TaskLinks and Tasks, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.
The custom fields are not exposed.

Tables

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

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

Microsoft Project Connector for CData Sync Tables


Name	Description
Assignments	Retrieve and modify assignments.
Calendars	Retrieve and modify calendars.
EnterpriseResources	Retrieve and modify resources.
Phases	Retrieve and modify project phases.
ProjectResources	Retrieve and modify project resources.
Projects	Retrieve and modify projects.
Stages	Retrieve and modify project stages.
TaskLinks	Retrieve and modify task links.
Tasks	Retrieve and modify tasks.
TimeSheetLines	Retrieve and modify timesheets.
TimeSheets	Retrieve and modify timesheets.

Assignments

Retrieve and modify assignments.

Table Specific Information

To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.

SELECT * FROM Assignments WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	True		False
ActualCostWorkPerformed	Double	True		False
ActualOvertimeCost	Double	True		False
BaselineCost	Double	True		False
BaselineCostPerUse	Double	True		False
BaselineFinish	Datetime	True		False
BaselineStart	Datetime	True		False
BaselineWork	String	True		False
BaselineWorkMilliseconds	Int	True		False
BaselineWorkTimeSpan	Time	True		False
BudgetedCostWorkPerformed	Double	True		False
BudgetedCostWorkScheduled	Double	True		False
CostVariance	Double	True		False
CostVarianceAtCompletion	Double	True		False
Created	Datetime	True		False
CurrentCostVariance	Double	True		False
Finish	Datetime	True		False
FinishVariance	String	True		False
FinishVarianceMilliseconds	Int	True		False
FinishVarianceTimeSpan	Time	True		False
IsConfirmed	Bool	True		False
IsOverAllocated	Bool	True		False
IsPublished	Bool	True		False
IsResponsePending	Bool	True		False
IsUpdateNeeded	Bool	True		False
LevelingDelay	String	True		False
LevelingDelayMilliseconds	Int	True		False
LevelingDelayTimeSpan	Time	True		False
Modified	Datetime	True		False
Notes	String	True		False
OvertimeCost	Double	True		False
RemainingCost	Double	True		False
RemainingOvertimeCost	Double	True		False
Resume	Datetime	True		False
ScheduleCostVariance	Double	True		False
Start	Datetime	True		False
StartVariance	String	True		False
StartVarianceMilliseconds	Int	True		False
StartVarianceTimeSpan	Time	True		False
Stop	Datetime	True		False
WorkContourType	Int	True		False
WorkVariance	String	True		False
WorkVarianceMilliseconds	Int	True		False
WorkVarianceTimeSpan	Time	True		False
LinkedCustomFields	String	False		False
ActualCost	Double	False		False
ActualFinish	Datetime	False		False
ActualOvertimeWork	String	False		False
ActualOvertimeWorkMilliseconds	Int	False		False
ActualOvertimeWorkTimeSpan	Time	False		False
ActualStart	Datetime	False		False
ActualWork	String	False		False
ActualWorkMilliseconds	Int	False		False
ActualWorkTimeSpan	Time	False		False
BudgetedCost	Double	False		False
BudgetedWork	String	False		False
BudgetedWorkMilliseconds	Int	False		False
BudgetedWorkTimeSpan	Time	False		False
Cost	Double	False		False
CostRateTable	Int	False		False
DefaultBookingType	Int	False		False
Delay	String	False		False
DelayMilliseconds	Int	False		False
DelayTimeSpan	Time	False		False
IsLockedByManager	Bool	False		False
IsWorkResource	Bool	False		False
OvertimeWork	String	False		False
OvertimeWorkMilliseconds	Int	False		False
OvertimeWorkTimeSpan	Time	False		False
PercentWorkComplete	Int	False		False
RegularWork	String	False		False
RegularWorkMilliseconds	Int	False		False
RegularWorkTimeSpan	Time	False		False
RemainingOvertimeWork	String	False		False
RemainingOvertimeWorkMilliseconds	Int	False		False
RemainingOvertimeWorkTimeSpan	Time	False		False
RemainingWork	String	False		False
RemainingWorkMilliseconds	Int	False		False
RemainingWorkTimeSpan	Time	False		False
ResourceCapacity	Double	False		False
ResourceId	String	False		False
TaskId	String	False		False
Work	String	False		False
WorkMilliseconds	Int	False		False
WorkTimeSpan	Time	False		False
LinkedOwner	String	False		False
LinkedParent	String	False		False
LinkedResource	String	False		False
LinkedTask	String	False		False
ProjectId [KEY]	String	True		False	Id of the parent.

Calendars

Retrieve and modify calendars.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	False		False
Created	Datetime	False		False
IsStandardCalendar	Bool	False		False
Modified	Datetime	False		False
Name	String	False		False
OriginalId	String	False		False
LinkedBaseCalendarExceptions	String	False		False

EnterpriseResources

Retrieve and modify resources.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	False		False
CanLevel	Bool	False		False
Code	String	False		False
CostAccrual	Int	False		False
CostCenter	String	False		False
Created	Datetime	False		False
DefaultBookingType	Int	False		False
Email	String	False		False
ExternalId	String	False		False
Group	String	False		False
HireDate	Datetime	False		False
HyperlinkName	String	False		False
HyperlinkUrl	String	False		False
Initials	String	False		False
IsActive	Bool	False		False
IsBudget	Bool	False		False
IsCheckedOut	Bool	False		False
IsGeneric	Bool	False		False
IsTeam	Bool	False		False
MaterialLabel	String	False		False
Modified	Datetime	False		False
Name	String	False		False
Phonetics	String	False		False
RequiresEngagements	Bool	False		False
ResourceIdentifier	Int	False		False
ResourceType	Int	False		False
TerminationDate	Datetime	False		False
LinkedAssignments	String	False		False
LinkedBaseCalendar	String	False		False
LinkedCostRateTables	String	False		False
LinkedCustomFields	String	False		False
LinkedDefaultAssignmentOwner	String	False		False
LinkedEngagements	String	False		False
LinkedResourceCalendarExceptions	String	False		False
LinkedSelf	String	False		False
LinkedTimesheetManager	String	False		False
LinkedUser	String	False		False
LinkedUserPermissions	String	False		False

Phases

Retrieve and modify project phases.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	False		False
Description	String	False		False
Name	String	False		False
LinkedStages	String	False		False

ProjectResources

Retrieve and modify project resources.

Table Specific Information

To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.

SELECT * FROM ProjectResources WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	True		False
ActualCost	Double	True		False
ActualCostWorkPerformed	String	True		False
ActualCostWorkPerformedMilliseconds	Int	True		False
ActualCostWorkPerformedTimeSpan	Time	True		False
ActualOvertimeCost	Double	True		False
ActualOvertimeWork	String	True		False
ActualOvertimeWorkMilliseconds	Int	True		False
ActualOvertimeWorkTimeSpan	Time	True		False
ActualWork	String	True		False
ActualWorkMilliseconds	Int	True		False
ActualWorkTimeSpan	Time	True		False
AvailableFrom	Datetime	True		False
AvailableTo	Datetime	True		False
BaselineCost	Double	True		False
BaselineWork	String	True		False
BaselineWorkMilliseconds	Int	True		False
BaselineWorkTimeSpan	Time	True		False
BudetCostWorkPerformed	Double	True		False
BudgetedCost	Double	True		False
BudgetedCostWorkScheduled	Double	True		False
BudgetedWork	String	True		False
BudgetedWorkMilliseconds	Int	True		False
BudgetedWorkTimeSpan	Time	True		False
Cost	Double	True		False
CostVariance	Double	True		False
CostVarianceAtCompletion	Double	True		False
Created	Datetime	True		False
CurrentCostVariance	Double	True		False
Finish	Datetime	True		False
IsBudgeted	Bool	True		False
IsGenericResource	Bool	True		False
IsOverAllocated	Bool	True		False
Modified	Datetime	True		False
Notes	String	True		False
OvertimeCost	Double	True		False
OvertimeWork	String	True		False
OvertimeWorkMilliseconds	Int	True		False
OvertimeWorkTimeSpan	Time	True		False
PeakWork	String	True		False
PeakWorkMilliseconds	Int	True		False
PeakWorkTimeSpan	Time	True		False
PercentWorkComplete	Int	True		False
RegularWork	String	True		False
RegularWorkMilliseconds	Int	True		False
RegularWorkTimeSpan	Time	True		False
RemainingCost	Double	True		False
RemainingOvertimeCost	Double	True		False
RemainingOvertimeWork	String	True		False
RemainingOvertimeWorkMilliseconds	Int	True		False
RemainingOvertimeWorkTimeSpan	Time	True		False
RemainingWork	String	True		False
RemainingWorkMilliseconds	Int	True		False
RemainingWorkTimeSpan	Time	True		False
ScheduleCostVariance	Double	True		False
Start	Datetime	True		False
Work	String	True		False
WorkMilliseconds	Int	True		False
WorkTimeSpan	Time	True		False
WorkVariance	String	True		False
WorkVarianceMilliseconds	Int	True		False
WorkVarianceTimeSpan	Time	True		False
LinkedCustomFields	String	False		False
LinkedEnterpriseResource	String	False		False
CanLevel	Bool	False		False
Code	String	False		False
CostAccrual	Int	False		False
CostCenter	String	False		False
CostPerUse	Double	False		False
DefaultBookingType	Int	False		False
Email	String	False		False
Group	String	False		False
Initials	String	False		False
MaterialLabel	String	False		False
MaximumCapacity	Double	False		False
Name	String	False		False
OvertimeRate	Double	False		False
OvertimeRateUnits	Int	False		False
Phonetics	String	False		False
StandardRate	Double	False		False
StandardRateUnits	Int	False		False
LinkedAssignments	String	False		False
LinkedDefaultAssignmentOwner	String	False		False
ProjectId [KEY]	String	True		False	Id of the parent.

Projects

Retrieve and modify projects.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	True		False
ApprovedEnd	Datetime	True		False
ApprovedStart	Datetime	True		False
CalculateActualCosts	Bool	True		False
CalculatesActualCosts	Bool	True		False
CheckedOutDate	Datetime	True		False
CheckOutDescription	String	True		False
CheckOutId	String	True		False
CreatedDate	Datetime	True		False
CriticalSlackLimit	Int	True		False
DefaultFinishTime	Datetime	True		False
DefaultOvertimeRateUnits	Int	True		False
DefaultStandardRateUnits	Int	True		False
DefaultStartTime	Datetime	True		False
HasMppPendingImport	Bool	True		False
HonorConstraints	Bool	True		False
IsCheckedOut	Bool	True		False
LastPublishedDate	Datetime	True		False
LastSavedDate	Datetime	True		False
ListId	String	True		False
MoveActualIfLater	Bool	True		False
MoveActualToStatus	Bool	True		False
MoveRemainingIfEarlier	Bool	True		False
MoveRemainingToStatus	Bool	True		False
MultipleCriticalPaths	Bool	True		False
OptimizerDecision	Int	True		False
PercentComplete	Int	True		False
PlannerDecision	Int	True		False
ProjectSiteUrl	String	True		False
ProjectType	Int	True		False
SplitInProgress	Bool	True		False
SpreadActualCostsToStatus	Bool	True		False
SpreadPercentCompleteToStatus	Bool	True		False
SummaryTaskId	String	True		False
TaskListId	String	True		False
WebId	String	True		False
LinkedCheckedOutBy	String	False		False
LinkedCustomFields	String	False		False
LinkedEngagements	String	False		False
LinkedEnterpriseProjectType	String	False		False
LinkedPhase	String	False		False
LinkedProjectSummaryTask	String	False		False
LinkedQueueJobs	String	False		False
LinkedStage	String	False		False
LinkedUserPermissions	String	False		False
CurrencyCode	String	False		False
CurrencyDigits	Int	False		False
CurrencyPosition	Int	False		False
CurrencySymbol	String	False		False
CurrentDate	Datetime	False		False
DaysPerMonth	Int	False		False
DefaultEffortDriven	Bool	False		False
DefaultEstimatedDuration	Bool	False		False
DefaultFixedCostAccrual	Int	False		False
DefaultOvertimeRate	Double	False		False
DefaultStandardRate	Double	False		False
DefaultTaskType	Int	False		False
DefaultWorkFormat	Int	False		False
Description	String	False		False
FinishDate	Datetime	False		False
FiscalYearStartMonth	Int	False		False
MinutesPerDay	Int	False		False
MinutesPerWeek	Int	False		False
Name	String	False		False
NewTasksAreManual	Bool	False		False
NumberFiscalYearFromStart	Bool	False		False
OwnerId	String	False		False
ProjectIdentifier	String	False		False
ProtectedActualsSynch	Bool	False		False
ScheduledFromStart	Bool	False		False
ShowEstimatedDurations	Bool	False		False
StartDate	Datetime	False		False
StatusDate	Datetime	False		False
TrackingMode	Int	False		False
UtilizationDate	Datetime	False		False
UtilizationType	Int	False		False
WeekStartDay	Int	False		False
WinprojVersion	Decimal	False		False
LinkedAssignments	String	False		False
LinkedCalendar	String	False		False
LinkedIncludeCustomFields	String	False		False
LinkedOwner	String	False		False
LinkedProjectResources	String	False		False
LinkedTaskLinks	String	False		False
LinkedTasks	String	False		False

Stages

Retrieve and modify project stages.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	False		False
Behavior	Int	False		False
CheckInRequired	Bool	False		False
Description	String	False		False
Name	String	False		False
SubmitDescription	String	False		False
LinkedCustomFields	String	False		False
LinkedPhase	String	False		False
LinkedProjectDetailPages	String	False		False
LinkedWorkflowStatusPage	String	False		False

TaskLinks

Retrieve and modify task links.

Table Specific Information

To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.

SELECT * FROM TaskLinks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	True		False
DependencyType	Int	False		False
EndId	String	False		False
LinkLagDuration	String	False		False
StartId	String	False		False
LinkedEnd	String	False		False
LinkedStart	String	False		False
ProjectId [KEY]	String	True		False	Id of the parent.

Tasks

Retrieve and modify tasks.

Table Specific Information

To query this table, the ProjectId must be specified either in the query's WHERE clause criteria or via the ProjectId connection property.

SELECT * FROM Tasks WHERE ProjectId = '99a38309-dc1d-eb11-bf8a-00155d9c6312'

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	True		False
ActualCostWorkPerformed	Double	True		False
ActualDuration	String	True		False
ActualDurationMilliseconds	Int	True		False
ActualDurationTimeSpan	Time	True		False
ActualOvertimeCost	Double	True		False
ActualOvertimeWork	String	True		False
ActualOvertimeWorkMilliseconds	Int	True		False
ActualOvertimeWorkTimeSpan	Time	True		False
BaselineCost	Double	True		False
BaselineDuration	String	True		False
BaselineDurationMilliseconds	Int	True		False
BaselineDurationTimeSpan	Time	True		False
BaselineFinish	Datetime	True		False
BaselineStart	Datetime	True		False
BaselineWork	String	True		False
BaselineWorkMilliseconds	Int	True		False
BaselineWorkTimeSpan	Time	True		False
BudgetCost	Double	True		False
BudgetedCostWorkPerformed	Double	True		False
BudgetedCostWorkScheduled	Double	True		False
Contact	String	True		False
CostPerformanceIndex	Double	True		False
CostVariance	Double	True		False
CostVarianceAtCompletion	Double	True		False
CostVariancePercentage	Int	True		False
Created	Datetime	True		False
CurrentCostVariance	Double	True		False
DurationVariance	String	True		False
DurationVarianceMilliseconds	Int	True		False
DurationVarianceTimeSpan	Time	True		False
EarliestFinish	Datetime	True		False
EarliestStart	Datetime	True		False
EstimateAtCompletion	Double	True		False
ExternalProjectUid	String	True		False
ExternalTaskUid	String	True		False
FinishSlack	String	True		False
FinishSlackMilliseconds	Int	True		False
FinishSlackTimeSpan	Time	True		False
FinishVariance	String	True		False
FinishVarianceMilliseconds	Int	True		False
FinishVarianceTimeSpan	Time	True		False
FixedCostAccrual	Int	True		False
FreeSlack	String	True		False
FreeSlackMilliseconds	Int	True		False
FreeSlackTimeSpan	Time	True		False
IgnoreResourceCalendar	Bool	True		False
IsCritical	Bool	True		False
IsDurationEstimate	Bool	True		False
IsExternalTask	Bool	True		False
IsOverAllocated	Bool	True		False
IsRecurring	Bool	True		False
IsRecurringSummary	Bool	True		False
IsRolledUp	Bool	True		False
IsSubProject	Bool	True		False
IsSubProjectReadOnly	Bool	True		False
IsSubProjectScheduledFromFinish	Bool	True		False
IsSummary	Bool	True		False
LatestFinish	Datetime	True		False
LatestStart	Datetime	True		False
LevelingDelay	String	True		False
LevelingDelayMilliseconds	Int	True		False
LevelingDelayTimeSpan	Time	True		False
Modified	Datetime	True		False
Notes	String	True		False
OutlinePosition	String	True		False
OvertimeCost	Double	True		False
OvertimeWork	String	True		False
OvertimeWorkMilliseconds	Int	True		False
OvertimeWorkTimeSpan	Time	True		False
PercentWorkComplete	Int	True		False
PreLevelingFinish	Datetime	True		False
PreLevelingStart	Datetime	True		False
RegularWork	String	True		False
RegularWorkMilliseconds	Int	True		False
RegularWorkTimeSpan	Time	True		False
RemainingCost	Double	True		False
RemainingOvertimeCost	Double	True		False
RemainingOvertimeWork	String	True		False
RemainingOvertimeWorkMilliseconds	Int	True		False
RemainingOvertimeWorkTimeSpan	Time	True		False
RemainingWork	String	True		False
RemainingWorkMilliseconds	Int	True		False
RemainingWorkTimeSpan	Time	True		False
Resume	Datetime	True		False
ScheduleCostVariance	Double	True		False
ScheduledDuration	String	True		False
ScheduledDurationMilliseconds	Int	True		False
ScheduledDurationTimeSpan	Time	True		False
ScheduledFinish	Datetime	True		False
ScheduledStart	Datetime	True		False
SchedulePerformanceIndex	Double	True		False
ScheduleVariancePercentage	Int	True		False
StartSlack	String	True		False
StartSlackMilliseconds	Int	True		False
StartSlackTimeSpan	Time	True		False
StartVariance	String	True		False
StartVarianceMilliseconds	Int	True		False
StartVarianceTimeSpan	Time	True		False
Stop	Datetime	True		False
ToCompletePerformanceIndex	Double	True		False
TotalSlack	String	True		False
TotalSlackMilliseconds	Int	True		False
TotalSlackTimeSpan	Time	True		False
WorkBreakdownStructure	String	True		False
WorkVariance	String	True		False
WorkVarianceMilliseconds	Int	True		False
WorkVarianceTimeSpan	Time	True		False
LinkedCustomFields	String	False		False
LinkedSubProject	String	False		False
ActualCost	Double	False		False
ActualFinish	Datetime	False		False
ActualStart	Datetime	False		False
ActualWork	String	False		False
ActualWorkMilliseconds	Int	False		False
ActualWorkTimeSpan	Time	False		False
AddAfterId	String	False		False
BudgetWork	String	False		False
BudgetWorkMilliseconds	Int	False		False
BudgetWorkTimeSpan	Time	False		False
Completion	Datetime	False		False
ConstraintStartEnd	Datetime	False		False
ConstraintType	Int	False		False
Cost	Double	False		False
Deadline	Datetime	False		False
Duration	String	False		False
DurationMilliseconds	Int	False		False
DurationTimeSpan	Time	False		False
Finish	Datetime	False		False
FinishText	String	False		False
FixedCost	Double	False		False
IsActive	Bool	False		False
IsEffortDriven	Bool	False		False
IsLockedByManager	Bool	False		False
IsManual	Bool	False		False
IsMarked	Bool	False		False
IsMilestone	Bool	False		False
LevelingAdjustsAssignments	Bool	False		False
LevelingCanSplit	Bool	False		False
Name	String	False		False
OutlineLevel	Int	False		False
ParentId	String	False		False
PercentComplete	Int	False		False
PercentPhysicalWorkComplete	Int	False		False
Priority	Int	False		False
RemainingDuration	String	False		False
RemainingDurationMilliseconds	Int	False		False
RemainingDurationTimeSpan	Time	False		False
Start	Datetime	False		False
StartText	String	False		False
TaskType	Int	False		False
UsePercentPhysicalWorkComplete	Bool	False		False
Work	String	False		False
WorkMilliseconds	Int	False		False
WorkTimeSpan	Time	False		False
LinkedAssignments	String	False		False
LinkedCalendar	String	False		False
LinkedParent	String	False		False
LinkedPredecessors	String	False		False
LinkedStatusManager	String	False		False
LinkedSuccessors	String	False		False
ProjectId [KEY]	String	True		False	Id of the parent.

TimeSheetLines

Retrieve and modify timesheets.

Columns


Name	Type	ReadOnly	References	Required	Description
Id [KEY]	String	False		False
Comment	String	False		False
LineClass	Int	False		False
ProjectName	String	False		False
Status	Int	False		False
TaskName	String	False		False
TotalWork	String	False		False
TotalWorkMilliseconds	Int	False		False
TotalWorkTimeSpan	Time	False		False
ValidationType	Int	False		False
LinkedAssignment	String	False		False
LinkedTimeSheet	String	False		False
LinkedWork	String	False		False
PeriodId [KEY]	String	True		False	Id of the parent.

TimeSheets

Retrieve and modify timesheets.

Columns


Name	Type	ReadOnly	References	Required	Description
PeriodId [KEY]	String	False		False
Comments	String	False		False
EntryMode	Int	False		False
IsControlledByOwner	Bool	False		False
IsProcessed	Bool	False		False
Name	String	False		False
Status	Int	False		False
TotalActualWork	String	False		False
TotalActualWorkMilliseconds	Int	False		False
TotalActualWorkTimeSpan	Time	False		False
TotalNonBillableOvertimeWork	String	False		False
TotalNonBillableOvertimeWorkMilliseconds	Int	False		False
TotalNonBillableOvertimeWorkTimeSpan	Time	False		False
TotalNonBillableWork	String	False		False
TotalNonBillableWorkMilliseconds	Int	False		False
TotalNonBillableWorkTimeSpan	Time	False		False
TotalOvertimeWork	String	False		False
TotalOvertimeWorkMilliseconds	Int	False		False
TotalOvertimeWorkTimeSpan	Time	False		False
TotalWork	String	False		False
TotalWorkMilliseconds	Int	False		False
TotalWorkTimeSpan	Time	False		False
WeekStartsOn	Int	False		False
LinkedCreator	String	False		False
LinkedLines	String	False		False
LinkedManager	String	False		False
LinkedPeriod	String	False		False

Views

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.

Microsoft Project Connector for CData Sync Views


Name	Description
Assignment_Resource	Retrieve and modify assignments.
Assignment_Task	Retrieve and modify assignments.
Events	Retrieve events.
ProjectDetailPages	Retrieve project details.
StageDetailPages	Retrieve project details..
Tasks_Assignments	Retrieve and modify assignments.
Tasks_Calendar	Retrieve and modify assignments.
TimeSheetPeriods	Retrieve timesheet periods.

Assignment_Resource

Retrieve and modify assignments.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the table.
Name	String		The name of the association.
ProjectId	String		The project Id.
AssignmentId	String		The assignment Id.

Assignment_Task

Retrieve and modify assignments.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the table.
Name	String		The name of the association.
ProjectId	String		The project Id.
AssignmentId	String		The assignment Id.

Events

Retrieve events.

Columns


Name	Type	References	Description
Id [KEY]	Int
EventName	String
SourceName	String

ProjectDetailPages

Retrieve project details.

Columns


Name	Type	References	Description
Id [KEY]	String
Name	String
PageType	Int
LinkedItem	String

StageDetailPages

Retrieve project details..

Columns


Name	Type	References	Description
Id [KEY]	String
Name	String
PageType	Int
LinkedItem	String
StageId [KEY]	String		Id of the parent.

Tasks_Assignments

Retrieve and modify assignments.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the table.
ProjectId	String		The project Id.
TaskId	String		The task Id.

Tasks_Calendar

Retrieve and modify assignments.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the table.
Name	String		The name of the association.
ProjectId	String		The project Id.
TaskId	String		The task Id.

TimeSheetPeriods

Retrieve timesheet periods.

Columns


Name	Type	References	Description
Id [KEY]	String
End	Datetime
Name	String
Start	Datetime
LinkedTimeSheet	String

ODataV1 Data Model

The ODataV1 schema implement the ProjectData service endpoints, which is read-only and can only be used for reporting.

Views

Read-only Views are retrieved dynamically from the authenticated Microsoft Project account.

Stored Procedures

Stored Procedures are function-like interfaces to Microsoft Project. Stored procedures allow you to execute operations to Microsoft Project.

ODataV1 advantages compared to ODataV2

The custom fields are exposed as view columns.
The ProjectId is not required to query any of the exposed views, since the ProjectData endpoints return data for all the available projects.

ODataV1 limitations

No write operation is supported as this schema is read-only.

Views

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.

Microsoft Project Connector for CData Sync Views


Name	Description
AssignmentBaselines	Retrieve assignment baselines.
AssignmentBaselineTimephasedDataSet	Retrieve assignment baseline timephased dataset.
Assignments	Retrieve assignments.
AssignmentTimephasedDataSet	Retrieve assignment timephased dataset.
BusinessDriverDepartments	Retrieve business driver departments.
BusinessDrivers	Retrieve business drivers.
CostConstraintScenarios	Retrieve cost constraint scenarios.
CostScenarioProjects	Retrieve cost scenario projects.
Deliverables	Retrieve deliverables.
Engagements	Retrieve engagements.
EngagementsComments	Retrieve engagements comments.
EngagementsTimephasedDataSet	Retrieve engagements timephased dataset.
FiscalPeriods	Retrieve fiscal periods.
Issues	Retrieve issues.
IssueTaskAssociations	Retrieve issue-task associations.
PortfolioAnalyses	Retrieve portfolio analyses.
PortfolioAnalysisProjects	Retrieve portfolio analysis projects.
PrioritizationDriverRelations	Retrieve prioritization driver relations.
PrioritizationDrivers	Retrieve prioritization drivers.
Prioritizations	Retrieve prioritizations.
ProjectBaselines	Retrieve project baselines.
Projects	Retrieve projects.
ProjectWorkflowStageDataSet	Retrieve project workflow stage dataset.
ResourceConstraintScenarios	Retrieve resource constraint scenarios.
ResourceDemandTimephasedDataSet	Retrieve resource demand timephased dataset.
Resources	Retrieve resources.
ResourceScenarioProjects	Retrieve resource scenario projects.
ResourceTimephasedDataSet	Retrieve resource timephased dataset.
Risks	Retrieve risks.
RiskTaskAssociations	Retrieve risk task associations.
TaskBaselines	Retrieve task baselines.
TaskBaselineTimephasedDataSet	Retrieve task baseline timephased dataset.
Tasks	Retrieve tasks.
TaskTimephasedDataSet	Retrieve task timephased dataset.
TimeSet	Retrieve timeset.
TimesheetClasses	Retrieve timesheet classes.
TimesheetLineActualDataSet	Retrieve timesheet line actual dataset.
TimesheetLines	Retrieve timesheet lines.
TimesheetPeriods	Retrieve timesheet periods.
Timesheets	Retrieve timesheets.

AssignmentBaselines

Retrieve assignment baselines.

Columns

References Description String [KEY] Int [KEY] String Decimal Decimal Decimal Decimal Datetime Decimal Datetime Datetime Decimal Int String String String String String String String />


Name	Type style="white-space:nowrap">AssignmentId
BaselineNumber
ProjectId
AssignmentBaselineBudgetCost
AssignmentBaselineBudgetMaterialWork
AssignmentBaselineBudgetWork
AssignmentBaselineCost
AssignmentBaselineFinishDate
AssignmentBaselineMaterialWork
AssignmentBaselineModifiedDate
AssignmentBaselineStartDate
AssignmentBaselineWork
AssignmentType
ProjectName
TaskId
TaskName
LinkedAssignment
LinkedAssignmentBaselineTimephasedDataSet
LinkedProject
LinkedTask

AssignmentBaselineTimephasedDataSet

Retrieve assignment baseline timephased dataset.

Columns


Name	Type	References	Description
AssignmentId [KEY]	String
BaselineNumber [KEY]	Int
ProjectId [KEY]	String
TimeByDay [KEY]	Datetime
AssignmentBaselineBudgetCost	Decimal
AssignmentBaselineBudgetMaterialWork	Decimal
AssignmentBaselineBudgetWork	Decimal
AssignmentBaselineCost	Decimal
AssignmentBaselineMaterialWork	Decimal
AssignmentBaselineModifiedDate	Datetime
AssignmentBaselineWork	Decimal
FiscalPeriodId	String
ProjectName	String
ResourceId	String
TaskId	String
TaskName	String
LinkedAssignment	String
LinkedBaseline	String
LinkedProject	String
LinkedTasks	String
LinkedTime	String

Assignments

Retrieve assignments.

Columns


Name	Type	References	Description
AssignmentId [KEY]	String
ProjectId [KEY]	String
AssignmentActualCost	Decimal
AssignmentActualFinishDate	Datetime
AssignmentActualOvertimeCost	Decimal
AssignmentActualOvertimeWork	Decimal
AssignmentActualRegularCost	Decimal
AssignmentActualRegularWork	Decimal
AssignmentActualStartDate	Datetime
AssignmentActualWork	Decimal
AssignmentACWP	Decimal
AssignmentAllUpdatesApplied	Bool
AssignmentBCWP	Decimal
AssignmentBCWS	Decimal
AssignmentBookingDescription	String
AssignmentBookingId	Int
AssignmentBookingName	String
AssignmentBudgetCost	Decimal
AssignmentBudgetMaterialWork	Decimal
AssignmentBudgetWork	Decimal
AssignmentCost	Decimal
AssignmentCostVariance	Decimal
AssignmentCreatedDate	Datetime
AssignmentCreatedRevisionCounter	Int
AssignmentCV	Decimal
AssignmentDelay	Decimal
AssignmentFinishDate	Datetime
AssignmentFinishVariance	Decimal
AssignmentIsOverallocated	Bool
AssignmentIsPublished	Bool
AssignmentMaterialActualWork	Decimal
AssignmentMaterialWork	Decimal
AssignmentModifiedDate	Datetime
AssignmentModifiedRevisionCounter	Int
AssignmentOvertimeCost	Decimal
AssignmentOvertimeWork	Decimal
AssignmentPeakUnits	Decimal
AssignmentPercentWorkCompleted	Int
AssignmentRegularCost	Decimal
AssignmentRegularWork	Decimal
AssignmentRemainingCost	Decimal
AssignmentRemainingOvertimeCost	Decimal
AssignmentRemainingOvertimeWork	Decimal
AssignmentRemainingRegularCost	Decimal
AssignmentRemainingRegularWork	Decimal
AssignmentRemainingWork	Decimal
AssignmentResourcePlanWork	Decimal
AssignmentResourceType	Int
AssignmentStartDate	Datetime
AssignmentStartVariance	Decimal
AssignmentSV	Decimal
AssignmentType	Int
AssignmentUpdatesAppliedDate	Datetime
AssignmentVAC	Decimal
AssignmentWork	Decimal
AssignmentWorkVariance	Decimal
CostType_R	String
FlagStatus_T	Bool
Health_T	String
IsPublic	Bool
ProjectName	String
RBS_R	String
ResourceId	String
ResourceName	String
TaskId	String
TaskIsActive	Bool
TaskName	String
TimesheetClassId	String
TypeDescription	String
TypeName	String
LinkedBaseline	String
LinkedProject	String
LinkedResource	String
LinkedTask	String
LinkedTimephasedData	String

AssignmentTimephasedDataSet

Retrieve assignment timephased dataset.

Columns


Name	Type	References	Description
AssignmentId [KEY]	String
ProjectId [KEY]	String
TimeByDay [KEY]	Datetime
AssignmentActualCost	Decimal
AssignmentActualOvertimeCost	Decimal
AssignmentActualOvertimeWork	Decimal
AssignmentActualRegularCost	Decimal
AssignmentActualRegularWork	Decimal
AssignmentActualWork	Decimal
AssignmentBudgetCost	Decimal
AssignmentBudgetMaterialWork	Decimal
AssignmentBudgetWork	Decimal
AssignmentCombinedWork	Decimal
AssignmentCost	Decimal
AssignmentMaterialActualWork	Decimal
AssignmentMaterialWork	Decimal
AssignmentModifiedDate	Datetime
AssignmentOvertimeCost	Decimal
AssignmentOvertimeWork	Decimal
AssignmentRegularCost	Decimal
AssignmentRegularWork	Decimal
AssignmentRemainingCost	Decimal
AssignmentRemainingOvertimeCost	Decimal
AssignmentRemainingOvertimeWork	Decimal
AssignmentRemainingRegularCost	Decimal
AssignmentRemainingRegularWork	Decimal
AssignmentRemainingWork	Decimal
AssignmentResourcePlanWork	Decimal
AssignmentWork	Decimal
FiscalPeriodId	String
ProjectName	String
ResourceId	String
TaskId	String
TaskIsActive	Bool
TaskName	String
LinkedAssignment	String
LinkedProject	String
LinkedTask	String
LinkedTime	String

BusinessDriverDepartments

Retrieve business driver departments.

Columns


Name	Type	References	Description
BusinessDriverId [KEY]	String
DepartmentId [KEY]	String
BusinessDriverName	String
DepartmentName	String
LinkedBusinessDriver	String

BusinessDrivers

Retrieve business drivers.

Columns


Name	Type	References	Description
BusinessDriverId [KEY]	String
BusinessDriverCreatedDate	Datetime
BusinessDriverDescription	String
BusinessDriverIsActive	Bool
BusinessDriverModifiedDate	Datetime
BusinessDriverName	String
CreatedByResourceId	String
CreatedByResourceName	String
ImpactDescriptionExtreme	String
ImpactDescriptionLow	String
ImpactDescriptionModerate	String
ImpactDescriptionNone	String
ImpactDescriptionStrong	String
ModifiedByResourceId	String
ModifiedByResourceName	String
LinkedCreatedByResource	String
LinkedDepartments	String
LinkedModifiedByResource	String

CostConstraintScenarios

Retrieve cost constraint scenarios.

Columns


Name	Type	References	Description
ScenarioId [KEY]	String
AnalysisId	String
AnalysisName	String
CreatedByResourceId	String
CreatedByResourceName	String
CreatedDate	Datetime
ModifiedByResourceId	String
ModifiedByResourceName	String
ModifiedDate	Datetime
ScenarioDescription	String
ScenarioName	String
SelectedProjectsCost	Decimal
SelectedProjectsPriority	Double
UnselectedProjectsCost	Decimal
UnselectedProjectsPriority	Double
UseDependencies	Bool
LinkedAnalysis	String
LinkedCostScenarioProjects	String
LinkedCreatedByResource	String
LinkedModifiedByResource	String
LinkedResourceConstraintScenarios	String

CostScenarioProjects

Retrieve cost scenario projects.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
ScenarioId [KEY]	String
AbsolutePriority	Double
AnalysisId	String
AnalysisName	String
ForceAliasLookupTableId	String
ForceAliasLookupTableName	String
ForceStatus	Int
HardConstraintValue	Decimal
Priority	Double
ProjectName	String
ScenarioName	String
Status	Int
LinkedAnalysis	String
LinkedCostConstraintScenario	String
LinkedProject	String

Deliverables

Retrieve deliverables.

Columns


Name	Type	References	Description
DeliverableId [KEY]	String
ProjectId [KEY]	String
CreateByResource	String
CreatedDate	Datetime
Description	String
FinishDate	Datetime
IsFolder	Bool
ItemRelativeUrlPath	String
ModifiedByResource	String
ModifiedDate	Datetime
ProjectName	String
StartDate	Datetime
Title	String
LinkedDependentProjects	String
LinkedDependentTasks	String
LinkedParentProjects	String
LinkedParentTasks	String
LinkedProject	String

Engagements

Retrieve engagements.

Columns


Name	Type	References	Description
EngagementId [KEY]	String
CommittedFinishDate	Datetime
CommittedMaxUnits	Decimal
CommittedStartDate	Datetime
CommittedWork	Decimal
EngagementCreatedDate	Datetime
EngagementModifiedDate	Datetime
EngagementName	String
EngagementReviewedDate	Datetime
EngagementStatus	Int
EngagementSubmittedDate	Datetime
ModifiedByResourceId	String
ModifiedByResourceName	String
ProjectId	String
ProjectName	String
ProposedFinishDate	Datetime
ProposedMaxUnits	Decimal
ProposedStartDate	Datetime
ProposedWork	Decimal
ResourceId	String
ResourceName	String
ReviewedByResourceId	String
ReviewedByResourceName	String
SubmittedByResourceId	String
SubmittedByResourceName	String
LinkedComment	String
LinkedTimephasedInfo	String

EngagementsComments

Retrieve engagements comments.

Columns


Name	Type	References	Description
CommentId [KEY]	String
AuthorId	String
AuthorName	String
CommentCreatedDate	Datetime
CommentMessage	String
EngagementId	String
EngagementName	String
LinkedEngagement	String

EngagementsTimephasedDataSet

Retrieve engagements timephased dataset.

Columns


Name	Type	References	Description
EngagementId [KEY]	String
TimeByDay [KEY]	Datetime
CommittedMaxUnits	Decimal
CommittedWork	Decimal
EngagementModifiedDate	Datetime
EngagementName	String
ProjectId	String
ProjectName	String
ProposedMaxUnits	Decimal
ProposedWork	Decimal
ResourceId	String
ResourceName	String
LinkedEngagement	String

FiscalPeriods

Retrieve fiscal periods.

Columns


Name	Type	References	Description
FiscalPeriodId [KEY]	String
CreatedDate	Datetime
FiscalPeriodFinish	Datetime
FiscalPeriodModifiedDate	Datetime
FiscalPeriodName	String
FiscalPeriodQuarter	Int
FiscalPeriodStart	Datetime
FiscalPeriodYear	Int

Issues

Retrieve issues.

Columns


Name	Type	References	Description
IssueId [KEY]	String
ProjectId [KEY]	String
AssignedToResource	String
Category	String
CreateByResource	String
CreatedDate	Datetime
Discussion	String
DueDate	Datetime
IsFolder	Bool
ItemRelativeUrlPath	String
ModifiedByResource	String
ModifiedDate	Datetime
NumberOfAttachments	Int
Owner	String
Priority	String
ProjectName	String
Resolution	String
Status	String
Title	String
LinkedProject	String
LinkedRelatedRisks	String
LinkedSubIssues	String
LinkedTasks	String

IssueTaskAssociations

Retrieve issue-task associations.

Columns


Name	Type	References	Description
IssueId [KEY]	String
ProjectId [KEY]	String
RelationshipType [KEY]	Int
TaskId [KEY]	String
ProjectName	String
RelatedProjectId	String
RelatedProjectName	String
TaskName	String
Title	String
LinkedIssue	String
LinkedProject	String
LinkedRelatedProject	String
LinkedTask	String

PortfolioAnalyses

Retrieve portfolio analyses.

Columns


Name	Type	References	Description
AnalysisId [KEY]	String
AnalysisDescription	String
AnalysisName	String
AnalysisType	Int
BookingType	Int
CreatedByResourceId	String
CreatedByResourceName	String
CreatedDate	Datetime
DepartmentId	String
DepartmentName	String
FilterResourcesByDepartment	Bool
FilterResourcesByRBS	Bool
FilterResourcesByRBSValueId	String
FilterResourcesByRBSValueText	String
ForcedInAliasLookupTableId	String
ForcedInAliasLookupTableName	String
ForcedOutAliasLookupTableId	String
ForcedOutAliasLookupTableName	String
HardConstraintCustomFieldId	String
HardConstraintCustomFieldName	String
ModifiedByResourceId	String
ModifiedByResourceName	String
ModifiedDate	Datetime
PlanningHorizonEndDate	Datetime
PlanningHorizonStartDate	Datetime
PrioritizationId	String
PrioritizationName	String
PrioritizationType	Int
RoleCustomFieldId	String
RoleCustomFieldName	String
TimeScale	Int
UseAlternateProjectDatesForResourcePlans	Bool
LinkedAnalysisProjects	String
LinkedCostConstraintScenarios	String
LinkedCreatedByResource	String
LinkedModifiedByResource	String
LinkedPrioritization	String
LinkedResourceConstraintScenarios	String

PortfolioAnalysisProjects

Retrieve portfolio analysis projects.

Columns


Name	Type	References	Description
AnalysisId [KEY]	String
ProjectId [KEY]	String
AbsolutePriority	Double
AnalysisName	String
Duration	Decimal
FinishNoLaterThan	Datetime
Locked	Int
OriginalEndDate	Datetime
OriginalStartDate	Datetime
Priority	Double
ProjectName	String
StartDate	Datetime
StartNoEarlierThan	Datetime
LinkedAnalysis	String
LinkedProject	String

PrioritizationDriverRelations

Retrieve prioritization driver relations.

Columns


Name	Type	References	Description
BusinessDriver1Id [KEY]	String
BusinessDriver2Id [KEY]	String
PrioritizationId [KEY]	String
BusinessDriver1Name	String
BusinessDriver2Name	String
PrioritizationName	String
RelationValue	String
LinkedBusinessDriver1	String
LinkedBusinessDriver2	String
LinkedPrioritization	String

PrioritizationDrivers

Retrieve prioritization drivers.

Columns


Name	Type	References	Description
BusinessDriverId [KEY]	String
PrioritizationId [KEY]	String
BusinessDriverName	String
BusinessDriverPriority	Double
PrioritizationName	String
LinkedBusinessDriver	String
LinkedPrioritization	String

Prioritizations

Retrieve prioritizations.

Columns


Name	Type	References	Description
PrioritizationId [KEY]	String
ConsistencyRatio	Double
CreatedByResourceId	String
CreatedByResourceName	String
DepartmentId	String
DepartmentName	String
ModifiedByResourceId	String
ModifiedByResourceName	String
PrioritizationCreatedDate	Datetime
PrioritizationDescription	String
PrioritizationIsManual	Bool
PrioritizationModifiedDate	Datetime
PrioritizationName	String
LinkedCreatedByResource	String
LinkedModifiedByResource	String
LinkedPrioritizationDriverRelations	String
LinkedPrioritizationDrivers	String

ProjectBaselines

Retrieve project baselines.

Columns


Name	Type	References	Description
BaselineNumber [KEY]	Int
ProjectId [KEY]	String
ProjectBaselineBudgetCost	Decimal
ProjectBaselineBudgetWork	Decimal
ProjectBaselineCost	Decimal
ProjectBaselineDeliverableFinishDate	Datetime
ProjectBaselineDeliverableStartDate	Datetime
ProjectBaselineDuration	Decimal
ProjectBaselineDurationString	String
ProjectBaselineFinishDate	Datetime
ProjectBaselineFinishDateString	String
ProjectBaselineFixedCost	Decimal
ProjectBaselineModifiedDate	Datetime
ProjectBaselineStartDate	Datetime
ProjectBaselineStartDateString	String
ProjectBaselineWork	Decimal
ProjectName	String
TaskId	String
LinkedProject	String

Projects

Retrieve projects.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
EnterpriseProjectTypeDescription	String
EnterpriseProjectTypeId	String
EnterpriseProjectTypeIsDefault	Bool
EnterpriseProjectTypeName	String
OptimizerCommitDate	Datetime
OptimizerDecisionAliasLookupTableId	String
OptimizerDecisionAliasLookupTableValueId	String
OptimizerDecisionID	Int
OptimizerDecisionName	String
OptimizerSolutionName	String
ParentProjectId	String
PlannerCommitDate	Datetime
PlannerDecisionAliasLookupTableId	String
PlannerDecisionAliasLookupTableValueId	String
PlannerDecisionID	Int
PlannerDecisionName	String
PlannerEndDate	Datetime
PlannerSolutionName	String
PlannerStartDate	Datetime
ProjectActualCost	Decimal
ProjectActualDuration	Decimal
ProjectActualFinishDate	Datetime
ProjectActualOvertimeCost	Decimal
ProjectActualOvertimeWork	Decimal
ProjectActualRegularCost	Decimal
ProjectActualRegularWork	Decimal
ProjectActualStartDate	Datetime
ProjectActualWork	Decimal
ProjectACWP	Decimal
ProjectAuthorName	String
ProjectBCWP	Decimal
ProjectBCWS	Decimal
ProjectBudgetCost	Decimal
ProjectBudgetWork	Decimal
ProjectCalculationsAreStale	Bool
ProjectCalendarDuration	Int
ProjectCategoryName	String
ProjectCompanyName	String
ProjectCost	Decimal
ProjectCostVariance	Decimal
ProjectCPI	Decimal
ProjectCreatedDate	Datetime
ProjectCurrency	String
ProjectCV	Decimal
ProjectCVP	Decimal
ProjectDepartments	String
ProjectDescription	String
ProjectDuration	Decimal
ProjectDurationVariance	Decimal
ProjectEAC	Decimal
ProjectEarlyFinish	Datetime
ProjectEarlyStart	Datetime
ProjectEarnedValueIsStale	Bool
ProjectEnterpriseFeatures	Bool
ProjectFinishDate	Datetime
ProjectFinishVariance	Decimal
ProjectFixedCost	Decimal
ProjectIdentifier	String
ProjectKeywords	String
ProjectLastPublishedDate	Datetime
ProjectLateFinish	Datetime
ProjectLateStart	Datetime
ProjectManagerName	String
ProjectModifiedDate	Datetime
ProjectName	String
ProjectOvertimeCost	Decimal
ProjectOvertimeWork	Decimal
ProjectOwnerId	String
ProjectOwnerName	String
ProjectPercentCompleted	Int
ProjectPercentWorkCompleted	Int
ProjectRegularCost	Decimal
ProjectRegularWork	Decimal
ProjectRemainingCost	Decimal
ProjectRemainingDuration	Decimal
ProjectRemainingOvertimeCost	Decimal
ProjectRemainingOvertimeWork	Decimal
ProjectRemainingRegularCost	Decimal
ProjectRemainingRegularWork	Decimal
ProjectRemainingWork	Decimal
ProjectResourcePlanWork	Decimal
ProjectSPI	Decimal
ProjectStartDate	Datetime
ProjectStartVariance	Decimal
ProjectStatusDate	Datetime
ProjectSubject	String
ProjectSV	Decimal
ProjectSVP	Decimal
ProjectTCPI	Decimal
ProjectTimephased	String
ProjectTitle	String
ProjectType	Int
ProjectVAC	Decimal
ProjectWork	Decimal
ProjectWorkspaceInternalUrl	String
ProjectWorkVariance	Decimal
ResourcePlanUtilizationDate	Datetime
ResourcePlanUtilizationType	Int
WorkflowError	String
WorkflowErrorResponseCode	Int
WorkflowInstanceId	String
WorkflowOwnerId	String
WorkflowOwnerName	String
LinkedAssignmentBaselines	String
LinkedAssignments	String
LinkedDeliverables	String
LinkedDependencies	String
LinkedIssues	String
LinkedRisks	String
LinkedStagesInfo	String
LinkedTasks	String

ProjectWorkflowStageDataSet

Retrieve project workflow stage dataset.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
StageId [KEY]	String
LastModifiedDate	Datetime
LCID	Int
PhaseDescription	String
PhaseName	String
ProjectName	String
StageCompletionDate	Datetime
StageDescription	String
StageEntryDate	Datetime
StageInformation	String
StageLastSubmittedDate	Datetime
StageName	String
StageOrder	Int
StageStateDescription	String
StageStatus	Int
LinkedProject	String

ResourceConstraintScenarios

Retrieve resource constraint scenarios.

Columns


Name	Type	References	Description
ScenarioId [KEY]	String
AllocationThreshold	Decimal
AnalysisId	String
AnalysisName	String
ConstraintType	Int
ConstraintValue	Decimal
CostConstraintScenarioId	String
CostConstraintScenarioName	String
CreatedByResourceId	String
CreatedByResourceName	String
CreatedDate	Datetime
EnforceProjectDependencies	Bool
EnforceSchedulingConstraints	Bool
HiringType	Int
ModifiedByResourceId	String
ModifiedByResourceName	String
ModifiedDate	Datetime
RateTable	Int
ScenarioDescription	String
ScenarioName	String
LinkedAnalysis	String
LinkedCostConstraintScenario	String
LinkedCreatedByResource	String
LinkedModifiedByResource	String
LinkedResourceScenarioProjects	String

ResourceDemandTimephasedDataSet

Retrieve resource demand timephased dataset.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
ResourceId [KEY]	String
TimeByDay [KEY]	Datetime
FiscalPeriodId	String
ProjectName	String
ResourceDemand	Decimal
ResourceDemandModifiedDate	Datetime
ResourceName	String
ResourcePlanUtilizationDate	Datetime
ResourcePlanUtilizationType	Int
LinkedProject	String
LinkedResource	String
LinkedTime	String

Resources

Retrieve resources.

Columns


Name	Type	References	Description
ResourceId [KEY]	String
CostType	String
RBS	String
ResourceBaseCalendar	String
ResourceBookingType	Int
ResourceCanLevel	Bool
ResourceCode	String
ResourceCostCenter	String
ResourceCostPerUse	Decimal
ResourceCreatedDate	Datetime
ResourceDepartments	String
ResourceEarliestAvailableFrom	Datetime
ResourceEmailAddress	String
ResourceGroup	String
ResourceHyperlink	String
ResourceHyperlinkHref	String
ResourceInitials	String
ResourceIsActive	Bool
ResourceIsGeneric	Bool
ResourceIsTeam	Bool
ResourceLatestAvailableTo	Datetime
ResourceMaterialLabel	String
ResourceMaxUnits	Decimal
ResourceModifiedDate	Datetime
ResourceName	String
ResourceNTAccount	String
ResourceOvertimeRate	Decimal
ResourceStandardRate	Decimal
ResourceStatusId	String
ResourceStatusName	String
ResourceTimesheetManageId	String
ResourceType	Int
ResourceWorkgroup	Int
TypeDescription	String
TypeName	String
LinkedAssignments	String
LinkedResourceDemandTimephasedInfo	String
LinkedTimephasedInfoDataSet	String

ResourceScenarioProjects

Retrieve resource scenario projects.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
ScenarioId [KEY]	String
AbsolutePriority	Double
AnalysisId	String
AnalysisName	String
CostConstraintScenarioId	String
CostConstraintScenarioName	String
ForceAliasLookupTableId	String
ForceAliasLookupTableName	String
ForceStatus	Int
HardConstraintValue	Decimal
NewStartDate	Datetime
Priority	Double
ProjectName	String
ResourceCost	Decimal
ResourceWork	Decimal
ScenarioName	String
Status	Int
LinkedAnalysis	String
LinkedCostConstraintScenario	String
LinkedProject	String
LinkedResourceConstraintScenario	String

ResourceTimephasedDataSet

Retrieve resource timephased dataset.

Columns


Name	Type	References	Description
ResourceId [KEY]	String
TimeByDay [KEY]	Datetime
BaseCapacity	Decimal
Capacity	Decimal
FiscalPeriodId	String
ResourceModifiedDate	Datetime
ResourceName	String
LinkedResource	String
LinkedTime	String

Risks

Retrieve risks.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
RiskId [KEY]	String
AssignedToResource	String
Category	String
ContingencyPlan	String
Cost	Double
CostExposure	Double
CreateByResource	String
CreatedDate	Datetime
Description	String
DueDate	Datetime
Exposure	Double
Impact	Double
IsFolder	Bool
ItemRelativeUrlPath	String
MitigationPlan	String
ModifiedByResource	String
ModifiedDate	Datetime
NumberOfAttachments	Int
Owner	String
Probability	Double
ProjectName	String
Status	String
Title	String
TriggerDescription	String
TriggerTask	String
LinkedProject	String
LinkedRelatedIssues	String
LinkedSubRisks	String
LinkedTasks	String

RiskTaskAssociations

Retrieve risk task associations.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
RelationshipType [KEY]	Int
RiskId [KEY]	String
TaskId [KEY]	String
ProjectName	String
RelatedProjectId	String
RelatedProjectName	String
TaskName	String
Title	String
LinkedProject	String
LinkedRelatedProject	String
LinkedRisk	String
LinkedTask	String

TaskBaselines

Retrieve task baselines.

Columns


Name	Type	References	Description
BaselineNumber [KEY]	Int
ProjectId [KEY]	String
TaskId [KEY]	String
ProjectName	String
TaskBaselineBudgetCost	Decimal
TaskBaselineBudgetWork	Decimal
TaskBaselineCost	Decimal
TaskBaselineDeliverableFinishDate	Datetime
TaskBaselineDeliverableStartDate	Datetime
TaskBaselineDuration	Decimal
TaskBaselineDurationString	String
TaskBaselineFinishDate	Datetime
TaskBaselineFinishDateString	String
TaskBaselineFixedCost	Decimal
TaskBaselineModifiedDate	Datetime
TaskBaselineStartDate	Datetime
TaskBaselineStartDateString	String
TaskBaselineWork	Decimal
TaskName	String
LinkedProject	String
LinkedTask	String
LinkedTaskBaselineTimephasedDataSet	String

TaskBaselineTimephasedDataSet

Retrieve task baseline timephased dataset.

Columns


Name	Type	References	Description
BaselineNumber [KEY]	Int
ProjectId [KEY]	String
TaskId [KEY]	String
TimeByDay [KEY]	Datetime
FiscalPeriodId	String
ProjectName	String
TaskBaselineBudgetCost	Decimal
TaskBaselineBudgetWork	Decimal
TaskBaselineCost	Decimal
TaskBaselineFixedCost	Decimal
TaskBaselineModifiedDate	Datetime
TaskBaselineWork	Decimal
TaskName	String
LinkedProject	String
LinkedTask	String
LinkedTaskBaselines	String
LinkedTime	String

Tasks

Retrieve tasks.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
TaskId [KEY]	String
FlagStatus	Bool
Health	String
ParentTaskId	String
ParentTaskName	String
ProjectName	String
TaskActualCost	Decimal
TaskActualDuration	Decimal
TaskActualFinishDate	Datetime
TaskActualFixedCost	Decimal
TaskActualOvertimeCost	Decimal
TaskActualOvertimeWork	Decimal
TaskActualRegularCost	Decimal
TaskActualRegularWork	Decimal
TaskActualStartDate	Datetime
TaskActualWork	Decimal
TaskACWP	Decimal
TaskBCWP	Decimal
TaskBCWS	Decimal
TaskBudgetCost	Decimal
TaskBudgetWork	Decimal
TaskClientUniqueId	Int
TaskCost	Decimal
TaskCostVariance	Decimal
TaskCPI	Decimal
TaskCreatedDate	Datetime
TaskCreatedRevisionCounter	Int
TaskCV	Decimal
TaskCVP	Decimal
TaskDeadline	Datetime
TaskDeliverableFinishDate	Datetime
TaskDeliverableStartDate	Datetime
TaskDuration	Decimal
TaskDurationIsEstimated	Bool
TaskDurationString	String
TaskDurationVariance	Decimal
TaskEAC	Decimal
TaskEarlyFinish	Datetime
TaskEarlyStart	Datetime
TaskFinishDate	Datetime
TaskFinishDateString	String
TaskFinishVariance	Decimal
TaskFixedCost	Decimal
TaskFixedCostAssignmentId	String
TaskFreeSlack	Decimal
TaskHyperLinkAddress	String
TaskHyperLinkFriendlyName	String
TaskHyperLinkSubAddress	String
TaskIgnoresResourceCalendar	Bool
TaskIndex	Int
TaskIsActive	Bool
TaskIsCritical	Bool
TaskIsEffortDriven	Bool
TaskIsExternal	Bool
TaskIsManuallyScheduled	Bool
TaskIsMarked	Bool
TaskIsMilestone	Bool
TaskIsOverallocated	Bool
TaskIsProjectSummary	Bool
TaskIsRecurring	Bool
TaskIsSummary	Bool
TaskLateFinish	Datetime
TaskLateStart	Datetime
TaskLevelingDelay	Decimal
TaskModifiedDate	Datetime
TaskModifiedRevisionCounter	Int
TaskName	String
TaskOutlineLevel	Int
TaskOutlineNumber	String
TaskOvertimeCost	Decimal
TaskOvertimeWork	Decimal
TaskPercentCompleted	Int
TaskPercentWorkCompleted	Int
TaskPhysicalPercentCompleted	Int
TaskPriority	Int
TaskRegularCost	Decimal
TaskRegularWork	Decimal
TaskRemainingCost	Decimal
TaskRemainingDuration	Decimal
TaskRemainingOvertimeCost	Decimal
TaskRemainingOvertimeWork	Decimal
TaskRemainingRegularCost	Decimal
TaskRemainingRegularWork	Decimal
TaskRemainingWork	Decimal
TaskResourcePlanWork	Decimal
TaskSPI	Decimal
TaskStartDate	Datetime
TaskStartDateString	String
TaskStartVariance	Decimal
TaskStatusManagerUID	String
TaskSV	Decimal
TaskSVP	Decimal
TaskTCPI	Decimal
TaskTotalSlack	Decimal
TaskVAC	Decimal
TaskWBS	String
TaskWork	Decimal
TaskWorkVariance	Decimal
LinkedAssignments	String
LinkedAssignmentsBaselines	String
LinkedAssignmentsBaselineTimephasedData	String
LinkedBaselines	String
LinkedBaselinesTimephasedDataSet	String
LinkedIssues	String
LinkedProject	String
LinkedRisks	String
LinkedTimephasedInfo	String

TaskTimephasedDataSet

Retrieve task timephased dataset.

Columns


Name	Type	References	Description
ProjectId [KEY]	String
TaskId [KEY]	String
TimeByDay [KEY]	Datetime
FiscalPeriodId	String
ProjectName	String
TaskActualCost	Decimal
TaskActualWork	Decimal
TaskBudgetCost	Decimal
TaskBudgetWork	Decimal
TaskCost	Decimal
TaskIsActive	Bool
TaskIsProjectSummary	Bool
TaskModifiedDate	Datetime
TaskName	String
TaskOvertimeWork	Decimal
TaskResourcePlanWork	Decimal
TaskWork	Decimal
LinkedProject	String
LinkedTask	String
LinkedTime	String

TimeSet

Retrieve timeset.

Columns


Name	Type	References	Description
TimeByDay [KEY]	Datetime
FiscalPeriodId	String
FiscalPeriodModifiedDate	Datetime
FiscalPeriodName	String
FiscalPeriodStart	Datetime
FiscalPeriodYear	Int
FiscalQuarter	Int
TimeDayOfTheMonth	Int
TimeDayOfTheWeek	Int
TimeMonthOfTheYear	Int
TimeQuarter	Int
TimeWeekOfTheYear	Int

TimesheetClasses

Retrieve timesheet classes.

Columns


Name	Type	References	Description
DepartmentId [KEY]	String
TimesheetClassId [KEY]	String
DepartmentName	String
Description	String
LCID	Int
TimesheetClassName	String
TimesheetClassType	Int

TimesheetLineActualDataSet

Retrieve timesheet line actual dataset.

Columns


Name	Type	References	Description
AdjustmentIndex [KEY]	Int
TimeByDay [KEY]	Datetime
TimesheetLineId [KEY]	String
ActualOvertimeWorkBillable	Decimal
ActualOvertimeWorkNonBillable	Decimal
ActualWorkBillable	Decimal
ActualWorkNonBillable	Decimal
Comment	String
CreatedDate	Datetime
LastChangedResourceName	String
PlannedWork	Decimal
ResourceName	String
TimeByDay_DayOfMonth	Int
TimeByDay_DayOfWeek	Int
TimesheetLineModifiedDate	Datetime
LinkedLastChangedByResource	String
LinkedTime	String
LinkedTimesheetLine	String

TimesheetLines

Retrieve timesheet lines.

Columns


Name	Type	References	Description
TimesheetLineId [KEY]	String
ActualOvertimeWorkBillable	Decimal
ActualOvertimeWorkNonBillable	Decimal
ActualWorkBillable	Decimal
ActualWorkNonBillable	Decimal
AssignmentId	String
CreatedDate	Datetime
LastSavedWork	Decimal
LCID	Int
ModifiedDate	Datetime
PeriodEndDate	Datetime
PeriodStartDate	Datetime
PlannedWork	Decimal
ProjectId	String
ProjectName	String
TaskHierarchy	String
TaskId	String
TaskName	String
TimesheetApproverResourceId	String
TimesheetApproverResourceName	String
TimesheetClassDescription	String
TimesheetClassId	String
TimesheetClassName	String
TimesheetClassType	Int
TimesheetId	String
TimesheetLineComment	String
TimesheetLineStatus	String
TimesheetLineStatusId	Int
TimesheetName	String
TimesheetOwner	String
TimesheetOwnerId	String
TimesheetPeriodId	String
TimesheetPeriodName	String
TimesheetPeriodStatus	String
TimesheetPeriodStatusId	Int
TimesheetStatus	String
TimesheetStatusId	Int
LinkedActuals	String
LinkedApproverResource	String
LinkedTimesheet	String
LinkedTimesheetClass	String

TimesheetPeriods

Retrieve timesheet periods.

Columns


Name	Type	References	Description
PeriodId [KEY]	String
Description	String
EndDate	Datetime
LCID	Int
PeriodName	String
PeriodStatusId	Int
StartDate	Datetime

Timesheets

Retrieve timesheets.

Columns


Name	Type	References	Description
TimesheetId [KEY]	String
Comment	String
Description	String
EndDate	Datetime
ModifiedDate	Datetime
PeriodId	String
PeriodName	String
PeriodStatusId	Int
StartDate	Datetime
StatusDescription	String
TimesheetName	String
TimesheetOwner	String
TimesheetOwnerId	String
TimesheetStatusId	Int
LinkedLines	String
LinkedPeriods	String

Data Type Mapping

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


Microsoft Project (OData V3)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.DateTime	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

Connection String Options

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 scheme used for authentication. Accepted entries are Auto,OAuth,OKTA,ADFS, and OneLogin.
URL	URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
User	The Microsoft Project user account used to authenticate.
Password	The password used to authenticate the user.

Connection

Property	Description
ProjectId	The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.
AuthCookie	The cookie to use for authenticating to the online SharePoint server.

Azure Authentication

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

SSO

Property	Description
SSOLoginURL	The identity provider's login URL.
SSODomain	The domain of the user when using single sign-on (SSO).
SSOProperties	Additional properties required to connect to the identity provider in a semicolon-separated list.

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.
Scope	The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page.
State	Optional value for representing extra OAuth state information.

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.
Schema	The type of schema to use: ODataV1 or ODataV2.

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.
Pagesize	The maximum number of results to return per page from Microsoft Project.
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.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

Authentication

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

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are Auto,OAuth,OKTA,ADFS, and OneLogin.
URL	URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.
User	The Microsoft Project user account used to authenticate.
Password	The password used to authenticate the user.

AuthScheme

The scheme used for authentication. Accepted entries are Auto,OAuth,OKTA,ADFS, and OneLogin.

Remarks

This field is used to authenticate to Microsoft Project. Auto is the default option.

Auto: Lets the CData Sync App determine what to do based on other connection properties.
SharePointOnlineCookies: Set the User and Password to perform the cookie based authentication to your SharePoint Online server.
OAuth: Set this to use OAuth authentication.
ADFS: Set this to use Single Sign-On authentication with ADFS.
OKTA: Set this to use Single Sign-On authentication with OKTA.
OneLogin: Set this to use Single Sign-On authentication with OneLogin.
AzureAD: Set this to use Azure Active Directory authentication.

URL

URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.

Remarks

URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/.

User

The Microsoft Project user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Microsoft Project server.

Password

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

Connection

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

Property	Description
ProjectId	The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.
AuthCookie	The cookie to use for authenticating to the online SharePoint server.

ProjectId

The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.

Remarks

The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter.

Note: This property is applicable only for the "ODataV2" schema. For the "ODataV1" schema, no table requires the ProjectId to be specified, as the ProjectData endpoints return data for all the available projects.

AuthCookie

The cookie to use for authenticating to the online SharePoint server.

Remarks

After logging in to http://yourdomain.sharepoint.com/TeamSite, the "keep me signed in" setting must be checked in order for the connection to be established.

Azure Authentication

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

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

AzureTenant

The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

AzureEnvironment

The Azure Environment to use when establishing a connection.

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

SSO

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

Property	Description
SSOLoginURL	The identity provider's login URL.
SSODomain	The domain of the user when using single sign-on (SSO).
SSOProperties	Additional properties required to connect to the identity provider in a semicolon-separated list.

SSOLoginURL

The identity provider's login URL.

Remarks

The identity provider's login URL.

SSODomain

The domain of the user when using single sign-on (SSO).

Remarks

This property is only applicable when using single sign-on (UseSSO is set to true) and if the domain of the User (e.g. [email protected]) is different than the domain configured within the SSO service (e.g. [email protected]).

This property may be required when using the ADFS, OneLogin, or OKTA SSO services.

SSOProperties

Additional properties required to connect to the identity provider in a semicolon-separated list.

Remarks

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.

SSO configuration is discussed further in .

OAuth

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.
Scope	The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page.
State	Optional value for representing extra OAuth state information.

OAuthClientId

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.

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.

Scope

The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page.

Remarks

The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl.

State

Optional value for representing extra OAuth state information.

Remarks

Optional value for representing extra OAuth state information.

SSL

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.

SSLServerCert

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.

Firewall

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.

FirewallType

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

FirewallServer

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.

FirewallPort

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.

FirewallUser

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.

FirewallPassword

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.

Proxy

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 .

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.

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.

ProxyServer

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.

ProxyPort

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.

ProxyAuthScheme

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.

ProxyUser

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

ProxyPassword

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.

ProxySSLType

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.

ProxyExceptions

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.

Logging

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.

LogModules

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.

Schema

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.
Schema	The type of schema to use: ODataV1 or ODataV2.

Location

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 Microsoft Project 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\\MicrosoftProject Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

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.

Tables

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.

Views

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.

Schema

The type of schema to use: ODataV1 or ODataV2.

Remarks

The schemas available are ODataV2 (MS Project's static schema with full CRUD support) and ODataV1 (MS Project's dynamic schema with read-only capabilities).

The ODataV1 schema can only be used to read data, but schemas are read dynamically and the custom fields are exposed.
The ODataV2 schema can be used to perform read, insert, update, and delete operations, but schemas are fixed. Main fields are dynamically retrieved, however custom fields are not exposed.

Miscellaneous

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.
Pagesize	The maximum number of results to return per page from Microsoft Project.
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.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

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.

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.

Other

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.

Pagesize

The maximum number of results to return per page from Microsoft Project.

Remarks

The Pagesize property affects the maximum number of results to return per page from Microsoft Project. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns

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, "*=*".

Timeout

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.

UserDefinedViews

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"

UseSimpleNames

Boolean determining if simple names should be used for tables and columns.

Remarks

Microsoft Project tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.