Gateway Developer's Guide 1Release 1.0

Transcription

1 Gateway Developer's Guide 1Release 1.0 March 2013

2 Legal Notices Oracle Primavera Gateway Developer's Guide Copyright 2013, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. This software or hardware and documentation may provide access to or information on content, products and services from third-parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. 2

3 Contents Legal Notices... 2 Preface... 5 Where to Get Documentation... 5 Where to Get Training... 6 Where to Get Support... 6 Overview... 9 Business Flows Primavera Gateway System Architecture Provider Architecture Creating a Third-Party Provider Step 1: Determine what data should be exchanged between the third-party system and P P6 Business Objects P6 Business Object: Resource P6 Business Object: ResourceRate P6 Business Object: Role P6 Business Object: RoleRate P6 Business Object: ExpenseCategory P6 Business Object: Project P6 Business Object: WBS P6 Business Object: WBSCategory P6 Business Object: Activity P6 Business Object: ActivityExpense P6 Business Object: ResourceAssignment P6 Business Object: ProjectResource P6 Business Object: Relationship Step 2: Design and Create Data Definition XML files XML Files Included with Primavera Gateway Primavera Gateway Schema Files Data Dictionary Files (*MetaData.xml) Provider Files (*Provider.xml) XRef.xml Data Value Mapping Files (*DVM.xml) Customization XML File Example XML Files Example PDI XML Document Example ERP XML Document Step 3: Determine What Flows Are Required Step 4: Write the Java Provider Code to Support the Flows Sample Flows FlowProvider Interface FlowStepContext Interface Compare Step Supporting Filters in the ERP Provider

4 Gateway Developer's Guide Assigning A NotebookTopic to an Activity Step 5: Create a Provider XML File Step 6: Package All of the Artifacts Together Step 7: Installing and Testing the Third-Party Provider About the Primavera Gateway Configuration Utility Using the Primavera Gateway Configuration Utility Testing the Third-Party Provider

5 Preface Primavera Gateway is an application that facilitates sharing project and resource information between third-party applications, enabling you to combine P6 EPPM's management and scheduling power for projects, portfolios, and resources with other enterprise software. In This Section Where to Get Documentation... 5 Where to Get Training... 6 Where to Get Support... 6 Where to Get Documentation For the most up-to-date versions of all manuals and technical documents related to installing, administering, and using Primavera Gateway, go to: Most documentation assumes a standard setup of the product, with full access rights to all features and functions. The following table describes the core documents available for Primavera Gateway and lists the recommended readers by role. Title Gateway Help Primavera Gateway Installation and Configuration Guide Installing and Configuring the P6 Adapter The Help describes how to work with Primavera Gateway and provides tasks to help users accomplish tasks. All users should read the Help. This book provides information on how to install and configure Primavera Gateway. Primavera Gateway is a product that facilitates integrations with Primavera products and third-party systems such as enterprise resource management (ERP) and enterprise asset management (EAM) systems. The Primavera Gateway network administrator/database administrator and the administrator for the third-party or ERP system should read this guide. This book provides information on how to install and configure the P6 Adapter. The P6 Adapter is used to connect Primavera Gateway to the P6 database. The Primavera Gateway network administrator/database administrator and the P6 administrator should read this guide. 5

6 Gateway Developer's Guide Title Primavera Gateway Developer's Guide Primavera Gateway Customization Guide Tested Configurations This book provides information on how third-party systems such as enterprise resource management (ERP) and enterprise asset management (EAM) systems can create their own providers in order to integrate with Primavera products. Developers of third-party providers that integrate with Primavera products via Primavera Gateway should read this book. This book provides information that allows customers to customize an existing third-party integration. Developers interested in customization and existing third-party providers that integrate with Primavera products via Primavera Gateway should read this book. This document lists the configurations that have been tested and verified to work with Primavera Gateway. The Primavera Gateway network administrator/database administrator and the administrator for the third-party or ERP system should read this guide. Distributing Information to the Team You can copy the online documentation to a network drive for access by project participants. Each team member can then view or print those portions that specifically relate to his or her role in the organization. Throughout this documentation, the Security Guidance icon helps you to quickly identify security-related content to consider during the installation and configuration process. Where to Get Training To access comprehensive training for all Primavera products, go to: Where to Get Support Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired. 6

7 Preface Using Primavera's Support Resource Centers Primavera s Support Resource Center provides links to important support and product information. Primavera's Product Information Centers (PICs) organize documents found on My Oracle Support (MOS), providing quick access to product and version specific information such as important knowledge documents, Release Value Propositions, and Oracle University training. PICs also offer documentation on Lifetime Management, from planning to installs, upgrades, and maintenance. Visit to access links to all of the current PICs. PICs also provide access to: Communities are moderated by Oracle providing a place for collaboration among industry peers to share best practices. News from our development and strategy groups. Education contains a list of available Primavera product trainings through Oracle University. The Oracle Advisor Webcast program brings interactive expertise straight to the desktop using Oracle Web Conferencing technology. This capability brings you and Oracle experts together to access information about support services, products, technologies, best practices, and more. For more information about working with Support, visit 7

8

9 Overview Primavera Gateway Functionality The Primavera Gateway facilitates synchronizing master and project data between P6 EPPM and third-party systems. When synchronizing data, the Primavera Gateway supports three basic flow types: Importing master data from a third-party system into P6 EPPM. Importing project data from a third-party system into P6 EPPM. Exporting project data from P6 EPPM into a third-party system. The third-party system can be any system that has data that can be shared with P6 EPPM. Enterprise Resource Planning (ERP) systems are just one class of systems that process the type of data that can be shared with P6 EPPM. The Primavera Gateway ships with a sample ERP provider that illustrates how to use the Primavera Gateway to synchronize data between the P6 EPPM and the sample ERP. The sample ERP provider demonstrates how to synchronize data from the following objects: Import Master data: Demonstrates how to import the following master data from the sample ERP to the P6 EPPM: Expense categories Resources Resource rates Roles Role rates WBS categories Import Project data: Demonstrates how to import the following project data from the sample ERP into P6 EPPM: Activity expenses Activities Budgets Activity notes Project resources Projects Relationships Resource Assignments WBSs 9

10 Gateway Developer's Guide Export Project data: Demonstrates how to export the following project data from P6 EPPM to the sample ERP: Activity expenses Activities Budgets Activity notes Project resources Projects Relationships Resource Assignments WBSs 10

11 Overview Business Flows Business flows define an end-to-end synchronization and have the following characteristics: Flows are directional: Flows either export data from the P6 database to the third-party provider or import data from the third-party provider into the P6 EPPM database. An individual flow can define the synchronization of data in only one direction. You can only define master data flows that import data into P6. You can define project data flows that either exports project data from P6 or imports project data from the third-party provider. Flows contain one or more flow steps. There are four types of flow steps:load, Convert, Compare, and Save. Project flows support the compare step. This step compares the source and destination data and saves the delta into the target system. Master data flows do not support the compare step. Master data flows perform a record by record update of the data. Load Step This step loads the source data and passes it on to the next step. Convert Step This step converts the source data to the target data structure. Compare Step This step compares the source and destination data and identifies changed, deleted, and added objects so that the system can synchronize the data efficiently. To ensure that the data that follows the same structure when it is compared, both the source and the destination data must be converted to the PDI format before it can be compared. When identifying objects that are deleted in the source data, the compare step uses the cross reference table to determine whether the data has been synchronized in the past; the presence of the data in the cross reference table indicates that the data has been synchronized in the past. During the compare step, the system marks objects that have been deleted in the source data for deletion in the target system only if the record is in the cross reference table and a delete parameter is associated with the flow. Save Step This step saves the data into the target system. 11

12 Gateway Developer's Guide Primavera Gateway System Architecture The Primavera Gateway is a three-tier system that includes web, business, and database tiers. Each of these tiers provide specific functions to synchronize data between P6 EPPM database and a third-party system. Refer to the system architecture drawing below for a general orientation of how these three tiers work together to synchronize data between P6 EPPM and a third-party provider. System Architecture System Architecture: Three Tiers The following table provides additional information about how the three tiers work together to synchronize data. 12

13 Overview Tier 1. Web Tier 2. Business Tier This tier provides a browser-based user interface. You use this interface to create, view, schedule, and monitor business flows to synchronize data between the P6 EPPM and a third-party (ERP) provider. This tier provides the provider logic that orchestrates the business flow steps and includes the two providers and the Gateway Framework. The two providers are the P6 Provider and the Third-party Provider. Note: In some contexts the P6 Provider is also known as the Host. In some contexts the Third-party Provider is known as the ERP Provider or the Guest. The Gateway Framework is a web application that is deployed on a WebLogic application server and provides the following functions Exposes Java APIs that the two providers use to interact with the framework. Provides orchestration of the business flow steps within the Primavera Gateway. Provides job scheduling services. 13

14 Gateway Developer's Guide Tier 3. Database Tier This tier stores the Primavera Gateway schema and data, which includes the following items: Cross references (Xref), data value mappings (DVM), flows, metadata (data dictionary), and customizations Audit information, logs, and intermediate artifacts Configuration settings Schedules Provider Architecture A provider consists of the following components: XML Files Data definition file Provider description file Cross reference definition file mapping template definition file Data value mapping (DVM) definition file. This file is optional and is only required if there are enum fields that require mapping. Java code that implements the provider and is packaged in a jar file. The Primavera Gateway ships with a utility that you use to load the information from the XML files into the Oracle Primavera Gateway Database. The jar file that implements the provider code needs to go into the lib folder of the WebLogic Primavera Gateway domain. Customizations and the Sample Provider We supply a sample provider that you can use to get started. The Primavera Gateway comes with a sample provider that contains the flows, XML files and sample Java code that uses best practices to help you get started. When you install the Primavera Gateway, you can choose to load the sample customization project containing this seed data into the Primavera Gateway database. You can use the sample customization project to get started with your implementations. The data that comes with the Sample Project can be customized for your environment. 14

15 Creating a Third-Party Provider Creating a Third-Party Provider Developing a third-party provider for the Primavera Gateway involves the following steps: 1) Determining what data should be exchanged between the third-party system and P6. 2) Designing and creating data definition XML files that include this data. 3) Determining what flows to support to integrate the data. 4) Writing the Java provider code that supports these flows. 5) Creating a provider description XML file. 6) Packaging all of the artifacts together so that they can be installed. 7) Installing and testing the third-party provider. Step 1: Determine what data should be exchanged between the third-party system and P6 You can gather information about the P6 business objects that the Primavera Gateway supports by following these steps to view the Data Dictionaries in the Primavera Gateway user interface: To view the P6 or PDI Data Dictionary: 1) Log into the Primavera Gateway. 2) Select Data Dictionary and select P6 from the menu to view the P6 business objects that are available. or 3) Select Data Dictionary and select PDI from the menu to view the PDI business objects that are available. The Primavera Gateway to present a list of the business objects and their descriptions. To view additional information about a specific business object, selected the business object. Selecting the business object causes the Primavera Gateway presents a list of fields that are associated with the selected business object. As a developer, you should be familiar with the third-party application and the data that it supports and how it relates to P6 business objects. You will need to analyze your business objects and then create or modify the XML file that comes with the sample ERP provider to describe your business objects. 15

16 Gateway Developer's Guide P6 Business Objects The following tables describe the P6 business objects that are available. Business Object Resource ResourceRate Role RoleRate ExpenseCategory Project WBS WBSCategory Activity ActivityExpense ResourceAssignm ent ProjectResource Relationship Resources include labor, nonlabor, and materials that are used for activities across all projects. Resource rates provide a way of specifying multiple resource prices and maximum units per time values that vary over time. Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. Role rates enable you to select a predefined price per unit for cost calculating when assigning the role to an activity. Expense categories are used to categorize project expenses. They are used for standardizing expenses and for rolling up expenses across projects. A project is a temporary endeavor undertaken to create a unique product, service, or result. Projects usually contain a work breakdown structure (WBS) and activities. The project work breakdown structure (WBS) is a hierarchical arrangement of the products and services produced during and by a Each element of a WBS may contain more-detailed WBS elements, activities, or both. WBS are hierarchical objects. As their name implies, WBS categories are used to categorize WBS elements. They are defined globally. An activity is a unit of work performed during the course of a Activity expenses are non-resource costs associated with a project and assigned to a project's activities. They are typically one-time expenditures for non-reusable items. Resource assignments track the work of resources or roles that are performing various activities. Primavera's resource planning feature allows you to do high-level project planning for future project or project that does not require resource assignments at the activity level. A relationship defines how an activity relates to the start or finish of another 16

17 Creating a Third-Party Provider Business Object activity or assignment. These relationships, which form the logic of the project network, are used together with activity durations to determine schedule dates. P6 Business Object: Resource : Resources include labor, nonlabor, and materials that are used for activities across all projects. AutoComputeActuals CalculateCostFromUnits CalendarName CalendarObjectId CreateDate CreateUser CurrencyId CurrencyName CurrencyObjectId DefaultUnitsPerTime EffectiveDate Address EmployeeId The option that determines whether the activity actual and remaining units, and start and finish dates for the resource are calculated automatically using the planned dates, planned units, and the activity's schedule percent complete. The option that determines whether any new assignments for this resource will have its costs recalculated whenever any quantity changes occur. The name of the calendar that is assigned to the resource. The unique ID of the calendar assigned to the resource. The date this resource was created. The name of the user that created this resource. The unique currency abbreviation for the currency associated with this resource. The name of the currency associated with this resource. The unique ID of the currency associated with this resource. The default units/time setting, which determines the value of the remaining units/time and planned units/time when a resource assignment is added. The earliest day when the resource becomes overallocated. This date is calculated during the summarization. The address for the resource. The resource identifier within the organization, typically the 17

18 Gateway Developer's Guide GUID Id IntegratedType IsActive IsOverTimeAllowed LastUpdateDate LastUpdateUser LocationName LocationObjectId MaxUnitsPerTime Name ObjectId OfficePhone OtherPhone OvertimeFactor ParentObjectId employee number or social security number. The globally unique ID generated by the system. The short code that uniquely identifies the resource. The indicator that determines whether the resource is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the resource is integrated with Oracle Fusion. 'ERP' indicates the resource is integrated with another ERP system. The option that determines whether the resource is currently active. Non-active resources may be resources that have left the organization but not deleted from the system since they may have actual hours. The option that determines whether the resource is allowed to log overtime hours. The date this resource was last updated. The name of the user that last updated this resource. The name of the location assigned to the resource. The unique ID of the location assigned to the resource. The maximum work units per time this resource can perform on all their assigned activities. The name of the resource. The unique ID generated by the system. The office phone number for the resource. The other phone numbers for the resource - pager, home phone, cell phone, etc. The overtime factor used to compute the overtime price for the resource. The unique ID of the parent resource of this resource in the hierarchy. 18

19 Creating a Third-Party Provider PricePerUnit PrimaryRoleId PrimaryRoleName PrimaryRoleObjectId ResourceNotes ResourceType SequenceNumber ShiftObjectId TimesheetApprovalManager TimesheetApprovalManagerOb jectid Title UnitOfMeasureAbbreviation UseTimesheets UserName UserObjectId The planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost. The short code that uniquely identifies the primary role for this resource. The name of the primary role for this resource. The unique ID of the role that is assigned as the resource's primary role. The notes about the resource. The resource type: Labor resource performs labor and is measured in units of time, Nonlabor resource does not perform labor and is measured in units of time, Material resource has a unit of measure other than time. The sequence number for sorting. The unique ID of the shift associated with the resource. The resource manager assigned to approve timesheets for the resource. The unique ID of the resource manager assigned to approve timesheets for the resource. The title of the resource. The unique ID of the unit of measure this material resource uses. The option that determines whether the resource uses timesheets. The user's login name. The unique ID of the associated user. 19

20 Gateway Developer's Guide P6 Business Object: ResourceRate : Resource rates provide a way of specifying multiple resource prices and maximum units per time values that vary over time. CreateDate CreateUser EffectiveDate LastUpdateDate LastUpdateUser MaxUnitsPerTim e ObjectId PricePerUnit PricePerUnit2 PricePerUnit3 PricePerUnit4 PricePerUnit5 ResourceId ResourceName ResourceObjectI d ShiftPeriodObjec tid The date this resource rate was created. The name of the user that created this resource rate. The effective date for the resource price and maximum units per time. The date this resource rate was last updated. The name of the user that last updated this resource rate. The maximum work units per time this resource can perform on all their assigned activities. The unique ID generated by the system. The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. The non-overtime price per time for the resource. This price is used to compute costs for any activities the resource is assigned to. The short code that uniquely identifies the resource. The name of the resource. The unique ID of the associated resource. The unique ID of the associated shift. 20

21 Creating a Third-Party Provider P6 Business Object: Role : Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. Id ObjectId Name SequenceNumber ParentObjectId CalculateCostFromU nits Responsibilities LastUpdateDate LastUpdateUser CreateDate CreateUser The short code that uniquely identifies the role. The unique ID generated by the system. The name of the role. The sequence number for sorting. The unique ID of the parent role of this role in the hierarchy. The option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated. The responsibilities for the role. The date this role was last updated. The name of the user that last updated this role. The date this role was created. The name of the user that created this role. 21

22 Gateway Developer's Guide P6 Business Object: RoleRate : Role rates enable you to select a predefined price per unit for cost calculating when assigning the role to an activity. CreateDate CreateUser LastUpdateDat e LastUpdateUs er ObjectId PricePerUnit PricePerUnit2 PricePerUnit3 PricePerUnit4 PricePerUnit5 RoleId RoleName RoleObjectId The date this role rate was created. The name of the user that created this role rate. The date this role rate was last updated. The name of the user that last updated this role rate. The unique ID generated by the system. The non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. The non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. The non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. The non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. The non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. The short code that uniquely identifies the role. The name of the role. The unique ID of the associated role. 22

23 Creating a Third-Party Provider P6 Business Object: ExpenseCategory : Expense categories are used to categorize project expenses. They are used for standardizing expenses and for rolling up expenses across projects. ObjectId Name CreateDate CreateUser The unique ID generated by the system. The name of the expense category. The date this expense category was created. The name of the user that created this expense category. LastUpdateDate The date this expense category was last updated. LastUpdateUser The name of the user that last updated this expense category. SequenceNumb er The sequence number for sorting. 23

24 Gateway Developer's Guide P6 Business Object: Project : A project is a temporary endeavor undertaken to create a unique product, service, or result. Projects usually contain a work breakdown structure (WBS) and activities. ObjectId Name Status Id PlannedStartDate MustFinishByDate ParentEPSObjectId ActivityDefaultActivityType ActivityDefaultCalendarObjectId ActivityDefaultCalendarName ActivityDefaultCostAccountObjectId ActivityDefaultDurationType ActivityDefaultPercentCompleteType ActivityDefaultPricePerUnit ActivityIdBasedOnSelectedActivity ActivityIdIncrement The unique ID generated by the system. The name of the The status of the The short id assigned to each project for identification. The planned start date of the The date by which all project activities must finish. The unique ID of the parent EPS of this Indicates the activitytype of the activity. The unique ID of the Activity Default Calendar of this The name of the Activity Default Calendar of this The unique ID of the Activity Default Cost Acount of this Indicates the activity default duration type of the activity.. Indicates the activity default percent complete type of the activity.. The activity default price per unit for a activity. The boolean activity id based on selected activity indicator of the activity. The increment value of the activity Id. 24

25 Creating a Third-Party Provider ActivityIdPrefix ActivityIdSuffix ActivityPercentCompleteBasedOnActivitySteps AddActualToRemaining AddedBy AllowNegativeActualUnitsFlag AnnualDiscountRate AnticipatedFinishDate AnticipatedStartDate AssignmentDefaultDrivingFlag AssignmentDefaultRateType CheckOutDate CheckOutStatus CheckOutUserObjectId ContainsSummaryData ContractManagementGroupName ContractManagementProjectName CostQuantityRecalculateFlag The prefix value of the activity Id. The suffix value of the activity Id. The boolean activity percent complete based on activity steps value of the prject. The boolean add actual to remaining value of the activity. The addedby value of the The boolean allow negative actual units flag value of the activity. The annual discount rate value of the The anticipated finish date of the The anticipated start date of the The boolean assignment default driving flag value of the assignment. Indicates the default rate type of the assignment. The check out date of the The boolean check out status flag value of the The check out user objectid value. The boolean contains summary data flag of the The contract management group name value of the The contract management project name value of the The boolean cost quantity recalculate flag of the 25

26 Gateway Developer's Guide CreateDate CreateUser CriticalActivityFloatLimit CriticalActivityPathType CurrentBaselineProjectObjectId CurrentBudget CurrentVariance DataDate DateAdded DefaultPriceTimeUnits DiscountApplicationPeriod DistributedCurrentBudget EarnedValueComputeType EarnedValueETCComputeType EarnedValueETCUserValue EarnedValueUserPercent EnablePublication EnableSummarization The created date of the The user who created the The critical activity float limit. Indicates Activity critical path type. The current baseline project objectid of the The current budget of the The current variance of the The data date of the The date added of the Indicates default price time units of the activity The description of the Indicates discount application period of the project The distributed current budget of the Indicates earned value compute type of the project Indicates earned value ETC compute type of the project The earned value ETC user value for project computing earned value. The earned value user percent for project to compute earned value. The boolean enable publication flag of the The boolean enable summarization flag of the 26

27 Creating a Third-Party Provider FinishDate FiscalYearStartMonth ForecastFinishDate ForecastStartDate GUID HasFutureBucketData IndependentETCLaborUnits IndependentETCTotalCost IntegratedType IsTemplate LastApplyActualsDate LastFinancialPeriodObjectId LastLevelDate LastPublishedOn LastScheduleDate LastSummarizedDate LastUpdateDate LastUpdateUser LevelingPriority LinkActualToActualThisPeriod The date finish date of the The fiscal year start month of the The date forecast finish date of the The date forecast start date of the The GUID of the The boolean has future bucket data flag of the The independent ETC labor units of the The independent ETC total cost of the The type of system integration, if any, in place at the organization. The boolean is template flag of the The last apply actuals date of the The last financial period objectid of the The last leveling date of the The date last published on of the The last schedule date of the The last summarized date of the The last update date of the The last update user of the The leveling priority of the The boolean link actual to actual this period 27

28 Gateway Developer's Guide LinkPercentCompleteWithActual LinkPlannedAndAtCompletionFlag OBSName NetPresentValue OBSObjectId OriginalBudget OverallProjectScore OwnerResourceObjectId ParentEPSId PaybackPeriod PrimaryResourcesCanMarkActivitiesAsComplete d ProjectForecastStartDate ProposedBudget PublicationPriority ResetPlannedToRemainingFlag ResourceCanBeAssignedToSameActivityMoreTh anonce ResourcesCanAssignThemselvesToActivities ResourcesCanEditAssignmentPercentComplete of the The boolean link percent complete with actual of the The boolean link planned and atcompletion flag of the The obs name of the The net present value of the The obs object id of the The original budget of the The overall project score of the The owner resource objectid of the The parent eps id of the The pay back period of the The boolean primary resources can mark activities as completed flag of the The forecast start date of the The proposed budget of the The publication priority of the The boolean reset planned to remaining flag of the The boolean resource can be assigned to same activity more than once flag of the The boolean resource can assign themselves to activities of the The boolean resource can edit assignment percent complete of the 28

29 Creating a Third-Party Provider ResourcesCanMarkAssignmentAsCompleted ResourcesCanViewInactiveActivities ReturnOnInvestment RiskExposure RiskLevel RiskMatrixObjectId RiskScore ScheduledFinishDate SourceProjectObjectId StartDate StrategicPriority SummarizeToWBSLevel SummarizedDataDate SummaryAccountingVarianceByCost SummaryAccountingVarianceByLaborUnits SummaryActivityCount SummaryActualDuration SummaryActualExpenseCost SummaryActualFinishDate SummaryActualLaborCost SummaryActualLaborUnits The boolean resource can mark assignment as completed of the The boolean resource can view inactive activities of the The return on investment of the The proposed budget of the Indicates risk level of the project The risk matrix objectid of the The risk score of the The scheduled finish date of the The source project objectid of the The start date of the The strategic priority of the The summarize to wbs level of the The summarized data date of the The summary accounting variance by cost of the The summary accounting variance by labor units of the The summary activity count of the The summary actual duration of the The summary actual expense costof the The summary actual finish date of the The summary actual labor cost of the The summary actual labor units of the 29

30 Gateway Developer's Guide SummaryActualMaterialCost SummaryActualNonLaborCost SummaryActualNonLaborUnits SummaryActualStartDate SummaryActualThisPeriodCost SummaryActualThisPeriodLaborCost SummaryActualThisPeriodLaborUnits SummaryActualThisPeriodMaterialCost SummaryActualThisPeriodNonLaborCost SummaryActualThisPeriodNonLaborUnits SummaryActualTotalCost SummaryActualValueByCost SummaryActualValueByLaborUnits SummaryAtCompletionDuration SummaryAtCompletionExpenseCost SummaryAtCompletionLaborCost The summary actual material cost of the The summary actual nonlabor cost of the The summary actual nonlabor units of the The summary actual start date of the The summary actual this period cost of the The summary actual this period labor cost of the The summary actual this period labor unit of the The summary actual this period material cost of the The summary actual this period nonlabor cost of the The summary actual this period nonlabor unit of the The summary actual total cost of the The summary actual value by cost of the The summary actual value by labor units of the The summary at completion duration of the The summary at completion expense cost of the The summary at completion labor cost of the 30

31 Creating a Third-Party Provider SummaryAtCompletionLaborUnits SummaryAtCompletionMaterialCost SummaryAtCompletionNonLaborCost SummaryAtCompletionNonLaborUnits SummaryAtCompletionTotalCost SummaryAtCompletionTotalCostVariance SummaryBaselineCompletedActivityCount SummaryBaselineDuration SummaryBaselineExpenseCost SummaryBaselineFinishDate SummaryBaselineInProgressActivityCount SummaryBaselineLaborCost SummaryBaselineLaborUnits SummaryBaselineMaterialCost SummaryBaselineNonLaborCost The summary at completion labor units of the The summary at completion material cost of the The summary at completion nonlabor cost of the The summary at completion nonlabor units of the The summary at completion total cost of the The summary at completion total cost variance of the The summary baseline completed activity count of the The summary baseline duration of the The summary baseline expense cost of the The summary baseline finish date of the The summary baseline in progress activity count of the The summary baseline labor cost of the The summary baseline labor units of the The summary baseline material cost of the The summary baseline nonlabor cost of the 31

32 Gateway Developer's Guide SummaryBaselineNonLaborUnits SummaryBaselineNotStartedActivityCount SummaryBaselineStartDate SummaryBaselineTotalCost SummaryBudgetAtCompletionByCost SummaryBudgetAtCompletionByLaborUnits SummaryCompletedActivityCount SummaryCostPercentComplete SummaryCostPercentOfPlanned SummaryCostPerformanceIndexByCost SummaryCostPerformanceIndexByLaborUnits SummaryCostVarianceByCost SummaryCostVarianceByLaborUnits SummaryCostVarianceIndex SummaryCostVarianceIndexByCost SummaryCostVarianceIndexByLaborUnits The summary baseline nonlabor Units of the The summary baseline not start activity count of the The summary baseline start date of the The summary baseline total cost of the The summary budget at comletion by cost of the The summary budget at completion by labor units of the The summary completed activity count of the The summary cost percent complete of the The summary cost percent of planned of the The summary cost performance index by cost of the The summary cost performance index by labor units of the The summary cost variance by cost of the The summary cost variance by labor units of the The summary cost variance index of the The summary cost variance index by cost of the The summary cost variance index by labor 32

33 Creating a Third-Party Provider SummaryDurationPercentComplete SummaryDurationPercentOfPlanned SummaryDurationVariance SummaryEarnedValueByCost SummaryEarnedValueByLaborUnits SummaryEstimateAtCompletionByCost SummaryEstimateAtCompletionByLaborUnits SummaryEstimateAtCompletionHighPercentByLa borunits SummaryEstimateAtCompletionLowPercentByLa borunits SummaryEstimateToCompleteByCost SummaryEstimateToCompleteByLaborUnits SummaryExpenseCostPercentComplete SummaryExpenseCostVariance SummaryFinishDateVariance SummaryInProgressActivityCount unit of the The summary duration percent complete of the The summary duration percent of planned of the The summary duration variance of the The summary earned value by cost of the The summary earned value by labor units of the The summary estimate at completion by cost of the The summary estimate at completion by labor units of the The summary estimate at completion high percent by labor units of the The summary estimate at completion low percent by labor units of the The summary estimate to completion by cost of the The summary estimate to completion by labor units of the The summary expense cost percent complete of the The summary expense cost variance of the The summary finish date variance of the The summary in progress activity count of the 33

34 Gateway Developer's Guide SummaryLaborCostPercentComplete SummaryLaborCostVariance SummaryLaborUnitsPercentComplete SummaryLaborUnitsVariance SummaryLevel SummaryMaterialCostPercentComplete SummaryMaterialCostVariance SummaryNonLaborCostPercentComplete SummaryNonLaborCostVariance SummaryNonLaborUnitsPercentComplete SummaryNonLaborUnitsVariance SummaryNotStartedActivityCount SummaryPerformancePercentCompleteByCost SummaryPerformancePercentCompleteByLabor Units SummaryPlannedCost SummaryPlannedDuration The summary labor cost percent complete of the The summary labor cost variance of the The summary labor units percent complete of the The summary labor units variance of the Indicates summary level of the project The summary material cost percent complete of the The summary material cost variance of the The summary nonlabor cost percent complete of the The summary nonlabor cost variance of the The summary nonlabor units percent complete of the The summary nonlabor units variance of the The summary non started activity count of the The summary performance percent complete by cost of the The summary performance percent complete by labor units of the The summary planned cost of the The summary planned duration of the 34

35 Creating a Third-Party Provider SummaryPlannedExpenseCost SummaryPlannedFinishDate SummaryPlannedLaborCost SummaryPlannedLaborUnits SummaryPlannedMaterialCost SummaryPlannedNonLaborCost SummaryPlannedNonLaborUnits SummaryPlannedStartDate SummaryPlannedValueByCost SummaryPlannedValueByLaborUnits SummaryProgressFinishDate SummaryRemainingDuration SummaryRemainingExpenseCost SummaryRemainingFinishDate SummaryRemainingLaborCost SummaryRemainingLaborUnits The summary planned expense cost of the The summary planned finish date of the The summary planned labor cost of the The summary planned labor units of the The summary planned material cost of the The summary planned non labor cost of the The summary planned non labor units of the The summary planned start date of the The summary planned value by cost of the The summary planned value by labor units of the The summary progress finish date of the The summary remaining duration of the The summary remaining expense cost of the The summary remaining finish date of the The summary remaining labor cost of the The summary remaining labor units of the 35

36 Gateway Developer's Guide SummaryRemainingMaterialCost SummaryRemainingNonLaborCost SummaryRemainingNonLaborUnits SummaryRemainingStartDate SummaryRemainingTotalCost SummarySchedulePercentComplete SummarySchedulePercentCompleteByLaborUnit s SummarySchedulePerformanceIndexByCost SummarySchedulePerformanceIndexByLaborUnit s SummaryScheduleVarianceByCost SummaryScheduleVarianceByLaborUnits SummaryScheduleVarianceIndex SummaryScheduleVarianceIndexByCost SummaryScheduleVarianceIndexByLaborUnits SummaryStartDateVariance The summary remaining material cost of the The summary remaining non labor cost of the The summary remaining non labor units of the The summary remaining start date of the The summary remaining total cost of the The summary schedule percent complete of the The summary schedule percent complete by labor units of the The summary schedule performance index by cost of the The summary schedule performance index by labor units of the The summary schedule variance by cost of the The summary schedule variance by labor units of the The summary schedule variance index of the The summary schedule variance index by cost of the The summary schedule variance index by labor units of the The summary start date variance of the 36

37 Creating a Third-Party Provider SummaryToCompletePerformanceIndexByCost SummaryTotalCostVariance SummaryTotalFloat SummaryUnitsPercentComplete SummaryVarianceAtCompletionByLaborUnits TotalBenefitPlan TotalBenefitPlanTally TotalFunding TotalSpendingPlan TotalSpendingPlanTally UnallocatedBudget UndistributedCurrentVariance UseProjectBaselineForEarnedValue WBSCodeSeparator WBSMilestonePercentComplete WBSObjectId WebSiteRootDirectory WebSiteURL The summary to complete performance index by costof the The summary total cost variance of the The summary total float of the The summary units percent complete of the The summary variance at completion by labor units of the The total benefit plan of the The total benefitplantally of the The total funding of the The total spending plan of the The total spending plantally of the The unallocated budget of the The undistributed current variance of the The boolean use project baseline for earned value of the The wbs code separator of the The wbs milestone percent complete of the The unique ID of the associated wbs. The web site root directory of the The web site URL of the 37

38 Gateway Developer's Guide P6 Business Object: WBS : The project work breakdown structure (WBS) is a hierarchical arrangement of the products and services produced during and by a Each element of a WBS may contain more-detailed WBS elements, activities, or both. WBS are hierarchical objects. ObjectId Name ProjectObjectId Code ParentObjectId WBSCategoryObjectId AnticipatedStartDate AnticipatedFinishDate ContainsSummaryData CreateDate CreateUser CurrentBudget CurrentVariance DistributedCurrentBudget EarnedValueComputeType EarnedValueETCComputeType The unique ID generated by the system. The name of the WBS. The unique ID of the associated The short code assigned to each WBS element for identification. The unique ID of the parent WBS of this WBS in the hierarchy. The unique wbs category objectidof the WBS. The anticipated start date of WBS, project and EPS elements. The anticipated finish date of WBS, project and EPS elements. The boolean contains summary data flag of the WBS. The created date of the WBS. The user who created the WBS. The current budget of the WBS. The current variance of the WBS. The distributed current budget of the WBS. Indicates earned value compute type of the WBS Indicates earned value ETC compute type of the WBS 38

39 Creating a Third-Party Provider EarnedValueETCUserValue EarnedValueUserPercent FinishDate ForecastFinishDate ForecastStartDate GUID IndependentETCLaborUnits IndependentETCTotalCost IntegratedType IsBaseline IsTemplate LastUpdateDate LastUpdateUser OBSName OBSObjectId OriginalBudget ProjectId ProposedBudget StartDate SequenceNumber Status SummaryAccountingVarianceByCost The earned value ETC user value for WBS computing earned value. The earned value user percent for WBS to compute earned value. The date finish date of the WBS. The date forecast finish date of the WBS. The date forecast start date of the WBS. The GUID of the WBS. The independent ETC labor units of the WBS. The independent ETC total cost of the WBS. Indicates integrated type of the WBS The boolean is baseline flag of the WBS. The boolean is template flag of the WBS. The last update date of the WBS. The last update user of the WBS. The obs name of the WBS. The obs object id of the WBS. The original budget of the The project Id of the WBS. The proposed budget of the WBS. The start date of the WBS. The sequence number of the WBS. The status of the WBS. The summary accounting variance by cost of 39

40 Gateway Developer's Guide SummaryAccountingVarianceByLaborUnits SummaryActivityCount SummaryActualDuration SummaryActualExpenseCost SummaryActualFinishDate SummaryActualLaborCost SummaryActualLaborUnits SummaryActualMaterialCost SummaryActualNonLaborCost SummaryActualNonLaborUnits SummaryActualStartDate SummaryActualThisPeriodCost SummaryActualThisPeriodLaborCost SummaryActualThisPeriodLaborUnits SummaryActualThisPeriodMaterialCost SummaryActualThisPeriodNonLaborCost SummaryActualThisPeriodNonLaborUnits the WBS. The summary accounting variance by labor units of the WBS. The summary activity count of the WBS. The summary actual duration of the WBS. The summary actual expense costof the WBS. The summary actual finish date of the WBS. The summary actual labor cost of the WBS. The summary actual labor units of the WBS. The summary actual material cost of the WBS. The summary actual nonlabor cost of the WBS. The summary actual nonlabor units of the WBS. The summary actual start date of the WBS. The summary actual this period cost of the WBS. The summary actual this period labor cost of the WBS. The summary actual this period labor unit of the WBS. The summary actual this period material cost of the WBS. The summary actual this period nonlabor cost of the WBS. The summary actual this period nonlabor unit of the WBS. 40

41 Creating a Third-Party Provider SummaryActualTotalCost SummaryActualValueByCost SummaryActualValueByLaborUnits SummaryAtCompletionDuration SummaryAtCompletionExpenseCost SummaryAtCompletionLaborCost SummaryAtCompletionLaborUnits SummaryAtCompletionMaterialCost SummaryAtCompletionNonLaborCost SummaryAtCompletionNonLaborUnits SummaryAtCompletionTotalCost SummaryAtCompletionTotalCostVariance SummaryBaselineCompletedActivityCount SummaryBaselineDuration SummaryBaselineExpenseCost SummaryBaselineFinishDate The summary actual total cost of the WBS. The summary actual value by cost of the WBS. The summary actual value by labor units of the WBS. The summary at completion duration of the WBS. The summary at completion expense cost of the WBS. The summary at completion labor cost of the WBS. The summary at completion labor units of the WBS. The summary at completion material cost of the WBS. The summary at completion nonlabor cost of the WBS. The summary at completion nonlabor units of the WBS. The summary at completion total cost of the WBS. The summary at completion total cost variance of the WBS. The summary baseline completed activity count of the WBS. The summary baseline duration of the WBS. The summary baseline expense cost of the WBS. The summary baseline finish date of the WBS. 41

42 Gateway Developer's Guide SummaryBaselineInProgressActivityCount SummaryBaselineLaborCost SummaryBaselineLaborUnits SummaryBaselineMaterialCost SummaryBaselineNonLaborCost SummaryBaselineNonLaborUnits SummaryBaselineNotStartedActivityCount SummaryBaselineStartDate SummaryBaselineTotalCost SummaryBudgetAtCompletionByCost SummaryBudgetAtCompletionByLaborUnits SummaryCompletedActivityCount SummaryCostPercentComplete SummaryCostPercentOfPlanned SummaryCostPerformanceIndexByCost SummaryCostPerformanceIndexByLaborUnits The summary baseline in progress activity count of the WBS. The summary baseline labor cost of the WBS. The summary baseline labor units of the WBS. The summary baseline material cost of the WBS. The summary baseline nonlabor cost of the WBS. The summary baseline nonlabor Units of the prowbsect. The summary baseline not start activity count of the WBS. The summary baseline start date of the WBS. The summary baseline total cost of the WBS. The summary budget at comletion by cost of the WBS. The summary budget at completion by labor units of the WBS. The summary completed activity count of the WBS. The summary cost percent complete of the WBS. The summary cost percent of planned of the WBS. The summary cost performance index by cost of the WBS. The summary cost performance index by labor units of the WBS. 42

43 Creating a Third-Party Provider SummaryCostVarianceByCost SummaryCostVarianceByLaborUnits SummaryCostVarianceIndex SummaryCostVarianceIndexByCost SummaryCostVarianceIndexByLaborUnits SummaryDurationPercentComplete SummaryDurationPercentOfPlanned SummaryDurationVariance SummaryEarnedValueByCost SummaryEarnedValueByLaborUnits SummaryEstimateAtCompletionByCost SummaryEstimateAtCompletionByLaborUnits SummaryEstimateAtCompletionHighPercentByLa borunits SummaryEstimateAtCompletionLowPercentByLa borunits SummaryEstimateToCompleteByCost SummaryEstimateToCompleteByLaborUnits The summary cost variance by cost of the WBS. The summary cost variance by labor units of the WBS. The summary cost variance index of the WBS. The summary cost variance index by cost of the WBS. The summary cost variance index by labor unit of the WBS. The summary duration percent complete of the WBS. The summary duration percent of planned of the WBS. The summary duration variance of the WBS. The summary earned value by cost of the WBS. The summary earned value by labor units of the WBS. The summary estimate at completion by cost of the WBS. The summary estimate at completion by labor units of the WBS. The summary estimate at completion high percent by labor units of the WBS. The summary estimate at completion low percent by labor units of the WBS. The summary estimate to completion by cost of the WBS. The summary estimate to completion by labor units of the WBS. 43

44 Gateway Developer's Guide SummaryExpenseCostPercentComplete SummaryExpenseCostVariance SummaryFinishDateVariance SummaryInProgressActivityCount SummaryLaborCostPercentComplete SummaryLaborCostVariance SummaryLaborUnitsPercentComplete SummaryLaborUnitsVariance SummaryMaterialCostPercentComplete SummaryMaterialCostVariance SummaryNonLaborCostPercentComplete SummaryNonLaborCostVariance SummaryNonLaborUnitsPercentComplete SummaryNonLaborUnitsVariance SummaryNotStartedActivityCount SummaryPerformancePercentCompleteByCost The summary expense cost percent complete of the WBS. The summary expense cost variance of the WBS. The summary finish date variance of the WBS. The summary in progress activity count of the WBS. The summary labor cost percent complete of the WBS. The summary labor cost variance of the WBS. The summary labor units percent complete of the WBS. The summary labor units variance of the WBS. The summary material cost percent complete of the WBS. The summary material cost variance of the WBS. The summary nonlabor cost percent complete of the WBS. The summary nonlabor cost variance of the WBS. The summary nonlabor units percent complete of the WBS. The summary nonlabor units variance of the WBS. The summary non started activity count of the WBS. The summary performance percent 44

45 Creating a Third-Party Provider SummaryPerformancePercentCompleteByLabor Units SummaryPlannedCost SummaryPlannedDuration SummaryPlannedExpenseCost SummaryPlannedFinishDate SummaryPlannedLaborCost SummaryPlannedLaborUnits SummaryPlannedMaterialCost SummaryPlannedNonLaborCost SummaryPlannedNonLaborUnits SummaryPlannedStartDate SummaryPlannedValueByCost SummaryPlannedValueByLaborUnits SummaryProgressFinishDate SummaryRemainingDuration SummaryRemainingExpenseCost complete by cost of the WBS. The summary performance percent complete by labor units of the WBS. The summary planned cost of the WBS. The summary planned duration of the WBS. The summary planned expense cost of the WBS. The summary planned finish date of the WBS. The summary planned labor cost of the WBS. The summary planned labor units of the WBS. The summary planned material cost of the WBS. The summary planned non labor cost of the WBS. The summary planned non labor units of the WBS. The summary planned start date of the WBS. The summary planned value by cost of the WBS. The summary planned value by labor units of the WBS. The summary progress finish date of the WBS. The summary remaining duration of the WBS. The summary remaining expense cost of the WBS. 45

46 Gateway Developer's Guide SummaryRemainingFinishDate SummaryRemainingLaborCost SummaryRemainingLaborUnits SummaryRemainingMaterialCost SummaryRemainingNonLaborCost SummaryRemainingNonLaborUnits SummaryRemainingStartDate SummaryRemainingTotalCost SummarySchedulePercentComplete SummarySchedulePercentCompleteByLaborUnits SummarySchedulePerformanceIndexByCost SummarySchedulePerformanceIndexByLaborUnit s SummaryScheduleVarianceByCost SummaryScheduleVarianceByLaborUnits SummaryScheduleVarianceIndex SummaryScheduleVarianceIndexByCost The summary remaining finish date of the WBS. The summary remaining labor cost of the WBS. The summary remaining labor units of the WBS. The summary remaining material cost of the WBS. The summary remaining non labor cost of the WBS. The summary remaining non labor units of the WBS. The summary remaining start date of the WBS. The summary remaining total cost of the WBS. The summary schedule percent complete of the WBS. The summary schedule percent complete by labor units of the WBS. The summary schedule performance index by cost of the WBS. The summary schedule performance index by labor units of the WBS. The summary schedule variance by cost of the WBS. The summary schedule variance by labor units of the WBS. The summary schedule variance index of the WBS. The summary schedule variance index by 46

47 Creating a Third-Party Provider SummaryScheduleVarianceIndexByLaborUnits SummaryStartDateVariance SummaryToCompletePerformanceIndexByCost SummaryTotalCostVariance SummaryTotalFloat SummaryUnitsPercentComplete SummaryVarianceAtCompletionByLaborUnits TotalBenefitPlan TotalBenefitPlanTally TotalSpendingPlan TotalSpendingPlanTally UnallocatedBudget UndistributedCurrentVariance WBSMilestonePercentComplete cost of the WBS. The summary schedule variance index by labor units of the WBS. The summary start date variance of the WBS. The summary to complete performance index by costof the WBS. The summary total cost variance of the WBS. The summary total float of the WBS. The summary units percent complete of the WBS. The summary variance at completion by labor units of the WBS. The total benefit plan of the WBS. The total benefitplantally of the WBS. The total spending plan of the WBS. The total spending plantally of the WBS. The unallocated budget of the WBS. The undistributed current variance of the WBS. The wbs milestone percent complete of the WBS. 47

48 Gateway Developer's Guide P6 Business Object: WBSCategory : As their name implies, WBS categories are used to categorize WBS elements. They are defined globally. ObjectId Name CreateDate CreateUser The unique ID generated by the system. The name of the WBS Category. The date this WBS Category was created. The name of the user that created this WBS Category. LastUpdateDate The date this WBS Category was last updated. LastUpdateUser The name of the user that last updated this WBS Category. SequenceNumb er The sequence number of the WBS Category. 48

49 Creating a Third-Party Provider P6 Business Object: Activity : An activity is a unit of work performed during the course of a AccountingVariance AccountingVarianceLaborUnits ActualDuration ActualExpenseCost ActualFinishDate ActualLaborCost ActualLaborUnits ActualMaterialCost ActualNonLaborCost ActualNonLaborUnits ActualStartDate ActualThisPeriodLaborCost The difference between the planned value of work scheduled and the actual cost of work performed. Computed as accounting variance = planned value - actual cost. A negative value indicates that actual costs have exceeded the scheduled costs. The difference between the planned value of work scheduled and the actual work performed. Computed as accounting variance labor units = planned value labor units - actual units. The activity actual duration percent of planned. Computed as actual duration / BL duration * 100. The value can exceed 100. The BL duration is the activity's at completion duration from the project baseline. The actual costs for all project expenses associated with the activity. The date on which the activity is actually finished. The actual costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity actual labor units * project default price / time. The actual units for all labor resources assigned to the activity. The sum of all regular and overtime costs for material resources. The actual costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. The actual units for all nonlabor resources assigned to the activity. The date on which the activity is actually started. The actual this period labor cost for all labor resources assigned to the activity. 49

50 Gateway Developer's Guide ActualThisPeriodLaborUnits ActualThisPeriodMaterialCost ActualThisPeriodNonLaborCost ActualThisPeriodNonLaborUnits ActualTotalCost ActualTotalUnits AtCompletionDuration AtCompletionExpenseCost AtCompletionLaborCost AtCompletionLaborUnits AtCompletionLaborUnitsVarianc e AtCompletionMaterialCost AtCompletionNonLaborCost AtCompletionNonLaborUnits The actual this period labor units (hours) for all labor resources assigned to the activity. The sum of all material resource costs for the current period. The actual this period nonlabor cost for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity actual nonlabor units * project default price / time. The actual this period nonlabor units (hours) for all nonlabor resources assigned to the activity. The actual total cost for the activity, including labor resources, nonlabor resources, and project expenses. Actual total cost = actual labor costs + actual nonlabor costs + actual expense costs. the sum of Actual Labor Units and Actual Nonlabor Units. The total working time from the activity's current start date to the current finish date. The sum of the actual plus remaining costs for all expenses associated with the activity. Computed as actual expense cost + remaining expense cost. The sum of the actual plus remaining costs for all labor resources assigned to the activity. Computed as actual labor cost + remaining labor cost. The sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. The project baseline planned total labor units minus the estimate at completion labor units. The sum of all actual and remaining costs for material resources. The sum of the actual plus remaining costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost + remaining nonlabor cost. The sum of the actual plus remaining units for all nonlabor 50

51 Creating a Third-Party Provider AtCompletionTotalCost AtCompletionTotalUnits AtCompletionVariance AutoComputeActuals Baseline1Duration Baseline1FinishDate Baseline1PlannedDuration Baseline1PlannedExpenseCost Baseline1PlannedLaborCost Baseline1PlannedLaborUnits Baseline1PlannedMaterialCost resources assigned to the activity. Computed as actual nonlabor units + remaining nonlabor units. The total cost at completion for the activity, including labor resources, nonlabor resources, and project expenses. At completion total cost = at completion labor cost + at completion nonlabor cost + at completion expense cost. The sum of the actual plus remaining units for the resource assignment on the activity. The difference between the project baseline total cost and the current estimate of total cost. Computed as VAC = BAC - EAC. A negative value indicates an estimated cost overrun. BAC is computed from the current project baseline. The option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. The duration for the activity in the primary baseline. The current finish date of the activity in the primary baseline. The planned duration for the activity in the primary baseline. Planned duration is the total working time from the activity current start date to the current finish date. The planned costs for all project expenses associated with the activity. This field is named Baseline 1 Budgeted Expense Cost in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The cost at completion for all labor resources assigned to the activity in the primary baseline. Computed from the primary baseline at completion labor units. The planned units for all labor resources assigned to the activity. This field is named Baseline 1 Budgeted Labor Units in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The Planned Material Cost for a primary baseline activity. Baseline1PlannedNonLaborCost The planned costs for all nonlabor resources assigned to the 51

52 Gateway Developer's Guide Baseline1PlannedNonLaborUnits Baseline1PlannedTotalCost Baseline1StartDate BaselineDuration BaselineFinishDate BaselinePlannedDuration BaselinePlannedExpenseCost BaselinePlannedLaborCost BaselinePlannedLaborUnits BaselinePlannedMaterialCost BaselinePlannedNonLaborCost BaselinePlannedNonLaborUnits BaselinePlannedTotalCost BaselineStartDate BudgetAtCompletion activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. The planned units for all nonlabor resources assigned to the activity. This field is named Baseline 1 Budgeted Non Labor Units in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. Planned total cost = planned labor cost + planned nonlabor cost + planned expense cost. The current start date of the activity in the primary baseline. Set to the planned start date until the activity is started, then set to the actual start date. The duration for the activity in the project baseline. The current finish date of the activity in the project baseline. The planned duration for the activity in the project baseline. The planned costs for all project expenses associated with the activity. The cost at completion for all labor resources assigned to the activity in the project baseline. The planned units for all labor resources assigned to the activity. The Planned Material Cost for a project baseline activity. The planned costs for all nonlabor resources assigned to the activity. The planned units for all nonlabor resources assigned to the activity. The planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. The current start date of the activity in the project baseline. The planned total cost through activity completion. 52

53 Creating a Third-Party Provider CalendarName CalendarObjectId CostPercentComplete CostPercentOfPlanned CostPerformanceIndex CostPerformanceIndexLaborUni ts CostVariance CostVarianceIndex CostVarianceIndexLaborUnits CostVarianceLaborUnits CreateDate CreateUser DataDate Duration1Variance The name of the calendar. The unique ID of the calendar assigned to the activity. Activity calendars can be assigned from the global calendar pool or the project calendar pool. The percent complete of costs for all labor resources, nonlabor resources, and expenses for the activity. The percent complete of planned costs for all labor resources, nonlabor resources, and expenses for the activity. The earned value divided by the actual cost. A value less than 1 indicates that actual cost have exceeded the planned value. The ratio of the earned value labor units and the actual work performed. Computed as CPI labor units = earned value labor units / actual labor units. The difference between the earned value and the actual cost of work performed. Computed as CV = earned value - actual costs. The ratio of the cost variance and the earned value of work performed. Computed as CVI = cost variance / earned value. The ratio of the cost variance labor units and the earned value of work performed. Computed as CVI labor units = CV labor units / earned value labor units. The difference between the earned value of labor units and the actual cost of labor units. Calculated as CV labor units = earned value planned units - actual units. The date this activity was created. The name of the user that created this activity. The current data date for the The project status is up to date as of the data date. The data date is modified when project actuals are applied. The duration between the activity's primary baseline duration and the at complete duration. Computed as primary baseline duration - at completion duration. 53

54 Gateway Developer's Guide DurationPercentComplete DurationPercentOfPlanned DurationType DurationVariance EarlyFinishDate EarlyStartDate EarnedValueCost EarnedValueLaborUnits EstimateAtCompletionCost EstimateAtCompletionLaborUnit s EstimateToComplete The percent complete of the activity duration. Computed as (planned duration - remaining duration) / planned duration * 100. Always in the range 0 to 100. The activity actual duration percent of planned. Computed as actual duration / BL duration * 100. The value can exceed 100. The BL duration is the activity's at completion duration from the project baseline. The duration type of the activity. One of 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. The duration between the activity's project baseline duration and the at complete duration. Computed as project baseline duration - at completion duration. The earliest possible date the activity can finish. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. The earliest possible date the remaining work for the activity can begin. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. The portion of the project baseline total cost of the activity that is actually completed as of the project data date. Computed as earned value = BAC * performance % complete. The portion of the project baseline labor units that is actually completed as of the project data date. Computed as labor units earned value = project baseline labor units * performance % complete. The estimated cost at completion for the activity. Computed as the actual total cost plus the estimate-to-complete cost; EAC = ACWP + ETC. The estimated labor units at completion of the activity. Calculated as actual labor units + estimate to complete labor units. The estimated cost to complete the activity. Computed as either the remaining total cost for the activity (remaining total cost), or as PF * (BAC - earned value), depending on the 54

55 Creating a Third-Party Provider EstimateToCompleteLaborUnits ExpectedFinishDate ExpenseCost1Variance ExpenseCostPercentComplete ExpenseCostVariance ExternalEarlyStartDate ExternalLateFinishDate Feedback FinishDate FinishDate1Variance FloatPath earned-value technique selected for the activity's WBS.. The estimated quantity to complete the activity. Computed as either the remaining total units for the activity (remaining total units), or as PF * (BL labor units - earned value), depending on the earned-value technique selected for the activity's WBS. The date the activity is expected to be finished according to the progress made on the activity's work products. The expected finish date is entered manually by people familiar with progress of the activity's work products. The difference between primary baseline expense cost and at completion expense cost. The percent complete of costs for all expenses associated with the activity. Computed as actual expense cost / at completion expense cost * 100. Always in the range 0 to 100. The difference between project baseline expense cost and at completion expense cost. Calculated as project baseline expense cost - at completion expense cost (at completion expense cost = actual expense cost + remaining expense cost). The date value that determines the early start date for imported activities with external constraints lost (relations from/to external projects that do not exist in the database). The date value that determines the Late Finish Date for imported activities with external constraints lost (from/to external projects that do not exist in the database). The feedback from the resource. The current finish date of the activity. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The duration between the finish date in the current project and the primary baseline finish date. Calculated as finish date - primary baseline finish date. The integer representing the critical path this activity is on. 55

56 Gateway Developer's Guide FreeFloat GUID HasFutureBucketData Id IsBaseline IsCritical IsLongestPath IsNewFeedback IsTemplate LaborCost1Variance LaborCostPercentComplete LaborCostVariance LaborUnits1Variance The value 1 is the most critical path, value 2 is the second most critical path, etc. The amount of time the activity can be delayed before delaying the start date of any successor activity. The globally unique ID generated by the system. The flag that indicates whether a resource assignment on the activity has future bucket data. The short ID that uniquely identifies the activity within the The boolean value indicating if this business object is related to a Project or Baseline The flag that indicates whether the activity is critical. An activity is critical when its total Float is below the critical duration specified for the Delaying critical activities will delay the finish date of the The flag that indicates whether an activity is on the longest path. The flag that indicates that a resource has sent feedback notes about this activity which have not been reviewed yet. The boolean value indicating if this business object is related to a template Project. The difference between primary baseline labor cost and at completion labor cost. Calculated as BL labor cost - at completion labor cost. The percent complete of costs for all labor resources assigned to the activity. Computed as actual labor cost / at completion labor cost * 100. Always in the range 0 to 100. The difference between project baseline labor cost and at completion labor cost. Calculated as BL labor cost - at completion labor cost. The difference between primary baseline labor units and at completion labor units. Calculated as BL labor units - at completion labor units. 56

57 Creating a Third-Party Provider LaborUnitsPercentComplete LaborUnitsVariance LastUpdateDate LastUpdateUser LateFinishDate LateStartDate LevelingPriority MaterialCost1Variance MaterialCostPercentComplete MaterialCostVariance Name NonLaborCost1Variance NonLaborCostPercentComplete The percent complete of units for all labor resources for the activity. Computed as actual labor units / at completion labor units * 100. Always in the range 0 to 100. The difference between project baseline labor units and at completion labor units. Calculated as BL labor units - at completion labor units. The date this activity was last updated. The name of the user that last updated this activity. The latest possible date the activity must finish without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. The latest possible date the remaining work for the activity must begin without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. The activity priority used to prioritize activities in a project when performing resource leveling. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'. The primary Baseline Planned Material Cost minus the At Completion Material Cost. The percent complete of costs for all material resources assigned to the activity. Computed as actual nonlabor cost / at completion nonlabor cost * 100. Always in the range 0 to 100. The project BaselinePlannedMaterialCost minus the AtCompletionMaterialCost. The name of the activity. The activity name does not have to be unique. The difference between the primary baseline nonlaborcost and at completion nonlabor cost. Calculated as BL nonlabor cost - at completion nonlabor cost. The percent complete of costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost / at completion nonlabor cost * 100. Always in the range 0 to

58 Gateway Developer's Guide NonLaborCostVariance NonLaborUnits1Variance NonLaborUnitsPercentComplet e NonLaborUnitsVariance NotesToResources ObjectId PercentComplete PercentCompleteType PerformancePercentComplete PhysicalPercentComplete PlannedDuration PlannedExpenseCost The difference between the project baseline labor cost and at completion labor cost. Calculated as BL nonlabor cost - at completion nonlabor cost. The difference between the primary baseline nonlabor units and at completion nonlabor units. Calculated as BL nonlabor units - at completion nonlabor units. The percent complete of units for all nonlabor resources for the activity. Computed as actual nonlabor units / at completion nonlabor units * 100. Always in the range 0 to 100. The difference between the project baseline labor units and at completion labor units. Calculated as BL nonlabor units - at completion nonlabor units. The notes from the project manager to the timesheet resources. The unique ID generated by the system. The activity percent complete. This value is tied to the activity duration % complete, units % complete, or physical % complete, depending on the setting for the activity's percent complete type. The activity percent complete type: 'Physical', 'Duration', or 'Units'. The activity performance percent complete. The performance percent complete is used to compute earned value. The physical percent complete, which can either be user entered or calculated from the activity's weighted steps. The total working time from the activity planned start date to the planned finish date. The planned working time is computed using the activity's calendar. The planned costs for all project expenses associated with the activity. This field is named BudgetedExpenseCost in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. 58

59 Creating a Third-Party Provider PlannedFinishDate PlannedLaborCost PlannedLaborUnits PlannedMaterialCost PlannedNonLaborCost PlannedNonLaborUnits PlannedStartDate PlannedTotalCost PlannedTotalUnits PlannedValueCost The date the activity is scheduled to finish. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. The planned costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity planned labor units * project default price / time. The planned units for all labor resources assigned to the activity. This field is named BudgetedLaborUnits in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The sum of all material resource costs. The planned costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity planned nonlabor units * project default price / time. The planned units for all nonlabor resources assigned to the activity. This field is named BudgetedNonLaborUnits in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The date the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has been started. The planned total cost for the activity, including labor resources, nonlabor resources, and project expenses. Planned total cost = planned labor cost + planned nonlabor cost + planned expense cost. The sum of Planned Labor Units and Planned Nonlabor Units. This field is named BudgetedTotalUnits in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The portion of the project baseline total cost of the activity that is scheduled to be completed as of the project data date. Computed as BAC * schedule % complete. Also known as the work scheduled to be performed for the activity. 59

60 Gateway Developer's Guide PlannedValueLaborUnits PrimaryConstraintDate PrimaryConstraintType PrimaryResourceId PrimaryResourceName PrimaryResourceObjectId ProjectId ProjectName ProjectObjectId The portion of the project baseline labor units that is scheduled to be completed as of the project data date. Computed as BL labor units * schedule % complete. The constraint date for the activity, if the activity has a constraint. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler. The type of constraint applied to the activity start or finish date. Activity constraints are used by the project scheduler. The name of the resource. The name of the resource. The unique ID of the primary resource for the activity. The primary resource is responsible for the overall work on the activity and updates the activity status using Timesheets. The short code of the associated The name of the associated The unique ID of the associated RemainingDuration RemainingEarlyFinishDate RemainingEarlyStartDate RemainingExpenseCost RemainingFloat RemainingLaborCost The remaining late end date, which is calculated by the scheduler. The date the remaining work for the activity is scheduled to begin. This date is computed by the project scheduler but can be updated manually by the project manager. The remaining costs for all project expenses associated with the activity. The amount of time remaining by which the activity can be delayed before delaying the project finish date. Computed as late finish - remaining finish. The remaining costs for all labor resources assigned to the activity. If no resources are assigned, computed as the activity remaining labor units * project default price / time. 60

61 Creating a Third-Party Provider RemainingLaborUnits RemainingLateFinishDate RemainingLateStartDate RemainingMaterialCost RemainingNonLaborCost RemainingNonLaborUnits RemainingTotalCost RemainingTotalUnits ResumeDate ReviewFinishDate ReviewStatus SchedulePercentComplete SchedulePerformanceIndex The remaining units for all labor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. The remaining late finish date calculated by the scheduler. The remaining late start date calculated by the scheduler. The sum of all material resource remaining costs. The remaining costs for all nonlabor resources assigned to the activity. If no resources are assigned, computed as the activity remaining nonlabor units * project default price / time. The remaining units for all nonlabor resources assigned to the activity. The remaining units reflects the work remaining to be done for the activity. The remaining total cost for the activity, including labor resources, nonlabor resources, and project expenses. Remaining total cost = remaining labor costs + remaining nonlabor costs + remaining expense costs. The sum of Remaining Labor Units and Remaining Nonlabor Units. The date when a suspended task or resource dependent activity should be resumed. The resume date must be later than the suspend date and earlier than the actual finish date. The finish date of the activity as proposed by the primary resource using Timesheets, while the activity is in "For Review" state. If the project manager approves the activity completion, the review finish is copied to the actual finish. The activity review status. Valid values are 'OK', 'For Review', and 'Rejected'. Primary resources set the status to 'For Review' when they believe the activity is completed but are not allowed to mark activities as completed. The activity schedule percent complete, which specifies how much of the activity's project baseline duration has been completed so far. The ratio of the earned value of work performed and the work scheduled to be performed. Computed as SPI = earned 61

62 Gateway Developer's Guide SchedulePerformanceIndexLabor Units ScheduleVariance ScheduleVarianceIndex ScheduleVarianceIndexLaborUnit s ScheduleVarianceLaborUnits SecondaryConstraintDate SecondaryConstraintType StartDate StartDate1Variance StartDateVariance Status SuspendDate value/ planned value. A value less than 1 indicates that less work was actually performed than was scheduled. The ratio of the earned value of labor units and the planned value of labor units. Computed as SPI labor units = earned value labor units / planned value labor units. The difference between the earned value of work performed and the work scheduled to be performed. Computed as SV = earned value - planned value. A negative value indicates that less work was actually performed than was scheduled. The ratio of the schedule variance and the work scheduled to be performed. Computed as SVI = SV / planned value. The ratio of the schedule variance and the work scheduled to be performed. Computed as SVI labor units = SV labor units / planned value labor units. The difference between the earned value of work performed and the work scheduled to be performed. Computed as SV labor units = earned value labor units - planned value labor units. The date to be used for the cstr_type2 assignment, if the activity has a cstr_type2 value. The activity's constraint type determines whether this is a start date or finish date. Activity constraints are used by the project scheduler. The additional constraint to be used by the scheduler. The start date of the activity. Set to the remaining start date until the activity is started, then set to the actual start date. The duration between the start date in the current project and the primary baseline start date. Calculated as start date - primary baseline start date. The duration between the start date in the current project and the project baseline start date. Calculated as start date - project baseline start date. The current status of the activity, either 'Not Started', 'In Progress', or 'Completed'. The start date when the progress of a task or resource 62

63 Creating a Third-Party Provider ToCompletePerformanceIndex TotalCost1Variance TotalCostVariance TotalFloat Type UnitsPercentComplete WBSCode WBSName WBSObjectId dependent activity is delayed from. The suspend date must be later than the actual start date, which the activity must have. The TCPI, which is calculated as (budget at completion - earned value) / (estimate at completion - ACWP). The difference between the primary baseline total cost and the at completion total cost. Calculated as BL total cost - at completion total cost. The difference between the project baseline total cost and the at completion total cost. Calculated as BL total cost - at completion total cost. The amount of time the activity can be delayed before delaying the project finish date. Total float can be computed as late start - early start or as late finish - early finish; this option can be set when running the project scheduler. The type of activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', 'Start Milestone', 'Finish Milestone', or 'WBS Summary'. The percent complete of units for all labor and nonlabor resources assigned to the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes. The name of the WBS element. The unique ID of the WBS for the activity. 63

64 Gateway Developer's Guide P6 Business Object: ActivityExpense : Activity expenses are non-resource costs associated with a project and assigned to a project's activities. They are typically one-time expenditures for non-reusable items. AccrualType ActivityId ActivityName ActivityObjectId ActualCost ActualUnits AtCompletionCost AtCompletionUnits AutoComputeActuals CostAccountId CostAccountName CostAccountObjectId CreateDate CreateUser DocumentNumber ExpenseCategoryName The accrual type for the project expense. If the accrual type is 'Start of Activity', the entire expense costs are accrued at the start date of the activity. The short ID that uniquely identifies the activity within the The name of the activity. The activity name does not have to be unique. The unique ID of the activity to which the project expense is linked. Every project expense is associated with one activity in the The actual cost for the project expense. The actual units for the project expense. The sum of the actual plus remaining costs for the project expense. Computed as actual cost + remaining cost. The at completion units for the project expense. The flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete. The ID of associated cost account. The name of the associated cost account. The unique ID of the cost account associated with the project expense. The date this expense was created. The name of the user that created this expense. The document number for the expense. Use this for the purchase order number, invoice number, requisition number, or similar, as needed. The name of the expense category. 64

65 Creating a Third-Party Provider ExpenseCategoryObjectI d Expense ExpenseItem The unique ID of the expense category for the project expense. The description of the expense. The name of the project expense. ExpensePercentComplete The percent complete of the project expense. IsBaseline IsTemplate LastUpdateDate LastUpdateUser ObjectId OverBudget PlannedCost PlannedUnits PricePerUnit ProjectId ProjectObjectId RemainingCost RemainingUnits UnitOfMeasure The boolean value indicating if this business object is related to a Project or Baseline. The boolean value indicating if this business object is related to a template Project. The date this expense was last updated. The name of the user that last updated this expense. The unique ID generated by the system. The indicator that reflects whether the project expense is over budget. An expense is over budget when the actual cost + remaining cost exceeds the planned cost. The planned cost for the project expense. This field is named BudgetedCost in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The planned number of units for the project expense. This number is multiplied by the price per unit to compute the planned cost. The planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost. The short code that uniquely identifies the The unique ID of the associated The remaining cost for the project expense. Before actual expenses are made, remaining cost should be the same as planned cost. The remaining units for the project expense. The unit of measure for the project expense. 65

66 Gateway Developer's Guide Vendor WBSObjectId The name of the vendor providing the product or service associated with the expense. The unique ID of the WBS for the activity. 66

67 Creating a Third-Party Provider P6 Business Object: ResourceAssignment : Resource assignments track the work of resources or roles that are performing various activities. ActivityId ActivityName ActivityObjectId ActualCost ActualDuration ActualFinishDate ActualOvertimeCost ActualOvertimeUnits ActualRegularCost ActualRegularUnits ActualStartDate ActualThisPeriodCost ActualThisPeriodUnits ActualUnits The short ID that uniquely identifies the activity within the The name of the activity. The activity name does not have to be unique. The unique ID of the activity to which the resource is assigned. The actual non-overtime plus overtime cost for the resource assignment on the activity. Computed as actual cost = actual regular cost + actual overtime cost. The actual duration for the resource assignment on the activity. The date the resource actually finished working on the activity. The actual overtime cost for the resource assignment on the activity. Computed as actual overtime cost = actual overtime units * cost per time * overtime factor. The actual overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. The actual non-overtime cost for the resource assignment on the activity. Computed as actual regular cost = actual regular units * cost per time. The actual non-overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. The date the resource actually started working on the activity. The actual this period cost (will be labor or nonlabor). The actual this period units (hours) (will be labor or nonlabor). The actual non-overtime plus overtime units worked by the resource on this activity. This value is computed from timesheets when project actuals are applied or may be entered directly by the project manager. 67

68 Gateway Developer's Guide AtCompletionCost AtCompletionDuration AtCompletionUnits AutoComputeActuals CalendarName CalendarObjectId CostAccountId CostAccountName CostAccountObjectId CreateDate CreateUser DrivingActivityDatesFlag FinishDate GUID HasFutureBucketData The sum of the actual plus remaining costs for the resource assignment on the activity. The total working time from the activity's current start date to the current finish date. The sum of the actual plus remaining units for the resource assignment on the activity. The option that determines whether the activity's actual and remaining units, start date, finish date, and percent complete are computed automatically using the planned dates, planned units and the schedule percent complete. The name of the calendar. The unique ID generated by the system for the calendar associated with the resource assignment. The id of associated cost account. The name of the associated cost account. The unique ID of the cost account associated with this resource assignment. The date this assignment was created. The name of the user that created this assignment. The flag indicating whether new resource/role assignments drive activity dates, by default. The finish date of the resource assignment on the activity. Set to the remaining finish date until the activity is completed, then set to the actual finish date. The globally unique ID generated by the system. The flag that indicates whether the assignment has future bucket data. IsActive IsBaseline IsCostUnitsLinked The flag that indicates whether this resource assignment is active. The flag that determines whether or not cost should be calculated 68

69 Creating a Third-Party Provider IsOvertimeAllowed IsPrimaryResource IsTemplate LastUpdateDate LastUpdateUser ObjectId OvertimeFactor PendingActualOvertime Units PendingActualRegularUni ts PendingPercentComplete PendingRemainingUnits PlannedCost PlannedDuration PlannedFinishDate based on units. The flag that indicates whether the resource is allowed to log overtime hours. The flag that indicates whether this resource is the activity's primary resource. The boolean value indicating if this business object is related to a template Project. The date this assignment was last updated. The name of the user that last updated this assignment. The unique ID generated by the system. The overtime factor used to compute the overtime price for the resource assignment on this activity. Overtime price = standard price * overtime factor. The actual overtime units worked by the resource on this activity. The actual nonovertime units worked by the resource on this activity. The estimate of the percentage of the resource's units of work completed on this activity. The pending percent complete is entered by each resource using Timesheets. The estimate of the resource's remaining units on this activity. The pending remaining units is entered by each resource using Timesheets. The planned cost for the resource assignment on the activity. Computed as planned cost = planned units * price per time. The planned working time for the resource assignment on the activity, from the resource's planned start date to the planned finish date. The date the resource is scheduled to finish working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. 69

70 Gateway Developer's Guide PlannedLag PlannedStartDate PlannedUnits PlannedUnitsPerTime PricePerUnit PriorActualOvertimeUni ts PriorActualRegularUnits Proficiency ProjectId ProjectObjectId RateSource RateType RemainingCost RemainingDuration The planned time lag between the activity's planned start date and the resource's planned start date on the activity. If the resource is planned to start work when the activity is planned to start, the planned lag is zero. The date the resource is scheduled to begin working on the activity. This date is computed by the project scheduler but can be updated manually by the project manager. The planned units of work for the resource assignment on the activity. This field is named BudgetedUnits in Primavera's Engineering and Construction and Maintenance and Turnaround solutions. The planned units per time at which the resource is to perform work on this activity. The price per time for the resource on this activity. This price is used to compute the resource's cost for the activity. The difference between the pending quantity value and the actual quantity value for overtime before applying the new actual value. The difference between the pending quantity value and the actual quantity value before applying the new actual value. The skill level that is associated with the role. The values are 'Master', 'Expert', 'Skilled', 'Proficient', and 'Inexperienced'. The short code that uniquely identifies the The unique ID of the associated The value that indicates which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'. The rate type that determines which of the five prices specified for the resource will be used to calculate the cost for the resource assignment. The remaining cost for the resource assignment on the activity. Computed as remaining cost = remaining units * cost per time. The remaining duration of the resource assignment. The remaining duration is the remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date. 70

71 Creating a Third-Party Provider RemainingFinishDate RemainingLag The date the resource is scheduled to finish the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. The time lag between the activity's remaining start date and the resource's remaining start date on the activity. RemainingLateFinishDate The remaining late finish date calculated by the scheduler. RemainingLateStartDate RemainingStartDate RemainingUnits RemainingUnitsPerTime The remaining late start date calculated by the scheduler. The date the resource is scheduled to begin the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. The remaining units of work to be performed by this resource on this activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero. The units per time at which the resource will be performing work on the remaining portion of this activity. ResourceCalendarName The name of the calendar for the resource. ResourceCurveName The name of the resource curve that determines how resources and costs are distributed over time for this activity. ResourceCurveObjectId The unique ID of the resource curve. ResourceId ResourceName ResourceObjectId ResourceType RoleId RoleName RoleObjectId The short code that uniquely identifies the resource. The name of the resource. The unique ID of the associated resource. The resource type: "Labor", "Nonlabor", or "Material". The short code that uniquely identifies the role. The name of the role. The role name uniquely identifies the role. The unique ID of the role the resource is performing on this activity. A resource may be assigned to the same activity more than once, performing different roles. 71

72 Gateway Developer's Guide StaffedRemainingCost StaffedRemainingUnits StartDate UnitsPercentComplete UnstaffedRemainingCost UnstaffedRemainingUnits WBSObjectId The time distribution of the resource's remaining cost for resource assignments that have filled a role. The time distribution of the resource's remaining units for resource assignments that have filled a role. The start date of the resource assignment on the activity. Set to the remaining start date until the activity is started, then set to the actual start date. The percent complete of units for the resource assignment on the activity. Computed as actual units / at completion units * 100. Always in the range 0 to 100. The time distribution of the resource's remaining cost for resource assignments that have not filled a role. The time distribution of the resource's remaining units for resource assignments that have not filled a role. The unique ID of the WBS for the activity. RolledupWBSObjectId 72

73 Creating a Third-Party Provider P6 Business Object: ProjectResource : Primavera's resource planning feature allows you to do high-level project planning for future project or project that does not require resource assignments at the activity level. CommittedFlag CreateDate CreateUser FinishDate IsBaseline IsTemplate LastUpdateDate LastUpdateUser LifeOfProjectFlag ObjectId ProjectId ProjectObjectId ProjectResourceCategoryNa me ProjectResourceCategoryOb jectid ResourceName ResourceObjectId The Boolean value that determines whether a resource is committed, and so, the resource assignment is stable and unlikely to change. When calculating availability, Primavera considers only assignments that are marked as committed. The date this project resource was created. The name of the user that created this project resource. The finish date of the assignment. By default, it is set to the Planned Start date of the project + 1 day, finishing at 5:00pm. The boolean value indicating if this business object is related to a Project or Baseline. The boolean value indicating if this business object is related to a template Project. The date this project resource was last updated. The name of the user that last updated this project resource. The Boolean value that determines whether a resource that is assigned to a project at Project or WBS level, has that assignment for the duration of the The unique ID generated by the system. The short code that uniquely identifies the associated The unique ID of the associated The name of the associated project resource category. The unique ID of the associated project resource category. The name of the associated resource. The unique ID of the associated resource. 73

74 Gateway Developer's Guide RoleName RoleObjectId StartDate Status WBSCode WBSObjectId The name of the associated role. The unique ID of the associated role. The start date of the assignment. By default, it is set to the Planned Start date of the If LifeOfProjectFlag is set to true, this date is set to the Project Planned Start date.. The project or WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'. The short code assigned to the associated WBS element for identification. The unique ID of the associated WBS. 74

75 Creating a Third-Party Provider P6 Business Object: Relationship : A relationship defines how an activity relates to the start or finish of another activity or assignment. These relationships, which form the logic of the project network, are used together with activity durations to determine schedule dates. CreateDate CreateUser IsPredecessorBaseline IsPredecessorTemplate IsSuccessorBaseline IsSuccessorTemplate Lag LastUpdateDate LastUpdateUser ObjectId PredecessorActivityId PredecessorActivityNam e PredecessorActivityObj ectid PredecessorActivityTyp e PredecessorProjectId PredecessorProjectObje The date this calendar was created. The name of the user that created this calendar. The boolean value indicating if the predecessor activity is related to a Project or Baseline The boolean value indicating if this business object is related to a template Project. The boolean value indicating if the successor activity is related to a Project or Baseline The boolean value indicating if this business object is related to a template Project. The time lag of the relationship. This is the time lag between the predecessor activity's start or finish date and the successor activity's start or finish date, depending on the relationship type. The date this resource code was last updated. The name of the user that last updated this resource code. The unique ID generated by the system. The unique ID of the predecessor activity. The name of the predecessor activity. The unique ID of the predecessor activity. The type of the predecessor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. The unique ID of the project that owns the predecessor activity. The unique ID of the project that owns the predecessor activity. 75

76 Gateway Developer's Guide ctid SuccessorActivityId SuccessorActivityName SuccessorActivityObject Id SuccessorActivityType SuccessorProjectId SuccessorProjectObjectI d Type The unique ID of the successor activity. The name of the successor activity. The unique ID of the successor activity. The type of the successor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. The unique ID of the project that owns the successor activity. The unique ID of the project that owns the successor activity. The type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'. 76

77 Creating a Third-Party Provider Step 2: Design and Create Data Definition XML files You will need to create the following XML files: MetaData:. Describes the ERP business objects and any fields that these business objects contain. MapTemplate: Describes how your ERP business objects map to the PDI and P6 metadata files. DVM: Lists the enumeration mappings for fields that have enumerated values. Provider: Describes the flows that the provider supports and defines which flow steps are the provider's responsibility. XRefData: Describes the keys that are used to establish the links between the business objects. ExtraMetaData: These files provide a mechanism that third-party providers can use to extend PDI or P6 Data dictionary. These files are typically used to describe any UDF and Code fields that a particular ERP or third-party system requires to be in P6, along with their corresponding fields in the PDI data format. 77

78

79 XML Files Included with Primavera Gateway When you install the Primavera Gateway, the installer invokes a Configuration Utility that uses XML files to load seed data into the Primavera Gateway database. When you develop an ERP provider, you invoke the dataloader to use the XML files that you have created or customized to load your customized seed data into the Primavera Gateway database. The following XML files are provided with the Primavera Gateway: Host and Framework files Host P6DVM.xml P6MetaData.xml P6Provider.xml PDI ExportProjectData.xml ImportMasterData.xml PDIMetaData.xml ERP Files Sample Provider (root folder) P6ExtraMetaData.xml PDIExtraMetaData.xml SampleDVM.xml SampleMapTemplate.xml SampleMetaData.xml SampleProvider.xml SampleXRefData.xml Schema folder Customization.xsd Dvm.xsd MetaData.xsd FlowDefinition.xsd Provider.xsd MapTemplate.xsd XRef.xsd When you create or customize an ERP provider, you can use the XML files that are included in the Sample Provider folder as a basis for your provider. You can refer to the files in the Host, PDI, and Schema folder as you customize or create your own ERP provider. You use the Gateway Configuration Utility to load new seed data that makes use of your ERP provider XML files into the Primavera Gateway. 79

80 Gateway Developer's Guide Primavera Gateway Schema Files Data Dictionary Files (*MetaData.xml) Purpose The data dictionary files provide the format for the data that can be synchronized by the Primavera Gateway. Schema file MetaData.xsd Contents A MetaData element that contains zero to many App elements, each of which contains the following child elements: Element Type Parent maxlength(255) App The optional element that describes the data dictionary. This description is displayed in the Summary area of the Data Dictionary tab in the Primavera Gateway GUI. Name maxlength(60) App The optional element that provides the name of the data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway GUI. Type 'Host' 'Guest' 'PDI' App The optional element that determines the type of data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway GUI. Version maxlength(60) App The optional element that provides the version of the data dictionary. The content of this element is listed in the Summary area of the Data Dictionary tab in the Primavera Gateway GUI. 80

81 Creating a Third-Party Provider Element Type Parent Category AppConfigs AppInstance CategoryType See the CategoryType table below. AppConfigsType See the AppConfigsType table below. AppInstanceType See the AppInstanceType table below. App App App BusinessObject BusinessObjectType App Zero to many elements containing child elements that define the structure of the fields. For example, a Project business object might contain a field that is named ID that has a data type of String. Zero to many elements containing child elements that describe the structure of the deployments. Zero to many elements containing child elements that describe the instantiation of a deployment. Zero to many elements containing child elements that define the business objects. Examples of business objects include Projects, Resources, and Activities. BusinessObject elements can contain zero or more elements. Elements in this node are included in the Business Objects area of the Data Dictionary tab of the Primavera Gateway GUI. 81

82 Gateway Developer's Guide CategoryType table Element Type Parent Name maxlength(255) Category The element that provides the name of the field category. maxlength(255) Category The element that describes the purpose of the field category. AppConfigs table AppConfig element that contains zero to many AppConfig elements. Element Type Parent Name maxlength(60) AppConfigs The element that defines the name that is used to look up the deployment in deployment code. Title maxlength(60) AppConfigs The element that provides the title text that is used in the Primavera Gateway GUI. SequenceNo int AppConfigs The element that controls the ordering of the item in the Primavera Gateway GUI. Type maxlength(10) AppConfigs The element that defines the data type of the configuration item. maxlength(255) AppConfigs The element that describes the configuration item. DefaultValue maxlength(255) AppConfigs The value that appears in the Primavera Gateway GUI and is used as the default value configuration item if no other input is provided. 82

83 Creating a Third-Party Provider AppInstanceType table Element Type Parent maxlength(60) AppInstance The element that describes the instantiated deployment. Name maxlength(60) AppInstance The name of the instantiated deployment. Configs ConfigsType AppInstance Zero to many elements containing child elements that describe the structure of instantiated deployments. ConfigType table Element Type Parent Name Configs Value Configs The element that provides the name of the configuration item. The element that provides the value of the configuration item. 83

84 Gateway Developer's Guide BusinessObjectType table Element Type Parent maxlength(60) BusinessObject The optional element that describes the business object. This description is presented in the Business Objects table on the Data Dictionary tab in the Primavera Gateway GUI. Name maxlength(60) BusinessObject The optional element that determines the name of the Business object. This name is presented in the Business Objects table on the Data Dictionary tab in the Primavera Gateway GUI. Type BusinessObject The zero to many elements that contain the fields that are related to the business object. 84

85 Creating a Third-Party Provider Type Tables Type Attribute Table Atribute Type Element category topic required boolean The optional attribute that relates the field to a particular Category element. The optional attribute used to specify an alternate name for the field. An example use is for specifying field name that contains spaces to be used as an alternate for the same field name without spaces. The optional attribute that determines whether the field must be synchronized. Type Element Table Element Type Parent maxlength(255) The optional element that describes the field. This description is presented in the s table on the Data Dictionary tab in the Primavera Gateway GUI. Name maxlength(60) The optional element that determines the name of the field. This name is presented in the s table of the Data Dictionary tab in the Primavera Gateway GUI. Type maxlength(10) Boolean DateTime Double Int String Enum The optional element that defines the data type of the value of the field's data when it is synchronized. 85

86 Gateway Developer's Guide Element Type Parent MaxLength positiveinteger MaxValue double MinValue double Value ValueType The optional element that defines the maximum length of the value of the field's data when it is synchronized. This element can be used with the Type element whose content is String to limit the field's data values. The optional element that defines the maximum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values. The optional element that defines the minimum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values. An optional element that defines the value of an enum field type. elements can contain zero or more Value elements if the element contains a Type element whose content is Enum. ValueType table Element Type Parent maxlength(255) Value An optional element that describes the fieldvalue. Value maxlength(60) Value An optional element that defines an enumerated value. 86

87 Creating a Third-Party Provider Provider Files (*Provider.xml) Purpose The provider files defines how the data will be exchanged between the P6 and the ERP application by defining the following information for each application: Flows Parameters Class path to Java code that implements the provider Schema file Provider.xsd Contents A Provider element containing the following elements: Element Type Parent ApplicationName maxlength(60) Provider The name of the application that is associated with this file. ClassPath maxlength(255) Provider The path to the Java class that implements the flow provider interfaces. FlowDefinition FlowDefinitionType Provider The container for the elements that describe the business objects that can be synchronized, the flows that the provider supports and the parameters that are associated with the flow. The information in the FlowDefinition element provides the ability to filter and limit what data is exchanged by the Primavera Gateway and corresponds to Flow Type in the GUI. 87

88 Gateway Developer's Guide FlowDefinitionType Table Element Type Parent Name maxlength(60) FlowDefinition The name of Flow. FlowBusinessObject FlowBusinessObjectType FlowDefinition FlowStep FlowStepType FlowDefinition Parameter ParameterType FlowDefinition The container for the element that defines the name of one of the business objects that can be included in the flow. The container for the element that defines the name of one of the individual steps in the flow which this provider supports or for which it provides an implementation. The container for the elements that defines the parameters that are associated with the business objects and flows. 88

89 Creating a Third-Party Provider FlowBusinessObjectType Table Element Type Parent Name maxlength(60) FlowBusinessObject FlowStepType Table Element Type Parent Name maxlength(60) FlowStep 89

90 Gateway Developer's Guide ParameterType Table Element Type Parent DefaultValue EnumerationOptions Name maxlength(255) maxlength(255) Parameter Parameter EnumerationOptionsType Parameter maxlength(60) Parameter Sequence int Parameter Title Type maxlength(255) maxlength(15) Boolean DateTime Double Int String Enum Custom Filter HiddenString Parameter Parameter The default value for this custom parameter that is used when the parameter is included in the flow and the value is not changed. The element that provides a description of the parameter. The element that contains the enumerated options. The element that provides the name of the parameter. The name is used to lookup the parameter in the provider Java code. The element that provides the mechanism for ordering the parameters. The element that provides the display title of the parameter. The element that defines the data type of the value of the field's data when it is synchronized. 90

91 Creating a Third-Party Provider EnumerationOptionsType Table Element Type Parent Enumeration EnumerationOptions The element that specifies the name of the enumeration. XRef.xml Purpose This file is used to describe the keys that are used to establish the links between the business objects. Schema file XRef.xsd Contents An XRefs element containing the following elements: Element Type Parents XRefMap XRefMapType XRefs The container element for the map. 91

92 Gateway Developer's Guide XRefMapType Table Element Type Parents GuestAppName XRefMap HostAppName XRefMap XRefObject XRefObjectType XRefMap The element that specifies the name of the guest (third party) application name. The name should match the appropriate /MetaData/App/Name that is specified in the *MetaData.xml file The element that specifies the name of the host (Primavera) application name. The name should match the appropriate /MetaData/App/Name that is specified in the *MetaData.xml file The container element for elements that identify the object and the identifiers. 92

93 Creating a Third-Party Provider XRefMapType Table Element Type Parents Name XRefObject GuestName XRefObject PDIName XRefObject HostName XRefObject GuestPrimaryKeyFiel dname HostPrimaryKey Name PDIPrimaryKey Name XRefObject XRefObject XRefObject The element that identifies the default name that is used when the GuestName, PDIName, or HostName is not specified. The Guest business object name if different from the value specified by the Name element. The PDI business object name if different from the value specified by the Name element. The Host business object name if different from the value specified by the Name element. The element that specifies the name of the Guest field to be used to find the matching field. The element that specifies the name of the Host field to be used to find the matching field. The element that specifies the name of the PDI field to be used to find the matching field. 93

94 Gateway Developer's Guide Data Value Mapping Files (*DVM.xml) Purpose The data value mapping files list the enumeration mappings for fields that have enumerated values. The P6DVM.xml file that is located in the host folder, which can be used as a reference, maps the P6 field enumerations to the PDI field enumerations. The sampleprovider/data folder contains a SampleDVM.xml file that provides an example use of this file to map the sample ERP provider field enumerations to the corresponding PDI field enumerations. Schema file Dvm.xsd Contents A ValueMaps element that contains zero to many ValueMap elements containing the following elements: Element Type Parents AppName maxlength(60) ValueMap The element that indicates the name of the application for which this mapping applies. This name must match the name of an App that is defined in a *MetaData.xml file.. For example, specify P6 as the content of the AppName element to indicate that the mapping applies to P6. PDIObjectName maxlength(60) ValueMap The element that indicates the name of the PDI object for which this mapping applies. PDIName maxlength(60) ValueMap The element that indicates the name of the PDI field for which this mapping applies. AppObjectName maxlength(60) ValueMap The element that indicates the name of the object for which this mapping applies. The object that is specified in this element must reside in the application that is specified by the AppName. AppName maxlength(60) ValueMap The element that indicates the name of the field for which this mapping applies. The element that is specified in this element must reside in the 94

95 Creating a Third-Party Provider Element Type Parents DirectCopy boolean ValueMap application that is specified by the AppName. The indicator that specifies whether to copy the field directly. Setting this element to true causes the system to copy the field without referring to the enumeration mappings. This element should only be set to true when the values are exactly the same in both side Item ItemType. See the ItemType table below. ValueMap The element that maps each AppName field enumeration to its corresponding PDI enumeration. There can be zero to many item elements. ItemType Table Element Type Parent PDIValue maxlength(60) Item The element that provides the enumerated value in the PDI. This element is required if the parent element is present. AppValue maxlength(60) Item The element that provides the enumerated value in the application that is specified by the AppName. This element is required if the parent element is present. 95

96 Gateway Developer's Guide The following is an example ValueMap: <ValueMap> <AppName>Sample</AppName> <PDIObjectName>Project</PDIObjectName> <PDIName>Status</PDIName> <AppObjectName>Project</AppObjectName> <AppName>Status</AppName> <Item> <PDIValue>Planned</PDIValue> <AppValue>SamplePlanned</AppValue> </Item> <Item> <PDIValue>Active</PDIValue> <AppValue>SampleActive</AppValue> </Item> <Item default="true"> <PDIValue>Inactive</PDIValue> <AppValue>SampleInactive</AppValue> </Item> <Item> <PDIValue>What-If</PDIValue> <AppValue>SampleInactive</AppValue> </Item> <Item> <PDIValue>Requested</PDIValue> <AppValue>SampleInactive</AppValue> </Item> </ValueMap> Default Attribute The Item element can include an optional default attribute. In the example above, Inactive, What-If, and Requested are all mapped to SampleInactive. In this case, when going from the PDI application to the Sample application, there is no ambiguity since there is a many to one relationship between the mappings. However, when going from the Sample application to the PDI, there is a one to many relationship between the mappings. In this case, the system resolves the ambiguity by mapping all of the Sample application SampleInactive enumerations for the Status field to the PDI Inactive enumeration. 96

97 Creating a Third-Party Provider Customization XML File Purpose This file is loaded into the system by the data loader utility and is used to extend the system by adding any of the following customizations to the specified P6 (Host), PDI, or ERP (Guest) application: s Custom Metadata (UDFs) Java custom Mappings Flow Definition Customizations Schema file Customization.xsd Contents A Customization element containing the following elements: Element Type Parents Name maxlength(60) Customization The optional element that specifies the name of the customization. Version maxlength(60) Customization The optional element that specifies the version of the customization. JavaClassPath maxlength(255) Customization The optional element that specifies the path to the customization file that loads the customization functions. This element is required if you are using Java customization. CustomMetadata CustomMetadataType Customization The optional element that contains zero to three App elements. An example use is to add references to user defined fields (UDFs) MapTemplates MapTemplatesType Customization The optional element that contains zero to many 97

98 Gateway Developer's Guide Element Type Parents MapTemplate elements that can be used to map additional fields. JavaCustomizationMap ping JavaCustomizationMappi ngtype Customization The zero to many optional elements that contain the following elements: GuestAppName (required if the parent is present). HostAppName (required if the parent is present). Zero to many Mapping elements. FlowDefinitionCustom ization FlowDefinitionCustomiz ationtype Customization The zero to many optional elements that allow you to add custom parameters to a particular flow. Contains the following elements: FlowDefinitionName element (required if the parent is present). DisableCompare boolean flag. Zero to many FlowStep elements. Zero to many Parameter elements. CustomMetadataType Table Element Type Parent App AppType CustomMetadata The application to which you are adding a user defined field (UDF). 98

99 Creating a Third-Party Provider AppType Table Element Type Parent Name maxlength(60) App The name of the application to which you are adding a user defined field (UDF). Category CategoryType App BusinessObject BusinessObjectType App Provides a mechanism for classifying fields. It is defined here and referenced by attribute "category" when a field is defined within a business object. For example, in the P6 provider, "udf" is defined as a field category to indicate that this field is an actual UDF in the P6 side. The zero to many BusinessObject elements that are containers for elements that relate to the business object specified by the Name element. CategoryType Table Element Type Parent Name maxlength(60) Category The name of the field category. maxlength(255) Category The description of the field category. 99

100 Gateway Developer's Guide BusinessObjectType Table Element Type Parent Name maxlength(60) BusinessObject Type BusinessObject The name of the business object to which you are adding the user defined field. The container element for elements that define various aspects about the field. Type Table Element Type Parent maxlength(255) The element that describes the field. This description is presented in the s table on the Data Dictionary tab in the Primavera Gateway GUI. Name maxlength(60) The element that determines the name of the field. This name is presented in the s table of the Data Dictionary tab in the Primavera Gateway GUI. Type maxlength(10) 'Boolean' 'DateTime' 'Double' 'Int' 'String' 'Enum' The element that defines the data type of the value of the field's data when it is synchronized. 100

101 Creating a Third-Party Provider MaxLength positiveinteger MaxValue double MinValue double Value ValueType The optional element that defines the maximum length of the value of the field's data when it is synchronized. This element can be used with the Type element whose content is String to limit the field's data values. The optional element that defines the maximum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values. The optional element that defines the minimum value of the field's data when it is synchronized. This element can be used with the Type element whose content is Int to limit the field's data values. An optional element that defines the value of an enum field type. elements can contain zero or more Value elements if the element contains a Type element whose content is Enum. 101

102 Gateway Developer's Guide ValueType Table Element Type Parent maxlength(255) Value An optional element that describes the fieldvalue. Value maxlength(60) Value An optional element that defines an enumerated value. MapTemplatesType Table Element Type Parents GuestAppName maxlength(60) Customization The name of the guest (third-party) application. HostAppName maxlength(60) Customization The name of the host application. MapTemplate MapTemplateTyp e Customization The container element that contains zero to many MapTemplate elements. 102

103 Creating a Third-Party Provider MapTemplateType Table Element Type Parents maxlength(255) MapTempla te The text that is used in the Primavera Gateway user interface to provide a description of the field mapping. GuestBusinessObject Name maxlength(60) MapTempla te The guest (third-party) business object name. This element is only necessary if the name is different from the name that is indicated by the PDIBusinessObjectName element. HostBusinessObjectN ame MapTemplateType MapTempla te The host business object name. This element is only necessary if the name is different from the name that is indicated by the PDIBusinessObjectName element. Name maxlength(60) MapTempla te The text that is used in the Primavera Gateway user interface to provide a name for the field mapping. PDIBusinessObjectNa me maxlength(60) MapTempla te The PDI business object name. Also indicates the guest and\or the host business object name if the GuestBusinessObjectName or the HostBusinessObjectName elements are omitted. Map MapType MapTempla te The element that specifies the field map. 103

104 Gateway Developer's Guide MapType Table Element Type Parents Guest maxlength(60) Map The element that specifies the name of the field that is involved in the mapping from the third-party provider side of the mapping. Host maxlength(60) Map The element that specifies the name of the field that is involved in the mapping from the Primavera provider side of the mapping. PDI maxlength(60) Map The element that specifies the name of the field that is involved in the mapping from the PDI side. JavaCustomizationMappingType Table Element Type Parents GuestAppName maxlength(60) JavaCustomizati onmapping The name of the third-party application in the apptable in the Gateway database. HostAppName maxlength(60) JavaCustomizati onmapping The name of the Primavera application in the apptable in the Gateway database. Mapping MappingType JavaCustomizati onmapping The element that specifies the field mapping. MappingType Table Element Type Parents maxlength(255) Mapping The description of the custom java field map 104

105 Creating a Third-Party Provider GuestBusinessObject Name maxlength(60) Mapping The name of the third-party business object that is involved in the mapping. HostBusinessObjectN ame maxlength(60) Mapping The name of the Primavera business object. Name maxlength(255) Mapping The name name of the field map that is used to look up the Java class in the code that you have written that contains customization logic. PDIBusinessObjectNa me maxlength(60) Mapping The name of the PDI business object that is involved in the field map. s stype Mapping The container element for the fields that are involved in the field map. 105

106 Gateway Developer's Guide stype Table Element Type Parents Guest maxlength(60) s The element that specifies the name of the field that is involved in the mapping from the third-party provider side of the mapping. Host maxlength(60) s The element that specifies the name of the field that is involved in the mapping from the Primavera provider side of the mapping. PDI maxlength(60) s The element that specifies the name of the field that is involved in the mapping from the PDI side. FlowDefinitionCustomizationType Table Element Type Parents FlowDefinitionName maxlength(60) FlowDefinitionC ustomization The name of the flow to which the parameters are to apply. DisableCompare boolean FlowDefinitionC ustomization The flag that when set to true causes compare to be disabled for all flowtypes. FlowStep FlowStepType FlowDefinitionC ustomization The element that contains lows define an end-to-end synchronization Parameter ParameterType FlowDefinitionC ustomization The element that specifies the properties of the Parameter. 106

107 Creating a Third-Party Provider FlowStepType Table Element Type Parents maxlength(255) FlowStep The element that describes the purpose of the flow step. Name maxlength(60) FlowStep The element that determines the name of the flow step. OwnerAppName maxlength(60) FlowStep The element that the system uses to determine which document format to use when parsing XML document data. For example, specifying P6 as the OwnerAppName causes the system to use the P6 format to interpret the data. 107

108 Gateway Developer's Guide Element Type Parents A number that determines when the step will run relative to the other steps in the flow. When this element is used in a customization.xml file, you can use the following SQL commands to determine the existing sequencing, from which you can determine an appropriate sequence number for a particular flow type. Sequence int FlowStep Note: This example returns the sequence number for the Export Project Data flow type. Revise the commands as appropriate for the other flow types. select fd.flowdef_name, fs.flowstep_name, fs.flowstep_type, fs.flowstep_seqno from flowstep fs, flowdef fd where fs.flowdef_id = fd.flowdef_id and fd.flowdef_name = 'Export Project Data' order by fd.flowdef_name, fs.flowstep_seqno; Type maxlength(20) 'Custom' FlowStep The element that specifies the flow step type. 'Custom' is the only valid value when this element is used in a customization.xml file. 108

109 Creating a Third-Party Provider ParameterType Table Element Type Parents DefaultValue maxlength(255) Parameter The default value for this custom parameter that is used when the parameter is included in the flow and the value is not changed. maxlength(255) Parameter The element that provides a description of the parameter. EnumerationOptions EnumerationOptions Type Parameter The element that contains the list of enumerated values when the Parameter element is specified as an enum. Name maxlength(60) Parameter The element that provides the name of the parameter. The name is used to lookup the parameter in the provider Java code. Sequence int Parameter The element that provides the mechanism for ordering the parameters. Title maxlength(255) Parameter The element that provides the display title of the parameter. Type maxlength(15) Boolean DateTime Double Int String Enum Custom Parameter The element that defines the data type of the value of the field's data when it is synchronized. 109

110 Gateway Developer's Guide EnumerationOptionsType Table Element Type Parents Enumeration EnumerationType EnumerationOpti ons The element that specifies the name of the enumeration. Example XML Files Example PDI XML Document Provider XML File <Provider> <ApplicationName>P6</ApplicationName> <ClassPath>com.oracle.pgbu.pdi.p6provider.P6Provider</ClassPath> <FlowDefinition> <Name>Import Primavera Project Data</Name> <FlowBusinessObject> <Name>Project</Name> </FlowBusinessObject>... <FlowStep> <Name>Convert PDI Project data to Host format</name> </FlowStep>... <Parameter> <DefaultValue>Imported Projects</DefaultValue> <>Destination location for synced projects</> <Title>EPS Location</Title> <Type>String</Type> </Parameter>... </FlowDefinition>... </Provider> 110

111 Creating a Third-Party Provider Example ERP XML Document <?xml version="1.0" encoding="utf-8"?> <Provider xmlns=" xmlns:xsi=" xsi:schemalocation=" Provider.xsd"> <ApplicationName>Sample</ApplicationName> <ClassPath>com.oracle.pgbu.pdi.sampleprovider.SampleProvider</ClassPath> <FlowDefinition> <Name>Import Project Data</Name> <FlowBusinessObject> <Name>Project</Name> </FlowBusinessObject>... <Parameter> <DefaultValue/> <>Place holder for project Id</> <Name>ImportProjectId</Name> <Sequence>1</Sequence> <Title>Import Project Id</Title> <Type>HiddenString</Type> </Parameter> <Parameter> <DefaultValue>Project:ImportProjectIds=E-1922,E-1833</DefaultValue> <>A comma separated list of project Ids</> <FilterOptions> <ObjectOptions> <ObjectName>Project</ObjectName> <> <Name>ImportProjectIds</Name> <DefaultValue>Comma Separated IDs</DefaultValue> </> </ObjectOptions> </FilterOptions> <Name>ERPProjectFilter</Name> <Sequence>2</Sequence> <Title>ERP Project Filter</Title> <Type>Filter</Type> </Parameter> </FlowDefinition>... </Provider> 111

112 Gateway Developer's Guide Step 3: Determine What Flows Are Required Determine whether you need to implement flows for importing master data, project data, or exporting project data. These flows are are organized differently, depending on the flows: How the Flow Steps are Organized when Importing Master Data The following list describes how the steps are organized in a typical flow that is used to import Master data from the third-party provider system into Primavera. Load Data from the third-party provider: This step loads the third-party data into the Gateway Framework so that it can be processed. Convert Data from the third-party provider format into the PDI Format: This step converts the third-party provider data into the PDI format. Convert Data from the PDI Format into the Primavera Format: This step converts the master data into the Primavera format so that it can be saved into the Primavera database. Save Step: This step saves the data into Primavera database. How the Flow Steps are Organized when Importing Project Data The following list describes how the steps are organized in a typical flow that is used to import data from the third-party system into Primavera. Load Data from the third-party provider: This step loads the third-party provider data into the Gateway Framework so that it can be processed. Convert Data from the third-party provider format into the PDI Format: This step converts the third-party provider data into the PDI format. The converted data is used as the source data for the compare step. Load Data from Primavera: This step loads the P6 data into the Gateway Framework so that it can be processed. Convert Data from the Primavera Format into PDI Format: This step converts the Primavera data to the PDI format. The converted data is used as the destination data for the compare step. Compare Step: This step compares the source PDI data with the destination PDI data. This step compares each XML object and uses the following rules to determine how the data is synchronized in the save step. If the data is in the source object but not in the destination object, the data is created in the destination object during the save step. If the data is in the destination object but not in the source node, the system performs the following steps: - Inspects the cross reference tables to determine whether the data has ever been synchronized. - Determines whether the delete parameter has been set for the flow. If the data is in the cross reference tables and the delete parameter has been set for the flow, the data is deleted from the destination during the save step. Otherwise, the data is not deleted in the save step. Objects that contain updated data are marked for synchronization. Objects that contain the same data in both the source and the destination nodes are ignored. 112

113 Creating a Third-Party Provider Convert Data from the PDI Format into the Primavera Format: This step converts project data that is marked for creation or synchronization into the Primavera format so that it can be saved into the Primavera database. Save Step: This step saves the data into P6. Any data that is marked for deletion is deleted from the P6 database. How the Flow Steps are Organized when Exporting Project Data The following list describes how the steps are organized in a typical flow that is used to export data from Primavera to the third-party system Load Data from Primavera: This step loads the P6 data into the Gateway Framework so that it can be processed. Convert Data from the Primavera Format into PDI Format: This step converts the P6 data to the PDI format. The converted data is used as the source data for the compare step. Load Data from the third-party provider: This step loads the third-party provider data into the Gateway Framework so that it can be processed. Convert Data from the third-party provider format into the PDI Format: This step converts the third-party provider data to the PDI format. The converted data is used as the destination data for the compare step. Compare Step: This step compares the source PDI with the destination PDI data. This step compares each object and uses the following rules to determine how the data is synchronized in the save step. If the data is in the source object but not in the destination object, the data is created in the destination node during the save step. If the data is in the destination object but not in the source node, the system performs the following steps: - Inspects the cross reference tables to determine whether the data has ever been synchronized. - Determines whether the delete parameter has been set for the flow. If the data is in the cross reference tables and the delete parameter has been set for the flow, the data is deleted from the destination during the save step. Otherwise, the data is not deleted in the save step. Objects that contain updated data are marked for synchronization. Objects that contain the same data in both the source and the destination nodes are ignored. Convert Data from the PDI Format into the third-party providerformat: This step converts project data that is marked for creation or synchronization into the third-party provider format so that it can be saved into the third-party system. Save Step: This step saves the data into the third-party system. Any data that is marked for deletion is deleted from the third-party provider system. 113

114 Gateway Developer's Guide Step 4: Write the Java Provider Code to Support the Flows Sample Flows There are two basic flow types. In the first type, all of the data is synchronized, regardless of whether the data has changed. Flow Type 1: Synchronize all of the data in the flow In the second type of flow, a compare step is introduced that synchronizes the delta. Flow Type 2 Synchronize Delta Information 114