extensibility guide for oracle process accelerators 11g ... · pdf fileextensibility guide for...

Oracle® Fusion MiddlewareExtensibility Guide for Oracle Process Accelerators

11g Release 1 (11.1.1.7.2)

E38684-01

June 2014

Oracle Fusion Middleware Extensibility Guide for Oracle Process Accelerators, 11g Release 1 (11.1.1.7.2)

E38684-01

Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved.

Primary Author: Oracle Corporation

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.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

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.

iii

Contents

Preface ................................................................................................................................................................ vii

Audience........................................................................................................................................................ viiDocumentation Accessibility ........................................................................................................................ viiRelated Documents ....................................................................................................................................... viiConventions................................................................................................................................................... vii

What's New in This Guide for Release 11.1.1.7.2 ...................................................................... ix

1 Extending Business Objects

1.1 Extending Business Objects ................................................................................................. 1-11.1.1 Custom Objects for Other Oracle Process Accelerators .................................................. 1-13

2 Extending the BPM Process Model for an Oracle Process Accelerator

2.1 Example Overview .............................................................................................................. 2-12.2 Creating a New XSD ........................................................................................................... 2-42.3 Processing XSD Changes ..................................................................................................... 2-6

3 Using an External Source to Invoke a Service

3.1 Understanding Using an External Source ............................................................................... 3-13.1.1 Invoking ULO Using an External Source ........................................................................ 3-13.1.1.1 Interface Description .............................................................................................. 3-23.1.2 Invoking TRM Using an External Source ........................................................................ 3-33.1.2.1 Interface Description .............................................................................................. 3-33.1.3 Invoking ISR Using an External Source .......................................................................... 3-43.1.3.1 Interface Description .............................................................................................. 3-53.2 Testing a Service Called from an External Source .................................................................. 3-5

4 Generating a Report

4.1 Overview of Report Generation ............................................................................................ 4-14.2 Creating a RTF Template ..................................................................................................... 4-2

5 Using Approval Hierarchy Reporting

5.1 Overview of Approval Hierarchy Reporting .......................................................................... 5-15.2 Integrating Approval Hierarchy Reporting with BPM ............................................................. 5-3

iv

5.3 Modifying Level of Data Loaded into SecurityDO ................................................................. 5-35.4 Creating BAM Reports Using ApprovalDO and SecurityDO .................................................. 5-3

6 Supporting a New Language in an Oracle Process Accelerator

6.1 Adding a New Language for an Oracle Process Accelerator .................................................... 6-1

v

List of Figures

1–1 Incident Reporting Custom Model Project in Navigation Tree ..................................................... 1-21–2 Inherited Attributes to Override Dialog Box ................................................................................. 1-31–3 Attributes Page............................................................................................................................... 1-31–4 Create Database Connection Dialog Box ...................................................................................... 1-41–5 Attribute Settings ........................................................................................................................... 1-51–6 Value Type and Value Attribute Set Up........................................................................................ 1-51–7 Default Value Specification for the Selected Attribute ................................................................. 1-61–8 Burglary EO Entity Tab................................................................................................................. 1-61–9 ItemsStolen Control Hints Page..................................................................................................... 1-71–10 BurglaryEO Entity Tab Showing Custom Properties .................................................................... 1-71–11 Select Text Resource Dialog Box.................................................................................................. 1-81–12 PSIRCustomObjectVO Tab........................................................................................................... 1-81–13 Select Subtypes Dialog Box .......................................................................................................... 1-91–14 Create View Object Wizard Name Page........................................................................................ 1-91–15 Create View Object Wizard Step 2............................................................................................. 1-101–16 Create View Object Wizard Step 3............................................................................................. 1-101–17 Estimated Costs Control Hints Page........................................................................................... 1-111–18 Code for Custom Attributes Layout............................................................................................ 1-111–19 Select Subtypes Dialog Box ....................................................................................................... 1-121–20 PSIR Enter Incident Report GUI with New Attributes............................................................... 1-132–1 New Data Objects in the ProcessExternalLoanApplication Business Process.............................. 2-22–2 ExtractedExtendedAttributeDO Structure ..................................................................................... 2-22–3 ExtensibleAttrPlaceholderDO Structure........................................................................................ 2-32–4 New Data Objects in the LoanOriginationProcess Business Process............................................ 2-42–5 Example New XSD Structure ........................................................................................................ 2-52–6 Adding the location of the include statement ................................................................................ 2-64–1 Implementation for Oracle Process Accelerator Report Generation ............................................. 4-25–1 Approval Hierarchy Reporting Business Process .......................................................................... 5-25–2 Define Lookup Field Dialog Box .................................................................................................. 5-45–3 ApproverDO for TRM ................................................................................................................... 5-45–4 Main TRM Data Object ................................................................................................................. 5-45–5 Security Filter for TRM Data Object ............................................................................................. 5-55–6 SecurityDO for TRM ..................................................................................................................... 5-55–7 Approval Hierarchy Reporting Dashboard for TRM..................................................................... 5-65–8 Selection Criteria Using Manager and Period Filters .................................................................... 5-6

vi

List of Tables

1–1 Items Needed to Create New Attributes in Oracle PSIR .............................................................. 1-11–2 Items Needed to Create New Attributes in Oracle CMPM ....................................................... 1-131–3 Items Needed to Create New Attributes in Oracle EOB ........................................................... 1-141–4 Items Needed to Create New Attributes in Oracle ICM............................................................ 1-141–5 Items Needed to Create New Attributes in Oracle ULO ........................................................... 1-143–1 ULO Composite Application Fields ............................................................................................. 3-23–2 ULO Custom Attributes for Home Loans..................................................................................... 3-23–3 Loan Application Elements .......................................................................................................... 3-23–4 Travel Request Header.................................................................................................................. 3-43–5 Travel Request Segment or Details .............................................................................................. 3-43–6 Service Request Elements............................................................................................................. 3-5

vii

Preface

The Oracle Fusion Middleware Extensibility Guide for Oracle Process Accelerators provides information and instructions for customizing Oracle Process Accelerators.

AudienceThis document is intended for users who are customizing Oracle Process Accelerators.

Documentation AccessibilityFor information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle SupportOracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related DocumentsFor more information, see the following documents:

■ Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators

■ Oracle Fusion Middleware Fusion Developer’s Guide for Oracle Application Development

■ Oracle Fusion Middleware User's Guide for Oracle JDeveloper

ConventionsThe following text conventions are used in this document:

Convention Meaning

boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

viii

monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Convention Meaning

ix

What's New in This Guide for Release11.1.1.7.2

For Release 11.1.1.7.2, this guide has been updated in several ways. The following table lists the chapters and sections that have been added or changed.

Sections Changes Made

Chapter 1, "Extending Business Objects" Updated to show the items needed to update other Oracle Process Accelerators.

Chapter 2, "Extending the BPM Process Model for an Oracle Process Accelerator"

Updated based on improvements made to the process for extending a business process.

Chapter 4, "Generating a Report" New chapter to document the report generation for Oracle Process Accelerators.

Generating a PDF Chapter replaced with Generating a Report.

1

Extending Business Objects 1-1

1Extending Business Objects

This chapter provides an example of creating new attributes for a business object and surfacing business objects that already exist in an Oracle Process Accelerator (PA) graphical user interface (GUI).

Attributes are fields you add to a PA GUI. New attributes can be used to capture additional information you want a user to enter.

To create new attributes, you must know how to use Oracle JDeveloper and follow the steps described in this chapter.

For more information about Oracle JDeveloper and Oracle Application Development Framework (ADF) Business Components, upon which dynamic attributes are based, see "Introduction to Oracle JDeveloper" in Oracle Fusion Middleware User's Guide for Oracle JDeveloper and "Getting Started with ADF Business Components" in Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

This chapter includes the following sections:

■ Section 1.1, "Extending Business Objects"

1.1 Extending Business ObjectsThis section provides an example of creating the new attributes, Items Stolen and Mode of Entry, for a burglary incident type on the Oracle Public Sector Incident Reporting (PSIR) Enter Incident Report page. First, a new burglary entity object is created. This appears as a tab on the Enter Incident Report page. Next, the Items Stolen and Mode of Entry view objects are added. These become the fields on the burglary tab. Finally, the affected projects are deployed. Figure 1–20 shows the final results. Table 1–1 displays the files, business objects, and other items needed to create new attributes for this Oracle PSIR example.

Table 1–1 Items Needed to Create New Attributes in Oracle PSIR

Items Needed Oracle PSIR

Existing attributes to which new attributes must be related

IncidentType

.jws files ■ IncidentReportingCustomModel.jws

■ IncidentReportingModel.jws

■ IncidentReportingTask.jws

■ IncidentReportingExternalApp.jws

Extendable base entity objects PsirCustomObjectEO

Extending Business Objects

1-2 Oracle Fusion Middleware Extensibility Guide for Oracle Process Accelerators

To create new Oracle PSIR attributes:

1. Extract the following .jws files from the OraclePArelease.zip file:

■ OraclePArelease/PAHome/pa/src/ps/ir/model/IncidentReportingCustomModel/IncidentReportingCustomModel.jws

■ OraclePArelease/PAHome/pa/src/ps/ir/model/IncidentReportingModel/IncidentReportingModel.jws

■ OraclePArelease/PAHome/pa/src/ps/ir/view/IncidentReportingTaskUI/IncidentReportingTaskUI.jws

■ OraclePArelease/PAHome/pa/src/ps/ir/view/IncidentReportingExternalApp/IncidentReportingExternalApp.jws

2. In Oracle JDeveloper, use the Open Application command to open each .jws file.

You will modify and rebuild IncidentReportingCustomModel.jws, then redeploy IncidentReportingTaskUI.jws and IncidentReportingExternalApp.jws, both of which depend on and include IncidentReportingCustomModel.jws.

3. In the IncidentReportingCustomModel project, right-click entity in the tree and select New Entity Object, see Figure 1–1.

Figure 1–1 Incident Reporting Custom Model Project in Navigation Tree

The Create Entity Object wizard opens.

4. On the Name page, select the oracle.bpmpa.ps.ir.model.incident.custom.ext.entity package by typing it or using Browse, name the new entity (BurglaryEO in this example, see Figure 1–2), and use Browse to specify PsirCustomObjectEO as the entity to extend, then click Next.

Extendable base view objects PsirCustomObjectVO

UI Attribute Column categories In showCustomObject.jsff:

■ customAttributes1

■ customAttributes2

Table 1–1 (Cont.) Items Needed to Create New Attributes in Oracle PSIR

Items Needed Oracle PSIR



Figure 1–2 Inherited Attributes to Override Dialog Box

5. On the Attributes page, click Override, then select the attributes to override. Generic attributes of various types, such as Date, Number, and Varchar, are provided for you to modify, see Figure 1–3. Be sure to keep EntityKind, RecordName, and IncidentType in addition to the generic attributes. EntityKind and RecordName apply to all process accelerators.

Figure 1–3 Attributes Page

6. At some point you may be prompted to choose a database connection. This is optional.

If you do not already have a database connection, click Add (plus) and enter information for the database that all process accelerators use. By default, the username is accelerators and the password is welcome1. Figure 1–4 provides an example of configuring a database connection.



Figure 1–4 Create Database Connection Dialog Box

7. On the Attribute Settings page, assign more descriptive names to the generic attributes. In this example, NumberAttr1 becomes EstimatedCost, VarcharAttr2 becomes ModeOfEntry, and VarcharAttr3 becomes ItemsStolen. Figure 1–5 shows how to change NumberAttr1 to EstimatedCost.



Figure 1–5 Attribute Settings

8. Assign the EntityKind and RecordName attributes a Value Type of Expression and a Value of adf.object.structureDef.defName, see Figure 1–6.

Figure 1–6 Value Type and Value Attribute Set Up

9. For the IncidentType attribute, specify the Discriminator Default Value. This is the Lookup Code for the Incident Type for which you are creating new attributes. In Figure 1–7, the value is BUR (for Burglary).



Figure 1–7 Default Value Specification for the Selected Attribute

10. Click Next to skip the Java, Generate, and Summary pages. Click Finish to exit the Create Entity Object wizard.

11. The BurglaryEO entity you created appears in a tab in the central pane in Oracle JDeveloper. Select Attributes, see Figure 1–8. Double click each custom attribute to open it. On the Control Hints page for each attribute, specify the Label Text which will be displayed in the UI; see Figure 1–9.

Figure 1–8 Burglary EO Entity Tab



Figure 1–9 ItemsStolen Control Hints Page

12. Define a translatable custom property for the entity. Click Add (plus) for Custom Properties and select Translatable Property, see Figure 1–10.

Figure 1–10 BurglaryEO Entity Tab Showing Custom Properties

13. In the Select Text Resource dialog box, enter a Display Value and enter LABEL as the Key; see Figure 1–11. This labels the custom tab in the PSIR process accelerator user interface (UI) that displays the attributes.



Figure 1–11 Select Text Resource Dialog Box

14. Open the PsirCustomObjectVO view and select Entity Objects; see Figure 1–12.

Figure 1–12 PSIRCustomObjectVO Tab

15. Click Subtypes. In the Select Subtypes dialog box, add the BurglaryEO entity object to the list of subtypes; see Figure 1–13.



Figure 1–13 Select Subtypes Dialog Box

16. Right-click view in the IncidentReportingCustomModel tree and select New View Object. In the Name page of the Create View Object wizard, create a new view (BurglaryVO in this example) that extends PsirCustomObjectVO in the default package, see Figure 1–14.

Figure 1–14 Create View Object Wizard Name Page

17. By default, the new view object is associated with the PsirCustomObjectEO entity. You must change the associated entity to the new entity you created. On the Entity Objects page, select the new entity object (BurglaryEO in this example). When prompted to override, click Yes. See Figure 1–15.



Figure 1–15 Create View Object Wizard Step 2

18. On the Attributes page, select the same attributes for the view that you selected for the entity, see Figure 1–16.

Figure 1–16 Create View Object Wizard Step 3

19. Click Next to skip the remaining pages, and click Finish to exit the Create View Object wizard.

20. The view you created appears in a tab in the central pane in Oracle JDeveloper. Select Attributes. Double click each custom attribute to open it. On the Control Hints page for each attribute, change the Label Text to match the descriptive name.



21. Also on the view's Control Hints page, in the Category field, specify either customAttributes1 or customAttributes2 for each attribute. This places the attribute in either the first or second column in the PSIR PA UI.

In Figure 1–17, ModeOfEntry and ItemsStolen are in customAttributes1 and EstimatedCost is in customAttributes2.

Figure 1–17 Estimated Costs Control Hints Page

The default UI layout as shipped with PSIR is shown in Figure 1–18. The PsirCustomObjectViewIterator iterates through the subtypes of the PsirCustomObjectViewVO view. The category determines which of two columns each attribute is placed in within the UI. You can change the default layout and add new categories.

Figure 1–18 Code for Custom Attributes Layout

22. Right-click the IncidentReportingCustomModel project and select Deploy, then select IncidentReportingCustomModel. You should see Deploy to ADF Library JAR file selected. Click Next, then Finish.



23. In the IncidentReportingModel project, which you opened in step 2, open the incidentReportingAM object and select Data Model. Click Subtypes. In the Select Subtypes dialog box, add the BurglaryVO view to the list of subtypes; see Figure 1–19.

Figure 1–19 Select Subtypes Dialog Box

24. From PAHome/pa/src/ps/ir, in build.xml, change the value for the Jdev home to your Jdev home location.

<property name="jdev.home" value="your jdev location/jdevhome/jdeveloper"/>

25. Run ant build.xml to regenerate all the jar and ear files.

The regenerated ears are available in PAHome/pa/src/ps/ir/deploy.

26. In the Oracle WebLogic Server Administration Console, navigate to the Domain Structure navigation tree, click Deployments, then in the following order delete the application ears and shared libraries:

IncidentReportingAdminUIIncidentReportingTaskUIIncidentReportingBCServiceoracle.bpmpa.ps.ir.modeloracle.bpmpa.ps.ir.view

It is recommended to keep a backup of all ear and jar files.

27. Install the new generated shared libraries and application ears from step 2 in the following order:

oracle.bpmpa.ps.ir.model.earoracle.bpmpa.ps.ir.view.earIncidentReportingBCService.earIncidentReportingTaskUI.earIncidentReportingAdminUI.ear

When you are done, the PSIR PA GUI looks like Figure 1–20:



Figure 1–20 PSIR Enter Incident Report GUI with New Attributes

28. Configure the IncidentReportingAdminUI and IncidentReportingTaskUI application roles. See also, "Configuring Security Roles for Oracle Process Accelerator Pages" in Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators.

1.1.1 Custom Objects for Other Oracle Process AcceleratorsTable 1–2 through Table 1–5 provides the files, business objects, and other items needed to create new attributes for the following PAs respectively:

■ Oracle Complaints Management (CMPM)

■ Oracle Employee Onboarding (EOB)

■ Oracle Insurance Claim Management (ICM)

■ Oracle Unified Loan Origination (ULO)

You can substitute the items in these tables with the PSIR equivalents, in the steps outlined in Section 1.1, to extend these PAs.

Table 1–2 Items Needed to Create New Attributes in Oracle CMPM

Items Needed Oracle CMPM

Model Project ComplaintsManagementCustomModel.jpr under ComplaintsManagementModel.jws

.View Project ComplaintsCustomUI.jpr under ComplaintsCustomObjUI.jws

Extendable base entity objects CmCustomObjectEO

Extendable base view objects CmCustomObjectVO

JSFF Fragment showCustomObject.jsff



Table 1–3 Items Needed to Create New Attributes in Oracle EOB

Items Needed Oracle EOB


■ EmployeeID

■ EmployeeType

.jws files ■ EOBCustomModel.jws

■ EOBModel.jws

■ EOBCustomObjectsUI.jws

■ EOBReuseUI.jws

■ EOBAdminUI.jws

■ EOBTaskUI.jws

Extendable base entity objects EobEmployeeCustomObjectEO

Extendable base view objects EobEmployeeCustomObjectVO


■ customEmployeeAttributes1

■ customEmployeeAttributes2

Table 1–4 Items Needed to Create New Attributes in Oracle ICM

Items Needed Oracle ICM

Model Project InsuranceClaimsCustomModel.jpr under InsuranceClaimsCustomModel.jws

.View Project InsuranceClaimsManagementCustomObjUI.jpr under InsuranceClaimsManagementCustomObjUI.jws

Extendable base entity objects ■ IcmVehicleDamageEO

■ IcmCustomArtifactEO

Extendable base view objects ■ IcmVehicleDamageVO

■ IcmCustomArtifactVO

JSFF Fragments ■ showExamineDamage.jsff

■ showCustomObject.jsff

Table 1–5 Items Needed to Create New Attributes in Oracle ULO

Items Needed Oracle ULO


■ Product

■ Collateral

.jws files ■ ULOCustomModel.jws

■ ULOModel.jws

■ ULOCustomObjectsUI.jws

Extendable base entity objects PaCustomObjectEO

Extendable base view objects PaCustomObjectVO




■ first

■ second

■ third

In showCollateralCustomObject.jsff

■ first

Table 1–5 (Cont.) Items Needed to Create New Attributes in Oracle ULO

Items Needed Oracle ULO

2

Extending the BPM Process Model for an Oracle Process Accelerator 2-1

2Extending the BPM Process Model for anOracle Process Accelerator

This chapter provides an example on how to extend an Oracle Business Process Management (BPM) process used in an Oracle Process Accelerator. Extending an Oracle BPM process provides a customizable input schema for an Oracle BPM process entry point to access any external application. The customization becomes in-memory data which can be used in the process internally or passed to an external stub or downstream process.

This chapter contains the following sections:

■ Section 2.1, "Example Overview"

■ Section 2.2, "Creating a New XSD"

■ Section 2.3, "Processing XSD Changes"

2.1 Example OverviewOracle Unified Loan Origination (ULO) has been extended to calculate the down payment for a loan, based on the estimated market value. The EstimatedMarketValue element becomes part of the initial payload from the Oracle ULO external application. Custom attributes are used to calculate the down payment based on the formula Loan down payment amount = Estimated market value - Loan amount. The down payment amount appears in the Oracle ULO Perform final review and submit for funding page.

The infrastructure changes made to extend Oracle ULO to enable the calculation of the down payment are as follows:

■ The ProcessExternalLoanApplication business process includes new data objects, ExtractedExtendedAttributeDO and ExtensibleAttrPlaceholderDO that receive data from the extended attributes as highlighted in Figure 2–1. Figure 2–2 and Figure 2–3 show the structures for these two data objects. The ExtractedExtendedAttributeDO is based on the ExtractedExtendedAttribute business object. The ExtensibleAttrPlaceholderDO is based on the ApplicatonData business object.

Example Overview


Figure 2–1 New Data Objects in the ProcessExternalLoanApplication Business Process

Figure 2–2 ExtractedExtendedAttributeDO Structure

Example Overview


Figure 2–3 ExtensibleAttrPlaceholderDO Structure

■ The LoanOriginationProcess business processes includes a new variable to perform the loan amount calculation. The Custom Flow gateway ensures the new variable is not null before entering the overloaded flow. The Calculate loan disbursal amount task calculates the loan amount from the New_Var_Value - the loan amount to be disbursed. Figure 2–4 shows a portion of the LoanOriginationProcess with the gateway and task highlighted.

Creating a New XSD


Figure 2–4 New Data Objects in the LoanOriginationProcess Business Process

■ The GetAppDataResponse_To_applicationDataDO.xsl is a placeholder for custom input.

■ The localExternalAppDO_extensibleAttrPlaceholderDO.xsl facilitates a new data object to be populated by an external data set or transformed on demand without external user input.

■ The extensibleAttrPlaceholderDO_extractedExtendedAttributeDO.xsl facilitates a new data object to be populated by an external data set or transformed on demand without external user input.

You can use this example scenario to see how you can enhance the delivered payload, by creating, processing, and transforming an XSD, to meet your business requirements.

The high level configuration includes:

■ Creating a new XSD schema or editing the elements of the AppHeaderExtendedCollateralDtl.xsd

This enables you to pass the extended payload to a business process with minimal effort.

■ Modifying the AppHeaderAddInfo.xsd to include the new schema

This enables a business process to consume the new attributes and make them available in the process. You can also pass the new attributes to an external service.

■ Opening the ExternalApplicationData.xsd and ApplicationData.xsd and selecting the new elements

■ Modifying a business process based on your use case

2.2 Creating a New XSDYou review the business process model for a process accelerator (PA) and determine you need to include additional data in the process payload.You can create a new XSD and extend it to include this additional data.

To create a new XSD:

1. In Oracle JDeveloper, create a new XSD with the file structure and naming convention as used in the AppHeaderExtendedCollateralDtl.xsd. Place the new XSD in the XSD project folder.

Creating a New XSD


In this example, the j_AppHeaderExtSample is created from the AppHeaderExtendedCollateralDtl.xsd with the following structure. When creating a new XSD, do not change any structure not listed in this example. You can replace the italic text with names that reflect your implementation. Figure 2–5 depicts the AppHeaderExtendedCollateralDtl.xsd.

■ XSD element definition name: j_AppHeaderExtSample

■ Complex type name: j_AppHeaderExtSample

■ Individual elements inside the <xsd:sequence> tag for j_AppHeaderExtSample: EstimatedMarketValue, PropertyInsuranceFee, LoanOriginationFee, RegistrarFee, LoanCashinFee, LoanPaidInCashFlag (need to reference this for editing the XSD)

These are simple element types which can be shared at two levels. To share them across the extended XSDs, add them to the BasePrimitive.xsd. To refer to them individually, add them as a complex type. You can use these existing elements or create new ones.

Figure 2–5 Example New XSD Structure

2. In source mode, open the AppHeaderAddInfo.xsd and add the entry <xsd:include schemaLocation="NameOfTheNewXSD.xsd"/> for the newly created xsd.

Figure 2–6 depicts adding the entry for AppHeaderExtendedCollateralDtl.xsd.

Processing XSD Changes


Figure 2–6 Adding the location of the include statement

2.3 Processing XSD ChangesOnce you have created a new XSD, you must process the changes so they can be applied to the BPM process. The BPM process consumes the new attributes as the initial payload and makes them available through the entire process. The XSD and the fields appear in any data object bound to an application data business object and can be accessed using the standard XPATH function. Based on the business need, the XSD can be used internally in the process, or passed to an external service.

To process XSD changes:

1. Open the ExternalApplicationData.xsd and select the new element.

2. Open the ApplicationData.xsd and select the element chosen in step 1.

The new schema elements are available in the applicationDataDO for use in a business process or an external service at runtime.

3. In the ProcessExternalLoan business process, edit the ExtractedExtendedAttributeBO business object per your requirements.

This business object currently reflects the values based on the example scenario outlined in Section 2.1, "Example Overview."

4. In the ProcessExternalLoan business process, edit the extensibleAttrPlaceholderDO_extractedExtendedAttributeDO.xsl transformation file.

This transformation file transforms the placeholder dataset to the data object based on the example scenario. If you change the structure of the placeholder dataset, then transform this file.

5. In the ProcessExternalLoan business process, identify an unused elements step 4, and manually assign the output of the transformation.

In the example scenario, the AssignMarketValue activity, in the ProcessExternalLoan business process, maps to applicationDataDO.flsoCustomObjects.numberAttr9.



6. In the LoanOriginationProcess business process, edit the Custom Flow gateway and Calculate loan disbursal amount task as necessary, or implement your own logic.

In the example scenario, the Custom Flow gateway is implemented based on the value assigned in step 5. The Not Null design checks and diverts to the branch where the loan amount is calculated.

The calculateloanamount branch calculates the value of the loan amount based on the extended parameters in the example scenario. In the calculateloanamount branch the disbursal amount variable is overloaded with the calculated loan amount.

3

Using an External Source to Invoke a Service 3-1

3Using an External Source to Invoke a Service

This chapter provides an overview of invoking listed process accelerator services from an external source.


■ Section 3.1, "Understanding Using an External Source"

■ Section 3.2, "Testing a Service Called from an External Source"

3.1 Understanding Using an External SourceYou can invoke specific process accelerator services using external sources. While Oracle provides graphical user interfaces (GUIs) for each process accelerator, you can use third-party applications to call the same service as required by your organization's infrastructure. Use Oracle Enterprise Manager Fusion Middleware Control to test the connection once the external source is configured.

In the external source, configure the process accelerator end point, WSDL, receive operations, and the fields with the information you want to pass to the process accelerator. The following sections provide the details you need to configure an external source for specific process accelerators.

3.1.1 Invoking ULO Using an External SourceYou can use an external source to create the loan application, and pass on the loan details to ULO for further processing.

ULO details:

■ Composite application – UnifiedLoanOrigination

■ Service – ProcessExternalLoanApplication.service

■ Port – ProcessExternalLoanApplicationPort

■ WSDL - ProcessExternalLoanApplication.service.WSDL

■ Endpoint URL - http://servername:port/soa-infra/services/default/UnifiedLoanOrigination/ProcessExternalLoanApplication.service

Table 3–1 provides the ULO fields you can use to map custom objects. These are generic to all home loan products shipped with ULO.

Understanding Using an External Source


Table 3–2 provides the ULO fields you can use to map home loan attributes.

3.1.1.1 Interface DescriptionProcessExternalLoanApplication.service is exposed as a synchronous web service to facilitate the creation of loan application in the ULO database, and initiate the loan origination process with the required payload. The following parameters are included:

■ Input: Loan application data.

■ Output: Acknowledgment message with loan application ID or JboException in case of failure in business logic.

■ Fault: JboException, in case of failure in business logic. JboExceptions may occur in case of any failure in business logic at the model layer and will be reported back to the client as WSDL faults.

A loan application can contain the elements of the application and applicants defined in Table 3–3 as part of the payload.

Table 3–1 ULO Composite Application Fields

Field Name Type

Term VARCHAR_ATTR_3

Payment Frequency VARCHAR_ATTR_4

Loan Purpose VARCHAR_ATTR_2

Interest Rate NUMBER_ATTR_1

Table 3–2 ULO Custom Attributes for Home Loans

Field Name Type

Address Line 1 VARCHAR_S_ATTR_4

Address Line 2 VARCHAR_ATTR_5

Address Line 3 VARCHAR_ATTR_6

City VARCHAR_ATTR_7

Country VARCHAR_S_ATTR_2

State VARCHAR_S_ATTR_1

Zip Code NUMBER_ATTR_5

ExtMarketValue NUMBER_ATTR_3

MorgageBalance NUMBER_ATTR_2

PropertyType VARCHAR_S_ATTR_3

PurchasePrice NUMBER_ATTR_4

PurchaseYear DATE_ATTR_1

Table 3–3 Loan Application Elements

Element Mandatory

ApplicationSource Yes

ApplicationChannel Yes

ProductCode Yes



3.1.2 Invoking TRM Using an External SourceYou can use an external source to create travel requests and pass the travel details to TRM for further processing.

TRM details:

■ Composite application - TravelRequestManagement

■ Service - CreateTravelRequestProcess.service

■ Port - CreateTravelRequestProcessPort

■ Complete SOAP Request - CreateTravelRequest.xml

■ Endpoint URL - http://servername:port/soa-infra/services/default/TravelRequestManagement/CreateTravelRequestProcess.service

■ WSDL - CreateTravelRequestProcess.wsdl

■ XSD - CreateTravelData.xsd

3.1.2.1 Interface DescriptionCreateTravelRequestProcess.service is exposed as a synchronous webservice to facilitate the creation of travel data in the TRM database, and initiate the travel request process with the required payload. The following parameters are included:

■ Input: Travel data.

■ Output: Acknowledgment message with travel request ID.

■ Fault: Travel request validation exception, in case of failure in business logic.

■ CreateTravelRequestResponse - Travel request ID or validation exception in case of failure in business logic.

■ TravelRequestValidationException - Exceptions may occur in case of any failure in business logic at the model layer and will be reported back to the client as WSDL faults.

A Travel request can contain one header and multiple trip segments or details. You must submit one trip segment for a single round trip. Table 3–4 and Table 3–5 identify

LoanAmount Yes

InterestRate Yes

ApplicantType Yes

ExternalId Yes

LoanTerm No

LoanPaymentFrequency No

FsloApplicantsEmployment No

FsloApplicantAssets No

FsloApplicantsLiability No

FsloApplicantsIncome No

Table 3–3 (Cont.) Loan Application Elements

Element Mandatory



the mandatory and optional elements for the travel request header and trip segments, respectively.

3.1.3 Invoking ISR Using an External SourceYou can use an external source to create service requests and pass on the service request details to ISR for further processing.

ISR details:

■ Composite application - InternalServiceRequest

■ Service - ProcessExternalLoanApplication.service

Table 3–4 Travel Request Header

Element Mandatory

Employee User Name Yes

Travel Purpose Yes

Travel Type Yes

Origin Yes

Destination Yes

Trip Start Date Yes

Trip End Date Yes

Travel Justification Yes

Late Justification No

Sponsoring Executive No

Customer No

Reference ID No

Cost Center No

Org VP No

Table 3–5 Travel Request Segment or Details

Element Mandatory

Origin Yes

Destination Yes

Start Date Yes

End Date Yes

Airline No

Service Class No

Estimated Transportation Cost

No

Hotel Name No

Room Rate No

Car Rental Agency No

Rental Rate No

Testing a Service Called from an External Source


■ Port - ProcessExternalLoanApplicationPort

3.1.3.1 Interface DescriptionProcess_External_Service_Request.service is exposed as a synchronous web service to facilitate the creation of service request data in the ISR database, and initiate the service request process with the required payload. The following parameters are included:

■ Input: Service request data.

■ Output - Acknowledgment message with service request ID or validation exception in case of failure in business logic.

■ Fault: ServiceRequestValidationException, in case of failure in business logic. Exceptions may occur in case of any failure in business logic at the model layer and will be reported back to the client as WSDL faults.

A Service request can contain the elements in Table 3–6 as part of the payload.

3.2 Testing a Service Called from an External SourceThe steps for testing an external source invocation are as follows:

1. In Oracle Enterprise Manager Fusion Middleware Control, in the navigation tree, expand SOA, expand soa-infra (AdminServer), expand default, then select the composite application.

2. On the composite application page, click Test.

3. On the Test Web Service page:

■ In the Operation field, select the receive operation.

Table 3–6 Service Request Elements

Element Mandatory

externalId Yes

extSourceName Yes

serviceRequestID Yes

fulfillingDept Yes

serviceTypeCode Yes

ServiceSubTypeCode Yes

requiredDate Yes

submitter Yes

reason Yes

priority No

organization No

telephone No

extension No

building No

room No

Testing a Service Called from an External Source


■ On the Request tab, expand Input Arguments, switch to XML View, and paste the sample payload text into the text box.

4. Click Test Web Service.

4

Generating a Report 4-1

4Generating a Report

This chapter provides an overview of the report generation used in Oracle Process Accelerators (PA). It also describes how to create a template for a new report.


■ Section 4.1, "Overview of Report Generation"

■ Section 4.2, "Creating a RTF Template"

4.1 Overview of Report GenerationOracle Process Accelerators use Oracle BI Publisher to generate pdf reports from a process accelerator's transaction payload. The reports are then stored in Oracle WebCenter Content.

Oracle Process Accelerators use the Oracle BI Publisher RTF Processor Engine to generate the reports. The RTF Processor Engine takes a RTF template as input. The processor parses the template and creates a XSL-FO template and XLIFF. The FO Processor Engine uses the XSL-FO template, XLIFF, and XML data to produce the final report. This configuration, highlighted in Figure 4–1, is achieved through the BIPReportGenerationImpl web service implemented as part of PACommonService. The BIPReportGenerationImpl web service can be triggered by ADF or Oracle BPM.

The BIPReportGenerationImpl web service includes two methods that take a RTF template name and path in Oracle WebCenter Content as inputs, retrieves the XSL-FO and XLIFF, and generates the report output. The methods are:

■ Method 1: uses generateReportandUploadToUCM to generate a report and store it in Oracle WebCenter Content and returns the report ID (Oracle WebCenter Content content ID).

■ Method 2: uses generateReport to generate a report and stores the report in a temporary directory as specified by the calling application. This method is best used for previewing a report.

The BIPReportGenerationImpl web service currently produces reports in pdf format. You can modify this web service to produce reports in HTML, Excel, or RTF format.

Creating a RTF Template


Figure 4–1 Implementation for Oracle Process Accelerator Report Generation

Oracle Unified Loan Origination (ULO) and Complaints Management (CMPM) ship with RTF templates. The templates are stored in the PA specific folders in Oracle WebCenter Content. Template information is stored in the ULO_TEMPLATES for Oracle Unified Loan Origination and the CM_INVESTIGATION_REPORT_TMPLTS and CM_RESPONSE_CORRES_TMPLTS for Complaints Management.

If you decide to modify the ULO or CMPM templates, then upload the modified template to the appropriate PA folder in Oracle WebCenter Content and delete the existing XSL-FO and XLIFF files for the existing template. The web service automatically regenerates the XSL-FO and XLIFF files based on the modified template.

4.2 Creating a RTF TemplateYou can create additional RTF templates using Microsoft Word and the Oracle BI Publisher command syntax. Upload your RTF template to the PA specific contribution folder in Oracle WebCenter Content to make it available for use. To create a RTF template, see "Creating RTF Templates" or "Creating RTF Templates Using the Template Builder for Word" in Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

5

Using Approval Hierarchy Reporting 5-1

5Using Approval Hierarchy Reporting

This chapter explains Approval Hierarchy Reporting (AHR), how to integrate AHR with Oracle Business Process Management (BPM), and provides an example of how to use AHR in your Oracle Business Activity Monitoring (BAM) dashboards.


■ Section 5.1, "Overview of Approval Hierarchy Reporting"

■ Section 5.2, "Integrating Approval Hierarchy Reporting with BPM"

■ Section 5.3, "Modifying Level of Data Loaded into SecurityDO"

■ Section 5.4, "Creating BAM Reports Using ApprovalDO and SecurityDO"

5.1 Overview of Approval Hierarchy ReportingThe purpose of Approval Hierarchy Reporting is to allow reporting at the manager level, and for any particular manager to be able to view data for her directs.

Approval Hierarchy Reporting includes two data objects (DO), ApprovalDO and SecurityDO. AHR can be used by external applications or other BPM processes to load data into ApprovalDO and SecurityDO. ApproverDO is used as a lookup in BAM dashboards, and SecurityDO acts as a security filter to control access to the data. By default, SecurityDO loads four levels of management data. You can change the default, see Section 5.3, "Modifying Level of Data Loaded into SecurityDO". These data objects can be used with any process accelerator (PA) BAM dashboard.

The ApprovalDO is populated with the management hierarchy after a request is submitted. When the request is approved by the final approver, if any delegates are used, the delegate approver is replaced with the original approver, then the ApprovalDO is updated with a final list of approvers. The SecurityDO enables a user to view data at an individual approver level. Figure 5–1 depicts the full AHR business process.

Overview of Approval Hierarchy Reporting


Figure 5–1 Approval Hierarchy Reporting Business Process

ApprovalDO and SecurityDO are populated by exposing the createManagementChain and createApprovalChain operations, respectively. These operations are defined as:

■ createManagementChain: The management hierarchy of a user is generated and published to a JMS queue based on the following parameters. The enterprise messaging services running on BAM listens to the respective queue and uploads data into the data objects.

– Employee User Name

– Upto Level: specifies the top level to calculate the management chain

– Reverse Hierarchy: true or false (indicates whether to reverse the management chain)

– Application Key: name of the invoking application

– Request ID: application request ID

■ createApprovalChain: The approval hierarchy for a request is generated, then the delegates are replaced with the actual approvers, and a message is published to the JMS queue based on the following parameters. The enterprise messaging services running on BAM listens to the respective queue and uploads data into the data object.

– Task ID: task ID for the human task

– Approvers List

– Employee User Name

– Reverse Hierarchy: true or false (indicates whether to reverse the management chain)

– Application Key: name of the invoking application

– Request ID: application request ID

You must manually install Approval Hierarchy Reporting if you want to use it for any PA other than Travel Request Management, see "Installing Additional Process Accelerators Manually" in Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators. Approval Hierarchy Reporting and all its components are automatically installed after completing the Travel Request Management Process Accelerator installation using the Oracle Process Accelerator Installer.

Creating BAM Reports Using ApprovalDO and SecurityDO


5.2 Integrating Approval Hierarchy Reporting with BPMApproval Hierarchy Reporting service can be integrated into any BPM process by utilizing the exposed service contract, BuildApprovalDOProcess.wsdl, from Oracle Metadata Services repository (MDS).

To integrate with the AHR service:

1. Include the BuildApprovalDOProcess.wsdl as a service reference in your application’s composite.xml by loading the service definition from MDS.

The service definition is located in oramds:/apps/PAMetaData/pa/common/wsdl/BuildApprovalDOProcess.wsdl. Create a MDS soa-infra connection to access this location.

2. Create a reusable subprocess in your BPM project to invoke the AHR service operations.

3. Identify the invocation points in your main process flow, and conditionally call the available operations from the reusable subprocess using a BPMN Call activity.

5.3 Modifying Level of Data Loaded into SecurityDOBy default, SecurityDO loads four levels of management data used in the BAM reports. Management levels are based on your employee hierarchy with the CEO starting at level one.

To change the level of management used:

1. In Oracle BAM Architect, select Enterprise Message Sources from the drop-down list, select SecurityDOEMS, and then click Edit.

2. Under XML Formatting, click Advanced formatting options.

3. In the Advanced formatting dialog box, locate the condition <xsl:if test="position() <= 4">, and then replace the 4 with the level of management data you want uploaded.

5.4 Creating BAM Reports Using ApprovalDO and SecurityDOApprovalDO and SecurityDO can be used in any BAM dashboard. These data objects are in the ProcessAccelerators/Common folder in the BAM Architect. This section provides an example of how to extend a Travel Request Management (TRM) BAM dashboard using ApprovalDO and SecurityDO. The steps in this section are performed using the BAM Architect.

To link the ApprovalDO to the main TRM data object:

1. Create a lookup field in the main TRM data object, BI_default_TravelRequestManagement_TravelRequestManagementProcess based on the ApproverDO, see Figure 5–2. This lookup field retrieves the originator for a particular travel request, see Figure 5–3, and displays it in the main data object, see Table 5–4.



Figure 5–2 Define Lookup Field Dialog Box

Figure 5–3 ApproverDO for TRM

Figure 5–4 Main TRM Data Object

2. Add one security filter. Configure the filter to restrict managers to view only their directs data, see Figure 5–5 and Figure 5–6.



Figure 5–5 Security Filter for TRM Data Object

Figure 5–6 SecurityDO for TRM

3. Create a new dashboard or report to include views where the data is displayed by Manager. Make one view a Surface Prompt View. This is needed for the Selection Criteria.

Figure 5–7 provides an example of a new TRM dashboard with four views. The main difference between this dashboard and the shipped TRM dashboard is that the Selection Criteria in the shipped dashboard is based on the manager and the cost center.



Figure 5–7 Approval Hierarchy Reporting Dashboard for TRM

4. Create two prompts, Manager and Period. In Edit mode, go into the Change Report Properties and add the prompts. For the Manager prompt, use the Originator field from the BI_default_TravelRequestManagement_TravelRequestManagementProcess data object. For the Period prompt, use the Metric_travelStartDate field from the BI_default_TravelRequestManagement_TravelRequestManagementProcess data object.

5. From the new dashboard, select a view, and then go into the Edit View. Under the Filters tab, add filters for Manager and Period, and then click OK. Use the following filter parameters:

Originator is equal to [Parameter:Manager]METRIC_travelStartDate is equal to [Parameter:Period]Latest is equal to Y

You must add these filters to each dashboard view. Figure 5–8, depicts these filters in the Selection Criteria.

Figure 5–8 Selection Criteria Using Manager and Period Filters

6

Supporting a New Language in an Oracle Process Accelerator 6-1

6Supporting a New Language in an OracleProcess Accelerator

This chapter provides guidelines for supporting a new language in an Oracle Process Accelerator.

This chapter contains the following section:

■ Section 6.1, "Adding a New Language for an Oracle Process Accelerator"

6.1 Adding a New Language for an Oracle Process AcceleratorBy default, Oracle Process Accelerators (PA) are in English. The other supported languages are:

■ Brazilian Portuguese

■ Chinese/China

■ Chinese/Taiwan

■ French

■ German

■ Italian

■ Japanese

■ Korean

■ Spanish

You can customize a PA’s resource bundles to translate the PA into a language that is not already supported. You need to know the language code for the language you want to translate the PA to, and be able to translate the PA elements to the new language.

To add a new language:

1. In Oracle JDeveloper, copy the resource bundles for the PA you are going to translate, and rename the copied resource bundles with the language tag you want to use.

See PA_HOME/doc/TranslationReadMe.txt for the list of PA resource bundles and their locations.

For example, if you want to translate ULO from English to Hebrew you would access the ULO project from PA_HOME/pa/src/fs/ulo/, then copy the ULOModelBundle.properties resource bundle and rename it to

Adding a New Language for an Oracle Process Accelerator


ULOModelBundle_he.properties. Repeat the copy and renaming for all the ULO resource bundles.

2. Open the new resource bundles and translate all the PA elements to the language you want, then save the updated files.

3. If you want the list of values to be translated into the new language, add the resource bundles to the globalization folder.

For example, to change the ULO list of values, copy the resource bundles to PA_HOME/pa/src/fs/common/model/FSCommonModel/FSCommonModelLookup/src/oracle/bpmpa/fs/model/lookup/resource/globalization/.

4. If the resource bundle is an ADF UI project, then in the faces-config.xml file, add your language code in the supported-locale tag. If you want to set the newly added language as the default language, modify the default-locale tag. Example 6–1 shows the faces-config.xml modified for Hebrew for the ULO project in PA_HOME/pa/src/fs/ulo/view/ULOTaskUI, PA_HOME/pa/src/fs/ulo/view/ULOAdminUI, and PA_HOME/pa/src/fs/ulo/view/ULOCustomObjectsUI .

Example 6–1 Modified faces-config.xml File

<locale-config> <default-locale>he</default-locale> <supported-locale>he</supported-locale> </locale-config>5. If the common resource bundle is added or changed, rebuild the common resource

bundle projects from PA_HOME/pa/src/common.

In a bash shell:

■ For Linux, run source env.sh or for Windows, run env.bat from PAHome/bin.

■ In the build.xml file, change the value for the Jdev home to your Jdev home location.


■ Run ant build.xml.

6. Rebuild the PA resource bundle projects from the respective PA folder PA_HOME/pa/src/....

In a bash shell:

■ For Linux, run source env.sh or for Windows, run env.bat from PAHome/bin.

■ In the build.xml file, change the value for the Jdev home to your Jdev home location.


■ Run ant build.xml.

7. Deploy the artifacts by uninstalling and reinstalling the PA.

To uninstall the PA, see "Uninstalling Selective Oracle Process Accelerators" in Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators.


Supporting a New Language in an Oracle Process Accelerator 6-3

Reinstall the PA, see "Installing Oracle Process Accelerators (Subsequent Install)" in Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators.

Once the PA is reinstalled, the new resource bundles can be used.

8. To display the PA in the new language, see "How to Change the Preferred Language" in the Oracle Fusion Middleware Installation Guide for Oracle Process Accelerators.