Oracle Utilities Work and Asset Management and Operational … · 2020. 12. 11. · Oracle...

635
Oracle Utilities Work and Asset Management and Operational Device Management Administrative User Guide Release 2.2.0.6.3 F21795-04 December 2020

Transcript of Oracle Utilities Work and Asset Management and Operational … · 2020. 12. 11. · Oracle...

  • Oracle UtilitiesWork and Asset Management andOperational Device ManagementAdministrative User Guide

    Release 2.2.0.6.3F21795-04

    December 2020

  • 2

    Oracle Utilities Work and Asset Management and Operational Device Management Administrative User Guide

    Release 2.2.0.6.3

    F21795-04

    December 2020

    Documentation build: 10.21.2020 18:45:19 [WAM2_1603320319000]

    Copyright © 2012, 2020, Oracle and/or its affiliates. All rights reserved.

    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, then

    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 fail-safe, 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 about 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 unless otherwise set forth in an applicable agreement between you and Oracle. 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, except as set forth

    in an applicable agreement between you and Oracle.

  • 3

    Contents

    Framework Administrative User Guide.........................................................................................................17General Options................................................................................................................................................................. 17

    Defining Installation Options........................................................................................................................................... 17Installation Options - Main...........................................................................................................................................17Installation Options - Messages.................................................................................................................................. 18Installation Options - Algorithms................................................................................................................................. 18Installation Options - Accessible Modules.................................................................................................................. 20Installation Options - Installed Products......................................................................................................................20

    Support For Different Languages................................................................................................................................... 21User Language............................................................................................................................................................ 21Customer Language.................................................................................................................................................... 21Defining Languages.....................................................................................................................................................22

    Defining Countries...........................................................................................................................................................23Country - Main.............................................................................................................................................................23Country - States.......................................................................................................................................................... 23

    Defining Currency Codes................................................................................................................................................23Defining Time Zones.......................................................................................................................................................24

    Designing Time Zones................................................................................................................................................ 24Setting Up Time Zones............................................................................................................................................... 26Setting Up Seasonal Time Shift..................................................................................................................................26

    Defining Geographic Types............................................................................................................................................ 26Defining Work Calendar..................................................................................................................................................27Defining Display Profiles.................................................................................................................................................27

    Additional Hijri Date Configuration.............................................................................................................................. 29Defining Phone Types.................................................................................................................................................... 29Defining Feature Configurations..................................................................................................................................... 30

    Feature Configuration - Main...................................................................................................................................... 30Feature Configuration - Messages..............................................................................................................................31

    Defining Master Configurations.......................................................................................................................................31Security & User Options.................................................................................................................................................... 32

    The Big Picture of Application Security..........................................................................................................................32Application Security..................................................................................................................................................... 32Action Level Security...................................................................................................................................................34Field Level Security..................................................................................................................................................... 34Encryption and Masking.............................................................................................................................................. 35

    System Encryption................................................................................................................................................... 35User Interface Masking............................................................................................................................................ 35Application Encryption..............................................................................................................................................40

    The Base Package Controls One User, One User Group, And Many Application Services.......................................42Importing Security Configuration from an External Source.........................................................................................42

    The Big Picture of Row Security.................................................................................................................................... 43Defining Application Services......................................................................................................................................... 43Defining Security Types..................................................................................................................................................44

    Security Type - Main................................................................................................................................................... 44Defining User Groups..................................................................................................................................................... 44

    User Group - Main...................................................................................................................................................... 44User Group - Application Services..............................................................................................................................45User Group - Users.....................................................................................................................................................46

    User Group Services Management................................................................................................................................ 46Defining Access Groups................................................................................................................................................. 46Defining Data Access Roles...........................................................................................................................................47

    Data Access Role - Main............................................................................................................................................ 47Data Access Role - Access Group............................................................................................................................. 47

    Defining Users.................................................................................................................................................................48Data Privacy....................................................................................................................................................................48

    The Approach to Implementing Object Erasure..........................................................................................................48Configuring a Maintenance Object for Erasure....................................................................................................... 48Manage Erasure Schedule Algorithm...................................................................................................................... 49

  • 4

    Monitoring the Schedule and Performing Erasure...................................................................................................49Erasing User Information By Obfuscation............................................................................................................... 50Viewing an Object’s Erasure Status........................................................................................................................ 50Viewing Erasure Configuration.................................................................................................................................50Archiving the Object Erasure Schedule...................................................................................................................50

    Cryptography Keys..........................................................................................................................................................51Understanding Key Rings............................................................................................................................................51

    Signature Keys......................................................................................................................................................... 51Defining Key Rings......................................................................................................................................................51

    User Interface Tools...........................................................................................................................................................52Understanding Portals and Zones.................................................................................................................................. 52Setting Up Portals and Zones........................................................................................................................................ 54

    Defining Zone Types................................................................................................................................................... 55Defining Zones.............................................................................................................................................................56

    Overriding Parameter Values...................................................................................................................................56Overriding Zone Parameters....................................................................................................................................56Zone Parameter Details........................................................................................................................................... 57Data Explorer Graph Configuration......................................................................................................................... 77Pagination Configuration.......................................................................................................................................... 83Use Data Explorer for Derived Data........................................................................................................................85Configuring Timeline Zones..................................................................................................................................... 85

    Defining Context-Sensitive Zones............................................................................................................................... 86Defining Portals........................................................................................................................................................... 87

    Defining Menu Options................................................................................................................................................... 87Menu - Main................................................................................................................................................................ 87Menu - Menu Items..................................................................................................................................................... 88

    Defining Navigation Keys................................................................................................................................................90Navigation Key Types................................................................................................................................................. 90Navigation Key vs. Navigation Option.........................................................................................................................90The Flexibility of Navigation Keys...............................................................................................................................90Linking to External Locations...................................................................................................................................... 91Overriding Navigation Keys.........................................................................................................................................91Maintaining Navigation Keys....................................................................................................................................... 91

    Defining Navigation Options........................................................................................................................................... 92Navigation Option - Main............................................................................................................................................ 93Navigation Option - Tree.............................................................................................................................................95

    Understanding System Messages.................................................................................................................................. 95Defining System Messages.........................................................................................................................................95

    Message - Main....................................................................................................................................................... 95Message - Details.................................................................................................................................................... 96

    Defining Display Icons.................................................................................................................................................... 97Custom Look and Feel Options......................................................................................................................................97

    User Interface.............................................................................................................................................................. 98UI Map Help................................................................................................................................................................ 98

    Database Options...............................................................................................................................................................98Understanding The Data Model......................................................................................................................................98

    Fields............................................................................................................................................................................99Tables........................................................................................................................................................................ 101Maintenance Objects................................................................................................................................................. 102Defining Valid Values................................................................................................................................................ 104Characteristic Types.................................................................................................................................................. 105Foreign Key References............................................................................................................................................107

    Defining Tables............................................................................................................................................................. 109Table - Main.............................................................................................................................................................. 109Table - Table Field.................................................................................................................................................... 111Table - Constraints.................................................................................................................................................... 112Table - Referred by Constraints................................................................................................................................113

    Defining Fields.............................................................................................................................................................. 113Defining Maintenance Objects......................................................................................................................................114

    Maintenance Object - Main....................................................................................................................................... 114Maintenance Object - Options...................................................................................................................................114Maintenance Object - Algorithms.............................................................................................................................. 115Maintenance Object - Maintenance Object Tree...................................................................................................... 117

    Defining Lookups.......................................................................................................................................................... 117

  • 5

    Lookup - Main............................................................................................................................................................118Defining Extendable Lookups....................................................................................................................................... 118

    Extendable Lookup Advanced Topics.......................................................................................................................119Defining Characteristic Types.......................................................................................................................................120Defining Foreign Key References.................................................................................................................................120Audit Trails.................................................................................................................................................................... 121

    Captured Information................................................................................................................................................. 122How Auditing Works.................................................................................................................................................. 122The Audit Trail File....................................................................................................................................................122How To Enable Auditing........................................................................................................................................... 123

    Turn On Auditing For a Table............................................................................................................................... 123Specify The Fields and Actions To Be Audited.....................................................................................................123

    Audit Queries............................................................................................................................................................. 124Audit Query by User.............................................................................................................................................. 124Audit Query by Table / Field / Key........................................................................................................................125

    Bundling.........................................................................................................................................................................126About Bundling.......................................................................................................................................................... 126

    Sequencing of Objects in a Bundle....................................................................................................................... 126Recursive Key References.....................................................................................................................................126Owner Flags on Bundled Entities.......................................................................................................................... 127

    Configuring Maintenance Objects for Bundling.........................................................................................................127Working with Bundles................................................................................................................................................129

    Creating Export Bundles........................................................................................................................................ 129Creating and Applying Import Bundles.................................................................................................................. 130Editing Export Bundles...........................................................................................................................................130Editing Import Bundles...........................................................................................................................................130

    Revision Control............................................................................................................................................................131About Revision Control..............................................................................................................................................131

    Turning On Revision Control................................................................................................................................. 131Configuring Maintenance Objects for Revision Control.........................................................................................132

    Working with the Revision Control Zones.................................................................................................................132Checking Out an Object.........................................................................................................................................132Checking In an Object........................................................................................................................................... 133Reverting Changes.................................................................................................................................................133Forcing a Check In or Restore.............................................................................................................................. 133Deleting an Object................................................................................................................................................. 134Restoring an Object............................................................................................................................................... 134

    Working with the Revision Control Portal................................................................................................................. 134Revision Control Search........................................................................................................................................ 134

    Information Lifecycle Management ..............................................................................................................................135The Approach to Implementing Information Lifecycle Management.........................................................................135

    Batch Processes.................................................................................................................................................... 136Eligibility Algorithm................................................................................................................................................. 138

    Enabling ILM for Supported Maintenance Objects................................................................................................... 138Ongoing ILM Tasks................................................................................................................................................... 139Archived Foreign Keys.............................................................................................................................................. 139

    Configuration Tools.......................................................................................................................................................... 140Business Objects.......................................................................................................................................................... 140

    The Big Picture of Business Objects........................................................................................................................ 140What Is A Business Object?..................................................................................................................................140Business Object Inheritance.................................................................................................................................. 146Each Business Object Can Have A Different Lifecycle.........................................................................................147BO Algorithm Execution Summary........................................................................................................................ 154Granting Access To Business Objects.................................................................................................................. 155

    Defining Business Objects.........................................................................................................................................155Business Object - Main..........................................................................................................................................155Business Object - Schema.................................................................................................................................... 156Business Object - Algorithms.................................................................................................................................157Business Object - Lifecycle....................................................................................................................................159Business Object - Summary.................................................................................................................................. 161

    Advanced BO Tips and Techniques......................................................................................................................... 161Creating a Physical Business Object.....................................................................................................................162Managing To Do Entries........................................................................................................................................162Submitting a Batch Job..........................................................................................................................................163

  • 6

    Defining Status Reasons...........................................................................................................................................163Data Areas.................................................................................................................................................................... 163

    Defining Data Areas.................................................................................................................................................. 164Data Area - Main................................................................................................................................................... 164Data Area - Schema.............................................................................................................................................. 164

    Business Services.........................................................................................................................................................165Service Program........................................................................................................................................................ 165Defining Business Services.......................................................................................................................................166

    Business Service - Main........................................................................................................................................ 166Business Service - Schema...................................................................................................................................166Useful Services and Business Services................................................................................................................ 167

    User Interface (UI) Maps.............................................................................................................................................. 170Defining UI Maps.......................................................................................................................................................172

    UI Map - Main........................................................................................................................................................ 172UI Map - Schema...................................................................................................................................................173UI Map Attributes and Functions........................................................................................................................... 173UI Map Standards.................................................................................................................................................. 227

    Ensuring Unique Element IDs for UI Maps...............................................................................................................238Process Flows...............................................................................................................................................................239

    Understanding Process Flows...................................................................................................................................239Designing Process Flows.......................................................................................................................................... 241Defining Process Flow Types....................................................................................................................................243

    Action Method............................................................................................................................................................... 243Defining Action Methods........................................................................................................................................... 245

    Algorithms......................................................................................................................................................................245The Big Picture Of Algorithms.................................................................................................................................. 245

    How To Add A New Algorithm.............................................................................................................................. 247Minimizing The Impact Of Future Upgrades..........................................................................................................247

    Defining Algorithm Types.......................................................................................................................................... 248Defining Algorithms....................................................................................................................................................249

    Script Options................................................................................................................................................................249The Big Picture Of Scripts........................................................................................................................................ 250

    Scripts Are Business Process-Oriented.................................................................................................................250A Script Is Composed Of Steps............................................................................................................................ 250A Script May Declare Data Areas......................................................................................................................... 250Securing Script Execution......................................................................................................................................251

    The Big Picture Of BPA Scripts................................................................................................................................251How To Invoke Scripts...........................................................................................................................................252Developing and Debugging Your BPA Scripts...................................................................................................... 252Launching A Script From A Menu......................................................................................................................... 252Launching A Script When Starting The System.................................................................................................... 252Executing A Script When A To Do Entry Is Selected........................................................................................... 252The Big Picture Of Script Eligibility Rules............................................................................................................. 253

    The Big Picture Of Server-Based Scripts................................................................................................................. 257Additional Coding Options For Server Scripts.......................................................................................................257Plug-In Scripts........................................................................................................................................................ 259Service Scripts....................................................................................................................................................... 260Groovy Library Scripts............................................................................................................................................261Debugging Server-Based Scripts...........................................................................................................................261

    Maintaining Scripts.................................................................................................................................................... 261Script - Main...........................................................................................................................................................261Script - Step........................................................................................................................................................... 263Script - Data Area.................................................................................................................................................. 303Script - Schema..................................................................................................................................................... 303Script - Eligibility.....................................................................................................................................................304

    Merging Scripts..........................................................................................................................................................305Script Merge........................................................................................................................................................... 306

    Maintaining Functions................................................................................................................................................308Function - Main...................................................................................................................................................... 309Function - Send Fields...........................................................................................................................................309Function - Receive Fields...................................................................................................................................... 310

    Maintaining Managed Content......................................................................................................................................310Managed Content - Main...........................................................................................................................................310Managed Content - Schema..................................................................................................................................... 311

  • 7

    Advanced Schema Topics............................................................................................................................................ 311Schema Nodes and Attributes.................................................................................................................................. 311UI Hint Syntax........................................................................................................................................................... 331Schema Designer...................................................................................................................................................... 339Schema Viewer..........................................................................................................................................................341

    Business Event Log...................................................................................................................................................... 341Miscellaneous Topics....................................................................................................................................................342

    Module Configuration.................................................................................................................................................342Menu Item Suppression......................................................................................................................................... 342Menu Suppression................................................................................................................................................. 342Turn Off A Function Module.................................................................................................................................. 343

    Global Context Overview...........................................................................................................................................343System Data Naming Convention............................................................................................................................. 343

    Base Product System Data....................................................................................................................................343Implementation System Data................................................................................................................................. 344

    Accessibility Considerations...................................................................................................................................... 344Referencing URIs...................................................................................................................................................... 344

    Validation Against an Allowlist............................................................................................................................... 345URI Substitution..................................................................................................................................................... 345External File Storage............................................................................................................................................. 346

    Caching Overview......................................................................................................................................................347Expression Parser..................................................................................................................................................... 348Debug Mode.............................................................................................................................................................. 351System Override Date............................................................................................................................................... 351Advanced Search Options.........................................................................................................................................352

    To Do Lists.......................................................................................................................................................................352The Big Picture of To Do Lists.....................................................................................................................................352

    To Do Entries Reference A To Do Type.................................................................................................................. 352To Do Entries Reference A Role.............................................................................................................................. 353The Lifecycle Of A To Do Entry................................................................................................................................353How Are To Do Entries Created?.............................................................................................................................354

    Suppress the Creation of the To Do Entry............................................................................................................355To Do Entries Created By Background Processes............................................................................................... 355To Do Entries Created By Algorithms................................................................................................................... 357To Do Entries Created Manually........................................................................................................................... 357

    Refining a To Do Entry's Details at Creation Time...................................................................................................358The Priority Of A To Do Entry.................................................................................................................................. 360Working On A To Do Entry.......................................................................................................................................360Monitoring A To Do Entry......................................................................................................................................... 361To Do Entries Have Logs..........................................................................................................................................361Implementing Additional To Do Entry Business Rules............................................................................................. 361To Do Entries May Be Routed Out Of The System................................................................................................. 361To Do Information May Be Formatted By An Algorithm........................................................................................... 362Periodically Purging To Do Entries........................................................................................................................... 362

    Setting Up To Do Options............................................................................................................................................ 362Installation Options.................................................................................................................................................... 362Messages...................................................................................................................................................................363Feature Configuration................................................................................................................................................ 363Defining To Do Roles................................................................................................................................................363

    To Do Role - Main................................................................................................................................................. 363To Do Role - To Do Types....................................................................................................................................364

    Defining To Do Types............................................................................................................................................... 364To Do Type - Main................................................................................................................................................ 364To Do Type - Roles............................................................................................................................................... 365To Do Type - Sort Keys........................................................................................................................................ 365To Do Type - Drill Keys.........................................................................................................................................366To Do Type - Message Overrides......................................................................................................................... 366To Do Type - To Do Characteristics..................................................................................................................... 366To Do Type - Algorithms....................................................................................................................................... 367

    Implementing The To Do Entries.............................................................................................................................. 368Background Processes.....................................................................................................................................................368

    Understanding Background Processes.........................................................................................................................368Background Processing Overview.............................................................................................................................369Parallel Background Processes.................................................................................................................................370

  • 8

    Optimal Thread Count............................................................................................................................................370Parameters Supplied To Background Processes..................................................................................................... 371

    Indicating a File Path or File Name.......................................................................................................................373Manifest File........................................................................................................................................................... 374

    Processing Errors...................................................................................................................................................... 375Error Post-Processing Logic......................................................................................................................................375Post-Processing Logic............................................................................................................................................... 376Timed Batch Processes............................................................................................................................................ 376Monitor Background Processes.................................................................................................................................376Plug-in Driven Background Processes......................................................................................................................378

    Processing System Records.................................................................................................................................. 378Uploading Records.................................................................................................................................................383

    How to Re-extract Information.................................................................................................................................. 384How to Submit Batch Jobs........................................................................................................................................385How to Track Batch Jobs..........................................................................................................................................385How to Restart Failed Jobs and Processes............................................................................................................. 385Assessing Level of Service....................................................................................................................................... 385

    Defining Batch Controls................................................................................................................................................ 385Batch Control - Algorithms........................................................................................................................................ 388

    Defining File Integration Types.....................................................................................................................................389On-Line Batch Submission........................................................................................................................................... 389

    Batch Submission Creates a Batch Run.................................................................................................................. 389Jobs Submitted in the Background........................................................................................................................... 390Email Notification....................................................................................................................................................... 390Running Multi-Threaded Processes.......................................................................................................................... 390Batch Jobs May End in Error....................................................................................................................................390Submitting Jobs in the Future................................................................................................................................... 391Lifecycle of a Batch Job Submission........................................................................................................................ 391Granting Access To Batch Submission.....................................................................................................................391Batch Job Submission - Main................................................................................................................................... 392

    Tracking Batch Processes............................................................................................................................................ 394Batch Run Tree - Main............................................................................................................................................. 394Batch Run Tree - Run Control..................................................................................................................................395

    The Big Picture of Requests........................................................................................................................................ 395Request Type Defines Parameters........................................................................................................................... 395Previewing and Submitting a Request .....................................................................................................................395To Do Summary Email..............................................................................................................................................396Defining a New Request........................................................................................................................................... 396Setting Up Request Types........................................................................................................................................ 396Maintaining Requests................................................................................................................................................ 397

    Attachments...................................................................................................................................................................... 397Attachment Overview.................................................................................................................................................... 397Configuring Your System for Attachments................................................................................................................... 398Maintaining Attachments...............................................................................................................................................399

    Adding Attachments...................................................................................................................................................400Application Viewer............................................................................................................................................................ 400

    Application Viewer Toolbar........................................................................................................................................... 400Data Dictionary Button.............................................................................................................................................. 400Physical and Logical Buttons.................................................................................................................................... 401Collapse Button......................................................................................................................................................... 401Attributes and Schema Button.................................................................................................................................. 401Maintenance Object Button....................................................................................................................................... 401Algorithm Button........................................................................................................................................................ 402Batch Control Button................................................................................................................................................. 402To Do Type Button....................................................................................................................................................402Description and Code Buttons.................................................................................................................................. 402Service XML Button...................................................................................................................................................402Select Service Button................................................................................................................................................ 403Java Docs Button...................................................................................................................................................... 403Groovy Java Docs Button......................................................................................................................................... 403Classic Button............................................................................................................................................................403Preferences Button.................................................................................................................................................... 403Help Button................................................................................................................................................................ 403About Button.............................................................................................................................................................. 404

  • 9

    Slider Icon..................................................................................................................................................................404Data Dictionary..............................................................................................................................................................404

    Using the Data Dictionary List Panel........................................................................................................................ 404Primary And Foreign Keys.....................................................................................................................................405Field Descriptions Shown.......................................................................................................................................405

    Using the Data Dictionary Detail Panel.................................................................................................................... 405Related Tables View.............................................................................................................................................. 405Table Detail View................................................................................................................................................... 406Column Detail View................................................................................................................................................406

    Maintenance Object Viewer..........................................................................................................................................406Using the Maintenance Object List Panel.................................................................................................................407Using the Maintenance Object Detail Panel............................................................................................................. 407

    Algorithm Viewer........................................................................................................................................................... 407Using the Algorithm Viewer List Panel..................................................................................................................... 407Using the Algorithm Plug-In Spot Detail Panel.........................................................................................................407Using the Algorithm Type Detail Panel.....................................................................................................................407Using the Algorithm Detail Panel.............................................................................................................................. 408

    Batch Control Viewer.................................................................................................................................................... 408Using the Batch Control Viewer List Panel...............................................................................................................408Using the Batch Control Detail Panel....................................................................................................................... 408

    To Do Type Viewer.......................................................................................................................................................408Using the To Do Type Viewer List Panel................................................................................................................. 409Using the To Do Type Detail Panel..........................................................................................................................409

    Service XML Viewer..................................................................................................................................................... 409Using the Service XML Viewer Overview Panel.......................................................................................................409Using the Service XML Viewer Detail Panel............................................................................................................ 409

    Java Docs Viewer......................................................................................................................................................... 410Using the Java Docs Viewer List Panel....................................................................................................................410Using the Java Package Detail Panel...................................................................................................................... 410Using the Java Interface / Class Detail Panel.......................................................................................................... 410

    Groovy Java Docs Viewer............................................................................................................................................ 411Application Viewer Preferences.................................................................................................................................... 411Application Viewer Stand-Alone Operation...................................................................................................................411

    Stand-Alone Configuration Options........................................................................................................................... 411Example Application Viewer Configuration............................................................................................................... 412

    Application Viewer Generation......................................................................................................................................412Monitoring and Analytics.................................................................................................................................................. 413

    Reporting Tool Integration............................................................................................................................................ 413The Big Picture Of Reports.......................................................................................................................................413

    Integration with BI Publisher.................................................................................................................................. 413How To Request Reports...................................................................................................................................... 414Viewing Reports..................................................................................................................................................... 415

    Configuring The System To Enable Reports............................................................................................................ 415Configuring BI Publisher Reports.......................................................................................................................... 415Defining Reporting Options....................................................................................................................................415Defining Report Definitions.................................................................................................................................... 416

    Sample Reports Supplied with the Product.............................................................................................................. 417How to Use a Sample Report Provided with the System......................................................................................417

    How To Define A New Report.................................................................................................................................. 418Use a Sample Report as a Starting Point.............................................................................................................418Publishing Reports in BI Publisher........................................................................................................................ 418Designing Your Report Definition.......................................................................................................................... 419

    Service Health Check................................................................................................................................................... 421Health Check Configuration.......................................................................................................................................422Viewing Health Check Results.................................................................................................................................. 422Introducing Health Check Conditions........................................................................................................................423

    Measuring Performance................................................................................................................................................423Understanding Performance Targets........................................................................................................................ 423

    Performance Target Objects Overview..................................................................................................................424Calculating and Displaying Performance Targets..................................................................................................424Performance Target Metrics and Metric Types..................................................................................................... 424Performance Target Categories and Types.......................................................................................................... 425Performance Targets Define Specific Metrics....................................................................................................... 425Objects Linked to a Performance Target...............................................................................................................425

  • 10

    Creating Performance Target Zones..................................................................................................................... 426Setting Up Performance Target Configuration..........................................................................................................426

    Performance Target Category Lookup...................................................................................................................426Defining Performance Target Types......................................................................................................................426

    Maintaining Performance Targets............................................................................................................................. 427Capturing Statistics....................................................................................................................................................... 427

    Understanding Statistics............................................................................................................................................ 427Configuring Your System for Statistics..................................................................................................................... 428

    Defining and Monitoring Statistics......................................................................................................................... 428Creating Cube Views.................................................................................................................................................... 428

    Understanding Cube Viewer......................................................................................................................................429Cube Viewer Components..................................................................................................................................... 429Cube Configuration Components...........................................................................................................................433

    Configuring Cube Types............................................................................................................................................433Maintaining Cube Types........................................................................................................................................ 434Cube Type Advanced Topics.................................................................................................................................434

    Product Use Metrics..................................................................................................................................................... 435External Messages........................................................................................................................................................... 435

    Incoming Messages...................................................................................................................................................... 435Inbound Web Services.............................................................................................................................................. 435

    Understanding Inbound Web Services.................................................................................................................. 435Configuring Inbound Web Service Options........................................................................................................... 439Deploying Inbound SOAP Web Services.............................................................................................................. 443

    Guaranteed Delivery..................................................................................................................................................445Outgoing Messages...................................................................................................................................................... 445

    Outbound Messages..................................................................................................................................................445Polling Outbound Messages Using OSB...............................................................................................................446Batch Message Processing....................................................................................................................................447Real Time Messages............................................................................................................................................. 447Designing the System for Outbound Messages.................................................................................................... 448Configuring the System for Outbound Messages..................................................................................................451Managing Outbound Messages............................................................................................................................. 461

    Web Service Adapters...............................................................................................................................................462Understanding Web Service Adapters...................................................................................................................462Setting Up Web Service Adapters.........................................................................................................................463

    Sending Email............................................................................................................................................................464Web Service Category..................................................................................................................................................464

    Defining Web Service Categories............................................................................................................................. 465JMS Message Browser.................................................................................................................................................465Oracle Integration Cloud Catalog................................................................................................................................. 465

    Web Service Catalog Configuration.......................................................................................................................... 466Web Service Catalog Master Configuration.......................................................................................................... 466Maintaining the Web Service Catalog................................................................................................................... 466

    XAI Documentation Note.............................................................................................................................................. 467Integrations....................................................................................................................................................................... 467

    Creating Application Links in External Applications..................................................................................................... 467LDAP Integration...........................................................................................................................................................468

    LDAP Integration Overview....................................................................................................................................... 469Configuring LDAP Integration .................................................................................................................................. 470

    LDAP Mapping....................................................................................................................................................... 471Oracle Identity Manager Integration............................................................................................................................. 473User Redirection........................................................................................................................................................... 475Batch Scheduler Integration..........................................................................................................................................476Data Synchronization.................................................................................................................................................... 476

    Understanding Data Synchronization........................................................................................................................ 476Maintaining Sync Requests.......................................................................................................................................477

    Operational Analytics.................................................................................................................................................... 478Understanding Operational Analytics........................................................................................................................ 478Calendar and Time Dimensions................................................................................................................................479Maintaining Bucket Configurations............................................................................................................................ 479Defining Analytics Options.........................................................................................................................................480Defining Analytics Tables.......................................................................................................................................... 480

    Defining Analytics Dimensions...............................................................................................................................480Defining Analytics Facts.........................................................................................................................................481

  • 11

    Defining Characteristic Mapping................................................................................................................................481Analytics Integration......................................................................................................................................................481

    Understanding Analytics Integration..........................................................................................................................482Business Flags..............................................................................................................................................................482

    Understanding Business Flags..................................................................................................................................483Standard Name...................................................................................................................................................... 483Business Flag Type Defines Behavior for a Standard Name................................................................................483Business Flag Type Algorithms............................................................................................................................. 483Objects Linked to a Business Flag........................................................................................................................484Impacted Business Process...................................................................................................................................484Dates.......................................................................................................................................................................484Creating Business Flags.......................................................................................................................