Gateway Customization Guide
Contents
1. 7 Implementing the Customization Interfaces and Building Your 8 Creating the Customization XML File 15 Deploying a Customization aiden eae Naini Bain 15 Restarting the WebLogic Domain nn 17 Setting Up Your Environment Set up your environment as follows 1 Create a folder to contain your customization files This folder is known as the lt project_home gt folder 2 Locate the lt Primavera_Gateway_home gt pdi snapshots folder and copy the pdi jar file to an appropriate folder in your lt project_home gt folder 3 Put the pdi jar file in your project s classpath Gateway Customization Guide Implementing the Customization Interfaces and Building Your Project The Entrance to the Java Code The CustomizationHandler interface com oracle pgbu pdi customization CustomizationHandler provides the entry point into all of the Java code in the customization jar file and therefore must be implemented In the sample customization project the Customization class under com mycompany primavera integration custom package implements the CustomizationHandler interface The Gat2. Element Type Parents Description string restricted to Appt maxLength 10 FlowDefinition The role of the application PP ype Guest Customization in the flow Host PDI The element that contains FlowDefinition flow steps that define an Customization end to end synchronization FlowDefinition 18 element that Parameter ParameterT ype specifies the properties of Customization the parameter FlowStepType Table Element Type Parents Description string The element that Description restricted to FlowStep describes the purpose of maxLength 255 the flow step string The element that Name restricted to FlowStep determines the name of maxLength 60 the flow step The element that the system uses to determine which document format to use when parsing XML odi document data For example specifying OwnerAppType Guest FlowStep the OwnerAppType as Host Host and P6 is the host of the flow causes the system to ask the P6 provider to provide the implementation of this step 34 Appendix Contents of Customization XML Element Type Parents Description A number that determines when the step will run relative to the other steps in the flow When this element is used ina 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 p
3. FieldMapTemplates FieldMapTemplatesT ype Customization The optional element that contains zero to many FieldMapTemplate elements that can be used to map additional fields JavaCustomizationM apping JavaCustomizationM appingT ype Customization The zero to many optional elements that contain the following elements gt GuestAppName required if the parent is present gt HostAppName required if the parent is present gt Zero to many FieldMapping elements GroovyFieldMapping Templates GroovyFieldMapping TemplatesT ype Customization The optional element that contains zero to manny GroovyFieldMappingTe mplate elements 20 Appendix Contents of Customization XML Element Type Parents Description The zero to many optional elements that allow you to add custom parameters to a particular flow Contains the following elements gt FlowDefinitionName FlowDefinitionCusto FlowDefinitionCusto element required if mization mizationType 3 the parent is present gt DisableCompare boolean flag gt Zero to many FlowStep elements gt Zero to many Parameter elements CustomMetadataType Table Element Type Parent Description AppType For more details see CustomMetada The application to which A ou are adding a user E 1 3 UDF below CustomXRefType Table Element Type Pare
4. restricted to ppingTemplate business object in the maxLength 60 5 application string GroovyFieldMa The name of the restricted to ppingTemplate business object in the maxLength 60 5 application The Guest business _ string GroovyFieldMa object name if it is restricted to ppingTemplate different from the maxLength 60 5 PDIBusinessObjectName element The Host business object A string GroovyFieldMa name if it is different from aa restricted to ppingTemplate the maxLength 60 5 PDIBusinessObjectName element 30 Appendix Contents of Customization XML Element Type Parents Description Name to e Groovy maxLength 255 5 The name of the string GroovyFieldMa PDIBusinessObjectN raar dedw ppingTemplate PDIBusinessObjectName ame maxLength 60 in the Gateway data dictionary The GroovyFieldMapping being associated with the GuestBusinessObjectNa GroovyFieldMapping oleoyyricleMapp ina Set arn oe Type 5 HostBusinessObjectNam e and PDIBusinessObjectName GroovyFieldMappingType Table Element Type Parents Description string restricted to maxLength 10 GuestToPDI The direction of the data HostToPDI flow between the source Direction PDIToGuest application and PDIToHost pping destination application in App1ToPDI the GroovyFieldMapping App2ToPDI PDIToApp1 PDIToApp2 The fiel
5. lt App1BusinessObjectName gt Operation lt App1 BusinessObjectName gt lt Name gt Activity Cost Code Mapping lt Name gt lt PDIBusinessObjectName gt Activity lt PDIBusinessObjectName gt lt FieldMap gt lt App1 gt SampleCostCode lt App1 gt lt App2 gt CostCode lt App2 gt lt PDI gt CostCode lt PDI gt lt FieldMap gt lt FieldMapTemplate gt lt FieldMapTemplate gt lt Description gt Total planned cost for project object lt Description gt lt Name gt Project Customization Mapping lt Name gt lt PDIBusinessObjectName gt Project lt P DIBusinessObjectName gt lt FieldMap gt lt App1 gt TotalPlannedCost lt App1 gt lt App2 gt TotalPlannedCost lt App2 gt lt PDI gt TotalPlannedCost lt PDI gt lt FieldMap gt lt FieldMapTemplate gt lt FieldMapTemplates gt Foreign Key Mapping Foreign keys can now be defined and added in the data dictionary of the source and destination providers including Gateway Once defined the mapping can then be defined in a mapping template lt FieldMapTemplates gt lt App1Name gt Sample lt App1Name gt lt App2Name gt P6 lt App2Name gt lt FieldMapTemplate gt lt Description gt Demonstrating mapping foreign key in a mapping template lt Description gt lt App1BusinessObjectName gt Operation lt App1BusinessObjectName gt lt Name gt Sample Mapping Template lt Name gt lt PDIBusinessObjectName gt Activity lt PDIBusinessObjectName gt lt FieldMap gt lt App1 gt SampleWor
6. 60 string HostAppName restricted to Customization Wenas maxLength 60 PP The container element that contains zero to FieldMapTemplateTy feet many FieldMapTemplate pe Customization FieldMapTemplates included in the customization FieldMapTemplateType Table Element Type Parents Description The text that is used in string the Primavera Gateway Description restricted to T user interface to provide maxLength 255 a description of the field mapping The Guest business string object name if different la restricted to ee from the maxLength 60 PDIBusinessObjectName element The Host business object App2BusinessObjec FieldMapTemplateTy FieldMapTempl name if different from the tName pe ate PDIBusinessObjectName element Siri Guest business object GuestBusinessObje en ae dio FieldMapTempl name if different from ctName ate PDIBusinessObjectName maxLength 60 element Sim Host business object HostBusinessObject E di FieldMapTempl name if different from Name maxLength 60 ate PDIBusinessObjectName element 27 Gateway Customization Guide Element Type Parents Description The text that is used in string the Primavera Gateway Name restricted to user interface to provide maxLength 60 a name for the field mapping The PDI business object name Also indicates the guest and or the host PDIBusinessObject_ Sing Fiel
7. Namie App are adding a user defined field UDF Provides a mechanism ObjectCategory ObjectCategoryType App for classifying objects Provides a mechanism for classifying fields It is defined here and referenced by attribute category when a field is defined within a business FieldCategory FieldCategoryType App object For example in the P6 provider udf is defined as a field category to indicate that this field is an actual user defined field in the P6 EPPM side The zero to many business object elements that are containers for field elements that relate to the business object specified by the Name element All custom UDF fields defined in this element will be included when updating the business BusinessObject BusinessObjectType App object ObjectCategoryType Table Element Type Parent Description string Name raetricied ObjectCategor a dls of the object maxLength 60 y gory 23 Gateway Customization Guide Element Type Parent Description string Description restricted to erie maxLength 255 y gory FieldCategoryType Table Element Type Parent Description string Name restricted to FieldCategory es maxLength 60 gory string Description restricted to FieldCategory maxLength 255 gory BusinessObjectType Table Element Type Pare
8. administrator database administrator and the administrator for the third party or ERP system should read this guide Gateway Upgrade Guide Provides a sequence of procedures that must be completed to upgrade to a new version of Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party or ERP system should read this guide 40 For More Information Title Gateway Performance and Sizing Guide Description Provides hardware and software requirements for deploying Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party or ERP system should read this guide Gateway Security Guide Provides guidelines on establishing a highly secure environment for all Primavera Gateway environments The Primavera Gateway network administrator database administrator and the administrator for the third party or ERP system should read this guide Gateway API Programmer s Guide Provides instructions on how to access and use Primavera Gateway REST APIs The Primavera Gateway network administrator database administrator and Primavera Gateway users having the Gateway Developer role should read this guide Connecting with Instantis Enterprise Track Provides instructions on how to setup the integration environment for Oracle Instantis EnterpriseTrack in Primavera Gateway T
9. sample custom type parameter lt Description gt lt Name gt BusinessUnit lt Name gt lt Sequence gt 5 lt Sequence gt lt Title gt Business Unit lt Title gt lt Type gt Custom lt Type gt lt Parameter gt lt FlowDefinitionCustomization gt Adding Custom Steps A custom step is a very powerful tool that enables customers to make big changes to the flow In addition to the normal Load Convert Save Compare steps you can insert a custom step anywhere after the load step and before the save step This allows you to change the document before the document is passed on to the next step Note When you use a custom step you have to be very careful not to disrupt other existing flow steps In the sample customization project there is a sample custom step SummarizePlannedCost that does a very simple summarization It adds up the PlannedCost of all of the ResourceAssignments in the project and puts it into a new UDF field of the project object The new UDF field is the SummarizePlannedCost field After performing this task the custom step removes all ResourceAssignment elements from the document A simple boolean type parameter controls whether the custom step is executed or not SummarizePlannedCost can be found under the com mycompany primavera integration custom step package and it is defined in the following section in the customization xml file lt FlowDefinitionCustomization gt lt FlowDefinitionName gt Export Project Data l
10. used to extend the system by adding any of the following customizations to the Source application Gateway or the destination application User defined fields UDFs Mapping templates Java custom mappings Java custom steps Custom parameters Groovy field mappings Foreign field mappings Flow Definition customizations Custom metadata Custom XRefs v v v v v v v v v Schema File Customization xsd Contents A Customization element containing the following elements Element Type Parents Description string The optional element Name restricted to Customization that specifies the name maxLength 60 of the customization string The optional element Version restricted to Customization that specifies the version maxLength 60 of the customization 19 Gateway Customization Guide Element Type Parents Description JavaClassPath string restricted to 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 CustomMetadataT yp e Customization The optional element that contains zero to three App elements An example use is to add references to user defined fields UDFs CustomXRef CustomXRefType Customization The optional element that contains zero to more custom XRef elements
11. 60 mapping The container element for the fields defined inside Fields FieldsType FieldMapping __ this element to be included when loading the business object 32 Appendix Contents of Customization XML FieldsType Table Element Type Parents Description The name of the FieldsFieldType Fields application l l The name of the App2 FieldsFieldType Fields application The element that specifies the name of the l fields in the mapping Guest FieldsFieldType Fields from the application designated as the Guest application The element that specifies the name of the fields in the mapping Host FieldsFieldType Fields irom ihe Primavera application designated as the Host application The element that specifies the name of the PDI FieldsFieldType Fields fields that is involved in the mapping from the Gateway side FlowDefinitionCustomizationType Table Element Type Parents Description string The name of the flow to FlowDefinitionName restricted to which the parameters are maxLength 60 to apply string are The name of the Application Name restricted to application to which the ustomization ree maxLength 60 customization applies The flag when set to true DisableCompare bool an FlowDefinition causes compare to be Customization disabled for all FlowTypes 33 Gateway Customization Guide
12. Groovy resource field mapping lt Description gt lt App1BusinessObjectName gt Resource lt App1lBusinessObjectName gt lt App2BusinessObjectName gt Resource lt App2BusinessObjectName gt lt Name gt SampleGroovyResourceFieldMap lt Name gt lt PDIBusinessObjectName gt Resource lt PDIBusinessObjectName gt lt GroovyFieldMapping gt lt Direction gt GuestToPDI lt Direction gt lt SourceFields gt EmployeeName SampleDate lt SourceFields gt lt TargetFields gt Name PDISampleDate lt TargetFields gt lt RequireAllFields gt true lt RequireAllFields gt lt Script gt lt CDATA Name EmployeeName toUpperCase if containsField EmployeeName Name EmployeeName toUpperCase if containsField SampleDate def cal new GregorianCalendar cal setTime SampleDate cal add Calendar DATE 1 cal add Calendar HOUR 2 PDISampleDate cal getTime 112 lt Script gt lt GroovyFieldMapping gt lt GroovyFieldMappingTemplate gt lt GroovyFieldMappingTemplates gt 1 At the top declare the two applications involved in the integration 2 Declare what business object from each side is involved In this example it is Resource object for all 3 sides 3 Within one Groovy mapping GroovyFieldMapping tag specify the following tags gt Direction The direction of the mapping it could be App1ToPDI App2ToPDI PDIToApp1 or PDIToApp2
13. ORACLE PRIMAVERA Gateway Customization Guide Release 15 1 March 2015 Contents Customization 5 Primavera Gateway Architecture 5 What can be Customized 6 Where are the Customizations Stored sssscccsescveseccccessccscscacceseseveseveceseees 6 Final Customization APU ACES 6 Customizing 6 1 1 7 Setting Up Your Kev vedsauetdvare ceewusveced oversee 7 Implementing the Customization Interfaces and Building 8 Defining Additional Fields 1055 aesialdeesds 8 Direct Field Mapping 9 Foreign Key Mapping cece cece cece cece cece eee e cece ence eee e eee eeeeeeeeeeeeeeeeees 10 Custom Java 11 Custom Groovy Field Mapping aesewernes 11 Adding Flow Pal veges nates nies neve neweeeeas 13 Adding Custom StEPS s cicacsncsveedeeedvandseecncseryeesveveravevencavenyeadeeseravesvaenerienes 14 Creating the Customization XML 15 Deploying a ey enti ees yn ope eae ro eee ne
14. SourceFields Comma separated field names from the source object TargetFields Comma separated field names from the target object Script The script in Groovy code RequireAllFields When set to True this mapping will be skipped unless all the source fields are present in the source object Within the Groovy script use brackets to surround a source field and curly brackets for a target field as in the following example Name EmployeeName toUpperCase Where EmployeeName is a field from the source object and Name is a field from the target object 12 Customizing an Integration You can also use the containsField method to test whether a field exists in the source object In the above example the script uses containsField to test whether EmployeeName or SampleDate fields are there before it executes the logic This is important to know so as to avoid null pointer exceptions When the RequireAllFields tag is set to true the script will only be called when all source fields are present in the source object no possibility for null pointer exception there But when the RequireAllFields tag is set to false the script will be executed even when some source fields are not present in the source object In the case when a source field is not present in the source object for a primitive type field such as integer long double types the value will be set to default value 0 for a string type field it will be set to defau
15. ame of the JavaCustomiza Primavera application in HostAppiamg tionMapping the apptable in the 9 Gateway database jagaGucioniea The element that FieldMapping FieldMappingType specifies the field tionMapping l mapping GroovyFieldMappingTemplatesType Table Element Type Parents Description App1Name to JavaCustomiza The name of the maxLength 60 tionMapping application string JavaCustomiza The name of the App2Name restricted to maxLength 60 tionMapping application 29 Gateway Customization Guide Element Type Parents Description The name of the string GroovyFieldMa application designated as GuestAppName restricted to ppingTemplate Guest application in the maxLength 60 5 apptable in the Gateway database The name of the string GroovyFieldMa application designated as HostAppName restricted to ppingTemplate the Host application in maxLength 60 5 the apptable in the Gateway database The name of the GroovyFieldMapping GroovyFieldMapping Template TemplateType ppingTemplate plate associated with the 5 applications designated as Guest and Host GroovyFieldMappingTemplateType Table Element Type Parents Description The name of the string GroovyFieldMa application designated as Description restricted to ppingTemplate Guest application in the maxLength 255 5 apptable in the Gateway database string GroovyFieldMa The name of the
16. articular 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 The element that string specifies the flow step Tvoe restricted to type Custom is the yp maxLength 20 only valid value when this Custom element is used in a customization xml file FlowStep 35 Gateway Customization Guide ParameterType Table Element Type Parents Description The default value for this string custom parameter that is DefaultValue restricted to Parameter used when the parameter maxLength 255 is included in the flow and the value is not changed string The element that provides Description restricted to Parameter a description of the maxLength 255 parameter e The element that contains For more details see Ioe listor EnumerationOptions th Parameter values when the Parameter element is specified as an enum sType Table The element that provides the name of the string Name restricted to Parameter maxLength 60 usen to JOORUD Me parameter in the provider Java code The elemen
17. ases are available on the Oracle Technology Network OTN at http www oracle com technetwork documentation default 1923957 html From this location you can either view libraries online or download them to have local copies We recommend viewing them from OTN to ensure you always access the latest versions including critical corrections and enhancements Primavera Gateway is configured to access its help system on OTN However you can also install a local version when you install the software The 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 Description Gateway Help Describes how to work with Primavera Gateway and provides information to help users accomplish tasks All users should read the Help Gateway Developer s Provides information on how third party systems such as Guide 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 39 Gateway Customization Guide Title Description Gateway Customization Provides information on how to customize an existing Guide third party integratio
18. ator Database Host Enter the host name of the Oracle database on which you will be updating the Primavera Gateway database gt Database Host Port Enter the port number of the Oracle database Database Name Enter the Gateway database name and select any of the following methods to connect to the database SID Enter the SID of the Oracle database Service Enter the service name of the Oracle database gt Schema Owner Enter the name of Gateway schema owner This name should match the name that was entered when you installed Primavera Gateway Schema Password Enter the password for the schema owner gt Select Test Connection Modify the applicable fields if the connection fails and repeat as necessary Select Update The status field displays a success message Select Finish to exit the configuration utility Supporting Java Customization on a Managed Server If you have installed Gateway on a managed server complete the following steps to ensure Java customization is supported 1 Log in to the WebLogic Administration console for Gateway 2 Select pdi ear in Deployments tab and stop the deployment 3 Select Lock amp Edit in the left pane and select pdi ear in Deployments tab 4 Select Update to update pdi ear for the managed server 16 5 6 Customizing an Integration Save the changes from the left pane Activate Changes Restart pdi ear deployment Restarting the WebLogic Doma
19. dMapTempl DUSiness object name if Naina restricted to aie the maxLength 60 GuestBusinessObjectNa me or the HostBusinessObjectNam e elements are omitted FieldMapTempl The element that ate specifies the field map FieldMapType Table Element Type Parents Description string restricted to FieldMap maxLength 60 PP string App2 restricted to FieldMap me maxLength 60 PP The element that string specifies the name of the Guest restricted to FieldMap gt oe ne maxLength 60 provider side of the mapping The element that string specifies the name of the Host restricted to FieldMap ae it i a mane maxLength 60 pping Primavera provider side of the mapping 28 Appendix Contents of Customization XML Element Type Parents Description The element that string specifies the name of the PDI restricted to FieldMap field that is involved in the maxLength 60 mapping from the Gateway side JavaCustomizationMappingType Table Element Type Parents Description App1Name to JavaCustomiza The name of the maxLength 60 tionMapping application string JavaCustomiza The name of the App2Name restricted to maxLength 60 tionMapping application string The name of the JavaCustomiza application in the i 60 tionMapping apptable in the Gateway 9 database string The n
20. ds in the source SourceFields string en application referenced in pping the GroovyFieldMapping The fields in the target TargetFields string application referenced in pping the GroovyFieldMapping The flag to determine if RequireAllFields boolean all fields are required for the GroovyFieldMapping 31 Gateway Customization Guide Element Type Parents Description string The element that Script restricted to tt a contains the Groovy maxLength 1024 pping code FieldMappingType Table Element Type Parents Description string Description restricted to FieldMapping maxLength 255 p string The name of the oe ne restricted to FieldMapping business object in the maxLength 60 application string The name of the eee restricted to FieldMapping business object in the maxLength 60 application The Guest business _ string object name if different eee restricted to FieldMapping from maxLength 60 PDIBusinessObjectName element string The Host business object HostBusinessObject l name if different from Name 0 FieldMapping PDIBusinessObjectName 8 element The name name of the field map that is used to Suing look up the Java class in Name restricted to FieldMapping the pa iat vol have maxLength 255 written that contains customization logic string The Gateway business restricted to FieldMapping object name in the field maxLength
21. e enterprise application side as well Customizing an Integration lt CustomMetadata gt lt App gt lt Name gt P6 lt Name gt lt BusinessObject gt lt Name gt Activity lt Name gt lt Field category UDF gt lt Description gt Cost code UDF Field lt Description gt lt Name gt CostCode lt Name gt lt Type gt String lt Type gt lt MaxLength gt 255 lt MaxLength gt lt Field gt lt BusinessObject gt lt BusinessObject gt lt Name gt Project lt Name gt lt Field category UDF gt lt Description gt Total planned cost UDF Field lt Description gt lt Name gt TotalPlannedCost lt Name gt lt Type gt Double lt Type gt lt Field gt lt BusinessObject gt lt App gt lt CustomMetadata gt Direct Field Mapping A direct field mapping template defines a series of simple one to one field mapping for one object The integration product that is built on Primavera Gateway should come with a list of direct field mapping templates already but you can add more if this becomes necessary Here is an example from the customization xml in the sample customization project that maps the CostCode field of the Activity business object and the TotalPlannedCost field of the Project business object Gateway Customization Guide lt FieldMapTemplates gt lt App1Name gt Sample lt App1Name gt lt App2Name gt P6 lt App2Name gt lt FieldMapTemplate gt lt Description gt Cost code mapping for activity object lt Description gt
22. e stored in an Oracle database The following items are stored in the database gt Cross references Xref data value mappings DVM flows metadata data dictionary and customizations Audit information logs and intermediate artifacts Configuration settings Schedules Final Customization Artifacts The following files must be created and deployed with each provider customization gt A customization description XML file gt A jar file containing any Java code to implement the customization interfaces The jar file is not needed if the customization does not have any java code Customizing an Integration To customize an integration complete the following steps 1 Set up your environment 2 If you have Java code then implement the customization interfaces and build your project 3 Create the customization description XML file Note Usually building the customization interfaces Step 2 and creating the customization XML file Step 3 occurs simultaneously 4 Deploy your project and customize the Primavera Gateway database schema by any of the following methods Using the Gateway Setup Configuration Utility Uploading the customization description XML file from the Customization tab in the Primavera Gateway user interface 5 Restart the WebLogic domain if the customization includes a jar file For more details on each step see the corresponding section in this guide In This Section Setting Up Your
23. e waren eaten eas 15 Uploading Customization Files Using the Configuration Utility eee eee 15 Supporting Java Customization on a Managed 5 16 Restarting the WebLogic Domain ssssssssssesosesosssccsescssscssscosesosesoosseeseeeo 17 Appendix Contents of Customization XML ssssssseccsesosecossecosecosscossesosesoeeeo 19 19 FOr More Informatio 39 Where to Get Documentation 39 Where to Get 1 42 Where to Get SUPDONE was cs cxice caecavccavucesaaenvscsseanesauieeantowneawhcoes deem 43 Doc mentation di morre is 44 Legal NOUGES annona eet eceeeenrecerseessocsseateseeseuteceusentsceuseerseces 45 Customization Overview Primavera Gateway is an application that facilitates sharing project resource and other data between your enterprise application and Primavera applications enabling you to combine Oracle Primavera s management and scheduling power for projects portfolios and resources with other enterprise software The Gateway Customization Guide describes how to customize an integration using a provider that
24. eway loads this class through reflection and retrieves all other feature implementations by querying this class The Java class also must be defined in the XML description file You can find the following at the top of the customization xml from the sample customization project lt JavaClassPath gt com mycompany primavera Customization lt JavaClassPath gt Defining Additional Fields You can customize your application by defining additional fields The following example defines two fields CostCode UDF field and TotalPlannedCost UDF field In P6 EPPM customers might have fields defined for project activity or other objects They can define them using codes project code resource code or activity code or user defined fields UDF Similarly they might have fields defined in their enterprise application as well that carries the same information as the corresponding fields in P6 EPPM Hence they would want these fields to be integrated when they implement their integration To provide support for these fields you start by defining them in an XML description file and then reference the fields later in direct field mappings foreign field mappings custom Java field mappings Groovy mappings or custom steps Here is a sample from the customization xml in the sample customization project that defines the CostCode UDF field for Activity and the TotalPlannedCost UDF field for the project on the P6 side You can define additional fields for th
25. for any loss costs or damages incurred due to your access to or use of third party content products or services 45
26. g impaired 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 https support oracle com epmos faces DocumentDisplay id 1486951 1 to access links to all of the current PICs PICs also provide access to gt Communities are moderated by Oracle providing a place for collaboration among industry peers to share best practices gt News from our development and strategy groups gt 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 https support oracle com epmos faces DocumentDisplay id 8888 13 2 43 Gateway Customization Guide Documentation Accessibility For information about Oracle s commitme
27. has been created for Primavera Gateway Also see the Provider s Reference Guide for a list of business objects supported by each Primavera provider in the data dictionary Primavera Gateway Architecture Primavera Gateway is a web application that is deployed on a WebLogic application server The following components are required to load data into a Primavera application and the Gateway database gt Seed Data XML files that provide flows and other data that illustrate best practices which can be used as a Starting point for your implementation gt Primavera Gateway Framework which includes Primavera Gateway user interface gt The following providers to support integrations with Primavera applications P6 provider The P6 provider enables you to share data with P6 EPPM Primavera Gateway supports P6 EPPM integration with the Oracle Primavera Prime application and a Sample provider Prime provider The Prime provider enables you to share data with the Oracle Primavera Prime application Primavera Gateway supports Oracle Primavera Prime integration with the P6 EPPM application EnterpriseTrack provider The EnterpriseTrack provider enables you to share data with Oracle Instantis Enterprise Track application Primavera Gateway supports Oracle Instantis Enterprise Track integration with a Sample provider Unifier provider The Unifier provider enables you to share data with the Primavera Unifier application Primavera Gateway support
28. he Primavera Gateway network administrator database administrator and the administrator for the third party system should read this guide Connecting Prime and P6 EPPM Provides instructions on how to setup the integration environment between Oracle Primavera Prime and P6 Enterprise Project Portfolio Management in Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party system should read this guide Connecting Unifier and P6 EPPM Provides instructions on how to setup the integration environment between Oracle Primavera Unifier and P6 Enterprise Project Portfolio Management in Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party system should read this guide Migrating P6 Data Between Distinct Environments Provides instructions on how to setup the integration environment between distinct P6 deployments to transfer P6 data in Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator should read this guide 4 Gateway Customization Guide Title Suite Connecting E Business Description Provides instructions on how to setup the integration environments for Oracle E Business Suite with P6 Enterprise Project Portfolio Management and Instantis Enterprise Track in Primavera Gateway The Primavera Gate
29. in Finally complete the customizations by restarting the WebLogic domain Depending on your operating system proceed as follows to restart the Primavera Gateway domain 1 Note Oracle recommends that you use the lt PrimaveraGateway_home gt WLST startGatewayWLDomain scripts to stop and start the Primavera Gateway domain because these scripts contain the specific memory and timezone settings required by Primavera Gateway First stop the WebLogic domain For Windows from the Start menu point to Oracle Primavera Gateway and select Stop Primavera Gateway This invokes the stopGatewayWLDomain cmd file For Linux and Solaris enter cd lt Primavara Gateway_Home gt WLST and then run the following script stopGatewayWLDomain sh Note If you are using a non Windows system you may need to set permissions on the stopGatewayWLDomain sh file If so enter the following command chmod 755 stopGatewayWLDomain sh Start the WebLogic domain For Windows From the Start menu point to Oracle Primavera Gateway and select Start Primavera Gateway This invokes the startGatewayWLDomain cmd file For Linux and Solaris enter cd lt Primavara Gateway_Home gt WLST and then run the following script startGatewayWLDomain sh 17 Appendix Contents of Customization XML In This Section Customization XML 19 Customization XML File This file is loaded into the system by the data loader utility and is
30. kOrderElementid lt App1 gt lt App2 gt SampleW BSObjectld lt App2 gt lt PDI gt SampleWBSObjectld lt PDI gt lt FieldMap gt lt FieldMapTemplate gt lt FieldMapTemplates gt In the metadata XML file or the customization XML file mark the field as a foreign key and set the JoinTo to the name of the object that this field is joining to as in the example below 10 Customizing an Integration lt Field gt lt Description gt Sample WBS Object IDs lt Description gt lt Name gt SampleWBSObjectld lt Name gt lt JoinTo gt WBS lt JoinTo gt lt Type gt ForeignKey lt Type gt lt Field gt Custom Java Field Mapping When the field mapping is not as simple as one to one you can use a custom Java field mapping mechanism Using a custom Java field mapping involves creating a class that implements the CustomFieldMap interface When you implement the CustomFieldMap interface you have control of the source object and the target object which permits you to write logic that involves more than one field The SampleResourceCustomFieldMap class under com mycompany primavera integration custom java package is a simple custom Java field mapping example in the sample customization project that concatenates the Resourceld and EmployeeName fields of Resource in the Host side and puts the concatenated field into the Name field of Resource in the PDI side This class is defined in the customization xml in the following section lt JavaCusto
31. lt value for a date type field it will be set to null Limitations For security reasons the following limitations have been enforced on Groovy capability Loops are not allowed Closure is not allowed Class loading or reflection is not allowed New classes cannot be defined File system access is not allowed Network access is not allowed Classes under java lang and java util only can be accessed but not any other packages Writing one or more expressions and calculating one or more target fields from one or more source fields is allowed v v YV vV v v v v Adding Flow Parameters A flow parameter is a mechanism to get user input for the flow There are some parameters defined already for each flow The flow parameter allows you to define additional parameters for the Java code to consume Consider the sample parameter BusinessUnit in the sample customization project BusinessUnit parameter is a custom type parameter which is a much more powerful parameter that requires an implementation class The BusinessUnitParameterExecutorlmpl class under com mycompany primavera integration custom param package implements the BusinessUnit parameter The BusinessUnit parameter is defined in the Customization xml file as follows 13 Gateway Customization Guide lt FlowDefinitionCustomization gt lt FlowDefinitionName gt Export Project Data lt FlowDefinitionName gt lt Parameter gt lt DefaultValue gt lt Description gt A
32. mizationMapping gt lt App1Name gt Sample lt App1Name gt lt App2Name gt P6 lt App2Name gt lt FieldMapping gt lt Description gt Resource Java Field Mapping lt Description gt lt App1BusinessObjectName gt Resource lt App1 BusinessObjectName gt lt App2BusinessObjectName gt Resource lt App2BusinessObjectName gt lt Name gt SampleResourceCustomFieldMap lt Name gt lt PDIBusinessObjectName gt Resource lt PDIBusinessObjectName gt lt Fields gt lt App1 gt lt Name gt EmployeeName lt Name gt lt App1 gt lt App2 gt lt Name gt Name lt Name gt lt App2 gt lt Fields gt lt FieldMapping gt lt JavaCustomizationMapping gt Custom Groovy Field Mapping Custom Groovy Field Mapping is similar to Custom Java Field Mapping in that they both can handle more complex logics and allow multiple fields to participate at the same time Custom Groovy Field Mapping is easier to use because the Groovy script is embedded in the customization description XML file and therefore will not require a separate jar file The syntax of Custom Groovy Field Mapping in the customization description XML file is also similar to Custom Java Field Mapping The following is an example from Customization xml in SampleCustomization project 11 Gateway Customization Guide lt GroovyFieldMappingTemplates gt lt App1Name gt Sample lt App1Name gt lt App2Name gt P6 lt App2Name gt lt GroovyFieldMappingTemplate gt lt Description gt Sample
33. n Developers interested in customizing existing third party providers that integrate with Primavera products via Primavera Gateway should read this book Gateway Provider Provides a list of the business objects available for each Reference Guide supported provider Developers of third party providers that integrate with Primavera products via Primavera Gateway should read this book EBS Provider Reference Guide Provides a list of the business objects available for the EBS provider Developers of third party providers that integrate with Primavera products via Primavera Gateway should read this book VCP Provider Reference Provides a list of the business objects available for the VCP Guide provider Developers of third party providers that integrate with Primavera products via Primavera Gateway should read this book Manual Deployment Provides information on how to manually install and Guide configure Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party or ERP system should read this guide Gateway Installation and Configuration Guide 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
34. nt Description The element that contains one or more XRefMapType XRef maps A XRef map For more details see contains a mapping of wegen the XRefMapType business objects table below cross referenced between two applications 21 Gateway Customization Guide XRefMapType Table Element Type Parent Description The name of the App1Name string XRefMap application The name of the App2Name string XRefMap application XRefObjectType For more details see One or more XRef the XRefObjectT ype objects in the XRef map table below XRefObjectType Table Element Type Parent Description The name of the Name siring APROBE cross reference object The App1 business App1Name string XRefObject object name if different from the Name element The PDI business object PDIName string XRefObject name if different from the Name element The App2 business App2Name string XRefObject object name if different from the Name element The name of the primary ee i string XRefObject _ key field in the database of the application l The name of the primary ee eo string XRefObject __ key field in the Gateway database The name of the primary string XRefObject _ key field in the database of the application 22 Appendix Contents of Customization XML AppType Table Element Type Parent Description string The name of the application to which you
35. nt Description string The name of the Name resirctedio BusinessObje business a 7 which maxLength 60 ct you are adding the user defined field All custom UDF fields _ defined inside this Field FieldType ee element will be included when updating the business object FieldType Table Element Type Parent Description The element that describes the field This string description is presented Description restricted to Field in the Fields table on the maxLength 255 Data Dictionary tab in the Primavera Gateway user interface 24 Element Type Parent Description The element that determines the name of the field This name is N string d Field presented in the Fields ame ee R ie table of the Data maxLength 60 Dictionary tab in the Primavera Gateway user interface The element that string contains the name of the JoinTo Field object to which it is being joined to string restricted to maxLength 10 Boolean The element that defines DateTime the data type of the value Type Double Fiela of the field s data when it Int is synchronized String ForeignKey Enum The optional element that defines the maximum length of the value of the field s data when it is MaxLength positivelnteger Field synchronized This element can be used with the Type element whose content is String to limit the field s data values The optional elemen
36. nt to accessibility visit the Oracle Accessibility Program website at http www oracle com pls topic lookup ctx acc amp id docacc 44 Legal Notices Oracle Primavera Gateway Customization Guide Copyright 2013 2015 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 deli
37. o restart the WebLogic domain Notes When you install the Primavera Gateway you have the option to install a sample customization project that contains examples that demonstrate how each additional feature can be defined You will find the XML description file called Customization xml under the data folder Java source code and Groovy code is included as well You can configure how the Primavera Gateway synchronizes data by interacting with the Primavera Gateway user interface Additionally you can create a provider or customize an existing provider to further control how the adapter loads the data We supply a Sample provider that you can use to get started Uploading Customization Files Using the Configuration Utility Use this procedure if a customization includes include XML files jar files and other files such as Java customization If you have installed Gateway on a managed server see Supporting Java Customization on a Managed Server on page 16 for more details Note If a customization does not include any jar files and uses Groovy customization then upload the XML file from the Gateway user interface To add or remove customization files in Gateway 1 Stop the Gateway domain before adding or removing providers or customizations 2 Ensure the following gt The bin folder of the supported Java JDK is included in the PATH If there are other JDK bin folders in the PATH it should be listed first 3 Navigate
38. ocumentation 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 http education oracle com 42 For More Information Oracle Learning Library The Oracle Learning Library OLL provides online learning content covering Primavera products Content includes videos tutorials articles demos step by step instructions to accomplish specific tasks and self paced interactive learning modules To access the learning library s Primavera content go to http www oracle com goto oll Where to Get Support If you have a question about using Oracle products that you or your network administrator cannot resolve with information in the documentation or help click http support oracle com This page provides the latest information on contacting Oracle Global Customer Support knowledge articles and the support renewals process For more information about working with Support visit https support oracle com epmos faces DocumentDisplay 7id 888813 2 to view Support Tools amp Tips Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support For information visit http www oracle com us support contact 068555 html or visit http www oracle com us corporate accessibility support index html if you are hearin
39. s Primavera Unifier integration with the P6 EPPM application Sample provider The Sample provider is a provider for demonstration purposes only The purpose of the Sample provider is to illustrate how to use Primavera Gateway to synchronize data between a Primavera application and the Sample provider Primavera Gateway supports a Sample provider integration with P6 EPPM and Oracle Instantis Enterprise Track applications Gateway Customization Guide What can be Customized With a provider an integration can be customized for the following gt Additional fields can be defined gt Additional direct field mapping templates can be provided gt Additional custom steps can be defined gt Additional flows and flow parameters can be defined and specified and the Java code can be extended to use new parameters Additional custom Java field mappings and java custom steps can be provided Additional Groovy field mappings can be provided vv Additionally you can include Java code that uses the custom Java field mappings custom steps and custom parameters You can also use Groovy code for custom field mappings As with most application development work when you customize a provider you will generally need to involve people that have various skills and that perform various roles programmers analysts users administration etc Where are the Customizations Stored Customizations that you make by interacting with Primavera Gateway ar
40. t FlowDefinitionName gt lt lt DisableCompare gt true lt DisableCompare gt Uncomment this line to disable compare for this flow type gt lt FlowStep gt lt Description gt A sample custom step lt Description gt lt Name gt Summarize Planned Cost lt Name gt lt OwnerAppName gt P6 lt OwnerAppName gt lt Sequence gt 15 lt Sequence gt to make sure it is inserted after Load step before the first convert step gt lt Type gt Custom lt T ype gt lt FlowStep gt lt FlowDefinitionCustomization gt Notice that the sequence number that you set here determines when this step will get called In this case this step is inserted right after the P6 Load step 14 Customizing an Integration Creating the Customization XML File Create a Customization xml file for each provider application that you intend to customize Primavera Gateway ships a sample customization XML file The sample customization XML file is located in lt Primavera Gateway Home gt sample samplecustomization data folder You can use this file along with the Customization xsd schema file as an example to create a Customization xml file specific to your deployment Deploying a Customization Deploy a customization using the Gateway Setup Configuration utility to deploy a customization description XML file and a jar file The utility is a desktop application and needs direct access to the database After deploying the customization you will need t
41. t that defines the maximum value of the field s data when it is synchronized MaxValue double Field This element can be used with the Type element whose content is Int to limit the field s data values Appendix Contents of Customization XML 25 Gateway Customization Guide Element Type Parent Description The optional element that defines the minimum value of the field s data when it is synchronized MinValue double Field 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 Field elements can FieldValue FieldValueType Field contain zero or more FieldValue elements if the Field element contains a Type element whose content is Enum FieldValueType Table Element Type Parent Description string Description restricted to FieldValue maxLength 255 i string An optional element that Value restricted to FieldValue defines an enumerated maxLength 60 value FieldMapTemplatesType Table Element Type Parents Description string App1Name restricted to Customization me maxLenth 60 i string App2Name restricted to Customization the maxLenth 60 PP 26 Appendix Contents of Customization XML Element Type Parents Description string GuestAppName restricted to Customization theguesi maxLength
42. t that provides Sequence int Parameter the mechanism for ordering the parameters string The element that provides Title restricted to Parameter the display title of the maxLength 255 parameter string restricted to maxLength 15 ce The element that defines the data type of the value Typa T Parameter of the field s data when it String is synchronized Password Enum Custom 36 Appendix Contents of Customization XML EnumerationOptionsType Table Element Type Parents Description The element that specifies Enumeration EnumerationT ype Hons P the name the enumeration FieldsFieldType Table Element Type Parents Description string dee The element that specifies Name restricted to Fields the name of the field maxLength 60 EnumerationType Table Element Type Parents Description string The element that specifies Name restricted to Fields the name of the maxLength 60 enumeration type 37 For More Information In This Section Where to Get Documentation eeeceececeeeeeeeeeeeeeeeeeee eee eeeeaaaaaaaeeeeeeeeetenesaaaeeeeeees 39 Where to Get Training sinc vedereebiunciped itereieceoureenes 42 Where to Get Support i eee eee 49 D cumentati n ACCOSSIONILY 44 Where to Get Documentation Complete documentation libraries for Primavera Gateway rele
43. to the lt Primavera_Gateway_Home gt pdi snapshots dbsetup dist folder 4 If you are installing on a non Microsoft Windows system type the following command for execute privileges chmod 755 Gateway Configuration sh 5 Run the following command Gateway Customization Guide gt For Windows installations run Gateway Configuration bat gt For Linux and Solaris installations run Gateway Configuration sh 6 Inthe Primavera Gateway Configuration Utility dialog box enter the following information a Select Manage Customizations and select Next Selecting this option updates the pdi ear file and the Gateway database with custom metadata from the customization XML files b In the Select Gateway ear file pdi ear location enter or select Browse to locate the ear file c Inthe Installed Gateway Customizations field review the list of customization files displayed in the dialog box and perform any of the following actions To add a customization select Add Customization and navigate to the folder location of the customization file To remove a customization from the list select a specific customization and select Remove To delete a customization from the database and the pdi ear file select the Delete option and select Remove 7 Enter the following database connection details gt DBA User Name Enter the name of the database administrator gt DBA Password Enter the password for the database administr
44. vered 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
45. way network administrator database administrator and the administrator for the third party system should read this guide Connecting Value Chain Planning and P6 EPPM Provides instructions on how to setup the integration environment between Oracle Value Chain Planning and P6 Enterprise Project Portfolio Management in Primavera Gateway The Primavera Gateway network administrator database administrator and the administrator for the third party system should read this guide Configuring Gateway for Single Sign On Provides instructions on how to configure Oracle Access Manager OAM and then enable Single Sign On for Primavera Gateway The Primavera Gateway network administrator database administrator should read this guide Gateway Licensing Information User Manual Lists licensing information of all third party software that is used or associated with the Oracle software program Tested Configurations 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 d
Download Pdf Manuals
Related Search