Oracle Utilities Generation Asset Manager Cloud Service
Business User Guide
Overview
Architectural Overview
High Level Administration Areas
Glossary of Terms
User Interface Standard Features
Page Components
The Application Toolbar
Home Icon
Menu
Admin Menu
Back and Forward Arrows
History Icon
Search
Help Menu
User Menu
Page Title Area
Page Actions Toolbar
Bookmark Button
Next/Previous Item Buttons
Duplicate Button
Delete Button
Clear Button
Save Button
Refresh Button
Object Display Area
Multiple Tabs
Text Box
Date and Time Fields
Search Button
Context Menu Button
Go To Button
Broadcast Button
Embedded Help Icon
Work Lists
Scroll Bars with Dynamic Height
Sorting Functionality
Get More Functionality
Adding and Removing Rows Using Arrows
Reorganizing Items Using the Up and Down Arrows
Trees
Required Field Indicator
Accordion Windows
Row Summary and Chunk Management
Dashboard Area
Script Area
Portal Pages
Portals Are Made Up Of Zones
Users Must Be Granted Security Access To Each Zone
Zones May Appear Collapsed When A Page Opens
Some Portals Allow User Customization
Dashboard Portal
Bookmarks Zone
Tags Zone
Collect Entity Zone
Current To Do Zone
Favorite Links Zone
Favorite Scripts Zone
Favorite Searches Zone
Switch Language Zone
To Do Summary Zone
Work List Zone
Zone Types and Characteristics
Common Characteristics of Zones
Zone Visibility
Control Zone Headers
Explorer Zones
Search Criteria / Filter Area
Description Bar
Results Area
Title Bar
Explorer Zone Menu
Clear Filters
Export to Excel
Print
Save Search Options
Save As
Open Saved Search
Save
Set As Default
Remove As Default
Add To Favorites
Remove From Favorites
Delete
Show Filters
Show Column Configuration Area
The Open Zone Maintenance Icon
Configurable Columns
Multi-Query Zones
Map Zones
Open Map Maintenance Icon
Tabbed Display Zones
Timeline Zone
Common Base Portals and Zones
All-In-One Portal
List Zone
Separate Query and Maintenance Portals
Query Portal Search Zone
Maintenance Portal
Object Display Zone
Log Zone
Process Flow
Fixed Pages
Maintenance Pages
The Unique Identifier Area
Confirmation & Error Messages
Warning If Unsaved Changes Exist
Query Pages
The Search Area
User Preferences
User - Main
User - To Do Roles
User - Access Security
User - Bookmarks
User - Portal Preferences
User - Favorite Links
User - Favorite Scripts
User - Characteristics
User - Miscellaneous
Initiating Scripts
Shortcut Key Summary
Historian
About Points
Maintaining Points
About Units
Maintaining Units
About Alerts
Maintaining Alerts
About GAM View
Measurement Download to CSV
Live Energy Connect Portal
Operations Tab
About Unit Status
About Unit Graphs
About Manage Graphs
About Unit Output
About Alerts and Notifications
Position Tab
About Load Data
About Pricing Data
Administrative User Guide
Framework Administrative User Guide
General Options
Defining Installation Options
Installation Options - Main
Installation Options - Messages
Installation Options - Algorithms
Installation Options - Accessible Modules
Installation Options - Installed Products
Support For Different Languages
User Language
Customer Language
Defining Languages
Defining Countries
Country - Main
Country - States
Defining Currency Codes
Defining Time Zones
Designing Time Zones
Setting Up Time Zones
Setting Up Seasonal Time Shift
Defining Geographic Types
Defining Work Calendar
Defining Display Profiles
Additional Hijri Date Configuration
Defining Phone Types
Defining Feature Configurations
Feature Configuration - Main
Feature Configuration - Messages
Defining Master Configurations
Security & User Options
The Big Picture of Application Security
Application Security
Action Level Security
Field Level Security
Encryption and Masking
System Encryption
User Interface Masking
Application Encryption
The Base Package Controls One User, One User Group, And Many Application Services
Importing Security Configuration from an External Source
The Big Picture of Row Security
Defining Application Services
Defining Security Types
Security Type - Main
Defining User Groups
User Group - Main
User Group - Application Services
User Group - Users
User Group Services Management
Defining Access Groups
Defining Data Access Roles
Data Access Role - Main
Data Access Role - Access Group
Defining Users
Defining Redaction Rules
Obfuscation Configuration
Data Privacy
The Approach to Implementing Object Erasure
Configuring a Maintenance Object for Erasure
Manage Erasure Schedule Algorithm
Monitoring the Schedule and Performing Erasure
Erasing User Information By Obfuscation
Viewing an Object’s Erasure Status
Viewing Erasure Configuration
Archiving the Object Erasure Schedule
Cryptography Keys
Understanding Key Rings
Signature Keys
OAuth Keys
Defining Key Rings
User Interface Tools
Understanding Portals and Zones
Setting Up Portals and Zones
Defining Zone Types
Defining Zones
Overriding Parameter Values
Overriding Zone Parameters
Zone Parameter Details
Zone Visibility Service Script
SQL Statement
Column Parameters
Zone Action
User Filters
Hidden Filters
Multi-Select Action
Data Explorer Graph Configuration
Pagination Configuration
Use Data Explorer for Derived Data
Configuring Timeline Zones
Defining Context-Sensitive Zones
Defining Portals
Defining Menu Options
Defining Navigation Keys
Navigation Key Types
Navigation Key vs. Navigation Option
The Flexibility of Navigation Keys
Linking to External Locations
Overriding Navigation Keys
Maintaining Navigation Keys
Defining Navigation Options
Navigation Option - Main
Navigation Option - Tree
Understanding System Messages
Defining System Messages
Defining Message Categories
Defining Messages
Understanding Unified Search
Trees
Defining Trees
Contextual Insights
Insight Types
Defining Insight Types
Insight Groups
Defining Insight Groups
Color Configuration
Defining Colors
Color Options
Defining Display Icons
Custom Look and Feel Options
User Interface
UI Map Help
Database Options
Understanding The Data Model
Fields
Tables
Maintenance Objects
Defining Valid Values
Characteristic Types
Foreign Key References
Defining Tables
Defining Fields
Defining Maintenance Objects
Maintenance Object - Main
Maintenance Object - Options
Maintenance Object - Algorithms
Maintenance Object - Maintenance Object Tree
Defining Lookups
Lookup - Main
Defining Extendable Lookups
Extendable Lookup Advanced Topics
Defining Characteristic Types
Defining Foreign Key References
Audit Trails
Captured Information
How Auditing Works
The Audit Trail File
How To Enable Auditing
Turn On Auditing For a Table
Specify The Fields and Actions To Be Audited
Audit Queries
Audit Query by User
Audit Query by Table / Field / Key
Bundling
About Bundling
Sequencing of Objects in a Bundle
Recursive Key References
Owner Flags on Bundled Entities
Configuring Maintenance Objects for Bundling
Working with Bundles
Creating Export Bundles
Creating and Applying Import Bundles
Editing Export Bundles
Editing Import Bundles
Revision Control
About Revision Control
Turning On Revision Control
Configuring Maintenance Objects for Revision Control
Working with the Revision Control Zones
Checking Out an Object
Checking In an Object
Reverting Changes
Forcing a Check In or Restore
Deleting an Object
Restoring an Object
Working with the Revision Control Portal
Revision Control Search
Information Lifecycle Management
The Approach to Implementing Information Lifecycle Management
Batch Processes
Eligibility Algorithm
Enabling ILM for Supported Maintenance Objects
Ongoing ILM Tasks
Archived Foreign Keys
Configuration Tools
Business Objects
The Big Picture of Business Objects
What Is A Business Object?
A Business Object Has a Schema
A Business Object May Define Business Rules
A Business Object Defines its User Interface
Invoking A Business Object
Determine the Identifying BO
Base Business Objects
Business Object Inheritance
Each Business Object Can Have A Different Lifecycle
Valid States versus State Transition Rules
One Initial State and Multiple Final States
State-Specific Business Rules
Logic To Take Place When Entering A State
Logic To Take Place When Exiting A State
Monitor Rules
Inheriting Lifecycle
Auto-Transition
Keeping An Entity In Its Last Successful State
Monitoring Batch Processes
Transitory States
State Transitions Are Audited
Required Elements Before Entering A State
Capturing a Reason for Entering a State
Opening UI Maps Before Entering A State
BO Algorithm Execution Summary
Granting Access To Business Objects
Defining Business Objects
Business Object - Main
Business Object - Schema
Business Object - Algorithms
Business Object - Lifecycle
Business Object - Summary
Advanced BO Tips and Techniques
Creating a Physical Business Object
Managing To Do Entries
Submitting a Batch Job
Defining Status Reasons
Data Areas
Defining Data Areas
Data Area - Main
Data Area - Schema
Business Services
Service Program
Defining Business Services
Business Service - Main
Business Service - Schema
Useful Services and Business Services
User Interface (UI) Maps
Defining UI Maps
UI Map - Main
UI Map - Schema
UI Map Attributes and Functions
UI Map Standards
Ensuring Unique Element IDs for UI Maps
Process Flows
Understanding Process Flows
Designing Process Flows
Defining Process Flow Types
Action Method
Defining Action Methods
Algorithms
The Big Picture Of Algorithms
How To Add A New Algorithm
Minimizing The Impact Of Future Upgrades
Defining Algorithm Types
Defining Algorithms
Advanced Algorithm Tips
Script Options
The Big Picture Of Scripts
Scripts Are Business Process-Oriented
A Script Is Composed Of Steps
A Script May Declare Data Areas
Securing Script Execution
The Big Picture Of BPA Scripts
How To Invoke Scripts
Developing and Debugging Your BPA Scripts
Launching A Script From A Menu
Launching A Script When Starting The System
Executing A Script When A To Do Entry Is Selected
The Big Picture Of Script Eligibility Rules
Script Eligibility Rules Are Not Strictly Enforced
You Can Mark A Script As Always Eligible
You Can Mark A Script As Never Eligible
Criteria Groups versus Eligibility Criteria
Defining Logical Criteria
Examples Of Script Eligibility Rules
A Script With A Time Span Comparison
A Script With Service Type Comparison
The Big Picture Of Server-Based Scripts
Additional Coding Options For Server Scripts
Using Groovy Within Scripts
Plug-In Scripts
A Plug-In Script's API
Setting Up Plug-In Scripts
Service Scripts
A Service Script's API
Invoking Service Scripts
Groovy Library Scripts
A Groovy Library Script's API
Invoking Groovy Library Methods
Debugging Server-Based Scripts
Maintaining Scripts
Script - Main
Script - Step
How To Set Up Each Step Type
Conditional Branch Steps
Display Text Steps
Edit Data Steps
Go To Steps
Height Steps
Input Data Steps
Invoke Business Object Steps
Invoke Business Service Steps
Invoke Function Steps
Invoke Map Steps
Invoke Service Script Steps
Groovy Imports Steps
Groovy Library Interface Steps
Groovy Member Steps
Label Steps
Mathematical Operation Steps
Move Data Steps
Navigate To A Page Steps
Perform Script Steps
Press A Button Steps
Prompt User Steps
Set Focus To A Field Steps
Terminate Steps
Transfer Control Steps
Additional Topics
How To Find The Name Of User Interface Fields
How To Find The Name Of Page Data Model Fields
How To Find The Name Of A Button
How To Substitute Variables In Text
How To Use HTML Tags And Spans In Text Strings and Prompts
How To Use Constants In Scripts
How To Use Global Variables
How To Name Temporary Storage Fields
How To Work With Dates
Move Data
Mathematical Operation
Input Data
How To Use To Do Fields
How To Reference Fields In Data Areas
Script Engine Version 2 and Above Notes
Script - Data Area
Script - Schema
Script - Eligibility
Merging Scripts
Script Merge
Maintaining Functions
Function - Main
Function - Send Fields
Function - Receive Fields
Maintaining Managed Content
Defining Entity Tags
Advanced Schema Topics
Schema Nodes and Attributes
UI Hint Syntax
Schema Designer
Schema Viewer
Business Event Log
Miscellaneous Topics
Module Configuration
Menu Item Suppression
Menu Suppression
Turn Off A Function Module
Global Context Overview
System Data Naming Convention
Base Product System Data
Implementation System Data
Accessibility Considerations
Referencing URIs
Validation Against an Allowlist
URI Substitution
External File Storage
Caching Overview
Expression Parser
Debug Mode
Prepare Issue Details
System Override Date
Additional Search Options
Extensions Dashboard
To Do Lists
The Big Picture of To Do Lists
To Do Entries Reference A To Do Type
To Do Entries Reference A Role
The Lifecycle Of A To Do Entry
How Are To Do Entries Created?
Suppress the Creation of the To Do Entry
To Do Entries Created By Background Processes
Dedicated To Do Background Processes
To Dos Created for Object-Specific Error Conditions
To Dos Created by Background Processes for Specific Conditions
To Do Entries Created By Algorithms
To Do Entries Created Manually
Refining a To Do Entry's Details at Creation Time
The Priority Of A To Do Entry
Working On A To Do Entry
Monitoring A To Do Entry
To Do Entries Have Logs
Implementing Additional To Do Entry Business Rules
To Do Entries May Be Routed Out Of The System
To Do Information May Be Formatted By An Algorithm
Periodically Purging To Do Entries
Setting Up To Do Options
Installation Options
Messages
Feature Configuration
Defining To Do Roles
To Do Role - Main
To Do Role - To Do Types
Defining To Do Types
To Do Type - Main
To Do Type - Roles
To Do Type - Sort Keys
To Do Type - Drill Keys
To Do Type - Message Overrides
To Do Type - To Do Characteristics
To Do Type - Algorithms
Implementing The To Do Entries
Background Processes
Understanding Background Processes
Background Processing Overview
Parallel Background Processes
Optimal Thread Count
Parameters Supplied To Background Processes
Indicating a File Path or File Name
Manifest File
Sharing Customer Exported Data
Processing Errors
Error Post-Processing Logic
Post-Processing Logic
Timed Batch Processes
Monitor Background Processes
Plug-in Driven Background Processes
Processing System Records
Extract Record Processing
Uploading Records
How to Re-extract Information
How to Submit Batch Jobs
How to Track Batch Jobs
How to Restart Failed Jobs and Processes
Assessing Level of Service
Defining Batch Controls
Batch Control - Algorithms
Defining File Integration Types
On-Line Batch Submission
Batch Submission Creates a Batch Run
Jobs Submitted in the Background
Email Notification
Running Multi-Threaded Processes
Batch Jobs May End in Error
Submitting Jobs in the Future
Lifecycle of a Batch Job Submission
Granting Access To Batch Submission
Batch Job Submission - Main
Tracking Batch Processes
Batch Run Tree
Batch Run Tree - Main
Batch Run Tree - Run Control
Batch Day Tracking
Batch Day Dashboard
Batch Run Threads
The Big Picture of Requests
Request Type Defines Parameters
Previewing and Submitting a Request
To Do Summary Email
Defining a New Request
Setting Up Request Types
Maintaining Requests
Attachments
Attachment Overview
Configuring Your System for Attachments
Maintaining Attachments
Adding Attachments
Monitoring and Analytics
Reporting Tool Integration
The Big Picture Of Reports
Integration with BI Publisher
Requesting Reports from The System
Overview of the Data - BI Publisher
How To Request Reports
Viewing Reports
Configuring The System To Enable Reports
Configuring BI Publisher Reports
Configure the System to Invoke BI Publisher Real-time
Batch Scheduling in BI Publisher
Defining Reporting Options
Defining Report Definitions
Report Definition - Main
Report Definition - Labels
Report Definition - Parameters
Sample Reports Supplied with the Product
How to Use a Sample Report Provided with the System
Steps Performed at Installation Time
How To Define A New Report
Use a Sample Report as a Starting Point
Publishing Reports in BI Publisher
BI Publisher Database Access
Verify BI Publisher User Access Rights
Designing Your Report Definition
Designing Main Report Definition Values
Designing Characteristic Types
Designing Parameters
Designing Validation Algorithms
Designing Application Services
Designing Labels
Service Health Check
Health Check Configuration
Viewing Health Check Results
Introducing Health Check Conditions
Measuring Performance
Understanding Performance Targets
Performance Target Objects Overview
Calculating and Displaying Performance Targets
Performance Target Metrics and Metric Types
Performance Target Categories and Types
Performance Targets Define Specific Metrics
Objects Linked to a Performance Target
Creating Performance Target Zones
Setting Up Performance Target Configuration
Performance Target Category Lookup
Defining Performance Target Types
Maintaining Performance Targets
Capturing Statistics
Understanding Statistics
Configuring Your System for Statistics
Defining and Monitoring Statistics
Creating Cube Views
Understanding Cube Viewer
Cube Viewer Components
The Toolbar
Cube View Details
The Settings Area
Defining Conditional Formatting
The Filters Area
The Views Area
Cube Configuration Components
Configuring Cube Types
Maintaining Cube Types
Cube Type Advanced Topics
Designing Your Cube Type SQL
Defining Your Cube Type Business Service
Product Use Metrics
External Messages
Incoming Messages
Inbound Web Services
Understanding Inbound Web Services
Inbound REST Web Services
Inbound SOAP Web Services
Deploying XAI Inbound Service via IWS
Configuring Inbound Web Service Options
Configuring SOAP Inbound Web Service Options
Technical Configuration
Maintaining Web Service Annotation Types
Maintaining Web Service Annotations
Maintaining XAI Inbound Services
Configuring REST Inbound Web Service Options
Owner Configuration Lookup
Resource Category Lookup
Maintaining Inbound Web Services
Maintaining Inbound Web Service Operations
Web Service Schema Nodes and Attributes
Deploying Inbound SOAP Web Services
Guaranteed Delivery
Outgoing Messages
Outbound Messages
Polling Outbound Messages Using OSB
Batch Message Processing
Real Time Messages
Designing the System for Outbound Messages
Define the Outbound Message Business Object and Type
Real-Time Message Configuration
Define the External System and Configure the Messages
Outbound Message Schema Validation
Configuring the System for Outbound Messages
JNDI Server
JMS Connection
JMS Queue
JMS Topic
Message Sender
Message Sender - Main
Message Sender - Context
Defining Outbound Message Types
External Systems
External System - Main
External System - Template Use
Message Option
Managing Outbound Messages
Outbound Message - Main
Outbound Message - Message
Outbound Message - Response
Web Service Adapters
Understanding Web Service Adapters
Setting Up Web Service Adapters
Sending Email
Web Service Category
Defining Web Service Categories
JMS Message Browser
Oracle Integration Cloud Catalog
Web Service Catalog Configuration
Web Service Catalog Master Configuration
Maintaining the Web Service Catalog
XAI Documentation Note
Integrations
Creating Application Links in External Applications
LDAP Integration
LDAP Integration Overview
Configuring LDAP Integration
LDAP Mapping
Oracle Identity Manager Integration
User Redirection
Batch Scheduler Integration
Data Synchronization
Understanding Data Synchronization
Accumulative Data Synchronization
Generic Data Synchronization
Maintaining Sync Requests
Operational Analytics
Understanding Operational Analytics
Calendar and Time Dimensions
Maintaining Bucket Configurations
Defining Analytics Options
Defining Analytics Tables
Defining Analytics Dimensions
Defining Analytics Facts
Defining Characteristic Mapping
Analytics Integration
Understanding Analytics Integration
Business Flags
Understanding Business Flags
Standard Name
Business Flag Type Defines Behavior for a Standard Name
Business Flag Type Algorithms
Objects Linked to a Business Flag
Impacted Business Process
Dates
Creating Business Flags
Confidence
Setting Up Business Flag Configuration
Standard Name Category Characteristic Type
Standard Name Lookup
Business Process Lookup
Integration Configuration
Defining Business Flag Types
Maintaining Business Flags
Market Transaction Management
Understanding Market Transaction Management
Configuring Market Transaction Management
Defining Market Configurations
Defining Market Message Types
Defining Market Process Types
Maintaining Market Transactions
Maintaining Market Processes
Maintaining Market Process Events
Maintaining Market Messages
Content Migration Assistant (CMA)
Understanding CMA
Types of Migrations
Migrating Configuration Data
Migrating Business Data
Data with System Generated Primary Keys
Importing Data that References a User
Additional Considerations
File Format Version
CMA Configuration
Master Configuration - Migration Assistant
Migration Plans
Defining a Migration Plan
Understanding the BO Filtering Process
Migration Plans for Objects with XML-Embedded Links
Defining a Migration Request
Identifying Tables to Exclude From Migrations
Configuring Custom Objects for Migration
The CMA Execution Process
Exporting a Migration
Migration Data Set Export
Export Lifecycle
Importing and Applying a Migration
Import Step
Compare Step
Approval Step
Apply Step
Adjusting Data Prior to Comparing
Import Process Summary
Cancelling a Data Set
Additional Note Regarding Imports
Caching Considerations
Maintaining Import Data
Migration Data Set Import
Migration Transaction Portal
Migration Object Portal
Running Batch Jobs
CMA Reference
Framework-Provided Migration Configuration
Facts
Fact Is A Generic Entity
Fact's Business Object Controls Everything
Fact Supports A Log
Conversion
Understanding The Conversion Process
Conversion Entities
Conversion Steps
Load Legacy Data Into Staging Tables
Validate Information In The Staging Tables
Allocate Production Keys
XML Resolution
Insert Production Data
Validate Production
A Note About Keys
Multiple Owners In A Single Database
Conversion Entity Dashboard
Data Export
Understanding Data Export
Generalized Data Export
Specialized Data Export
Defining Data Export Control
Generalized Export Dashboard
Generation Asset Manager Administrative User Guide
Overview
Architectural Overview
Defining General Options
Understanding Units of Measure
Configuring Units of Measure
Defining Historian Options
Understanding Point Types
Configuring Point Types
Understanding Alert Types
Configuring Alert Types
Understanding Unit Types
Configuring Unit Types
Understanding Downsampling Retention Policy
Configuring Downsampling Retention Policy
Integrations
Importing Data
Oracle Utilities Generation Asset Manager Cloud Service
Importing Data