Oracle Utilities Customer Care and Billing

Database Administrator's Guide

Release 2.4.0 Service Pack 2

E37714-03

May 2014Updated August 2014

Oracle Utilities Customer Care and Billing Database Administrator's Guide

E37714-03

Copyright © 2007, 2014, 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, 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 on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

This guide provides instructions for installing and maintaining the database for Oracle Utilities Customer Care and Billing.

Audience

Oracle Utilities Customer Care and Billing Database Administrator’s Guide is intended for database administrators who will be installing and maintaining the database for Oracle Utilities Customer Care and Billing.

Related Documents

For more information, refer to these Oracle documents:

Installation Guides and Release Notes

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Release Notes

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Quick Install Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Installation Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Database Administrator’s Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Optional Product Installation Guide

Administration and Business Process Guides

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Administration Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Business Process Guide

•

Oracle Utilities Application Framework V4.2.0.2 Administration Guide

•

Oracle Utilities Application Framework V4.2.0.2 Business Process Guide

Supplemental Documents

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Batch Server Administration Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Server Administration Guide

•

Oracle Utilities Customer Care and Billing V2.4.0.2 Security Guide

Updates to this Documentation

This documentation is provided with the version of the product indicated. Additional and updated information about the operations and configuration of the product is available from the Knowledge Base section of My Oracle Support (http://support.oracle.com). Please refer to My Oracle Support for more information.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

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

italic

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

monospace

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

Database Overview

This section provides an overview of the Oracle Utilities Customer Care and Billing database, including:

•

Supported Database Platforms

•

Database Maintenance Rules

Supported Database Platforms

This section defines the platforms on which Oracle Utilities Customer Care and Billing is verified to operate.

Supported Platforms Summary Table

Oracle Utilities Customer Care and Billing is supported on the following platforms:

Platform

Database Versions

AIX 7.1 TL1 (POWER 64-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

Oracle Linux 5.4, 5.8, 6.2, 6.3, 6.4, or 6.5 (64-bit) x86_64 (64-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

Red Hat Enterprise Linux* 5.4, 5.8, 6.2, 6.3, 6.4, or 6.5 (64-bit) x86_64 (64-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

Oracle Solaris 10 or 11 (SPARC 64-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

Windows Server 2008 SP2 (x86_64 64-bit)

Windows Server 2012 (x86_64 64-bit)

Windows Server 2008 (32-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

HP-UX 11.31 (64-bit)

Oracle Database Server 11.2.0.1+ (64-bit)

Oracle Database Server 12.1.0.1+ (64-bit)

*Oracle Utilities Customer Care and Billing is tested and supported on the versions of Oracle Linux specified. Because Oracle Linux is 100% userspace-compatible with Red Hat Enterprise Linux, Oracle Utilities Customer Care and Billing also is supported on Red Hat Enterprise Linux for this release.

Oracle Utilities Customer Care and Billing is tested on both Oracle Database Enterprise Edition and Standard Edition. Some features, such as Advanced Compression and Partitioning, require the Enterprise Edition.

The following Oracle Database Server Editions are supported:

•

Oracle Database Enterprise Edition

•

Oracle Database Standard Edition

Note: Oracle Database Enterprise Edition and the Partitioning and Advanced Compression options are not mandatory but recommended. Standard Edition should only be considered suitable for small non-production environments where scalability, performance, and database size-on-disk are not important considerations. Oracle Database Enterprise Edition, including the Advanced Compression and Partitioning options, is strongly recommended in all other situations.

Refer to My Oracle Support for additional details.

Support for Software Patches and Upgrades

Due to the ongoing nature of software improvement, vendors will issue patches and service packs for the operating systems, application servers and database servers on top of specific versions that Oracle Utilities Customer Care and Billing has been tested with.

If it is necessary to apply an upgrade, please do so in a test environment that is running on the same platform as your production environment prior to updating the Oracle Utilities Customer Care and Billing production environment.

The exceptions from this rule are Hibernate software version 4.1 GA. This version should not be upgraded.

Always contact Oracle Utilities Customer Care and Billing support prior to applying vendor updates that do not guarantee backward compatibility.

Database Maintenance Rules

The database supplied with the product consists of the following elements:

•

A set of users to administrate, execute and read the database schema provided.

•

A set of database roles to implement security for each of the users provided.

•

A tablespace and a schema containing the base database objects used by the product.

The installation of these components is outlined in the installation section of this document.

Permitted Database Changes

During and after installation of the product the following changes may be performed by the database administrator personnel on site:

•

Users supplied by product may be changed according to the site standards.

•

Database objects may be added to the schema according to database naming standards outlined later in this document.

•

Database views and indexes may be created against base database objects. Please make sure to prefix new items with "CM" (for customer modification).

•

Database storage attributes for base indexes and base tables may be changed according to site standards and hardware used.

•

Tablespace names, attributes and locations may be changed according to site standards.

•

Database topology (that is, base table/index to tablespace, tablespace to data file, data file to location) may be altered according to tuning and/or site standards.

•

Database triggers may be created against base database objects unless they attempt to contravene base data integrity rules.

•

Database initialization and parameter settings may be altered according to site standards unless otherwise advised by Oracle Support or outlined in this document.

Non-Permitted Database Changes

In order to maintain operability and upgradeability of the product, during and after the installation of the product the following changes may not be performed by the database administration personnel on site:

•

Base objects must not be removed or altered in the following ways:

•

Columns in base tables must not be altered in anyway (altered, removed or added).

•

Columns in Indexes must not be altered or removed.

•

Tables must not be renamed or removed.

•

Base views must not be renamed or removed.

•

Base Triggers and Sequences must not be renamed or removed.

•

Base indexes must not be altered or removed.

Installing the Version 2.4.0 Service Pack 2 Database

This section provides the steps required to install or upgrade the Oracle Utilities Customer Care and Billing database, including:

•

Installation Overview

•

Oracle Database Installation

Installation Overview

Note: Refer to the Oracle Utilities Customer Care and Billing Installation Guide for the hardware and software versions required for the installation on Unix or Windows. This section contains steps for installation of Oracle Utilities Customer Care and Billing V2.4.0 service pack 2.

The following type of installation is available for Oracle Utilities Customer Care and Billing:

•

Initial Install — a database with no demo data.

•

Upgrade Install — a database upgrade to version 2.4.0.2 from versions 1.5.10, 1.5.15, 2.0.5, 2.1.0, 2.2.0, 2.2.0.10, 2.3.1.8, 2.4.0.0 or 2.4.0.1.

•

Demo Install — a database populated with demo data.

The database installation requires a supported version of the Java Development Kit Version 6.0 Update 20 or later and Oracle 11.2.0.1 32-bit client installed on the Windows 64-bit or 32-bit desktop where the install package is staged and run from.

For an Initial Install you will create an empty database on the Unix or Windows database server on which you operate the production instance of Oracle Utilities Customer Care and Billing. For a database Upgrade Install you will upgrade your current Oracle Utilities Customer Care and Billing database.

For a Demo Install you will create an empty database on a UNIX or Windows database server using the CDXDBA Script.

The Oracle Utilities Customer Care and Billing installation package contains a script, CDXDBA that creates an empty database with a default tablespace (CISTS_01) and the required users and roles. After creating the database, install the product specific database objects/data from the desktop mentioned above.

Review the Storage.xml file under the FW42020\Install-Upgrade folder and the CCB\Upgrade\Oracle\Install-Upgrade folder prior to an initial install or upgrade install. This file allocates all base tables and indexes to the default tablespace (CISTS_01) and the required users and roles. Information in this file is used by ORADBI while installing the Oracle Utilities Customer Care and Billing database objects.

Note: The utility CDXDBA is provided to create the demo database and import the demo data into the database. CDXDBA should be used for demo database only and not for creating an Initial Install database or a production database. See Demo Install for more information about installing the demo database. Customers should use the Database Configuration Assistant (DBCA) to create an Initial Install or production database and configure the instance parameters according to the environment needs.

If you decide to allocate some tables or indexes outside of the default tablespace, change the tablespace name from the default value to a custom value in the Storage.xml file.

For instance, if you decide to allocate table CI_ACCT in a tablespace MyTablespace, change Storage.xml as shown:

<CI_ACCT>

<TABLESPACE>MyTablespace</TABLESPACE>

</CI_ACCT>

For optimum storage allocation, database administrators should create multiple tablespaces with extents sized to store different types of tables/indexes. They can then edit the storage.xml file before install process, to spread tables and indexes across these tablespaces. Tables and indexes can be created in parallel by editing degree of parallelism. Tablespace, storage options, secure file options, Advanced Compression, and parallel information are used only for new objects. Therefore, for initial installs, information for each object should be reviewed. Be careful while editing this file. Make sure that tablespace names being used exist in the database. Do not change the basic format of this file.

Note: Prior to the installation of the database schema for the product, please ensure that the Database Management System software is installed according to your site standards and the installation guide provided by the database vendor. Also please make sure that you have necessary licenses to use some of the advanced database features such as Advanced Compression.

Oracle Database Installation

This section describes how to install the Oracle Database for Oracle Utilities Customer Care and Billing 2.4.0 Service Pack 2. It contains the following topics:

•

Database Scripts and Utilities

•

Initial Install, or Installing Version 2.4.0.2 for the First Time

•

Upgrade Install

•

Demo Install

Note: The installation tools outlined in this guide run on Windows and UNIX/Linux only. Please refer to Supported Database Platforms for more information on supported platforms.

Database Scripts and Utilities

Follow these steps before you begin installing the database:

1.

Unzip the CCB-V2.4.0.2.0-Oracle-Database-MultiplatForm.zip file to your local machine. The database folder contains several files that will be referred to in the installation process.

2.

Set up a Microsoft Windows desktop with the Oracle Client installed.

Initial Install, or Installing Version 2.4.0.2 for the First Time

This section describes an initial installation of the version 2.4.0.2 database.

Note: You must have a supported version of the Java Development Kit installed on the Windows desktop where you stage and run the database installation package. Refer to the Oracle Utilities Customer Care and Billing Installation Guide for more information.

This section describes how to install the database components of Oracle Utilities Customer Care and Billing, including:

•

Copying and Decompressing Install Media

•

Creating the Database

•

Installing the CISADM Schema

•

Postinstallation Tasks

Copying and Decompressing Install Media

To copy and decompress the Oracle Utilities Customer Care and Billing database:

1.

Download the Oracle Utilities Customer Care and Billing v2.4.0.2.0 Oracle database from the Oracle Software Delivery Cloud.

2.

Unzip the CCB-V2.4.0.2.0-Oracle-Database-MultiPlatform.zip file to a temporary folder. This file contains all the database components required to install the Oracle Utilities Customer Care and Billing database.

Creating the Database

Note: You must have Oracle Database Server 11.2.0.1+ or 12.1.0.1 installed on your machine in order to create the database. This step is not required if you are performing a database upgrade from a previous version of Oracle Utilities Customer Care and Billing.

Creating a Production Database

It is recommended that you use the Database Configuration Assistant (DBCA) for creating a production database. Once the database is created the instance configuration can be done according to the environment needs and based on your production recommendations.

After creating the database, follow these steps to create specific product users (for example, CISADM).

1.

Create a tablespace CISTS_01.

2.

Log into the database as sys user and execute \CCB\DatabaseCreation\UNIX\11g\users.sql

Note: You can also edit the script to rename the users, or default tablespace as per your production recommendations. Before proceeding, review the section regarding the Storage.XML file in Installation Overview .

Creating a Non-Production Database

The CDXDBA utility provided in the CCB\DatabaseCreation folder may be used to automate the database creation process for non-production databases.

CDXDBA creates an empty database with AL32UTF8 character set and at least one tablespace for storing the DB objects before running the installation. The default name of the tablespace is CISTS_01. It also creates product specific users as well.

This section includes:

•

Creating the Database on Unix Using CDXDBA

•

Creating the Database on Windows Using CDXDBA

Creating the Database on Unix Using CDXDBA

The files for creating the database are located in the ../CCB/DatabaseCreation/Unix directory.

Note: For Oracle 12c (12.1.0.1), use files under /CCB/DatabaseCreation/Unix_12c

Follow these steps to create a database:

1.

FTP the contents of the DatabaseCreation folder to a temporary directory on the UNIX server.

2.

Set the ORACLE_HOME and ORACLE_BASE variables.

3.

Run the utility cdxdba.plx by executing the following command:

perl cdxdba.plx

4.

Provide the following parameter values when prompted:

•

Instance name (DEMO):

•

ORACLE_BASE: the directory where the setup files for the database will be created (/orasw/app/oracle):

•

ORACLE_HOME: the folder where the current version of Oracle software is installed (/orasw/app/oracle/product/):

•

ORACLE_DATA: the directory where the data files for the database will be created (/db05/oradata):

•

Character set for the database (AL32UTF8):

Enter the parameter values based on the settings of your database server. You can also accept the default values displayed if they match your database server settings. You will be prompted to confirm the settings and then to select Y or N to create the database.

ORACLE_SID: DEMO

ORACLE_HOME: /orasw/app/oracle/product/

ORACLE_BASE: /orasw/app/oracle

ORACLE_DATA: /db05/oradata

Character Set: AL32UTF8

Do you want to continue (Y/N)?

5.

When the database has been created, you will be prompted with the following question:

Do you want to import a demo database dump into this database (Y/N)?

Select N to exit the database utility.

Creating the Database on Windows Using CDXDBA

The files for creating the database are located in the ..\CCB\DatabaseCreation\Windows directory.

You should be logged in as a user who is a member of the local ORA_DBA group on that server. The ORA_DBA group should have "administrator" privileges assigned to it.

Follow these steps to create the database:

1.

From a command prompt, run the utility CDXDBA.exe, located in the Windows folder.

The utility displays the following options:

E - Export schema from the database

R - Refresh schema with a database dump

C - Create/Recreate a local database

H - See help for the command line options

Q - Quit

2.

Select option C to create an empty database on your machine.

Provide the following values:

•

Provide the instance name (DEMO): <DB Name> (for example, CCB_DB)

•

Enter the character set of the database (AL32UTF8): AL32UTF8

•

Enter ORACLE_BASE: the directory where the setup files for the database will be created (c:\oracle): <Oracle_Base> (for example, c:\app\oracle)

•

Enter ORACLE_HOME: the folder where the current version of Oracle software is installed (c:\oracle\product\11.1.0.6\Db_1):< Oracle_Home> (for example, c:\app\oracle\db_home)

•

Enter ORACLE_DATA: the directory where the data files for the database will be created (c:\app\oracle\oradata): <Directory where data files will be created>

3.

Select option Q to exit the utility after the database is created.

Installing the CISADM Schema

You will install the Oracle Utilities Application Framework V4.2.0.2 prior to Oracle Utilities Customer Care and Billing 2.4.0.2. The files for Oracle Utilities Application Framework installation are located in the FW\FW42020 folder. The installation process will prompt you for the following information:

•

The target database name in which the product is to be installed.

•

A database user that will own the application schema (for example, CISADM).

•

A database user that has read-write (select/update/insert/delete) privileges to the objects in the application schema. (for example, CISUSER). The application will access the database as this user.

•

A database user with read-only privileges to the objects in the application schema. (for example, CISREAD).

•

A database role that has read-write (select/update/insert/delete) privileges to the objects in the application schema. The application will access the database as this user. (for example, CIS_USER).

•

A database role with read-only privileges to the objects in the application schema. (for example, CIS_READ).

•

Location for jar files. (The Jar files are bundled with the database package.)

•

Java Home (For example, C:\Java\jdk1.6.0_20)

Installing the Oracle Utilities Application Framework Database Component

To install the schema for Oracle Utilities Application Framework 4.2.0.2 follow these steps:

1.

Run OraDBI.exe from the ..\FW\FW42020\Install-Upgrade directory. Please run the utility from the command prompt.

Note: Be sure to run ORADBI.exe from a Window 32-bit or 64-bit desktop that has the Oracle Database 11g Release 2 Client (11.2.0.1), 32-bit, and Java Development Kit Version 6.0 Update 20 or later installed. The database should already be listed in the local file tnsnames.ora

The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

Installing Prerequisite Database Single Fixes

Before installing Oracle Utilities Customer Care and Billing, you must install Oracle Utilities Framework Prerequisite DB Single Fixes as described below.

1.

Apply prerequisite Framework DB single fixes by running the CDXPatch.exe utility from the ..\FW\FW42020\FW42020-HFix47 directory. The utility will prompt you for the value of the following parameters:

•

The target database type (O/M/D) [O]:

•

The name of the user that owns the database objects

•

The password for the user (in silent mode)

•

The name of the Oracle database

CDXPatch.exe can be executed by selecting it from Windows explorer, or by using a command line from a DOS window. Use the option "-h" to see the help.

After the patches are processed, the utility may prompt you to create security for new objects.

When prompted as shown below, press Enter without any input, because security for new objects is generated in subsequent steps during installation of Oracle Utilities Customer Care and Billing.

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g.

•

CISUSER,CISREAD):

•

Enter a database role which has a read-write privilege (e.g. CIS_USER):

•

Enter a database role which has a read only privilege (e.g. CIS_READ):

Installing the Oracle Utilities Customer Care and Billing Database Component

To install the database component of Oracle Utilities Customer Care and Billing, follow these steps.

1.

Run ORADBI.exe from the ..\CCB\Upgrade\Oracle\Install-Upgrade directory. The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues upgrading schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

ORADBI Performs the Following Tasks

•

Interacts with the user to collect information about the name of Oracle account that will own the application schema (for example, CISADM), password of this account, and the name of the Oracle account that the application user will use (for example, CISUSER), and the name of the Oracle account that will be assigned read-only privileges to the application schema (for example, CISREAD).

•

Verifies whether tablespace names already exist in the Storage.xml file (if not, the process will abort).

•

Installs the schema, installs the system data, and configures security.

•

Maintains upgrade log tables in the database.

•

Updates release ID when the upgrade is completed successfully.

•

If an error occurs while executing a SQL script or another utility, it logs and displays the error message and allows you to re-execute the current step. Log files OraDBI###.log are created in the same folder as OraDBI and contains all the SQL commands executed against the database along with the results. The log files are incremental so that the results are never overwritten. If warning messages are generated during the upgrade, OraDBI prompts the user at the end of the process. Users should check the log files to verify the warning messages.

•

Warning messages are only alerts and do not necessary mean a problem exists.

•

Stores the Schema owner and password in the feature configuration table. The password is stored in encrypted format.

Postinstallation Tasks

•

Enable USER_LOCK Package

•

Generating Database Statistics

•

Environment Registration

Enable USER_LOCK Package

For inbound web services to work the USER_LOCK must be enabled at the database level. This is a one time step. If this is not already enabled please do so using the following steps.

1.

Login as SYS user

2.

On SQL prompt run:

@?/rdbms/admin/userlock.sql

3.

Grant permission by running the following SQL:

grant execute on USER_LOCK to public;

Please note that grant can also be made to the database user which the Application connects to only instead of to public. For example, cisuser.

Generating Database Statistics

During an install process new database objects may be added to the target database. Before starting to use the database, generate the complete statistics for these new objects by using the DBMS_STATS package.

Environment Registration

If the target database is registered as a configuration laboratory or archiving database in another database, or another database has been registered as a configuration laboratory or archiving database in this database, it is required that you upgrade the registration at this stage.

The detailed instructions for environment registration can be found in the Oracle Utilities Customer Care and Billing user documentation. Please refer to this documentation before executing the environment registration utility EnvSetup.exe included in the post-install folder.

Upgrade Install

This section describes how to upgrade the database components of Oracle Utilities Customer Care and Billing, including:

•

Copying and Decompressing Install Media

•

Upgrading the CISADM Schema

Copying and Decompressing Install Media

To copy and decompress the Oracle Utilities Customer Care and Billing database:

1.

Download the Oracle Utilities Customer Care and Billing v2.4.0.2.0 Oracle database from the Oracle Software Delivery Cloud.

2.

Unzip the CCB-V2.4.0.2.0-Oracle-Database-MultiPlatform.zip file to a temporary folder.This file contains all the database components required to install the Oracle Utilities Customer Care and Billing database.

Upgrading the CISADM Schema

The following upgrade paths are supported:

•

Upgrading from Version 2.4.0.1 to 2.4.0.2

•

Upgrading from Version 2.4.0.0 to 2.4.0.2

•

Upgrading from Version 2.3.1.8 to 2.4.0.2

•

Upgrading from Version 2.2.0.10 to 2.4.0.2

•

Upgrading from Version 2.2.0 to 2.4.0.2

•

Upgrading from Version 2.1.0 to 2.4.0.2

•

Upgrading from Version 2.0.5 to 2.4.0.2

•

Upgrading from Version 1.5.10 or 1.5.15 to 2.4.0.2

Upgrading from Version 2.4.0.1 to 2.4.0.2

You must install the Oracle Utilities Application Framework version 4.2.0.2 prior to Oracle Utilities Customer Care and Billing 2.4.0.2. The files for Oracle Utilities Application Framework installation are located in the FW/FW42020 folder.

Installing the Oracle Utilities Application Framework Database Component

To install the schema for Oracle Utilities Application Framework 4.2.0.2 follow these steps:

1.

Run ORADBI.exe from the ..\FW\FW42020\Install-Upgrade directory. Please run the utility from the command prompt.

Note: Be sure to run ORADBI.exe from a Window 32-bit or 64-bit desktop that has the Oracle Database 11g Release 2 Client (11.2.0.1), 32-bit, and Java Development Kit Version 6.0 Update 20 or later installed. The database should already be listed in the local file tnsnames.ora

The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues upgrading schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

Installing Prerequisite Database Single Fixes

Before installing Oracle Utilities Customer Care and Billing, you must install Oracle Utilities Framework Prerequisite DB Hot Fixes as described below.

1.

Apply prerequisite Framework DB single fixes by running the CDXPatch.exe utility from the ..\FW\FW42020\FW42020-HFix47 directory. The utility will prompt you for the value of the following parameters:

The utility prompts you for the value of the following parameters:

•

The target database type (O/M/D) [O]: O

•

The name of the user that owns the database objects: <CISADM>

•

The password for the user (in silent mode): <Password for CISADM user>

•

The name of the Oracle database: <DB Name>

CDXPatch.exe can be executed by selecting it from Windows explorer, or by using a command line from a DOS window. Use the option "-h" to see the help.

After the patches are processed, the utility may prompt you to create security for new objects.

When prompted as shown below, press Enter without any input, because security for new objects is generated in subsequent steps during installation of Oracle Utilities Customer Care and Billing.

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g.

•

CISUSER,CISREAD):

•

Enter a database role which has a read-write privilege (e.g. CIS_USER):

•

Enter a database role which has a read only privilege (e.g. CIS_READ):

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run CCB2402_Trim_SRCH_CHAR_VAL.sql from the .. \CCB\Upgrade\Oracle\Install-Upgrade directory.

@CCB2402_Trim_SRCH_CHAR_VAL.sql

This will generate a file called CCB_TRIM_SRCH_CHAR_VAL.sql

3.

Run the generated CCB_TRIM_SRCH_CHAR_VAL.sql script

@CCB_TRIM_SRCH_CHAR_VAL.sql

Installing the Oracle Utilities Customer Care and Billing Database Component

To install the database component of Oracle Utilities Customer Care and Billing, follow these steps.

1.

Run ORADBI.exe from the ..\CCB\Upgrade\Oracle\Install-Upgrade directory. The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues to upgrading the schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

ORADBI Performs the Following Tasks

•

Interacts with the user to collect information about the name of Oracle account that will own the application schema (for example, CISADM), password of this account, password of the SYSTEM account in the database, and the name of the Oracle account that the application user will use (for example, CISUSER), and the name of the Oracle account that will be assigned read-only privileges to the application schema (for example, CISREAD).

•

Verifies whether tablespace names already exist in the Storage.xml file (if not, the process will abort).

•

Installs the schema, installs the system data, and configures security. Maintains upgrade log tables in the database.

•

Updates release ID when the upgrade is completed successfully.

•

If an error occurs while executing a SQL script or another utility, it logs and displays the error message and allows you to re-execute the current step. Log files ORADBI###.log are created in the same folder as ORADBI and contains all the SQL commands executed against the database along with the results. The log files are incremental so that the results are never overwritten. If warning messages are generated during the upgrade, ORADBI prompts the user at the end of the process. Users should check the log files to verify the warning messages. Warning messages are only alerts and do not necessary mean a problem exists.

•

Stores the Schema owner and password in the feature configuration table. The password is stored in encrypted format.

Consideration for Upgrade from Framework Versions Prior to Version 4.2.0 Service Pack 2

Customers upgrading from Framework versions prior to 4.2.0.2 need to run an upgrade script to trim the SRCH_CHAR_VAL column on the char tables. The search char value column is so far being populated with trailing spaces for Java-based objects for char types which are pre-defined values as well as foreign key values with user defined keys. This will result in empty results during "exact string" searches on SRCH_CHAR_VAL column. As a part of patch 16745968, this is fixed in the application but the existing data needs to be cleaned up.

The upgrade script "FW4202_Trim_SRCH_CHAR_VAL.sql" that is available in FW420 SP2 database blueprint upgrade folder can be used to perform this cleanup. This SQL should be executed by a schema owner and it will create a SQL file named "TRIM_SRCH_CHAR_VAL.sql". This SQL file ("TRIM_SRCH_CHAR_VAL.sql") is going to trim SRCH_CHAR_VAL columns of all the characteristics tables and will do this update operation in multiple chunks of key ranges. Only char types with pre-defined values as well as foreign key values with user defined keys will be updated in those char tables. Once sql-"FW4202_Trim_SRCH_CHAR_VAL.sql" is executed it cannot be re-executed.

Note: This is only needed during upgrades from FW versions below 420 SP2. It should NOT be run in an initial install environment.

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run FW4202_Trim_SRCH_CHAR_VAL.sql from the ..\FW42020\Install-Upgrade directory

@FW4202_Trim_SRCH_CHAR_VAL.sql

3.

Run the generated TRIM_SRCH_CHAR_VAL.sql script

@TRIM_SRCH_CHAR_VAL.sql

Enable USER_LOCK Package

For In-bound web services to work the USER_LOCK must be enabled at the database level. This is a one time step. If this is not already enabled please do so using the following steps.

1.

Login as SYS user

2.

On SQL prompt run:

@?/rdbms/admin/userlock.sql

3.

Grant permission by running the following SQL:

grant execute on USER_LOCK to public;

Please note that grant can also be made to the database user which the Application connects to only instead of to public. For example, cisuser.

Generating Database Statistics

During an install process new database objects may be added to the target database. Before starting to use the database, generate the complete statistics for these new objects by using the DBMS_STATS package.

Upgrading from Version 2.4.0.0 to 2.4.0.2

You must install the Oracle Utilities Application Framework version 4.2.0.2 prior to Oracle Utilities Customer Care and Billing 2.4.0.2. The files for Oracle Utilities Application Framework installation are located in the FW/FW42020 folder.

Installing the Oracle Utilities Application Framework Database Component

To install the schema for Oracle Utilities Application Framework 4.2.0.2 follow these steps:

1.

Run ORADBI.exe from the ..\FW\FW42020\Install-Upgrade directory. Please run the utility from the command prompt.

Note: Be sure to run ORADBI.exe from a Window 32-bit or 64-bit desktop that has the Oracle Database 11g Release 2 Client (11.2.0.1), 32-bit, and Java Development Kit Version 6.0 Update 20 or later installed. The database should already be listed in the local file tnsnames.ora

The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues upgrading schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

Installing Prerequisite Database Single Fixes

Before installing Oracle Utilities Customer Care and Billing, you must install Oracle Utilities Framework Prerequisite DB Hot Fixes as described below.

1.

Apply prerequisite Framework DB single fixes by running the CDXPatch.exe utility from the ..\FW\FW42020\FW42020-HFix47 directory. The utility will prompt you for the value of the following parameters:

The utility prompts you for the value of the following parameters:

•

The target database type (O/M/D) [O]: O

•

The name of the user that owns the database objects: <CISADM>

•

The password for the user (in silent mode): <Password for CISADM user>

•

The name of the Oracle database: <DB Name>

CDXPatch.exe can be executed by selecting it from Windows explorer, or by using a command line from a DOS window. Use the option "-h" to see the help.

After the patches are processed, the utility may prompt you to create security for new objects.

When prompted as shown below, press Enter without any input, because security for new objects is generated in subsequent steps during installation of Oracle Utilities Customer Care and Billing.

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g.

•

CISUSER,CISREAD):

•

Enter a database role which has a read-write privilege (e.g. CIS_USER):

•

Enter a database role which has a read only privilege (e.g. CIS_READ):

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run CCB2402_Trim_SRCH_CHAR_VAL.sql from the .. \CCB\Upgrade\Oracle\Install-Upgrade directory.

@CCB2402_Trim_SRCH_CHAR_VAL.sql

This will generate a file called CCB_TRIM_SRCH_CHAR_VAL.sql

3.

Run the generated CCB_TRIM_SRCH_CHAR_VAL.sql script

@CCB_TRIM_SRCH_CHAR_VAL.sql

Installing the Oracle Utilities Customer Care and Billing Database Component

To install the database component of Oracle Utilities Customer Care and Billing, follow these steps.

1.

Run ORADBI.exe from the ..\CCB\Upgrade\Oracle\Install-Upgrade directory. The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues to upgrading the schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

ORADBI Performs the Following Tasks

•

Interacts with the user to collect information about the name of Oracle account that will own the application schema (for example, CISADM), password of this account, password of the SYSTEM account in the database, and the name of the Oracle account that the application user will use (for example, CISUSER), and the name of the Oracle account that will be assigned read-only privileges to the application schema (for example, CISREAD).

•

Verifies whether tablespace names already exist in the Storage.xml file (if not, the process will abort).

•

Installs the schema, installs the system data, and configures security. Maintains upgrade log tables in the database.

•

Updates release ID when the upgrade is completed successfully.

•

If an error occurs while executing a SQL script or another utility, it logs and displays the error message and allows you to re-execute the current step. Log files ORADBI###.log are created in the same folder as ORADBI and contains all the SQL commands executed against the database along with the results. The log files are incremental so that the results are never overwritten. If warning messages are generated during the upgrade, ORADBI prompts the user at the end of the process. Users should check the log files to verify the warning messages. Warning messages are only alerts and do not necessary mean a problem exists.

•

Stores the Schema owner and password in the feature configuration table. The password is stored in encrypted format.

Consideration for Upgrade from Framework Versions Prior to Version 4.2.0 Service Pack 2

Customers upgrading from Framework versions prior to 4.2.0.2 need to run an upgrade script to trim the SRCH_CHAR_VAL column on the char tables. The search char value column is so far being populated with trailing spaces for Java-based objects for char types which are pre-defined values as well as foreign key values with user defined keys. This will result in empty results during "exact string" searches on SRCH_CHAR_VAL column. As a part of patch 16745968, this is fixed in the application but the existing data needs to be cleaned up.

The upgrade script "FW4202_Trim_SRCH_CHAR_VAL.sql" that is available in FW420 SP2 database blueprint upgrade folder can be used to perform this cleanup. This SQL should be executed by a schema owner and it will create a SQL file named "TRIM_SRCH_CHAR_VAL.sql". This SQL file ("TRIM_SRCH_CHAR_VAL.sql") is going to trim SRCH_CHAR_VAL columns of all the characteristics tables and will do this update operation in multiple chunks of key ranges. Only char types with pre-defined values as well as foreign key values with user defined keys will be updated in those char tables. Once sql-"FW4202_Trim_SRCH_CHAR_VAL.sql" is executed it cannot be re-executed.

Note: This is only needed during upgrades from FW versions below 420 SP2. It should NOT be run in an initial install environment.

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run FW4202_Trim_SRCH_CHAR_VAL.sql from the ..\FW42020\Install-Upgrade directory

@FW4202_Trim_SRCH_CHAR_VAL.sql

3.

Run the generated TRIM_SRCH_CHAR_VAL.sql script

@TRIM_SRCH_CHAR_VAL.sql

Enable USER_LOCK Package

For In-bound web services to work the USER_LOCK must be enabled at the database level. This is a one time step. If this is not already enabled please do so using the following steps.

1.

Login as SYS user

2.

On SQL prompt run:

@?/rdbms/admin/userlock.sql

3.

Grant permission by running following SQL:

grant execute on USER_LOCK to public;

Please note that grant can also be made to the database user which the Application connects to only instead of to public. For example, cisuser.

Generating Database Statistics

During an install process new database objects may be added to the target database. Before starting to use the database, generate the complete statistics for these new objects by using the DBMS_STATS package.

Upgrading from Version 2.3.1.8 to 2.4.0.2

To upgrade Oracle Utilities Customer Care and Billing version 2.3.1.8 to version 2.4.0.2, you must install the Oracle Utilities Application Framework version 4.2.0.2 prior to Oracle Utilities Customer Care and Billing 2.4.0.2. The files for the Oracle Utilities Application Framework 4.2.0.2 installation are located in the FW42020 folder.

Installing the Oracle Utilities Application Framework 4.2.0.2 Database Component

To install the schema for Oracle Utilities Application Framework 4.2.0.2, follow these steps:

1.

Run ORADBI.exe from the ..\FW\FW42020\Install-Upgrade directory. Please run the utility from the command prompt.

Note: Be sure to run ORADBI.exe from a Window 32-bit or 64-bit desktop that has the Oracle Database 11g Release 2 Client (11.2.0.1), 32-bit, and Java Development Kit Version 6.0 Update 20 or later installed. The database should already be listed in the local file tnsnames.ora

The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

Installing Prerequisite Database Single Fixes

Before installing Oracle Utilities Customer Care and Billing, you must install Oracle Utilities Framework Prerequisite DB Hot Fixes as described below.

1.

Apply prerequisite Framework DB single fixes by running the CDXPatch.exe utility from the ..\FW\FW42020\FW42020-HFix47 directory. The utility will prompt you for the value of the following parameters:

The utility prompts you for the value of the following parameters:

•

The target database type (O/M/D) [O]: O

•

The name of the user that owns the database objects: <CISADM>

•

The password for the user (in silent mode): <Password for CISADM user>

•

The name of the Oracle database: <DB Name>

CDXPatch.exe can be executed by selecting it from Windows explorer, or by using a command line from a DOS window. Use the option "-h" to see the help.

After the patches are processed, the utility may prompt you to create security for new objects.

When prompted as shown below, press Enter without any input, because security for new objects is generated in subsequent steps during installation of Oracle Utilities Customer Care and Billing.

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g.

•

CISUSER,CISREAD):

•

Enter a database role which has a read-write privilege (e.g. CIS_USER):

•

Enter a database role which has a read only privilege (e.g. CIS_READ):

Optional: Execute CCB2401_BpSchema2.SQL

This step is recommended to improve the performance of the upgrade process.

Before executing this script, please verify the script and make a note that these operations are long-running and the script specifies a default level of parallelism that can be tailored to the implementation's hardware. Also, note that CCB2401_BpSchema2.SQL can be executed well in advance of the upgrade to CCB 2.4.0.2 as these changes are compatible with Oracle Utilities Customer Care and Billing 2.2.0 and 2.3.1

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade.

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_BpSchema2.SQL

Optional: Execute CCB2401_BpSchema3.SQL

This step is recommended to improve the performance of the upgrade process.

Before executing this script, please verify the script and make a note that these operations are long-running and the script specifies a default level of parallelism that can be tailored to the implementation's hardware.

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade.

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_BpSchema3.SQL

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run CCB2402_Trim_SRCH_CHAR_VAL.sql from the .. \CCB\Upgrade\Oracle\Install-Upgrade directory.

@CCB2402_Trim_SRCH_CHAR_VAL.sql

This will generate a file called CCB_TRIM_SRCH_CHAR_VAL.sql

3.

Run the generated CCB_TRIM_SRCH_CHAR_VAL.sql script

@CCB_TRIM_SRCH_CHAR_VAL.sql

Installing the Oracle Utilities Customer Care and Billing Database Component

To install the database component of Oracle Utilities Customer Care and Billing, follow these steps.

1.

Run ORADBI.exe from the ..\CCB\Upgrade\Oracle\Install-Upgrade directory. The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues to upgrading the schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

ORADBI Performs the Following Tasks

•

Interacts with the user to collect information about the name of Oracle account that will own the application schema (for example, CISADM), password of this account, password of the SYSTEM account in the database, and the name of the Oracle account that the application user will use (for example, CISUSER), and the name of the Oracle account that will be assigned read-only privileges to the application schema (for example, CISREAD).

•

Verifies whether tablespace names already exist in the Storage.xml file (if not, the process will abort).

•

Installs the schema, installs the system data, and configures security. Maintains upgrade log tables in the database.

•

Updates release ID when the upgrade is completed successfully.

•

If an error occurs while executing a SQL script or another utility, it logs and displays the error message and allows you to re-execute the current step. Log files ORADBI###.log are created in the same folder as ORADBI and contains all the SQL commands executed against the database along with the results. The log files are incremental so that the results are never overwritten. If warning messages are generated during the upgrade, ORADBI prompts the user at the end of the process. Users should check the log files to verify the warning messages. Warning messages are only alerts and do not necessary mean a problem exists.

•

Stores the Schema owner and password in the feature configuration table. The password is stored in encrypted format.

Execute CCB2401_APDATA1.sql

Before executing this script, please verify the script and make a note that these SQLs can be run in chunks across multiple sqlplus sessions in parallel. The execution process below explains how to run the script at once.

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_APDATA1.sql

Execute CCB_231_2402.sql

The execution process below explains how to run the script at once.

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB_231_2402.sql

Consideration for Upgrade from Framework Versions Prior to Version 4.2.0 Service Pack 2

Customers upgrading from Framework versions prior to 4.2.0.2 need to run an upgrade script to trim the SRCH_CHAR_VAL column on the char tables. The search char value column is so far being populated with trailing spaces for Java-based objects for char types which are pre-defined values as well as foreign key values with user defined keys. This will result in empty results during "exact string" searches on SRCH_CHAR_VAL column. As a part of patch 16745968, this is fixed in the application but the existing data needs to be cleaned up.

The upgrade script "FW4202_Trim_SRCH_CHAR_VAL.sql" that is available in FW420 SP2 database blueprint upgrade folder can be used to perform this cleanup. This SQL should be executed by a schema owner and it will create a SQL file named "TRIM_SRCH_CHAR_VAL.sql". This SQL file ("TRIM_SRCH_CHAR_VAL.sql") is going to trim SRCH_CHAR_VAL columns of all the characteristics tables and will do this update operation in multiple chunks of key ranges. Only char types with pre-defined values as well as foreign key values with user defined keys will be updated in those char tables. Once sql-"FW4202_Trim_SRCH_CHAR_VAL.sql" is executed it cannot be re-executed.

Note: This is only needed during upgrades from FW versions below 420 SP2. It should NOT be run in an initial install environment.

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run FW4202_Trim_SRCH_CHAR_VAL.sql from the ..\FW42020\Install-Upgrade directory

@FW4202_Trim_SRCH_CHAR_VAL.sql

3.

Run the generated TRIM_SRCH_CHAR_VAL.sql script

@TRIM_SRCH_CHAR_VAL.sql

Enable USER_LOCK Package

For In-bound web services to work the USER_LOCK must be enabled at the database level. This is a one time step. If this is not already enabled please do so using the following steps.

1.

Login as SYS user

2.

On SQL prompt run:

@?/rdbms/admin/userlock.sql

3.

Grant permission by running the following SQL:

grant execute on USER_LOCK to public;

Please note that grant can also be made to the database user which the Application connects to only instead of to public. For example, cisuser.

Generating Database Statistics

During an install process new database objects may be added to the target database. Before starting to use the database, generate the complete statistics for these new objects by using the DBMS_STATS package.

Upgrading from Version 2.2.0.10 to 2.4.0.2

To upgrade Oracle Utilities Customer Care and Billing version 2.2.0.10 to version 2.4.0.2, you must install the Oracle Utilities Application Framework version 4.2.0.2 prior to Oracle Utilities Customer Care and Billing 2.4.0.2. The files for the Oracle Utilities Application Framework 4.2.0.2 installation are located in the FW42020 folder.

Optional: Execute CCB2401_BpSchema2.SQL

This step is recommended to improve the performance of the upgrade process.

Before executing this script, please verify the script and make a note that these operations are long-running and the script specifies a default level of parallelism that can be tailored to the implementation's hardware. Also, note that CCB2401_BpSchema2.SQL can be executed well in advance of the upgrade to CCB 2.4.0.2 as these changes are compatible with Oracle Utilities Customer Care and Billing 2.2.0 and 2.3.1

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade.

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_BpSchema2.SQL

Optional: Execute CCB2401_BpSchema3.SQL

This step is recommended to improve the performance of the upgrade process.

Before executing this script, please verify the script and make a note that these operations are long-running and the script specifies a default level of parallelism that can be tailored to the implementation's hardware.

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade.

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_BpSchema3.SQL

Installing the Oracle Utilities Application Framework 4.2.0.2 Database Component

To install the schema for Oracle Utilities Application Framework 4.2.0.2, follow these steps:

1.

Run ORADBI.exe from the ..\FW\FW42020\Install-Upgrade directory. Please run the utility from the command prompt.

Note: Be sure to run ORADBI.exe from a Window 32-bit or 64-bit desktop that has the Oracle Database 11g Release 2 Client (11.2.0.1), 32-bit, and Java Development Kit Version 6.0 Update 20 or later installed. The database should already be listed in the local file tnsnames.ora

The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

Installing Prerequisite Database Single Fixes

Before installing Oracle Utilities Customer Care and Billing, you must install Oracle Utilities Framework Prerequisite DB Hot Fixes as described below.

1.

Apply prerequisite Framework DB single fixes by running the CDXPatch.exe utility from the ..\FW\FW42020\FW42020-HFix47 directory. The utility will prompt you for the value of the following parameters:

The utility prompts you for the value of the following parameters:

•

The target database type (O/M/D) [O]: O

•

The name of the user that owns the database objects: <CISADM>

•

The password for the user (in silent mode): <Password for CISADM user>

•

The name of the Oracle database: <DB Name>

CDXPatch.exe can be executed by selecting it from Windows explorer, or by using a command line from a DOS window. Use the option "-h" to see the help.

After the patches are processed, the utility may prompt you to create security for new objects.

When prompted as shown below, press Enter without any input, because security for new objects is generated in subsequent steps during installation of Oracle Utilities Customer Care and Billing.

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g.

•

CISUSER,CISREAD):

•

Enter a database role which has a read-write privilege (e.g. CIS_USER):

•

Enter a database role which has a read only privilege (e.g. CIS_READ):

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run CCB2402_Trim_SRCH_CHAR_VAL.sql from the .. \CCB\Upgrade\Oracle\Install-Upgrade directory.

@CCB2402_Trim_SRCH_CHAR_VAL.sql

This will generate a file called CCB_TRIM_SRCH_CHAR_VAL.sql

3.

Run the generated CCB_TRIM_SRCH_CHAR_VAL.sql script

@CCB_TRIM_SRCH_CHAR_VAL.sql

Installing the Oracle Utilities Customer Care and Billing Database Component

To install the database component of Oracle Utilities Customer Care and Billing, follow these steps.

1.

Run ORADBI.exe from the ..\CCB\Upgrade\Oracle\Install-Upgrade directory. The utility prompts you to enter values for the following parameters:

•

Name of the target database: <DB NAME>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Location of Java Home: <..\jdk1.6.0_20>

•

Location of UGBU Jar files: <..\CCB\jarfiles>

•

Oracle user with read-write privileges to the Database Schema: <CISUSER>

•

Oracle user with read-only privileges to the Database Schema: <CISREAD>

•

Oracle database role with read-write privileges to the Database Schema: <CIS_USER>

•

Oracle database role with read-only privileges to the Database Schema: <CIS_READ>

•

Name of the owner of the Database Schema: <CISADM>

•

Password for the user (in silent mode)

•

Password for the user (in silent mode)

After setting up roles and users, the utility continues to upgrading the schema and system data definitions. If an error occurs while executing an SQL or another utility, it logs and displays the error message and allows you to re-execute the current step.

ORADBI Performs the Following Tasks

•

Interacts with the user to collect information about the name of Oracle account that will own the application schema (for example, CISADM), password of this account, password of the SYSTEM account in the database, and the name of the Oracle account that the application user will use (for example, CISUSER), and the name of the Oracle account that will be assigned read-only privileges to the application schema (for example, CISREAD).

•

Verifies whether tablespace names already exist in the Storage.xml file (if not, the process will abort).

•

Installs the schema, installs the system data, and configures security. Maintains upgrade log tables in the database.

•

Updates release ID when the upgrade is completed successfully.

•

If an error occurs while executing a SQL script or another utility, it logs and displays the error message and allows you to re-execute the current step. Log files ORADBI###.log are created in the same folder as ORADBI and contains all the SQL commands executed against the database along with the results. The log files are incremental so that the results are never overwritten. If warning messages are generated during the upgrade, ORADBI prompts the user at the end of the process. Users should check the log files to verify the warning messages. Warning messages are only alerts and do not necessary mean a problem exists.

•

Stores the Schema owner and password in the feature configuration table. The password is stored in encrypted format.

Execute CCB2401_APDATA1.sql

Before executing this script, please verify the script and make a note that these SQLs can be run in chunks across multiple sqlplus sessions in parallel. The execution process below explains how to run the script at once.

1.

Open a command prompt.

2.

Change directory to ..\CCB\Upgrade\Oracle\Install-Upgrade

3.

Connect to SQLPLUS.

4.

Execute the file as follows:

@CCB2401_APDATA1.sql

Consideration for Upgrade from Framework Versions Prior to Version 4.2.0 Service Pack 2

Customers upgrading from Framework versions prior to 4.2.0.2 need to run an upgrade script to trim the SRCH_CHAR_VAL column on the char tables. The search char value column is so far being populated with trailing spaces for Java-based objects for char types which are pre-defined values as well as foreign key values with user defined keys. This will result in empty results during "exact string" searches on SRCH_CHAR_VAL column. As a part of patch 16745968, this is fixed in the application but the existing data needs to be cleaned up.

The upgrade script "FW4202_Trim_SRCH_CHAR_VAL.sql" that is available in FW420 SP2 database blueprint upgrade folder can be used to perform this cleanup. This SQL should be executed by a schema owner and it will create a SQL file named "TRIM_SRCH_CHAR_VAL.sql". This SQL file ("TRIM_SRCH_CHAR_VAL.sql") is going to trim SRCH_CHAR_VAL columns of all the characteristics tables and will do this update operation in multiple chunks of key ranges. Only char types with pre-defined values as well as foreign key values with user defined keys will be updated in those char tables. Once sql-"FW4202_Trim_SRCH_CHAR_VAL.sql" is executed it cannot be re-executed.

Note: This is only needed during upgrades from FW versions below 420 SP2. It should NOT be run in an initial install environment.

Installing the upgrade script to trim the SRCH_CHAR_VAL column on the char tables

1.

Login as CISADM user.

2.

On SQL prompt, run FW4202_Trim_SRCH_CHAR_VAL.sql from the ..\FW42020\Install-Upgrade directory

@FW4202_Trim_SRCH_CHAR_VAL.sql

3.

Run the generated TRIM_SRCH_CHAR_VAL.sql script

@TRIM_SRCH_CHAR_VAL.sql

Enable USER_LOCK Package

For In-bound web services to work the USER_LOCK must be enabled at the database level. This is a one time step. If this is not already enabled please do so using the following steps.

1.

Login as SYS user

2.

On SQL prompt run:

@?/rdbms/admin/userlock.sql

3.

Grant permission by running the following SQL:

grant execute on USER_LOCK to public;

Please note that grant can also be made to the database user which the Application connects to only instead of to public. For example, cisuser.

Generating Database Statistics

During an install process new database objects may be added to the target database. Before starting to use the database, generate the complete statistics for these new objects by using the DBMS_STATS package.

Upgrading from Version 2.2.0 to 2.4.0.2

This section describes the steps for upgrading Oracle Utilities Customer Care and Billing version 2.2.0 to version 2.4.0.2. The files for this upgrade are located in the following directory: ..\CCB\Upgrade\Oracle\ Upgrade-From-v210-v220\ From-v220-Upgrade-to-v2402.

1.

Apply Framework version 2.2.0 and Customer Care and Billing 2.2.0 Service Packs from the \Step_1_Apply_v220_SP10 folder:

a.

Apply Framework version 2.2.0 Service Pack 1 by running CDXDBI.exe from the \01_FW22_SP1 folder.

b.

Apply Framework version 2.2.0 Service Pack 18 by running CDXPATCH.exe from the \02_FW_220_SP18 folder.

c.

Apply Framework version 220 service pack 18 Rollup by running the CDXPATCH.exe from the \03_FW_220_SP18_Rollup folder.

d.

Apply Customer Care and Billing 2.2.0 Service Pack 10 by running the CDXPATCH.exe from the \04_CCB_220_SP10 folder.

2.

Upgrade to Customer Care and Billing 2.4.0.2.0 by following the steps in the Section Upgrading from Version 2.2.0.10 to 2.4.0.2 .

Upgrading from Version 2.1.0 to 2.4.0.2

This section describes the steps for upgrading Oracle Utilities Customer Care and Billing version 2.1.0 to version 2.4.0.2. The files for this upgrade are located in the following directory:..\CCB\Upgrade\Oracle\ Upgrade-From-v210-v220\ From-v210-Upgrade-to-v2402.

1.

Apply the Framework 2.1.0 and Customer Care and Billing 2.1.0 current rollups from the\ Step_1_Apply_210_Current_Rollup folder::

a.

Apply the Framework version 2.1.0 current rollup by running CDXPATCH.exe from the \01_FW210SP7_plus_Rollup folder.

b.

Apply the Customer Care and Billing version 2.1.0 current rollup by running CDXPATCH.exe from the \02_CCB210SP7_plus_Rollup folder.

2.

Upgrade to Framework version 2.2.0 and Customer Care and Billing version 2.2.0 by running CDXDBI.exe from the \Step_2_Upgrade_to_v220\Upgrade-Install folder.

3.

Apply Framework version 2.2.0 and Customer Care and Billing 2.2.0 Service Packs from the \Step_3_Apply_v220_SP10 folder.

a.

Apply Framework version 2.2.0 Service Pack 1 by running CDXDBI.exe from the \01_FW22_SP1 folder.

b.

Apply Framework version 2.2.0 Service Pack 18 by running CDXPATCH.exe from the \02_FW_220_SP18 folder.

c.

Apply Framework version 220 service pack 18 Rollup by running the CDXPATCH.exe from the \03_FW_220_SP18_Rollup folder.

d.

Apply Customer Care and Billing 2.2.0 Service Pack 10 by running the CDXPATCH.exe from the \04_CCB_220_SP10 folder.

4.

Upgrade to Customer Care and Billing 2.4.0.2.0 by following the steps in the Section Upgrading from Version 2.2.0.10 to 2.4.0.2 .

Upgrading from Version 2.0.5 to 2.4.0.2

This section describes the steps for upgrading Oracle Utilities Customer Care and Billing version 2.0.5 to version 2.4.0.2. The files for this upgrade are located in the following directory: ..\CCB\Upgrade\Oracle\ Upgrade-From-v205\

1.

Upgrade to Customer Care and Billing 2.1.0 by running CDXDBI.exe from \Step_1_Upgrade_to_v210\Upgrade-Install folder.

2.

Apply the Framework 2.1.0 and Customer Care and Billing 2.1.0 current rollups from the\ Step_2_Apply_210_Current_Rollup folder:

a.

Apply the Framework version 2.1.0 current rollup by running CDXPATCH.exe from the \01_FW210SP7_plus_Rollup folder.

b.

Apply the Customer Care and Billing version 2.1.0 current rollup by running CDXPATCH.exe from the \02_CCB210SP7_plus_Rollup folder.

3.

Upgrade to Framework version 2.2.0 and Customer Care and Billing version 2.2.0 by running CDXDBI.exe from the \Step_3_Upgrade_to_v220\Upgrade-Install folder.

4.

Apply Framework version 2.2.0 and Customer Care and Billing 2.2.0 Service Packs from the \Step_4_Apply_v220_SP10 folder:

a.

Apply Framework version 2.2.0 Service Pack 1 by running CDXDBI.exe from the \01_FW22_SP1 folder.

b.

Apply Framework version 2.2.0 Service Pack 18 by running CDXPATCH.exe from the \02_FW_220_SP18 folder.

c.

Apply Framework version 220 service pack 18 Rollup by running the CDXPATCH.exe from the \03_FW_220_SP18_Rollup folder.

d.

Apply Customer Care and Billing 2.2.0 Service Pack 10 by running the CDXPATCH.exe from the \04_CCB_220_SP10 folder.

5.

Upgrade to Customer Care and Billing 2.4.0.2.0 by following the steps in the Section Upgrading from Version 2.2.0.10 to 2.4.0.2 .

Upgrading from Version 1.5.10 or 1.5.15 to 2.4.0.2

This section describes the steps for upgrading Oracle Utilities Customer Care and Billing version 1.5.10 or 1.5.15 to version 2.4.0.2. The files for this upgrade are located in the following directory:

..\CCB\Upgrade\Oracle\Upgrade-From-v1.5.10-v1.5.15\

1.

Upgrade to Customer Care and Billing 1.5.20 by executing the steps below from \Step_1_Upgrade_to_v1520\Upgrade-Install folder.

a.

Pre-Install Steps

The clean-up scripts for each task consist of a "select" SQL and a "delete" SQL script. The "select" SQL script when executed will display the data that will be deleted by the "delete" SQL script. All the clean-up scripts spool their results in output files that have same names as the scripts but with an ".out" extension.

To execute these scripts, users must log in as a database user with delete privileges on the CC&B schema using SQLPLUS.

1. Open a command prompt.

2. Change directory to ..\01_Pre-Install Folder.

3. Connect to SQLPLUS.

4. Execute the file as follows:

@ delete_mdfl.sql.sql

@ delete_tddrl.sql

@ delete_tdsrt.sql

@ delete_tde.sql

Users must "commit" the data cleanup transaction explicitly and roll it back if the script fails for some reason.

The following scripts are included in the \01_Pre-Install Folder:

•

select_mdfl.sql and delete_mdfl.sql

•

select_tddrl.sql and delete_tddrl.sql

•

select_tdsrt.sql and delete_tdsrt.sql

•

select_tde.sql and delete_tde.sql

After completion of this follow the Install steps below.

b.

Install Steps

Upgrade to Customer Care and Billing version 1.5.20 by running CDXDBI.exe from \02_Install Folder.

c.

Post-Install Steps

The following steps are included in the post-install process:

Sequence synchronization

In release 1.4.5, two new sequences CI_MRSTGUPID_SEQ, CI_NTUPID_SEQ were added to ID the primary key columns of CI_MR_STAGE_UP and CI_NT_UP tables. Because these tables existed in previous versions of CC&B, we must adjust the "last number" value of the new sequences to either an existing sequence that you have already been using for the same purpose or the maximum value of the primary key column of the table(s). If you have already set these sequences in Release 1.4.5 or later, skip this step and continue from the next step (if any).

Following are the steps involved in the adjust sequences process:

1. Execute the AdjustSequences.bat utility file under \03_Post-Install folder, by double-clicking it or running it from command line. The utility prompts you to enter values for following parameters:

Enter the username that owns the CC&B schema (e.g. CISADM):

Enter the password for the CC&B schema owner:

Enter the name of the Oracle Database:

2. The utility connects to the database and prompts you to continue the processing.

3. The utility checks for the two new sequences in the database and for each sequence, prompts you to enter the name of an existing sequence that you have already been using to ID the primary key column of its corresponding table. You can press Enter if you are not using any existing sequence (the utility sets its value to the maximum value of the primary key in that case).

If you choose to adjust a new sequence to an existing sequence, the utility sets the new sequence to the current "last number" value of the existing sequence, drops the existing sequence, and creates a synonym for the dropped sequence. This way the existing sequence is replaced with a CC&B sequence without breaking any existing code that may be referring to the existing sequence.

4. After sequences are adjusted, the utility reconfigures the security in the database and prompts you to enter the values for following parameters:

Enter the Oracle user that owns the schema (e.g. CISADM):

Enter the password for the CC&B schema:

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g. cisuser,cisread):

Enter the name of the Oracle Database:

This completes the adjust sequences process. The process generates a log file (AdjustSequences.log). You can review the log for the actions performed and any errors that may have occurred during the process.

2.

Apply Customer Care and Billing 1.5.20 Service Pack 1 by running CDXPATCH.exe from \Step_2_Apply_ServicePack_v15201 folder.

3.

Upgrade to Customer Care and Billing 2.0.5 by executing the following steps from \Step_3_Upgrade_to_v205\Upgrade-Install folder.

a.

Pre-Install: Run CDXDBI.exe from \01_Pre-Install Folder. During this process, Owner Flag information will be upgraded from CI to C1 or F1 on system data.

b.

Install: Run CDXDBI.exe from \02_Install Folder. This process will complete upgrade of rest of the system data to CC&B V2.0.5.

4.

Upgrade to Customer Care and Billing 2.1.0 by running CDXDBI.exe from \Step_4_Upgrade_to_v210\Upgrade-Install folder.

5.

Apply the Framework 2.1.0 and Customer Care and Billing 2.1.0 current rollups from the \ Step_5_Apply_210_Current_Rollup folder:

a.

Apply the Framework version 2.1.0 current rollup by running CDXPATCH.exe from the \01_FW210SP7_plus_Rollup folder.

b.

Apply the Customer Care and Billing version 2.1.0 current rollup by running CDXPATCH.exe from the \02_CCB210SP7_plus_Rollup folder.

6.

Upgrade to Framework version 2.2.0 and Customer Care and Billing version 2.2.0 by running CDXDBI.exe from the \Step_6_Upgrade_to_v220\Upgrade-Install folder.

7.

Apply Framework version 2.2.0 and Customer Care and Billing 2.2.0 Service Packs from the \Step_7_Apply_v220_SP10 folder:

a.

Apply Framework version 2.2.0 Service Pack 1 by running CDXDBI.exe from the \01_FW22_SP1 folder.

b.

Apply Framework version 2.2.0 Service Pack 18 by running CDXPATCH.exe from the \02_FW_220_SP18 folder.

c.

Apply Framework version 220 service pack 18 Rollup by running the CDXPATCH.exe from the \03_FW_220_SP18_Rollup folder.

d.

Apply Customer Care and Billing 2.2.0 Service Pack 10 by running the CDXPATCH.exe from the \04_CCB_220_SP10 folder.

8.

Upgrade to Customer Care and Billing 2.4.0.2.0 by following the steps in the Section Upgrading from Version 2.2.0.10 to 2.4.0.2 .

Demo Install

This section describes how to install the demo database components for Oracle Utilities Customer Care and Billing, including:

•

Copying and Decompressing Install Media

•

About the Demo Environments

•

Creating the Database and Importing Dump File

•

Configuring Security

Copying and Decompressing Install Media

To copy and decompress the Oracle Utilities Customer Care and Billing database:

1.

Download the Oracle Utilities Customer Care and Billing v2.4.0.2.0 Oracle database from the Oracle Software Delivery Cloud.

2.

Unzip the CCB-V2.4.0.2.0-Oracle-Database-MultiplatForm.zip file to your local machine. The database folder contains several files that will be referred to in the installation process.

About the Demo Environments

This release includes two demo environment setups:

•

Classic Demo: Also referred to as standalone demo. This environment consists of all demo data that was made available in previous Oracle Utilities Customer Care and Billing releases through Oracle Utilities Customer Care and Billing 2.3.1. This environment does not have any demo data scenarios configured for enhancements introduced in Oracle Utilities Customer Care and Billing 2.4.0 and later versions. Note the integration between Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management is not enabled. The audit algorithms used to create sync requests have been removed from the various maintenance objects. Even with the correct JMS queue configuration required for integration, billing service agreements that require bill determinants will fail.

•

New Demo: Also referred to as integrated demo. This environment contains all demo scenarios configured for enhancements introduced in Oracle Utilities Customer Care and Billing 2.4.0 and later versions. This environment is released with the integration between Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management enabled, i.e. sync request audit algorithms are plugged-in on the various maintenance objects. Note that without the correct JMS queue configuration required for integration, integration requests between your Oracle Utilities Customer Care and Billing and Oracle Utilities Meter Data Management demo environments will fail. The available demo data includes:

•

Program management demo data, rate schedules configured using the new rating engine, net-energy metered (NEM), prepaid accounts and latest Oracle Utilities Customer Self Service (OUCSS) demo data.

•

A large number of accounts that are billed using Meter Data Management bill determinants. Meters for these accounts are set up in Oracle Utilities Meter Data Management only and Oracle Utilities Meter Data Management is responsible for usage calculations.

•

A large percentage of the standalone demo scenarios from previous Oracle Utilities Customer Care and Billing releases. Please note that some standalone scenarios are not as yet available in new demo, for example, open-item accounting.

Creating the Database and Importing Dump File

Note: You must have Oracle Database Server 11.2.0.1+ or 12.1.0.1 installed on your machine in order to create the database.

You can use the database creation tool (cdxdba.plx for UNIX or CDXDBA.exe for Windows) to create the demo database with AL32UTF8 character set and to import the demo environment. You can import either the classic demo environment or the new demo environment. You cannot have both demo environments running at the same time. See About the Demo Environments for additional information about the two demo environments.

The UNIX and Windows database creation utilities create an empty database with AL32UTF8 character set and at least one tablespace for storing the application objects before running the installation. The default name of the application tablespace is CISTS_01.

•

Creating the Demo Database on Unix

•

Creating the Demo Database on Windows

Creating the Demo Database on Unix

The files for creating the database are located in ../CCB/DatabaseCreation/Unix directory.

Note: For Oracle 12c (12.1.0.1), use the files under CCB/DatabaseCreation/Unix_12c

Follow these steps to create a database:

1.

FTP the contents of the Database Creation folder to a temporary directory on the UNIX server.

2.

Set the ORACLE_HOME and ORACLE_BASE variables.

3.

Run the utility cdxdba.plx by executing the following command:

perl cdxdba.plx

4.

When prompted, provide the following parameter values:

•

Instance name (DEMO):

•

ORACLE_BASE: the directory where the setup files for the database will be created (/orasw/app/oracle):

•

ORACLE_HOME: the folder where the current version of Oracle software is installed (/orasw/app/oracle/product/):

•

ORACLE_DATA: the directory where the data files for the database will be created (/db05/oradata):

•

Character set for the database (AL32UTF8):

Enter the parameter values based on the settings of your database server. You can also accept the default values displayed if they match your database server settings. You will be prompted to confirm the settings and then to select Y or N to create the database.

ORACLE_SID: DEMO

ORACLE_HOME: /orasw/app/oracle/product/

ORACLE_BASE: /orasw/app/oracle

ORACLE_DATA: /db05/oradata

Character Set: AL32UTF8

Do you want to continue (Y/N)?

5.

When the database has been created, you will be prompted with the following questions:

Do you want to import a demo database dump into this database (Y/N)?

Select Y to import the Demo Install data.

For the demo installation use the dump file expdp_classic_demo.dmp for the Classic Demo environment, or expdp_new_demo.dmp for the New Demo environment. The following instructions use "expdp_new_demo.dmp" as an example.

Note: The data_pump_dir directory object must exist in the database created above before continuing with the import. You should also copy the expdp_new_demo.dmp file to the data_pump_dir. Decompress the expdp_new_demo.dmp.gz file first to extract the expdp_new_demo.dmp file. This file is in ..\CCB\Demo directory.

Do you want to import a demo database dump into this database (Y/N)? Y

Enter the name of the dump file (exp_new_demo.dmp):

Enter the name of the dump file directory (data_pump_dir):

Enter the name of the log file (exp_new_demo.log):

6.

Update the oratab file for the new database and then check the connectivity to this database from another server and from your desktop after updating local tnsnames.ora file.

Note: If your database has been created without using the CDXDBA script, then you can also import demo data by following the steps below:

1.

Create a tablespace named CISTS_01.

2.

Log in to the database as sys user and execute the CCB\DatabaseCreation\UNIX\11g\users.sql to create the product users.

3.

Create a database directory data_pump_dir and copy the dump file to this location.

4.

Set the correct ORACLE_SID and ORACLE_HOME.

5.

Run the following command to import demo dump:

impdp directory= data_pump_dir dumpfile= expdp_new_demo.dmp logfile= expdp_new_demo.log schemas=CISADM

Creating the Demo Database on Windows

The files for creating the database are located in the ..\CCB\DatabaseCreation\Windows directory.

You should be logged in as a user who is a member of the local ORA_DBA group on that server. The ORA_DBA group should have "administrator" privileges assigned to it.

Follow these steps to create the database:

1.

From a command prompt, run the utility CDXDBA.exe, located in the Windows folder.

The utility displays the following options:

E - Export a schema from the database

R - Refresh a schema with a database dump

C - Create/Recreate a local database

H - See help for the command line options

Q - Quit

2.

Select option C to create an empty database on your machine.

Provide the following values:

•

Provide the instance name (DEMO): <DB Name> For example, CCB_DB

•

Enter the character set of the database (AL32UTF8): AL32UTF8

•

Enter ORACLE_BASE: the directory where the setup files for the database will be created (c:\oracle): <Oracle_Base> For example, c:\app\oracle

•

Enter ORACLE_HOME: the folder where the current version of Oracle software is installed (c:\oracle\product\11.1.0.6\Db_1):< Oracle_Home> For example, c:\app\oracle\db_home

•

Enter ORACLE_DATA: the directory where the data files for the database will be created (c:\app\oracle\oradata): <Directory where data files will be created>

3.

Once the database has been created, select the R - Refresh a schema option with a database dump file to load the Demo Install data.

•

Select an option: R

•

Enter the instance name (DEMO): <DB name>

•

Is it a LOCAL database (exists on the same machine) (Y/N): <Please provide Y or N>

•

Enter the name of the Oracle account that owns that application schema (cisadm): CISADM

•

Enter password for CISADM (cisadm): CISADM

•

Enter the character set of the database (AL32UTF8): AL32UTF8

•

Enter the name of data pump directory (DATA_PUMP_DIR): DATA_PUMP_DIR

For the demo installation use the dump file expdp_classic_demo.dmp for the Classic Demo environment, or expdp_new_demo.dmp for the New Demo environment. The remaining instructions use "expdp_new_demo.dmp" as an example.

•

Enter the name of the dump file (exp_demo.dmp):expdp_new_demo.dmp

•

Enter the name of the log file (imp_demo.log):expdp_new_demo.log

For the DB user system, the password is manager. Option R causes the utility to drop all the objects from the schema and import the schema from a database dump file. For the Demo Installation, use the dump file exp_demo.dmp.

Note: The data_pump_dir directory object must exist in the database created above before continuing with the import. You should also copy the expdp_new_demo.dmp file to the data_pump_dir. Decompress the expdp_new_demo.dmp.gz file first to extract the expdp_new_demo.dmp file. This file is in ..\CCB\Demo directory.

Check the connectivity to this database from another server and from your desktop after updating local tnsnames.ora file

Note: If your database has been created without using the CDXDBA script, then you can also import demo data by following the steps below:

1.

Create a tablespace named CISTS_01.

2.

Log in to the database as sys user and execute the CCB\DatabaseCreation\Windows\11g\users.sql to create the product users.

3.

Create a database directory data_pump_dir and copy the dump file to this location.

4.

Set the correct ORACLE_SID and ORACLE_HOME.

5.

Run the following command to import demo dump:

impdp directory= data_pump_dir dumpfile= expdp_new_demo.dmp logfile=expdp_new_demo.logschemas=CISADM

Configuring Security

The configuration utility and scripts are located in the .\CCB\Security folder. To configure security, follow these steps:

1.

Execute the OraGenSec.exe utility.

Note: Database vault must be disabled before running.

The script will prompt you for parameter values:

•

Enter the application read-only user or Schema Owner in the database (e.g CISADM or CISREAD): CISADM

•

Enter the password for the user: CISADM

•

Enter the name of the Oracle Database: database name

•

Enter a comma-separated list of Oracle users in which synonyms need to be created (e.g. cisuser,cisread): cisuser,cisread

•

Select the following options: A

•

(A/a): Generate security for All objects in the Database (e.g. A or a for all objects)

•

(O/o): Generate security for specific Objects inputted in this terminal (e.g. CI_ACCT,CI_ACCT_K)

•

Generate security for specific objects generated from an input File (e.g. Security_Objects.txt)

The utility configures security for the application owner schema objects.

If you run Oragensec in Interactive Mode (without using the command line options), it will by default grant permissions to CIS_USER and CIS_READ Role. If you prefer to use site-specific roles then execute Oragensec after providing command line options.

For example:

(Oragensec.exe -d [Schema Owner],[Schema Owner's Password],[Database Name] -u [Read/Write User],[Read Only User] -r [Read Only Role],[Read Write Role] -a A -l [Logfile Name)

Database Design

This section provides a standard for database objects such as tables, columns, and indexes, for products using the Oracle Utilities Application Framework. This standard helps smooth integration and upgrade processes by ensuring clean database design, promoting communications, and reducing errors. Just as Oracle Utilities Application Framework goes through innovation in every release of the software, it is also inevitable that the product will take advantage of various database vendors’ new features in each release. The recommendations in the database installation section include only the ones that have been proved by vigorous QA processes, field tests and benchmarks. This section includes:

•

Database Object Standard

•

Column Data Type and Constraints

•

Standard Columns

Database Object Standard

This section discusses the rules applied to naming database objects and the attributes that are associated with these objects.

Categories of Data

A table can belong to one of the three categories:

•

Control (admin)

•

Master

•

Transaction

For purposes of physical table space design, metadata and control tables can belong to the same category.

Example of tables in each category:

•

Control: SC_USER, CI_ADJ_TYPE, F1_BUS_OBJ

•

Master: CI_PER, CI_PREM,

•

Transaction: F1_FACT, CI_FT

All tables have the category information in their index name. The second letter of the index carries this information. See for more information.

Naming Standards

The following naming standards must be applied to database objects.

Table

Table names are prefixed with the owner flag value of the product. For customer modification CM must prefix the table name. The length of the table names must be less than or equal to 30 characters. A language table should be named by suffixing _L to the main table. The key table name should be named by suffixing _K to the main table.

It is recommended to start a table name with the 2-3 letter acronym of the subsystem name that the table belongs to. For example, MD stands for metadata subsystem and all metadata table names start with CI_MD.

Some examples are:

•

CI_ADJ_TYPE

•

CI_ADJ_TYPE_L

A language table stores language sensitive columns such as a description of a code. The primary key of a language table consists of the primary key of the code table plus language code (LANGAGUE_CD).

A key table accompanies a table with a surrogate key column. A key value is stored with the environment id that the key value resides in the key table.

The tables prior to V2.0.0 are prefixed with CI_ or SC_.

Columns

The length of a column name must be less than or equal to 30 characters. The following conventions apply when you define special types of columns in the database.

•

Use the suffix FLG to define a lookup table field. Flag columns must be CHAR(4). Choose lookup field names carefully as these column names are defined in the lookup table (CI_LOOKUP_FLD) and must be prefixed by the product owner flag value.

•

Use the suffix CD to define user-defined codes. User-defined codes are primarily found as the key column of the admin tables.

•

Use the suffix ID to define system assigned key columns.

•

Use the suffix SW to define Boolean columns. The valid values of the switches are 'Y' or 'N'. The switch columns must be CHAR(1)

•

Use the suffix DT to define Date columns.

•

Use the suffix DTTM to define Date Time columns.

•

Use the suffix TM to define Time columns.

Some examples are:

•

ADJ_STATUS_FLG

•

CAN_RSN_CD

Indexes

Index names are composed of the following parts:

[OF][ application specific prefix][C/M/T]NNN[P/S]n

•

OF - Owner Flag. Prior to Version 4.1.0 of the framework the leading character of the base Owner Flag was used. From 4.1.0 on the first two characters of product’s owner flag value should be used. For client specific implementation of index, use CM for Owner Flag.

•

Application specific prefix could be C, F, T or another letter.

•

C/M/T - The second character can be either C or M or T. C is used for control tables (Admin tables). M is for the master tables. T is reserved for the transaction tables.

•

NNN - A three-digit number that uniquely identifies the table on which the index is defined.

•

P/S - P indicates that this index is the primary key index. S is used for indexes other than primary keys.

•

n is the index number, unique across all indexes on a given table (0 for primary and 1, 2, etc., for the secondary indexes).

Some examples are:

•

F1C066P0

•

F1C066S1

•

XT206C2

•

CMT206S2

Warning! Do not use index names in the application as the names can change due to unforeseeable reasons.

Updating Storage.xml

The storage.xml file that comes with the product allocates all base tables and indexes to the default tablespace CISTS_01. If you decide to allocate some tables or indexes outside of the default tablespace, then this has to be reflected in the storage.xml file by changing the tablespace name from the default value to a custom value, according to the format shown below:

Format:

<Table_Name>

<TABLESPACE>CISTS_01</TABLESPACE>

<PARALLEL>1</PARALLEL>

- <LOB>

- <Column Name>

<TABLESPACE>CISTS_01</TABLESPACE>

<SECUREFILE>Y</SECUREFILE>

<CHUNK>8192</CHUNK>

<CACHE>N</CACHE>

<LOGGING>Y</LOGGING>

<INROW>Y</INROW>

<COMPRESS>N</COMPRESS>

</Column Name>

</LOB>

</Table_Name>

Where Parallel defines the number of threads, that Oracle DB Server will use to access a table or create an index.

For instance, if a DBA decided to allocate table CI_ACCT in a tablespace MyTablespace, then they would have to change the storage.xml as follows:

<CI_ACCT>

<TABLESPACE> MyTablespace</TABLESPACE>

</CI_ACCT>

The oradbi process uses the storage.xml file to place the new database objects into defined tablespaces. A tablespace referenced in the storage.xml file must exist in the database.

The storage.xml file has to be adjusted before each upgrade and/or new installation as required to allocate the tables and indexes across those tablespaces.

Table name is included as a comment for each of the indexes for clarity.

For initial installs, information for each object should be reviewed by a DBA. For upgrades, only tablespace information for the objects added in the new release needs to be reviewed by a DBA.

Be careful while editing this file. Make sure that the tablespace names being used exist in the database. Do not change the basic format of this file.

Sequence

The base sequence name must be prefixed with the owner flag value of the product. For customer modification CM must prefix the sequence name. The sequence numbers should be named as below

1.

If the Sequence is used for a specific Table then use the following sequence name:

[OF][C/M/T]NNN_SEQ

•

OF stands for Owner Flag. For example, Framework its F1. Other examples are W1, W2 M1,C1,D1,D2, etc.

•

C/M/T stands for Control (Admin)/Master/Transaction Tables.

•

NNN is a three digit unique Identifier for a Table on which the Sequence is defined.

For Example: F1T220_SEQ

2.

If more than one Sequence is used for a specific Table then use the following Sequence Name:

[OF][C/M/T]NNN_Column_Name_SEQ

•

OF stands for Owner Flag. For example, the framework is F1. Other examples are W1, W2 M1,C1,D1,D2, etc.

•

C/M/T stands for Control (Admin)/Master/Transaction tables.

•

NNN is a three digit unique identifier for a table on which the sequence is defined.

For Example: F1T220_BO_STATUS_CD_SEQ and F1T220_BUS_OBJ_CD_SEQ

3.

If sequence is used for a generic requirement and not specific to a table, then use the following sequence name.

[OF]Column_Name_SEQ

•

OF stands for Owner Flag. For example, the framework is F1. Other examples are W1, W2 M1,C1,D1,D2, etc.

For Example: F1FKVALID_SEQ

•

For a customer modification, CM must prefix the sequence name.

Trigger

The base trigger name must be prefixed with the owner flag value of the product.

When implementers add database objects, such as tables, triggers and sequences, the name of the objects should be prefixed by CM.

Column Data Type and Constraints

This section discusses the rules applied to column data type and constraints, and the attributes that are associated with these objects.

User Defined Code

User Defined Codes are defined as CHAR type. The length can vary by the business requirements but a minimum of eight characters is recommended. You will find columns defined in less than eight characters but with internationalization in mind new columns should be defined as CHAR(10) or CHAR(12). Also note that when the code is referenced in the application the descriptions are shown to users in most cases.

System Assigned Identifier

System assigned random numbers are defined as CHAR type. The length of the column varies to meet the business requirements. Number type key columns are used when a sequential key assignment is allowed or number type is required to interface with external software. For example, Notification Upload Staging ID is a Number type because most EDI software uses a sequential key assignment mechanism. For sequential key assignment implementation, the DBMS sequence generator is used in conjunction with Number Type ID columns.

Date/Time/Timestamp

Date, Time and Timestamp columns are defined physically as DATE in Oracle. Non-null constraints are implemented only for the required columns.

Number

Numeric columns are implemented as NUMBER type in Oracle. The precision of the number should always be defined. The scale of the number might be defined. Non-null constraints are implemented for all number columns.

Fixed Length/Variable Length Character Columns

When a character column is a part of the primary key of a table define the column in CHAR type. For the non-key character columns, the length should be the defining factor. If the column length should be greater than 10, use VARCHAR2 type in Oracle.

Null Column Support

Oracle Utilities Application Framework 4.1.0 Group Fix 2 and later versions support Nullable columns. This means that the application can write NULLs instead of a blank space or zero (for numeric columns) by using NULLABLE_SW on CI_MD_TBL_FLD. If REQUIRED_SW is set to 'N' and the NULLABLE_SW is set to 'Y', the application will write a NULL in that column. The artifact generator will create hibernate mapping files with appropriate parameters so that the framework hibernate mapping types will know if a given property supports a null value.

NULLABLE_SW is not new, but has previously been used for certain fields such as dates, and some string and number foreign-key columns. Because of this, there is the possibility that there is incorrect metadata for some columns, and that turning on this new feature could result in incorrect behavior when using that metadata. The upgrade script added to FW410 Group Fix 2 fixes the metadata to make sure that the existing tables will not be affected.

This new feature only supports tables maintained by Java. Thus, enhancing any existing tables to use null columns must be done only after making sure that the tables are maintained by Java, and not COBOL.

XML Type Support

Oracle Utilities Application Framework v4.2.0.0 onwards supports XML Type. XML Type provides following advantages

1.

The ability to use XQuery for querying nodes in the XML document stored within a column defined as XMLType.

2.

The option to use the XML engine, which is built into the Oracle Database, to create indexes using nodes within the XML document stored in the XMLType column.

Cache and Key Validation Flags

By default, the Cache Flag is set to NONE. For most of the admin tables the CACHE Flag should be 'Cached for Batch'. This specifies that the table is cached as L2 cache to reduce database trips.

By default the Key Validation Flag is set to ALL. For tables which have the user defined keys, the KEY_VALIDATION_FLG should be set as 'ALL'. This checks the existence of the key before inserting a new one.

Table Classification and Table Volume Flags

There are multiple types of tables in the application, namely Admin system tables, Admin non-system tables, master tables and transaction tables. The Table Classification flag (TBL_CLASSIFICATION_FLG) sets the appropriate value for this lookup field to give a better view of the table classification.

Table Volume flag (TBL_VOLUME_FLG) is a customer modifiable field which is initially populated by product, but can be overridden by implementation. The field gives an idea of the relative data volume (categorized as highVolume, lowVolume and mediumVolume) of the table to make informed decisions.

Default Value Setting

The rules for setting the database default values are as follows:

•

When a predefined default value is not available, set the default value of Non-null CHAR or VARCHAR columns to blank except the primary key columns.

•

When a predefined default value is not available, set the default value Non-null Number columns to 0 (zero) except the primary key columns.

•

No database default values should be assigned to the Non Null Date, Time, and Timestamp columns.

Foreign Key Constraints

Referential integrity is enforced by the application. In the database do not define FK constraints. Indexes are created on most of Foreign Key columns to increase performance.

Standard Columns

This section discusses the rules applied to standard columns and the attributes that are associated with these objects.

Owner Flag

Owner Flag (OWNER_FLG) columns exist on the system tables that are shared by multiple products. Oracle Utilities Application Framework limits the data modification of the tables that have owner flag to the data owned by the product.

Version

The Version column is used to for optimistic concurrency control in the application code. Add the Version column to all tables that are maintained by a Row Maintenance program irrespective of the language used (COBOL or JAVA).

Database Implementation Guidelines

The following section outlines the general implementation guidelines for the database components, including:

•

Configuration Guidelines

Configuration Guidelines

This section includes general recommendations for configuring various database objects and includes a brief syntax overview. It covers the general aspects of the database objects and does not cover any specific implementation requirements. This section includes:

•

Index

•

Table Partitioning Recommendations

•

Transparent Data Encryption Recommendations

•

Data Compression Recommendations

•

Database Vault Recommendations

•

Oracle Fuzzy Search Support

•

Information Lifecycle Management (ILM) and Data Archiving Support

•

•

Storage Recommendations

•

Database Configuration Recommendations

•

Database Syntax

•

Database Initialization Parameters

Index

Index recommendations specify points that need to be considered when creating indexes on a table.

1.

Indexes on a table should be created according to the functional requirements of the table and not in order to perform SQL tuning.

2.

The foreign keys on a table should be indexes.

In an Oracle Utilities Application Framework environment, always make sure that the optimization parameters are set as follows:

optimizer_index_cost_adj=1

optimizer_index_caching=100

This will make sure that the optimizer gives a higher priority to index scans.

Note: If the implementation creates a CM index on table-columns for which the product already provides an index, then the CM index will be overridden by the base index.

Table Partitioning Recommendations

Oracle Utilities recommends using a minimum of 'n' partitions for selective database objects, where 'n' is number of RAC nodes.

Transparent Data Encryption Recommendations

Oracle Utilities supports Oracle Transparent Data Encryption (TDE). Oracle 11gR1 supports tablespace level encryption. The application supports tablespace level encryption for all Application data. Make sure that the hardware resources are sufficiently sized for this as TDE uses additional hardware resources. The Oracle Advanced Security license is a prerequisite for using TDE.

Please consider the following when implementing TDE:

•

Create a wallet folder to store the master key. By default, the wallet folder should be created under $ORACLE_BASE/admin/<sid>.

•

The wallet containing the master key can be created using the following command:

alter system set encryption key authenticated by "keypasswd"

•

The wallet can be closed or opened using the following commands:

alter system set wallet open identified by "keypasswd"; alter system set wallet close;

•

Column level encryption can be achieved using the following commands:

create table <table_name> (name varchar2(200) default ' ' not null,bo_data_area CLOB encrypt using 'AES128',bo_status_cd char(12) encrypt using 'AES128')lob (bo_data_area) store as securefile (cache compress) tablespace <tablespace_name>;

•

AES128 is the default encryption algorithm.

•

Tablespace level encryption is also supported using the following command:

Create tablespace <tablespace_name> logging datafile '<datafilelocation>' size <initial size> reuse autoextend on next <next size> maxsize unlimited extent management local uniform size <uniform size> encryption using 'AES128' default storage(encrypt) ;

•

Indexed columns can only be encrypted using the NO SALT Option. Salt is a way to strengthen the security of encrypted data. It is a random string added to the data before it is encrypted, causing repetition of text in the clear to appear different when encrypted.

Data Compression Recommendations

Oracle Utilities supports Advanced Data Compression, available with Oracle 11gR1 onwards, to reduce the database storage footprint. Make sure that your resources are sufficiently sized for this as it uses additional system resources. Compression can be enabled at the Tablespace level or at the Table level.

Exadata Hardware

For Exadata hardware the compression recommendations are:

•

For high volume tables, keep the current table partition uncompressed. All of the older partitions will be compressed based on QUERY HIGH compression.

•

For high volume tables with CLOBs ensure to always keep CLOBs in securefile and medium compressed. Also keep the current table partition uncompressed. All of the older partitions will be compressed based on QUERY HIGH compression.

•

Load data into the uncompressed table partitions using a conventional load and then, once data is loaded using a CTAS operation, load into a temporary heap table. Then truncate the original partition. Alter the original partition into HCC compressed and then partition exchange this with the temporary heap table.

•

All multi column Indexes (primary as well as secondary) will be compressed using the default compression. HCC or OLTP compression is not applicable on the top of compressed Indexes.

Non- Exadata Hardware

For non-Exadata hardware the recommendations are the same as above, except that you cannot use HCC compression (it is only available in Exadata database machine). Instead of HCC you can use any other compression tool available to you for non-Exadata hardware.

CLOB Fields

All CLOB fields should be stored as SecureFiles and Medium compressed. This requires a separate license for Advanced Data Compression. As a part of the schema, we create the product-owned tables with compression turned OFF at the LOB level. If you have the license for Advanced Data Compression, you can enable compression by updating the storage.xml.

Database Vault Recommendations

We support Database Vault from the Oracle Utilities Application Framework 4.1.0. All non-application User IDs can be prevented from using DDL or DML statements against the application schema. So SYS and SYSTEM cannot issue DDL or DML statements against CISADM schema.

The application-specific administration account can issue DDL statements but should not be able to perform any DML or DCL statements.

Application user must be given DML only permissions.

Database Vault can be used to control access during patch process and Install/Upgrade process. Configuration is also supported beginning with the Oracle Utilities Application Framework 4.1.0 patch application with Database Vault.

Oracle Fuzzy Search Support

Oracle Utilities Application Framework version 4.2.0.0.0 onwards supports Oracle Fuzzy searches. To use this feature, Oracle Text must be installed. After Oracle Text is installed, an index must be created on the table where the fuzzy search needs to be performed from the application. This is only an Oracle database option and is not supported by other databases. Additionally, not all languages are supported. Refer to the Oracle database documentation for more information about fuzzy searching.

A typical syntax for implementation of fuzzy searching is as below. For the most updated syntax please refer to Oracle Fuzzy documentation.

GRANT CTXAPP TO <Application schema owner e.g CISADM>;

GRANT EXECUTE ON CTX_DDL TO <Application schema owner e.g CISADM>;

create index <Application schema owner e.g CISADM>.<Index_Name> on Application schema owner e.g CISADM>.<Table_Name> (<column_name>) indextype is ctxsys.context parameters ('sync (on commit)');

begin

ctx_ddl.sync_index(‘Application schema owner e.g CISADM>.<Index_Name>’);

end

/

Information Lifecycle Management (ILM) and Data Archiving Support

Oracle Utilities Application Framework version 4.2.0 service pack 2 provides support for Data Archiving based on Information Lifecycle Management (ILM).

Information Lifecycle Management is a methodology designed to manage data over its lifecycle. The implementation of ILM involves Oracle Utilities Application Framework based processes for high volume transactional objects. These processes evaluate eligible historical records and mark them eligible/not-eligible for archiving. Records marked eligible for archiving can then be migrated to lower cost storage or archived without compromising referential integrity in the production database. These processes are highly customizable in order to cater to an implementation's particular requirements.

Detailed guidelines for setting up the configuration to support Information Lifecycle Management are outlined in the white paper "Information Lifecycle Management (ILM) and Data Archiving Solution for Oracle Utilities Customer Care and Billing" and can be downloaded from My Oracle Support (https://support.oracle.com). The whitepaper also includes best practices for the initial setup and ongoing maintenance of the information lifecycle management based solution.

Storage Recommendations

This section specifies recommended options for storing the database objects.

SecureFile for Storing LOBs

Beginning with Oracle 11g, tables having fields with data type of CLOB or BLOBS should have the LOB Columns stored as SecureFiles.

•

The storage options with SecureFiles for Heap Tables should be ENABLE STORAGE IN ROW, CACHE and COMPRESS.

•

For the IOT Table the PCTTHRESHOLD 50 OVERFLOW clause should be specified and the storage options with SecureFiles should be ENABLE STORAGE IN ROW, CACHE and COMPRESS.

•

The PCTTHRESHOLD should be specified as a percentage of the block size. This value defines the maximum size of the portion of the row that is stored in the Index block when an overflow segment is used.

•

The CHUNK option for storage, which is the data size used when accessing or modifying LOB values, can be set to higher than one database block size if big LOBs are used in the IO Operation.

•

For SecureFiles, make sure that the initialization parameter db_securefile is set to ALWAYS.

•

The Tablespace where you are creating the SecureFiles should be enabled with Automatic Segment Space Management (ASSM). In Oracle Database 11g, the default mode of Tablespace creation is ASSM so it may already be set for the Tablespace. If it's not, then you have to create the SecureFiles on a new ASSM Tablespace.

Note: To enable compression on SecureFiles, you must have an Oracle Advanced Compression license in addition to Oracle Database Enterprise Edition. This feature is not available for the standard edition of the Oracle database.

If you are using Oracle Database Enterprise Edition, please ensure that the "COMPRESS" flag is turned on by setting it to "Y" in Storage.xml.

See for more information on SecureFiles.

Database Configuration Recommendations

This section specifies the recommended methods for configuring the database with a focus on specific functional area.

Large Redo Log File Sizes

The Redo Log files are written by the Log Writer Background process. These Log files are written in a serial manner. Once a Log File is full, a Log Switch occurs and the next Log file starts getting populated.

It is recommended that the size of the Redo Log files should be sufficiently high so that you do not see frequent Log Switches in the Alert logs of the database. Frequent Log Switches impact the IO performance and can be avoided by having a larger Redo log File size.

Frequent Log Switches impacts the IO performance and can be avoided by having a bigger Redo log File Size.

Database Syntax

SecureFile

CREATE TABLE <Table_Name>

( COLUMN1 ….,

COLUMN2 (CLOB)

)

LOB(COLUMN2) STORE AS SECUREFILE (CACHE COMPRESS);

CREATE TABLE <Table_Name>

( COLUMN1 ….,

COLUMN2 (CLOB)

CONTRAINT <> PRIMARY KEY(…)

)

ORGANIZATION INDEX PCTTHRESHOLD 50 OVERFLOW

LOB(COLUMN2) STORE AS SECUREFILE (ENABLE STORAGE IN ROW CHUNK CACHE COMPRESS);

Database Initialization Parameters

The recommended Initialization Parameters are given below. These parameters are a starting point for database tuning. An optimal value for a production environment may differ from one customer deployment to another.

db_block_size=8192

log_checkpoint_interval=0

db_file_multiblock_read_count=8

transactions=3000

open_cursors=3000 0

db_writer_processes=10

optimizer_index_cost_adj=1

optimizer_index_caching=100

db_files=1024

dbwr_io_slaves=10 (Only if Asynchronous IO is not Supported)

sessions=4500

memory_target=0

memory_max_target=0

processes=3000

dml_locks=48600

_b_tree_bitmap_plans=FALSE

Conversion Tools

This section describes the following database conversion tools:

•

Database Configuration

•

Script Installation

•

Preparing the Production Database

•

Preparing the Staging Database

Note: All database related single fixes and service packs need to be applied against the production schema. Staging schema should not be updated with database single fixes or service packs. Staging schema need to be rebuilt for any fixes that contain DDL to create new database objects in production schema.

Database Configuration

The Conversion Tool Kit requires at least two sets of schema. One is to hold the staging data that the conversion tool gets the data from and performs validations. We call this schema the staging database. The target schema, which is referred to as the production database, is where the conversion tool inserts the validated data. Both the production database and the staging databases can reside in a single Oracle database or in different databases that are connected via a database link. Only the single database configuration is supported.

The following schematic diagram shows a sample configuration of both the production and staging environments in which the Conversion Tool Kit operates. The production and staging databases must be the same release level.

All the tables and views for the application are defined in the production database. The staging database has the same set of tables and views as the production database, except the tables that are grouped as part of the business configuration (control tables). Details on the differences of the tables of the two databases and of the conversion tool functionality are found in the Conversion Tool document.

Script Installation

The Conversion Setup Utility, ConvSetup.exe, is provided in this release of Oracle Utilities Customer Care and Billing to set up conversion schemas.

1.

Install the Oracle client V11g or later on Windows desktop and configure SQLNet to connect to the target database.

The Conversion folder contains the conversion setup utility: ConvSetup.exe and Conversion.bat.

This section of this document describes how to create the databases for the conversion tool kit.

Preparing the Production Database

If the production database does not exist create the database under the production schema owner (CISADM).

If the production database is upgraded from the previous version of the application make sure all public synonyms that are created on the application tables are deleted. Instead, each application user should have private synonyms created on the application tables in order for the conversion tool configuration to work.

Preparing the Staging Database

Once you have created a staging owner (STGADM), application user (STGUSER) and read access user (STGREAD), install the initial database option in the staging schema. The rest of the steps are listed below.

Run ConvSetup.exe from under the Conversion folder. The script prompts you for the following values:

•

Database Platform: Oracle (O)

•

Database connection information

•

Database Name

•

System Password

•

Production Schema Name

•

Staging Schema Name

•

Read-Write user for Staging Schema.

ConvSetup.exe performs following tasks:

•

Creates cx* views on the master/transaction tables in the production database.

•

Grants the privileges on the master/transaction tables in the production database to the staging owner.

•

Drops control tables and creates views on production control tables in the staging database.

•

Grants privileges on the control tables to the staging owner.

•

Grants privileges on the cx* views to the staging application user.

•

Creates generated key tables.

•

Creates generated table primary key and secondary indexes.

In addition to above tasks ConvSetup.exe also generates the following SQL scripts:

•

create_cxviews.sql

•

create_ctlviews.sql

•

createck_tbls.sql

•

create_grants.sql

•

createck_pkix.sql

•

createck_secix.sql

By default the conversion.bat updates all changes to the staging schema. If you want to generate only the above sql scripts and not apply changes to staging schema then update conversion.bat by removing "-u". The sql scripts can be applied to the staging schema later. The sqls scripts need to be executed in the same order as described above using SQL*PLus.

Once the staging schema has been set up, generate the security for the staging user using:

oragensec -d stgadm,schemapassword,database_name -r stg_read,stg_user -u stguser

Upgrades to the Oracle Utilities Customer Care and Billing 2.4.0 Service Pack 2 Database

This section describes the changes made to the database for Oracle Utilities Customer Care and Billing 2.4.0 Service Pack 2.

This section includes:

•

New Tables

•

New ILM Columns

•

Dropped Tables

•

New Indexes

New Tables

The following new tables are added to Oracle Utilities Customer Care and Billing V2.4.0.2:

Table Name

Description

F1_GNRL_AUDIT_K

General Audit Key

F1_GNRL_AUDIT_CHAR

General Audit Characteristic

F1_GNRL_AUDIT_VAL

General Audit Value

F1_GNRL_AUDIT

General Audit

C1_PREM_ACTIVITY_GTT

Premise Activity Overview Temp Table

New ILM Columns

Information Lifecycle Management columns (ILM_DT and ILM_ARCH_SW) are added to the following tables in Oracle Utilities Customer Care and Billing V2.4.0.2:

Table

Description

CI_ADJ

Adjustment

CI_APPR_REQ

Approval Request

CI_PAY_EVENT

Payment Event

CI_PAY

Payment

CI_MATCH_EVT

Match Event

CI_MR

Meter Read

CI_BILL_CHG

Billable Charge

C1_USAGE

Usage

CI_BILL

Bill

CI_BSEG

Bill Segment

CI_STM

Statement

CI_FA

Field Activity

CI_ENRL

Order

CI_CASE

Case

C1_OFFCYC_BGEN

Off Cycle Bill Generator

Dropped Tables

None

New Indexes

The following indexes are added in Oracle Utilities Customer Care and Billing V2.4.0.2:

Index_name

Table_name

Column_Name

C1T001P0

C1_PREM_ACTIVITY_GTT

CRE_DTTM

C1T001P0

C1_PREM_ACTIVITY_GTT

SCHED_DTTM

C1T001P0

C1_PREM_ACTIVITY_GTT

SEQNO

F1T901P0

F1_GNRL_AUDIT

AUDIT_ID

F1T901S1

F1_GNRL_AUDIT

USER_ID

F1T901S2

F1_GNRL_AUDIT

AUDIT_ID

F1T901S2

F1_GNRL_AUDIT

CRE_DTTM

F1T901S2

F1_GNRL_AUDIT

USER_ID

F1T902P0

F1_GNRL_AUDIT_VAL

AUDIT_ID

F1T902P0

F1_GNRL_AUDIT_VAL

FLD_NAME

F1T902S1

F1_GNRL_AUDIT_VAL

AUDIT_ID

F1T902S1

F1_GNRL_AUDIT_VAL

FLD_NAME

F1T902S1

F1_GNRL_AUDIT_VAL

FLD_VAL

F1T903P0

F1_GNRL_AUDIT_K

AUDIT_ID

F1T903P0

F1_GNRL_AUDIT_K

ENV_ID

Upgrades to the Oracle Utilities Customer Care and Billing 2.4.0 Service Pack 1 Database

This section describes the changes made to the database for Oracle Utilities Customer Care and Billing 2.4.0 Service Pack 1.

This section includes:

•

New Tables

•

Dropped Tables

•

New Indexes

•

Upgrading System Configuration

New Tables

The following new tables are added to Oracle Utilities Customer Care and Billing V2.4.0.1:

Table

Description

C1_REPRESENTATIVE

Sales Representative

C1_REP_GRP_MEM

Sales Representative Group Membership

C1_REPRESENTATIVE_L

Sales Representative Language

C1_REPRESENTATIVE_CHAR

Sales Representative Characteristic

C1_INITIATIVE_REL_OBJ

Initiative Related Object

C1_INITIATIVE_CRITERIA

Initiative Criteria

C1_INITIATIVE_CRITERIA_L

Initiative Criteria Language

C1_INITIATIVE_CRITERIA_CHAR

Initiative Criteria Characteristic

C1_REPRESENTATIVE_LOG

Sales Representative Log

C1_REPRESENTATIVE_LOG_PARM

Sales Representative Log Message Parameter

Dropped Tables

The following tables were dropped in Oracle Utilities Customer Care and Billing V2.4.0.1:

Table

Description

C1_INITIATIVE_LEAD_CRIT

Initiative Lead Eligibility Criteria

C1_INITIATIVE_LEAD_CRIT_L

Initiative Lead Eligibility Criteria Characteristic

C1_INITIATIVE_LEAD_CRIT_CHAR

Initiative Lead Eligibility Criteria Language

C1_INITIATIVE_PRTC_CRIT

Initiative Participation Criteria

C1_INITIATIVE_PRTC_CRIT_L

Initiative Participation Criteria Language

C1_INITIATIVE_PRTC_CRIT_CHAR

Initiative Participation Criteria Characteristic

New Indexes

The following indexes are added in Oracle Utilities Customer Care and Billing V2.4.0.1:

Index

Table

Column

C1M252S1

CI_TNDR_CTL_ST

TND_CTL_STG_ST_FLG

C1M252S1

CI_TNDR_CTL_ST

TNDR_CTL_ID

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

SEQ_NUM

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

CHAR_TYPE_CD

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

PAY_CHAR_ENT_FLG

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

EXT_REFERENCE_ID

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

EXT_TRANSMIT_ID

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

EXT_SOURCE_ID

CI_CXT169P0

CI_PAY_TNDR_ST_CHAR

EXT_BATCH_ID

XC381S1

CI_SCR

SCR_TYPE_FLG

XC381S1

CI_SCR

APP_SVC_ID

XC381S1

CI_SCR

SCR_CD

XM244S1

CI_NB_SA

SA_ID

XM244S1

CI_NB_SA

CVRD_SA_ID

XT199S1

CI_ENRL_PER_ID

HASH_PER_ID_NBR

XT199S1

CI_ENRL_PER_ID

ENRL_ID

XT199S1

CI_ENRL_PER_ID

ID_TYPE_CD

XT313P0

CI_BILL_CHAR

SEQ_NUM

XT313P0

CI_BILL_CHAR

CHAR_TYPE_CD

XT313P0

CI_BILL_CHAR

BILL_ID

XT313S1

CI_BILL_CHAR

SRCH_CHAR_VAL

XT368S4

C1_USAGE

SA_ID

Upgrading System Configuration

Update Calculation Rules Mapping

Run the upgrade batch process Update Calc Rules Mapping (C1-UPDBF) to set the correct value of Calc Rule elements by using the correct mapping. This process will trigger the Post-Processing Service Script on each of the Calculation Rule business objects that is responsible in populating the Bill Factor, Item Type, Calc Value Algorithm, and Step Value Algorithm elements. If the Calculation Rule is Service Quantity or Stepped SQ, it will issue an update using the Calculation Rule Cleanup - Override Proration business object to populate the Override Proration switch.

For additional information, see the detailed description for the Update Calc Rules Mapping batch process in the application.

Upgrades to the Oracle Utilities Customer Care and Billing 2.4.0 Database

This document describes the database upgrade process for the Oracle Utilities Customer Care and Billing V2.4.0. It highlights changes made to the administrative tables and how those changes should be applied to the data in order for your current database to work with the V2.4.0 application, and to preserve the business logic implemented in the previous version of the application. The changes that do not require data upgrade are not described in this section of the document. The tasks that need to be performed after running the upgrade scripts are included.

The added functionality of V2.4.0 is not the scope of this documentation. The upgrade scripts do not turn on the newly added functionality by default. For new functionality, refer the V2.4.0 User Guides. In the last section of this document you will find a list of the new tables that are added in V2.4.0.

This section includes:

•

Schema Changes

•

New System Data

Schema Changes

New Tables

The following new tables are added to Oracle Utilities Customer Care and Billing V2.4.0.

Tables

Description

C1_CALC_GRP

Calculation Group

C1_CALC_GRP_CHAR

Calculation Group Characteristics

C1_CALC_GRP_L

Calculation Group Language

C1_CALC_RULE

Calculation Rule

C1_CALC_RULE_CHAR

Calculation Rule Characteristics

C1_CALC_RULE_CRT

Calc Rule Eligibility Criteria

C1_CALC_RULE_CRT_CHAR

Calc Rule Elig Criteria Characteristics

C1_CALC_RULE_CRT_L

Calc Rule Elig Criteria Language

C1_CALC_RULE_L

Calculation Rule Language

C1_CALC_RULE_MBR_CAT

Calculation Rule Member Category

C1_CALC_RULE_TRGT_CAT

Calculation Rule Target Category

C1_CL_CAT_TYPE

Calc Line Category Type

C1_CL_CAT_TYPE_CHAR

Calc Line Category Type Characteristic

C1_CL_CAT_TYPE_L

Calc Line Category Type Language

C1_CL_CAT_VAL

Calc Line Category Value

C1_CL_CAT_VAL_L

Calc Line Category Value Language

C1_INITIATIVE

Initiative

C1_INITIATIVE_CHAR

Initiative Characteristic

C1_INITIATIVE_L

Initiative Language

C1_INITIATIVE_LEAD_CRIT

Initiative Lead Eligibility Criteria

C1_INITIATIVE_LEAD_CRIT_CHAR

Initiative Lead Eligibility Criteria Characteri

C1_INITIATIVE_LEAD_DEFN

Initiative Lead Definition

C1_INITIATIVE_LOG

Initiative Log

C1_INITIATIVE_LOG_PARM

Initiative Log Message Parameter

C1_INITIATIVE_PRTC_CRIT

Initiative Participation Criteria

C1_INITIATIVE_PRTC_CRIT_CHAR

Initiative Participation Criteria Characteristi

C1_INITIATIVE_PRTC_CRIT_L

Initiative Participation Criteria Language

C1_INTV_DATA_GTT

Interval Data Temporary Table

C1_LEAD

Lead

C1_LEAD_CHAR

Lead Characteristic

C1_LEAD_EVT

Lead Event

C1_LEAD_EVT_CHAR

Lead Event Characteristic

C1_LEAD_EVT_K

Lead Event Key

C1_LEAD_EVT_LOG

Lead Event Log

C1_LEAD_EVT_LOG_PARM

Lead Event Log Message Parameter

C1_LEAD_EVT_TYPE

Lead Event Type

C1_LEAD_EVT_TYPE_CHAR

Lead Event Type Characteristic

C1_LEAD_EVT_TYPE_L

Lead Event Type Language

C1_LEAD_K

Lead Key

C1_LEAD_LOG

Lead Log

C1_LEAD_LOG_PARM

Lead Log Message Parameter

C1_LEAD_REL_OBJ

Lead Related Object

C1_RC_CALC_GTT

Rate Check - Calc Header Temp Table

C1_RC_CALC_LN_GTT

Rate Check - Calc Line Temp Table

C1_RC_CHAR_GTT

Rate Check - Characteristics Temp Table

C1_RC_READ_GTT

Rate Check - Reads Temp Table

C1_RC_SQ_GTT

Rate Check - Service Quantity Temp Table

C1_RC_TRACE_GTT

Rate Check - Trace Temp Table

C1_RS_POST_PROC

Rate Post-Processing

C1_RS_POST_PROC_L

Rate Post-Processing Language

C1_RS_PRE_PROC

Rate Pre-Processing

C1_RS_PRE_PROC_L

Rate Pre-Processing Language

C1_RS_RV2

Rate Version 2

C1_RS_RV2_L

Rate Version 2 Language

C1_TOU_MAP

TOU Map

C1_TOU_MAP_CHAR

TOU Map Characteristics

C1_TOU_MAP_DATA

TOU Map Data

C1_TOU_MAP_DATA_CHAR

TOU Map Data Characteristics

C1_TOU_MAP_K

TOU Map Key

C1_TOU_MAP_L

TOU Map Language

C1_TOU_MAP_LOG

TOU Map Log

C1_TOU_MAP_LOG_PARM

TOU Map Log Parameters

C1_TOU_MAP_TMPLT

TOU Map Template

C1_TOU_MAP_TMPLT_CHAR

TOU Map Template Characteristics

C1_TOU_MAP_TMPLT_L

TOU Map Template Language

C1_TOU_MAP_TYPE

TOU Map Type

C1_TOU_MAP_TYPE_CHAR

TOU Map Type Characteristics

C1_TOU_MAP_TYPE_L

TOU Map Type Language

C1_TOU_MAP_TYPE_TMPLT

TOU Map Type TOU Map Templates

CI_PAY_TNDR_ST_CHAR

Payment Tender Staging Characteristics

New Views

None

Dropped Tables

None

Unsupported Tables

None

Added Columns

The following Table Columns are added to Oracle Utilities Customer Care and Billing V2.4.0.

Table

Column

Required

CI_ACCT_APAY

ENCR_EXT_ACCT_ID

N

CI_ACCT_CHAR

SRCH_CHAR_VAL

N

CI_ADJ

ADJ_DATA_AREA

N

CI_ADJ_CALC_LN

CALC_GRP_CD

N

CI_ADJ_CALC_LN

CALC_RULE_CD

N

CI_APAY_CLR_STG

ENCR_EXT_ACCT_ID

N

CI_BILL

BILL_SIGN

N

CI_BPRT_GRP

DESCRLONG

N

CI_BSEG

BSEG_DATA_AREA

N

CI_BSEG_CALC_LN

CALC_GRP_CD

N

CI_BSEG_CALC_LN

CALC_RULE_CD

N

CI_CASE_STATUS_L

DESCRLONG

N

CI_CASE_TYPE_L

DESCRLONG

N

CI_CC

DESCRLONG

N

CI_CC_CHAR

SRCH_CHAR_VAL

N

CI_COLL_CL_CNTL_L

DESCRLONG

N

CI_COLL_EVT_TYP_L

DESCRLONG

N

CI_CUT_EVT_TYPE_L

DESCRLONG

N

CI_ENRL_PER_ID

ENCR_PER_ID_NBR

N

CI_ENRL_PER_ID

HASH_PER_ID_NBR

N

CI_FA

DESCRLONG

N

CI_FA_STAGE_UP

DESCRLONG

N

CI_FA_TYPE

BUS_OBJ_CD

N

CI_FA_TYPE

EXT_SERV_REQ_FLG

N

CI_FO

DESCRLONG

N

CI_ITEM

DESCRLONG

Y

CI_ITEM_CHAR

SRCH_CHAR_VAL

N

CI_MATCH_EVT

DESCRLONG

N

CI_MTR

DESCRLONG

N

CI_MTR_CHAR

SRCH_CHAR_VAL

N

CI_OD_EVT_TYPE_L

DESCRLONG

N

CI_PAY_TNDR

ENCR_MICR_ID

N

CI_PAY_TNDR

HASH_MICR_ID

N

CI_PAY_TNDR_ST

ENCR_MICR_ID

N

CI_PAY_TNDR_ST

HASH_MICR_ID

N

CI_PER_CHAR

SRCH_CHAR_VAL

N

CI_PER_ID

ENCR_PER_ID_NBR

N

CI_PER_ID

HASH_PER_ID_NBR

N

CI_PEVT_DTL_ST

ENCR_EXT_ACCT_ID

N

CI_PEVT_DTL_ST

ENCR_MICR_ID

N

CI_PEVT_DTL_ST

HASH_MICR_ID

N

CI_PKG_CRT_GRP_L

DESCRLONG

N

CI_PKG_INSTR_L

DESCRLONG

Y

CI_PREM_CHAR

SRCH_CHAR_VAL

N

CI_RC_CRT_GRP_L

DESCRLONG

Y

CI_REG_RULE_L

DESCRLONG

Y

CI_RS

RS_VERSION_FLG

Y

CI_SA_TYPE

C1_PREPAID_METER_FLG

N

CI_SC_EVT

DESCRLONG

N

CI_SEV_EVT_TYPE_L

DESCRLONG

N

CI_SP

DESCRLONG

N

CI_SP_CHAR

SRCH_CHAR_VAL

N

CI_SP_TYPE

EXT_SERV_REQ_FLG

Y

CI_SQ_RULE_L

DESCRLONG

N

Dropped Columns

Table Name

Column Name

CI_FO

DESCR254

CI_FA

DESCR254

CI_CUT_EVT_TYPE_L

DESCR254

CI_ITEM

DESCR254

CI_CASE_TYPE_L

DESCR254

CI_COLL_CL_CNTL_L

DESCR254

CI_PKG_CRT_GRP_L

DESCR254

CI_COLL_EVT_TYP_L

DESCR254

CI_SP

DESCR254

CI_MATCH_EVT

DESCR254

CI_MTR

DESCR254

CI_PKG_INSTR_L

DESCR254

CI_REG_RULE_L

DESCR254

CI_FA_STAGE_UP

DESCR254

CI_RC_CRT_GRP_L

DESCR254

CI_CASE_STATUS_L

DESCR254

CI_SEV_EVT_TYPE_L

DESCR254

CI_BPRT_GRP

DESCR254

CI_BF

NO_PRO_REF_FLG

CI_OD_EVT_TYPE_L

DESCR254

CI_CC

DESCR254

CI_SQ_RULE_L

DESCR254

C0_INSTALLATION

ALLOW_CR_NOTE_SW

CI_SCR_FLD_MAP

SCR_STEP_ID

Unsupported Table Columns

None

Column Format Change

Table Name

Column Name

From

To

C1_ISS_CTR_DTL

EXT_REFERENCE_ID

CHAR:30

CHAR:36

C1_USAGE

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_ACCT_PER

NBR_BILL_COPIES

NUMBER:22:1

NUMBER:22:2

CI_ADJ_APREQ

CITY

VARCHAR2:30

VARCHAR2:90

CI_ADJ_APREQ

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_ADJ_APREQ

PYMNT_ID

CHAR:10

CHAR:36

CI_BCHG_UP_XTYP_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_BILL_ROUTING

CITY

VARCHAR2:30

VARCHAR2:90

CI_BILL_ROUTING

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_BILL_ROUTING

NBR_BILL_COPIES

NUMBER:22:1

NUMBER:22:2

CI_ENRL_ADDR

CITY

VARCHAR2:30

VARCHAR2:90

CI_ENRL_ADDR

CITY_UPR

VARCHAR2:30

VARCHAR2:90

CI_ENRL_ADDR

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_FT_GL

STATISTIC_AMOUNT

NUMBER:22:15

NUMBER:22:19

CI_MR_CYC

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_CYC_L

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_RTE

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_RTEGEN_VW

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_RTEGEN_VW

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_RTE_CHAR

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_RTE_CHAR

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_RTE_L

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_RTE_L

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_SCHED

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_SCHED_RTE

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_SCHED_RTE

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_STAGE_DWN

MR_CYC_CD

CHAR:4

CHAR:16

CI_MR_STAGE_DWN

MR_RTE_CD

CHAR:8

CHAR:16

CI_MR_STGUP2_VW

MR_STAGE_UP_ID_CH

VARCHAR2:36

VARCHAR2:48

CI_MR_ST_EXC_VW

MR_STAGE_UP_ID_CH

VARCHAR2:36

VARCHAR2:48

CI_NT_DWN_PROF_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_DWN_TYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_UP_XTYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_XID_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_PAY_ST

CUST_ID

CHAR:15

CHAR:36

CI_PAY_ST

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_PAY_TNDR

CUST_ID

CHAR:15

CHAR:36

CI_PAY_TNDR

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_PAY_TNDR_ST

CUST_ID

CHAR:15

CHAR:36

CI_PAY_TNDR_ST

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_PER

CITY

VARCHAR2:30

VARCHAR2:90

CI_PER

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_PER_ADDR_OVRD

CITY

VARCHAR2:30

VARCHAR2:90

CI_PER_ADDR_OVRD

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_PER_ADDR_SEAS

CITY

VARCHAR2:30

VARCHAR2:90

CI_PER_ADDR_SEAS

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_PEVT_DTL_ST

CUST_ID

CHAR:15

CHAR:36

CI_PEVT_DTL_ST

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_POST_DFLT

CITY

VARCHAR2:30

VARCHAR2:90

CI_POST_DFLT

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_PREM

CITY

VARCHAR2:30

VARCHAR2:90

CI_PREM

CITY_UPR

VARCHAR2:30

VARCHAR2:90

CI_PREM

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_PRM_ALT_ADDR

CITY

VARCHAR2:30

VARCHAR2:90

CI_PRM_ALT_ADDR

CITY_UPR

VARCHAR2:30

VARCHAR2:90

CI_PRM_ALT_ADDR

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_QUOTE_RTG

CITY

VARCHAR2:30

VARCHAR2:90

CI_QUOTE_RTG

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_ROOT_OBJ_PK

FIELD_VAL

VARCHAR2:50

VARCHAR2:254

CI_SA

OLD_ACCT_ID

VARCHAR2:15

VARCHAR2:36

CI_SA_REL

MR_CYC_CD

CHAR:4

CHAR:16

CI_SED_ACCT_HST_VW

ACTIVITY_ID2

VARCHAR2:30

VARCHAR2:40

CI_SE_ACCT_HST_VW

ACTIVITY_ID2

VARCHAR2:30

VARCHAR2:40

CI_SP

MR_CYC_CD

CHAR:4

CHAR:16

CI_SP

MR_RTE_CD

CHAR:8

CHAR:16

CI_SPR_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_SS_ADDR_OVRD

CITY

VARCHAR2:30

VARCHAR2:90

CI_SS_ADDR_OVRD

COUNTY

VARCHAR2:30

VARCHAR2:90

CI_STM_CNST

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_TNDR_ST_EXCP

EXT_REFERENCE_ID

CHAR:30

CHAR:36

CI_WF_EVT_TYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_WO_RESP

DAYS_AFT_PROC_CRE

NUMBER:22:3

NUMBER:22:4

New System Data

This section lists the new system data that are added for business process configuration.

Algorithm Type

The following algorithm types are new to V2.4.0.

Algorithm Type

Description

C1-ACALR-RFG

Execute Calculation Group

C1-ADDLFAINF

Capture Additional FA Information

C1-ADJT-CL

Payoff=Current=Adj Amt (Calc Line Dist Code Source)

C1-APPLYTO

Apply To

C1-BILLSIG

Generate Digital Bill Signature

C1-BLEX-XML

Create XML bill print extract records

C1-C0-GL

Payoff Amt = Bill Amt / Current Amt = 0 (GL affected)

C1-C0-NOGL

Payoff Amt = Bill Amt / Current Amt = 0 (no GL)

C1-CALC-SQ

Calculate Service Quantity

C1-CALCBLDYS

Calculate days in billing period

C1-CALCFNVL

Calculate Final Reading Value

C1-CALCPBBBS

Generate PPB Bill Segment

C1-CALCRLVAL

Calculation Rule Sequence Validation

C1-CAPFASSF

Capture FA Final Snapshot

C1-CAPFASSI

Capture FA-Based Initial Snapshot

C1-CHKBSSTAT

Check PPB Bill Segment Status

C1-CHKFRZBS

Check for Freezable Bill Segments

C1-CHKPPBSA

Check PPB SA Status For Transition

C1-CK-TUMCN

Check True Up Monitor Eligibility For Cancellation

C1-CLRRETRYI

Clear Retry Information

C1-CNC-TUM

Cancel Active True Up Monitors

C1-CREATECC

Create Customer Contact

C1-CREATEPPB

Create Prepay Biller

C1-CREPPBBM

Create Prepay Biller Bill Message

C1-CRETMD-CT

Create TOU Map Data

C1-CURUBSKSA

Cancel Usage Request and Update BS Exception for Skipped SA

C1-DEL-TOUMD

Delete TOU Map Data

C1-DERTOU-DT

Derive Time Of Use For Date Time

C1-DETBSCALC

Determine Bill Segment Calculation Schedule

C1-DETPPBBAL

Determine Prepay Balances

C1-DETTOPUP

Determine If Top Up Needed

C1-DISPPBAP

Disable Prepaid Biller Automatic Payment

C1-ECF-APCRT

Evaluate Criteria Field - Apply Eligibility Criteria

C1-FA-PDTSY

Check If Related Non-Final Syncs Exist for the FA

C1-FASYNCELG

Check FA Sync Eligibility

C1-FLAT-CHRG

Flat Charge

C1-GEN-TMD

Generate TOU Map Data

C1-GETGEOLL

Retrieve Latitude/Longitude Geographic Value

C1-HIGHBILL

Check High Bill Amount

C1-ITEMTYPE

Item Type

C1-MATH

Math Rule

C1-MAXIMUM

Maximum Charge

C1-MINIMUM

Minimum Charge

C1-MISSEDAPP

Process Missed Appointment Notification

C1-MS-SQ

Multiply Step by SQ

C1-NEM-TRUUP

NEM True Up - Create Adjustments

C1-NOPROR

No Proration

C1-NTFYAPPT

Process Appointment Notification

C1-OVPY-PPSA

Keep Overpayment on a Prepaid SA

C1-PEVT-INFO

Payment Event Information

C1-PPBADJFRZ

Set Prepaid Funds Request FT Details

C1-PPBINFO

Prepay Biller Information

C1-PPBTYPVAL

Prepay Biller Type Validation

C1-PPBVALID

Prepay Biller Validation

C1-PROCSPFWO

Process SP Fieldwork Orchestration

C1-REACTVPPB

Reactivate PPB

C1-RS-DTMBO

Determine Rate Schedule BO

C1-RSINFO

Rate Schedule Information

C1-RT-CNFZAD

Reverse True Up - Cancel Frozen Adjustments

C1-RV-TRUP

Transition TUM to Reverse True Up

C1-SAT-SARL

Create SA Relationship and Sub SA For Master SA

C1-SAT-TUM

Create True Up Monitor For Sub SA

C1-SIMP-SUMM

Simple Summary

C1-SQ

Service Quantity

C1-SRTSKINFO

Service Request Task Information

C1-STPD-SQ

Stepped Service Quantity

C1-STSK-MINF

Service Task Information

C1-STSKALSAC

Service Task Alert By SA Characteristic

C1-SUMMARY

Summary

C1-SYNREQPRE

Sync Request - Pre-Processing Algorithm Type

C1-TOUMAP-VL

TOU Map Validation

C1-TOUMPD-VL

TOU Map Data Validation

C1-TOUMTP-VL

TOU Map Template Validation

C1-TOUMTS-VL

TOU Map Template Schedule Validation

C1-TOUMTY-VL

TOU Map Type Validation

C1-TR-SUBUSG

Transition Awaiting Sync Sub-SA Usage Requests

C1-TRANRELSY

Transition Related Sync Requests

C1-TRANSFASA

Transition Related FA From SA Sync

C1-TRANSFASP

Transition Related FA From SP Sync

C1-TRN-TUM

Transition True Up Monitor

C1-TRNRELPPB

Transition Related PPB

C1-TRU-ELIG

Check Eligibility For True Up

C1-TUM-SARL

Create Sub SA and SA Relationship For Next True Up Period

C1-VAL-FC

Validate Flat Charge Rule

C1-VAL-MATH

Validate Math Rule

C1-VAL-SQ

Validate Service Quantity Rule

C1-VAL-SSUM

Validate Simple Summary Rule

C1-VAL-STPSQ

Validate Stepped SQ Rule

C1-VAL-SUMM

Validate Summary Rule

C1-VALCALCRT

Validate Calc Rule Eligibility Criteria

C1-VALCALCSQ

Validate Calculate Service Quantity Rule

C1-VALCALFNL

Validate Final Reading Value Rule

C1-VCRITMTYP

Validate Item Type Rule

C1-VCRMNMX

Validate Maximum/Minimum Charge Rule

C1-VLCRAPLTO

Validate Apply To Rule

Algorithm

The following Algorithms are new to V2.4.0.

Algorithm

Description

C1-ACALR-RFG

Execute Calculation Group

C1-ADDLFAINF

Capture Additional FA Information

C1-ADHV-REQ

Validates that something (anything) is entered

C1-ADJT-CL

Payoff=Current=Adj Amt (Calc Line Dist Code Source)

C1-AGREF-EQU

Return collection agency with the least debt

C1-APPLYTO

Apply To

C1-AVAL-NOEX

Maximum number of appointments can't be exceeded

C1-BCMP-NBB

NBB Credit Transfer

C1-BILLSIG

Generate Digital Bill Signature

C1-BLEX-EX

Create bill extract records for Documaker

C1-BSBF-B0

NO PAYOFF! Payoff = 0 / Curr Amt = Bill Amt - no GL

C1-BSBF-BA

Payoff Amt = Bill Amt / Current Amt = Amt Due

C1-BSBF-CU

COMPANY USAGE! Payoff = Curr = 0 (GL affected)

C1-BSBF-LO

Payoff Amt = Interest / Current Amt = Principal

C1-BSBS-LO

Create a bill segment for a loan SA

C1-BSBS-RA

Bill recurring charge amount until payoff bal = 0

C1-BSBS-RB

Bill recur charge 'til amt to bill has been billed

C1-BSBS-RR

Create bill segment using recurring charge amount

C1-BSBS-RT

Create bill segment using rate application

C1-BSGC-MS

Get Consumption From Master Bill Segment

C1-C0-GL

Current Amt = 0 / Payoff Amt = Bill Amt (GL affected)

C1-C0-NOGL

Current Amt = 0 / Payoff Amt = Bill Amt (no GL)

C1-CALC-SQ

Calculate Service Quantity

C1-CALCBLDYS

Calculate days in billing period

C1-CALCFNVL

Calculate Final Reading Value

C1-CALCPBBBS

Generate PPB Bill Segment

C1-CALCRLVAL

Calculation Rule Sequence Validation

C1-CAPFASSF

Capture FA Final Snapshot

C1-CAPFASSI

Capture FA-Based Initial Snapshot

C1-CBSPSA-RA

Apply the rate to each billing scenario

C1-CCAL-CASE

Highlight open cases

C1-CCWO-DST

Write off SA by distribution code

C1-CHKBSSTAT

Check PPB Bill Segment Status

C1-CHKPPBSA

Check PPB SA Status For Transition

C1-CK-TUMCN

Check True Up Monitor Eligibility For Cancellation

C1-CLRRETRYI

Clear Retry Information

C1-COECA-STD

Cancel Contract Option Event Validate Overlap

C1-COEFR-STD

Freeze Contract Option Event Validate Overlap

C1-COEPD-STD

Pending Contract Option Event Validate Overlap

C1-COLC-BUDG

Check if account is on a budget

C1-COLC-CRRT

Check if credit score < installation CR threshold

C1-COLC-CSEV

Check if sev process exists for a SA in debt class

C1-COLC-DFLT

Always return true (the lowest priority condition)

C1-COLC-WBFT

Check if "we bill for them" SPr's are used

C1-CPIN-CAN

Collection Process Cancellation Threshold Info

C1-CR-NBRVAL

Credit Card Number Validation

C1-CREATECC

Create Customer Contact

C1-CRETMD-CT

Create TOU Map Data

C1-CRP-SATOS

Link service agreements to terms of service

C1-CRPS-BA

Update account's bill after date

C1-CRRT-BA

Retrieve account's bill after date

C1-CRV-SATOS

Validate Terms of Service ID

C1-CRVL-BA

Validate account's bill after date

C1-CSIN-DFLT

Case Information

C1-CT-INFO

Case Information

C1-CURUBSKSA

Cancel Usage Request and Update BS Exception for Skipped SA

C1-DEL-TOUMD

Delete TOU Map Data

C1-DEP-ARSDT

Deposit SA FT Arrears Date Setup

C1-DEPBAD

Customer is always considered 'bad'

C1-DEPGOOD

Customer is good if credit rating >= install threshold

C1-DEPNORFND

Do not automatically refund

C1-DERTOU-DT

Derive Time Of Use For Date Time

C1-DETBSCALC

Determine Bill Segment Calculation Schedule

C1-DETTOPUP

Determine If Top Up Needed

C1-DGRP-DFLT

Get default dispatch group from field service control

C1-DISPPBAP

Disable Prepaid Biller Automatic Payment

C1-DSOV-SAID

Distribute payment to SA ID in match value

C1-DVTRNMRIC

Determine if device test's component result is numeric

C1-ECF-APCRT

Evaluate Criteria Field - Apply Eligibility Criteria

C1-FA-PDTSY

Check If Related Non-Final Syncs Exist for the FA

C1-FAAD-INFO

Display phone number information from field order

C1-FAAUD

Field Activity Rescheduling - Audit

C1-FAIN-INFO

Field Activity Information

C1-FASYNCELG

Check FA Sync Eligibility

C1-FLAT-CHRG

Flat Charge

C1-FO-DISP

Create PDF of field order image using Documaker

C1-FOAUD

Field Order Rescheduling - Audit

C1-FOEX-OX

Create FO extract records for Documaker

C1-FTGL-ADNM

Process Holding Account Amounts

C1-FTGL-PSAC

Deferred Accrual Payment = Current = Payment Amt

C1-GEN-TMD

Generate TOU Map Data

C1-GEOTYTRSQ

Town/Range/Section/Quarter Format - 99A 99A 99 9

C1-GETGEOLL

Retrieve Latitude/Longitude Geographic Value

C1-GLBL-CTXT

Global Context

C1-GLCNSTR-D

Get the GL account from the distribution code

C1-HIGHBILL

Check High Bill Amount

C1-HILO-FCTR

Derive High Low Limits Using High Low Factor Table

C1-ITEMTYPE

Item Type

C1-ITMI-DFLT

Item information

C1-LINT-SI

Calculate Simple Interest for a Loan SA

C1-LPDA-SI

Calculate Number of Periods or Payment Amount

C1-LSCH-SI

Determine Loan Schedule Using Simple Interest

C1-LT-DISP

Create PDF of letter image using Documaker

C1-LTEX-COL

Create collection event letter extract records

C1-LTEX-GEN

Create generic letter extract records

C1-LTEX-SEV

Create severance event letter extract records

C1-LTEX-WF

Create workflow event letter extract records

C1-LTEX-WO

Create write-off event letter extract records

C1-MATH

Math Rule

C1-MAXIMUM

Maximum Charge

C1-MINIMUM

Minimum Charge

C1-MISSEDAPP

Process Missed Appointment Notification

C1-MTRI-DFLT

Meter Information

C1-NEM-TRUUP

NEM True Up - Create Adjustments

C1-NOPROR

No Proration

C1-NSFC-DFLT

Levy an adjustment against highest priority SA

C1-NTFYAPPT

Process Appointment Notification

C1-ONFD-CR

Create field order image using BI Publisher

C1-ONLN-CR

Create bill image using BI Publisher

C1-ONLTR-RPT

Display a letter using BI Publisher

C1-OPN-MEVT

Highlight Open and Disputed Match Events

C1-OVRPYPRTY

Keep overpayment on highest priority SA

C1-PKCC-DFLT

Always true

C1-PPBADJFRZ

Set Prepaid Funds Request FT Details

C1-PPBALERT

Prepay Biller Task Alert

C1-PPBINFO

Prepay Biller Information

C1-PPBTDCREA

Prepay Biller To Do Entry Creation

C1-PPBTYPVAL

Prepay Biller Type Validation

C1-PPBVALID

Prepay Biller Validation

C1-PPOVRDARS

Override arrears using pay plan's sched. payments

C1-PROCSPFWO

Process SP Fieldwork Orchestration

C1-PSEG-AC

CASH ACCTING! Payoff Amt = Current Amt = Pay Amt

C1-PSEG-CA

Payoff Amt = 0 / Cur Amt = Pay Amt / GL AFFECTED

C1-PSEG-NM

Payoff Amt = Current Amt = Pay Amt

C1-PY-INFO

Payment Information

C1-PYDST-DLP

Pay deliquent high priority debt first - PRORATED

C1-PYDST-PPR

Distribute Based On SA Type Priority/Debt Age

C1-QTEX-EX

Create quote extract records for Documaker

C1-RCE-APAY

Return true if on autopay

C1-REACTVPPB

Reactivate PPB

C1-RESPUSER

Require responsible user

C1-RS-DTMBO

Determine Rate Schedule BO

C1-RSINFO

Rate Schedule Information

C1-RT-CNFZAD

Reverse True Up - Cancel Frozen Adjustments

C1-RV-TRUP

Transition TUM to Reverse True Up

C1-SACR-AT

Activate service agreement

C1-SAIS-ST

Automatically stop service agreement

C1-SCEC-VBAL

Service credit balance may not go below zero

C1-SCEN-VB

Service credit balance should not go below zero

C1-SETL-ADJ

FT GL Creation for Settlement Adjustments

C1-SFAC-DFLT

Cancel severance process field activities

C1-SIMP-SUMM

Simple Summary

C1-SKIPINACC

Skip Inactive Accounts

C1-SPIN-DF

SP information - SP Type, Read Cycle, Premise Info

C1-SQ

Service Quantity

C1-SRTSKINFO

Service Request Task Information

C1-SRTSKTODO

Create Service Request Task To Do Entry

C1-ST-DISP

Create PDF of statement image using Documaker

C1-STEX-TX

Create statement extract records for Documaker

C1-STGSNDCON

Create FT process for sending consumption

C1-STOP-SA

Highlight Stopped SAs

C1-STPD-SQ

Stepped Service Quantity

C1-STRM-AS

Create / reuse a non-SP service agreement

C1-STSK-MINF

Service Task MO Information

C1-SUMMARY

Summary

C1-SVCRIT-LS

Check if customer has life support

C1-SVCRITDFT

Always return true (the lowest priority condition)

C1-SVEVT-SEV

Cut all other service agreements in the debt class

C1-SYCR-AS

Account staging sync criteria

C1-SYNREQPRE

Sync Request - Pre-Processing Algorithm

C1-SYPR-BC

Batch control sync processing

C1-TNDRAC-DF

Determine tender account via SA characteristic

C1-TODORETRY

Retry for To Do Entries

C1-TOUMAP-VL

TOU Map Validation

C1-TOUMPD-VL

TOU Map Data Validation

C1-TOUMTP-VL

TOU Map Template Validation

C1-TOUMTS-VL

TOU Map Template Schedule Validation

C1-TOUMTYVAL

TOU Map Type Validation

C1-TR-SUBUSG

Transition Awaiting Sync Sub-SA Usage Requests

C1-TR-TBFU

Transfer all FTs to service provider

C1-TR-WBFT

Transfer receivables to WBFT service provider

C1-TRANRELSY

Transition Related Sync Requests

C1-TRANSFASA

Transition Related FA From SA Sync

C1-TRANSFASP

Transition Related FA From SP Sync

C1-TRN-RELSY

Transition Related Data Sync

C1-TRNRELPPB

Transition Related PPB

C1-TRU-ELIG

Check Eligibility For True Up

C1-VAL-FC

Validate Flat Charge Rule

C1-VAL-SQ

Validate Service Quantity

C1-VAL-SSUM

Validate Simple Summary Rule

C1-VAL-STPSQ

Validate Stepped SQ Rule

C1-VAL-SUMM

Validate Summary Rule

C1-VAL-VM

Validate Math Rule

C1-VALCALCRT

Validate Calc Rule Eligibility Criteria

C1-VALCALCSQ

Validate Calculate Service Quantity Rule

C1-VALCALFNL

Validate Final Reading Value Rule

C1-VALXFRADJ

Validate Transfer Adjustment

C1-VCRITMTYP

Validate Item Type Rule

C1-VCRMNMX

Validate Maximum/Minimum Charge Rule

C1-VLCRAPLTO

Validate Apply To Rule

C1-WFCRITDFT

Always return true (the lowest priority condition)

C1-WOCRI-NCD

Check if non cash deposit exists

Application Service

The following Application Services are new to V2.4.0.

Application Service

Description

C1-CALC-GRP

Calculation Group MO

C1-CALC-R-EL

Calc Rule Eligibility Criteria MO

C1-CALC-RULE

Calculation Rule MO

C1-CCPREMINFO

Retrieve Control Central Premise Info

C1-CL-CAT

Calc Line Category Type MO

C1-CUSTCONTCTASKBOAS

Customer Contact Task BO

C1-CUSTCONTCTYPBOAS

Customer Contact Task Type BO

C1-NEMTRUEUPMONBOAS

NEM True Up Task BO

C1-NEMTRUEUPTYPBOAS

NEM True Up Task Type BO

C1-NOTIFYAPPTASKBOAS

Notify Appointment Task BO

C1-NOTIFYAPPTYPBOAS

Notify Appointment Task Type BO

C1-NTFYMISAPPTSKBOAS

Notify Missed Appointment Task BO

C1-NTFYMISAPPTYPBOAS

Notify Missed Appointment Task Type BO

C1-PREPAYBILLTSKBOAS

Prepay Biller Task

C1-PREPAYBILLTTYBOAS

Prepay Biller Task Type

C1-RTENGINMSTCFGBOAS

Rate Engine Master Configuration

C1-SELFSRVCINTEGBOAS

Self-Service Integration

C1-SERVICEREQTSKBOAS

Service Request Task BO

C1-SERVICEREQTYPBOAS

Service Request Task Type BO

C1-SERVREQINTEGBOAS

Service Request Integration Master Configuration

C1-TOUMAP

TOU Map MO

C1-TOUMAPBOAS

TOU Map BO

C1-TOUMAPDAT

TOU Map Data MO

C1-TOUMAPTM

TOU Map Template MO

C1-TOUMAPTYP

TOU Map Type MO

C1ACCMGT

Account Management

C1CALCAT

Calculation Line Category Type

C1CALGRP

Calculation Group

C1CALGRQ

Calculation Group Query

C1CALRLE

Calculation Rule

C1CALRLQ

Calculation Rule Query

C1RSQRY

Rate Schedule Query

C1RSV2M

Rate Schedule

C1RTCHK

Rate Check

C1TMTYP

TOU Map Type

C1TOUMAP

TOU Map

C1TOUMPQ

TOU Map Query

C1TOUMPT

TOU Map Template

CICORRREADOCBGBOAS

MDM Corrected Read Notification BO

CILXCXSP

Create XDS Message

Access Mode Added to Application Service

The following Access Mode are new to V2.4.0:

Application Service

Description

Access Mode

C1-FACOMPLBOAS

User

Enable/Disable (ENBL)

C1-PRODOFFERSYNCBOAS

Product Offer Sync Request BO

Send Request (F1SR)

C1-PRODOFFERSYNCBOAS

Product Offer Sync Request BO

Pending (PE)

C1USGRM

Usage Portal

Change (C)

CILMMSUP

MR Upload Staging

Execute (F1EX)

CILQCASP

Case Management

Delete (D)

Batch Control

The following Batch Controls are new to V2.4.0.

Batch Control

Description

C1-NEMDF

NEM Scheduled Monitor Process (Deferred)

C1-PPBER

Prepay Biller Task - Error

C1-PPBTR

Prepay Biller Task

C1-TOUTR

TOU Map Data Generation Monito

Business Object

The following Business Objects are new to V2.4.0.

Business Object

Description

C1-APRequestTypePhysicalBO

Physical BO for A/P Request Type

C1-AccountCreditReviewSchedule

Account Credit Review Schedule

C1-AccountManagementAccount

Account - Account Management

C1-AccountManagementSA

Service Agreement - Account Management

C1-AccountMngmtGroupPhysicalBO

Physical BO for Account Management Group

C1-AccountRelTypePhysicalBO

Physical BO for Account Relationship Type

C1-AccountingCalPhysicalBO

Physical BO for Accounting Calendar

C1-ActivityTypePhysicalBO

Physical BO for Activity Type

C1-AdjCancelReasonPhysicalBO

Physical BO for Adjustment Cancel Reason

C1-AdjTypePhysicalBO

Physical BO for Adjustment Type

C1-AdjTypeProfPhysicalBO

Physical BO for Adjustment Type Profile

C1-AlertTypePhysicalBO

Physical BO for Alert Type

C1-ApplyTo

Apply To

C1-AppointmentSchedPhysicalBO

Physical BO for Dispatch Group Appointment Schedule

C1-ApprovalProfilePhysicalBO

Physical BO for Approval Profile

C1-AutoPayRouteTypePhysicalBO

Physical BO for Auto Pay Route Type

C1-AutoPaySourcePhysicalBO

Physical BO for Auto Pay Source

C1-BankPhysicalBO

Physical BO for Bank

C1-BillCancelReasonPhysicalBO

Physical BO for Bill Cancel Reason

C1-BillChargeTypePhysicalBO

Physical BO for Billable Charge Line Type

C1-BillChgTemplatePhysicalBO

Physical BO for Billable Charge Template

C1-BillCyclePhysicalBO

Physical BO for Bill Cycle

C1-BillFactor

Bill Factor Type

C1-BillFactorPhysicalBO

Physical BO for Bill Factor

C1-BillFactorTOUValPhysicalBO

Physical BO for Bill Factor TOU Value

C1-BillFactorValuePhysicalBO

Physical BO for Bill Factor Value

C1-BillMessagePhysicalBO

Physical BO for Bill Message

C1-BillPeriodPhysicalBO

Physical BO for Bill Period

C1-BillRouteTypePhysicalBO

Physical BO for Bill Route Type

C1-BillSegmentCalcHeaders

Bill Segment Calc Headers

C1-BillSegmentRead

Bill Segment Read

C1-BillSegmentTypePhysicalBO

Physical BO for Bill Segment Type

C1-BudgetPlanPhysicalBO

Physical BO for Budget Plan

C1-CISDivisionPhysicalBO

Physical BO for CIS Division

C1-CalcGroup

Calculation Group

C1-CalcGroupBundlingAddBO

Bundling Add BO for Calculation Group

C1-CalcGroupPhysicalBO

Physical BO for Calculation Group

C1-CalcLineCatBundlingAddBO

Bundling Add BO for Calc Line Category Type

C1-CalcLineCatPhysicalBO

Physical BO for Calc Line Category Type

C1-CalcLineCategoryType

Calc Line Category Type

C1-CalcRuleBundlingAddBO

Bundling Add BO for Calculation Rule

C1-CalcRuleElCrtBundlingAddBO

Bundling Add BO for Calc Rule Eligibility Criteria

C1-CalcRuleElCrtPhysicalBO

Physical BO for Calc Rule Elig Criteria

C1-CalcRuleEligibilityCriteria

Calculation Rule Eligibility Criteria

C1-CalcRuleExecReSeqLite

Calculation Rule Execution Resequencing

C1-CalcRulePhysicalBO

Physical BO for Calculation Rule

C1-CalcRuleReferredCalcGroup

Execute Calculation Group

C1-CalculateFinalValue

Calculate Final Reading Values

C1-CalculateServiceQuantity

Calculate Service Quantity

C1-CampaignPhysicalBO

Physical BO for Campaign

C1-CaseTypePhysicalBO

Physical BO for Case Type

C1-CollClassControlPhysicalBO

Physical BO for Collection Class Control

C1-CollClassODRulesPhysicalBO

Physical BO for Collection Class Overdue Rules

C1-CollEventTypePhysicalBO

Physical BO for Collection Event Type

C1-CollProcTemplatePhysicalBO

Physical BO for Collection Process Template

C1-CollectionAgencyPhysicalBO

Physical BO for Collection Agency

C1-CollectionClassPhysicalBO

Physical BO for Collection Class

C1-ColumnReferencePhysicalBO

Physical BO for Column Reference

C1-ConservationProgPhysicalBO

Physical BO for Conservation Program

C1-ContOptEvtTypePhysicalBO

Physical BO for Contract Option Event Type

C1-ContractOptTypePhysicalBO

Physical BO for Contract Option Type

C1-ContractQtyTypePhysicalBO

Physical BO for Contract Quantity Type

C1-CreateCustContactTaskType

Create Customer Contact Task Type

C1-CreateCustomerContactTask

Customer Contact Request Task

C1-CreditUnitPhysicalBO

Physical BO for Credit Unit

C1-CustContactClassPhysicalBO

Physical BO for Customer Contact Class

C1-CustContactTypePhysicalBO

Physical BO for Customer Contact Type

C1-CustomerClassPhysicalBO

Physical BO for Customer Class

C1-CutEventTypePhysicalBO

Physical BO for Cut Event Type

C1-CutEvtCanReasonPhysicalBO

Physical BO for Cut Event Cancel Reason

C1-CutProcTemplatePhysicalBO

Physical BO for Cut Process Template

C1-DebtClassPhysicalBO

Physical BO for Debt Class

C1-DegreeDayPhysicalBO

Physical BO for Degree Day

C1-DepositClassPhysicalBO

Physical BO for Deposit Class

C1-DeviceConfigOutMsg

Device Configuration Outbound Message

C1-DeviceOverviewOutMsg

Device Overview Outbound Message

C1-DeviceTestTypePhysicalBO

Physical BO for Device Test Type

C1-DeviceTstCompTypePhysicalBO

Physical BO for Device Test Component Type

C1-DisconnectLocPhysicalBO

Physical BO for Disconnect Location

C1-DispatchGroupPhysicalBO

Physical BO for Dispatch Group

C1-DistributionCodePhysicalBO

Physical BO for Distribution Code

C1-DistributionRulePhysicalBO

Physical BO for Distribution Rule

C1-ExternalSystemLite

External System Lite

C1-FABasic

Field Activity Basic

C1-FAInfoOutMsg

Activity Information Outbound Message

C1-FARemarkPhysicalBO

Physical BO for Field Activity Remark

C1-FASyncReqOutMsg

FA Sync Request Outbound Message

C1-FASyncRequest

FA Sync Request

C1-FATypePhysicalBO

Physical BO for Field Activity Type

C1-FATypeProfilePhysicalBO

Physical BO for Field Activity Type Profile

C1-FacilityLevel1to2PhysicalBO

Physical BO for Facility Level 1 to 2

C1-FacilityLevel2to3PhysicalBO

Physical BO for Facility Level 2 to 3

C1-FieldServiceClassPhysicalBO

Physical BO for Field Service Class

C1-FieldSrvControlPhysicalBO

Physical BO for Field Service Control

C1-FieldWorkReschRsnPhysicalBO

Physical BO for Fieldwork Reschedule Reason

C1-FieldworkCanRsnPhysicalBO

Physical BO for Fieldwork Cancel Reason

C1-FlatCharge

Flat Charge

C1-FrequencyPhysicalBO

Physical BO for Frequency

C1-FundPhysicalBO

Physical BO for Fund

C1-GLDivisionPhysicalBO

Physical BO for General Ledger Division

C1-GenericCalcRule

Generic Calculation Rule

C1-HighLowFactorPhysicalBO

Physical BO for High Low Factor

C1-IdentifierTypePhysicalBO

Physical BO for Identifier Type

C1-InstallationOptPhysicalBO

Physical BO for Installation Options

C1-IntProfRelTypePhysicalBO

Physical BO for Interval Profile Rel Type

C1-IntProfileTypePhysicalBO

Physical BO for Interval Profile Type

C1-IntRegTypePhysicalBO

Physical BO for Interval Register Type

C1-ItemType

Item Type

C1-ItemTypePhysicalBO

Physical BO for Item Type

C1-LanguageCodePhysicalBO

Physical BO for Language Code

C1-LetterTemplatePhysicalBO

Physical BO for Letter Template

C1-MRInstructionPhysicalBO

Physical BO for Meter Read Instruction

C1-MRRouteTypePhysicalBO

Physical BO for Meter Read Route Type

C1-MRSchedulePhysicalBO

Physical BO for Meter Read Schedule

C1-ManufacturerPhysicalBO

Physical BO for Manufacturer

C1-MarketMessageTypePhysicalBO

Physical BO for Market Message Type

C1-MatchEvtCanRsnPhysicalBO

Physical BO for Match Event Cancel Reason

C1-MatchTypePhysicalBO

Physical BO for Match Type

C1-Math

Math

C1-Maximum

Maximum Charge

C1-MeterConfigTypePhysicalBO

Physical BO for Meter Configuration Type

C1-MeterIDTypePhysicalBO

Physical BO for Meter ID Type

C1-MeterLocationPhysicalBO

Physical BO for Meter Location

C1-MeterReadSourcePhysicalBO

Physical BO for Meter Read Source

C1-MeterReadWarningPhysicalBO

Physical BO for Meter Read Warning

C1-MeterReaderRemarkPhysicalBO

Physical BO for Meter Reader Remark

C1-MeterTypePhysicalBO

Physical BO for Meter Type

C1-Minimum

Minimum Charge

C1-NBBRulePhysicalBO

Physical BO for Non-billed Budget Rule

C1-NEMFinancialTransaction

NEM Financial Transaction BO

C1-NEMTrueUpTask

True Up Monitor Task

C1-NEMTrueUpTaskType

Net Energy Metering Task Type

C1-NonCashDepTypePhysicalBO

Physical BO for Non Cash Deposit Type

C1-NotifyAppointmentTask

Appointment Notification Task

C1-NotifyAppointmentTaskType

Appointment Notification Task Type

C1-NotifyMissedAppointmentTask

Missed Appointment Notification Task

C1-NotifyMissedApptTaskType

Missed Appointment Notification Task Type

C1-ODEvtCancelReasonPhysicalBO

Physical BO for Overdue Event Cancel Reason

C1-OperationalAreaPhysicalBO

Physical BO for Operational Area

C1-OrderCanRsnPhysicalBO

Physical BO for Order Cancel Reason

C1-OrderHoldReasonPhysicalBO

Physical BO for Order Hold Reason

C1-OverdueEventTypePhysicalBO

Physical BO for Overdue Event Type

C1-OverdueProcTemplPhysicalBO

Physical BO for Overdue Process Template

C1-PPBSA

Service Agreement Prepaid Biller

C1-PackagePhysicalBO

Physical BO for Package

C1-PayCancelReasonPhysicalBO

Physical BO for Pay Cancel Reason

C1-PayPlanTypePhysicalBO

Physical BO for Pay Plan Type

C1-PaySegmentTypePhysicalBO

Physical BO for Payment Segment Type

C1-PaymentMethodPhysicalBO

Physical BO for Payment Method

C1-PaymentTemplatePhysicalBO

Physical BO for Payment Template

C1-PersonRelTypePhysicalBO

Physical BO for Person Relationship Type

C1-PostalCodeDefaultPhysicalBO

Physical BO for Postal Code Default

C1-PremiseLatitudeLongitude

Premise - Latitude/Longitude

C1-PremiseTypePhysicalBO

Physical BO for Premise Type

C1-PrepayBillerTask

Prepay Biller Task

C1-PrepayBillerTaskType

Prepay Biller Task Type

C1-PropSADeclineRsnPhysicalBO

Physical BO for Proposal SA Decline Reason

C1-ProtocolPhysicalBO

Physical BO for Protocol

C1-QuoteRouteTypePhysicalBO

Physical BO for Quote Route Type

C1-RateComponentPhysicalBO

Physical BO for Rate Component

C1-RateEngineConfig

Rate Engine Configuration

C1-RateScheduleBundlingBO

Bundling Add BO for Rate Schedule

C1-RateScheduleLite

Rate Schedule Lite

C1-RateSchedulePhysicalBO

Physical BO for Rate Schedule

C1-RateScheduleV2

Rate Schedule

C1-RateVersionPhysicalBO

Physical BO for Rate Version

C1-ReadOutTypePhysicalBO

Physical BO for Read Out Type

C1-RebateDefinitionPhysicalBO

Physical BO for Rebate Definition

C1-RegisterRulePhysicalBO

Physical BO for Register Rule

C1-RepresentativePhysicalBO

Physical BO for Representative

C1-RetireReasonPhysicalBO

Physical BO for Retire Reason

C1-RevenueClassPhysicalBO

Physical BO for Revenue Class

C1-SARelTypePhysicalBO

Physical BO for SA Relationship Type

C1-SARelationship

SA Relationship BO

C1-SAServiceTaskDetails

SA Service Task Details BO

C1-SATypeSARelTypePhysicalBO

Physical BO for SA Type SA Relationship Type

C1-SATypeStartOptionPhysicalBO

Physical BO for SA Type Start Option

C1-SCEventTypePhysicalBO

Physical BO for Service Credit Event Type

C1-SCMInactiveRsnPhysicalBO

Physical BO for SCM Inactive Reason

C1-SCMTypePhysicalBO

Physical BO for Service Credit Membership Type

C1-SICCodePhysicalBO

Physical BO for SIC Code

C1-SPLatitudeLongitude

Service Point - Latitude/Longitude

C1-SPTypePhysicalBO

Physical BO for SP Type

C1-SQIPhysicalBO

Physical BO for Service Quantity Identifier

C1-SQRulePhysicalBO

Physical BO for Service Quantity Rule

C1-ServiceCyclePhysicalBO

Physical BO for Service Cycle

C1-ServiceProviderPhysicalBO

Physical BO for Service Provider

C1-ServiceQuantity

Service Quantity

C1-ServiceQuantityIdentifier

Service Quantity Identifier

C1-ServiceRequestFieldActivity

Service Request Field Activity

C1-ServiceRequestIntegration

Service Request Integration

C1-ServiceRequestOutMsg

Service Request Overview Outbound Message

C1-ServiceRequestTask

Service Request Task

C1-ServiceRequestTaskType

Service Request Task Type

C1-ServiceTypePhysicalBO

Physical BO for Service Type

C1-SevEvtTypePhysicalBO

Physical BO for Severance Event Type

C1-SevProcTemplatePhysicalBO

Physical BO for Severance Process Template

C1-SimpleSummary

Simple Summary

C1-StatementCyclePhysicalBO

Physical BO for Statement Cycle

C1-StatementRteTypePhysicalBO

Physical BO for Statement Route Type

C1-SteppedSQ

Stepped Service Quantity

C1-Summary

Summary

C1-TOSCancelReasonPhysicalBO

Physical BO for TOS Cancel Reason

C1-TOSTypePhysicalBO

Physical BO for Terms of Service Type

C1-TOUGroup

TOU Group

C1-TOUGroupPhysicalBO

Physical BO for TOU Group

C1-TOUMap

TOU Map

C1-TOUMapData

TOU Map Data

C1-TOUMapLite

TOU Map Lite

C1-TOUMapRelTypePhysicalBO

Physical BO for TOU Map Relationship Type

C1-TOUMapTemplate

TOU Map Template

C1-TOUMapTemplateLite

TOU Map Template Lite

C1-TOUMapTemplatePhysicalBO

Physical BO for TOU Map Template

C1-TOUMapTmBundlingAddBO

Bundling Add BO for TOU Map Template

C1-TOUMapTmPhysicalBO

Physical BO for TOU Map Template

C1-TOUMapType

TOU Map Type

C1-TOUMapTypeBundlingAddBO

Bundling Add BO for TOU Map Type

C1-TOUMapTypeLite

TOU Map Type Lite

C1-TOUMapTypePhyBO

TOU Map Type Physical BO

C1-TOUMapTypePhysicalBO

Physical BO for TOU Map Type

C1-TaxExemptTypePhysicalBO

Physical BO for Tax Exempt Type

C1-TenderSourcePhysicalBO

Physical BO for Tender Source

C1-TenderTypePhysicalBO

Physical BO for Tender Type

C1-TermsAndCondPhysicalBO

Physical BO for Terms and Conditions

C1-ThirdPartyPayorPhysicalBO

Physical BO for Third Party Payor

C1-TimeOfUse

Time Of Use

C1-TimeOfUsePhysicalBO

Physical BO for Time of Use

C1-TrendAreaPhysicalBO

Physical BO for Trend Area

C1-TrendClassPhysicalBO

Physical BO for Trend Class

C1-UATypePhysicalBO

Physical BO for Umbrella Agreement Type

C1-UOMPhysicalBO

Physical BO for Unit Of Measure

C1-UnitOfMeasure

Unit Of Measure

C1-UsageRequestLite

MDM Usage Request - Lite

C1-WOProcessTemplatePhysicalBO

Physical BO for Write Off Process Template

C1-WriteOffControlPhysicalBO

Physical BO for Write Off Control

C1-WriteOffDebtClassPhysicalBO

Physical BO for Write Off Debt Class

C1-WriteOffEventTypePhysicalBO

Physical BO for Write Off Event Type

CMCaseComment

CMCaseComment

FK Reference

The following FK References are new to V2.4.0.

FK Reference

Description

C1-ALTY

Alert Type

C1-APRTY

A/P Request Type

C1-APYRT

Auto Pay Route Type

C1-ATPRF

Adjustment Type Profile

C1-BCHLT

Billable Charge Upload Line Type

C1-BCHTM

Billable Charge Template

C1-BFACT

Bill Factor

C1-BFVAL

Bill Factor Value

C1-BILCA

Bill Cancel Reason

C1-BILCY

Bill Cycle

C1-CALGR

Calculation Group

C1-CALRE

Calculation Rule Eligibility Criteria

C1-CALRL

Calculation Rule

C1-CHTYE

Characteristic Type by Entity

C1-CLCAT

Calculation Line Category Type

C1-COLCL

Collection Class

C1-CONTQ

Contract Quantity Type

C1-DEPCL

Deposit Class

C1-FATYP

Foreign key reference for the FA Type.

C1-FREQ

Frequency

C1-ITMTY

Item Type

C1-MCFGT

Meter Configuration Type

C1-PAYCA

Pay Cancel Reason

C1-PKG

Package

C1-PUSCH

Payment Upload Staging Characteristics

C1-RC

Rate Component

C1-REVCL

Revenue Class

C1-RSINF

Rate Schedule Search

C1-STASK

Service Task

C1-TC

Terms and Conditions

C1-TOUBF

TOU Bill Factor Value

C1-TOUGR

TOU Group

C1-TOUMD

TOU Map Data

C1-TOUMP

TOU Map

C1-TOUTM

TOU Map Template

C1-TOUTY

TOU Map Type

C13RDPTY

Third Party

C1ACTCAL

Accounting Calendar

C1BILMSG

Bill Message

C1BILPRD

Bill Period

C1BSEGTY

Bill Segment Type

C1BUDPLN

Budget Plan

C1COEVTY

Contract Option Event Type

C1COLAGY

Collection Agency

C1COLCLC

Collection Class Control

C1COLEVT

Collection Event Type

C1COLPTM

Collection Process Template

C1CONTYP

Contract Option Type

C1CRUNIT

Credit Unit

C1DEGDAY

Degree Day

C1DISGRP

Dispatch Group

C1DSCLOC

Disconnect Location

C1DVTCT

Device Test Component Type

C1DVTSTY

Device Test Type

C1FACNRS

Field Activity Cancel Reason

C1FATYPR

Field Activity Type Profile

C1FLVL12

Facility Level 1 to 2

C1FLVL23

Facility Level 2 to 3

C1FREQ

Frequency

C1FSVCL

Field Service Class

C1FSVCTL

Field Service Control

C1GLDIV

General Ledger Division

C1HILOF

High Low Factor

C1IPRFRT

Interval Profile Relationship Type

C1IPRFTY

Interval Profile Type

C1IREGTY

Interval Register Type

C1LTRTMP

Letter Template

C1MANUF

Manufacturer

C1MECNRS

Match Event Cancel Reason

C1MRINST

Meter Read Instruction

C1MRRTTY

Meter Read Route Type

C1MRSCHD

Meter Read Schedule

C1MRSRCE

Meter Read Source

C1MRWARN

Meter Read Warning

C1MTCHTY

Match Type

C1MTRIDT

Meter ID Type

C1MTRLOC

Meter Location

C1MTRTYP

Meter Type

C1NBRULE

Non-Billed Budget Rule

C1NCDEPT

Non Cash Deposit Type

C1OF-MO

MO Option - OCBG Corrected Read BO

C1OPER

Operational Area

C1ORDCRS

Order Cancel Reason

C1ORDHRS

Order Hold Reason

C1PERELT

Person Relationship Type

C1POSTDF

Postal Code Default

C1PPLNTY

Pay Plan Type

C1PREMTY

Premise Type

C1PROTOC

Protocol

C1PSADR

Proposal SA Decline Reason

C1PSEGTY

Payment Segment Type

C1PYMTHD

Payment Method

C1QTERTY

Quote Route Type

C1RDOUTY

Read Out Type

C1REGRUL

Register Rule

C1RETRSN

Retirement Reason

C1RF-MO

Rate Check Function

C1RSINFO

Rate Schedule Search

C1RTVER

Rate Version

C1SATRLT

SA Type SA Relationship Type

C1SCEVTY

Service Credit Event Type

C1SCMIRS

Service Credit Membership Inactive Reason

C1SEVTYP

Severance Event Type

C1SQRULE

Service Quantity Rule

C1STMTCY

Statement Cycle

C1STMTRT

Statement Route Type

C1SVCCYC

Service Cycle

C1SVPRTM

Severance Process Template

C1TAXEXT

Tax Exemption Type

C1TOURLT

TOU Map Relationship Type

C1TRNDAR

Trend Area

C1TRNDCL

Trend Class

C1TS-MO

MO Option - Default User Tender Source BO

C1UB-MO

MO Option - Batch Billing Usage Request BO

C1UO-MO

MO Option - Online Billing Usage Request BO

C1V2-MO

MO Option - Rate Schedule Version 2 BO

C1WOCTRL

Write Off Control

C1WODCL

Write Off Debt Class

C1WOEVTY

Write Off Event Type

C1WOPRTM

Write Off Process Template

Lookups

The following Lookups are new to V2.4.0..

Lookup Field Name

Field Value

Language

Description

ACCESS_MODE

C1CB

ENG

Calculating Bill Segment

ACCESS_MODE

C1DT

ENG

Determine If Top Up Needed

ACCESS_MODE

RTRU

ENG

Reverse True Up

ACCESS_MODE

TRUP

ENG

True Up

ALG_ENTITY_FLG

C1CE

ENG

Calc Rule Criteria BO - Apply Criteria

ALG_ENTITY_FLG

C1CM

ENG

TOU Map (BO) - Create TOU Map Data

ALG_ENTITY_FLG

C1CR

ENG

Calc Rule BO - Apply Calc Rule

ALG_ENTITY_FLG

C1DS

ENG

Installation - Digital Signature

ALG_ENTITY_FLG

C1DV

ENG

Calculation Rule - Derive Value

ALG_ENTITY_FLG

C1EF

ENG

Calc Rule Elig Criteria - Field Algorithm

ALG_ENTITY_FLG

C1HB

ENG

SA Type - High Bill Amount

ALG_ENTITY_FLG

C1OP

ENG

Business Object - Override Proration Factors

ALG_ENTITY_FLG

C1PB

ENG

Business Object - Determine Prepay Balances

ALG_ENTITY_FLG

C1PE

ENG

Installation - Payment Event Information

ALG_ENTITY_FLG

C1SM

ENG

Calc Rule - Step Multiplier

ALG_ENTITY_FLG

C1TT

ENG

TOU Map Template (BO) - Derive TOU

ALLOW_EST_FLG

C1NO

ENG

No

ALLOW_EST_FLG

C1YE

ENG

Yes

ALLOW_PRO_FLG

C1NO

ENG

No

ALLOW_PRO_FLG

C1YE

ENG

Yes

APPLY_TMAP_TO_DRVD_VCTR_FLG

C1NO

ENG

No

APPLY_TMAP_TO_DRVD_VCTR_FLG

C1YE

ENG

Yes

BEFORE_RS_TYPE_FLG

C1PR

ENG

Primary

BEFORE_RS_TYPE_FLG

C1SC

ENG

Subsidiary

BO_SEVT_FLG

C1CE

ENG

Apply Calc Rule Eligibility Criteria

BO_SEVT_FLG

C1CM

ENG

Create TOU Map Data

BO_SEVT_FLG

C1CR

ENG

Apply Calc Rule

BO_SEVT_FLG

C1OP

ENG

Override Proration Factors

BO_SEVT_FLG

C1PB

ENG

Determine Prepay Balances

BO_SEVT_FLG

C1TT

ENG

Derive Tou

BUS_OBJ_OPT_FLG

C1TM

ENG

TOU Map Data BO

C1_APPT_REQ_TYPE_FLG

C1AN

ENG

Appointment Needed

C1_APPT_REQ_TYPE_FLG

C1AS

ENG

Appointment Scheduled

C1_CALLER_PROCESS_FLG

C1PP

ENG

Prepay Biller

C1_CAN_HAVE_LEADS_FLG

C1NO

ENG

No

C1_CAN_HAVE_LEADS_FLG

C1YS

ENG

Yes

C1_CONT_OPT_PTCP_ANLYS_FLG

C1DP

ENG

Does Not Participate

C1_CONT_OPT_PTCP_ANLYS_FLG

C1PT

ENG

Participates

C1_INTIATIVE_MST_SUB_FLG

C1MI

ENG

Master Initiative

C1_INTIATIVE_MST_SUB_FLG

C1SI

ENG

Subsidiary Initiative

C1_PPB_MIN_BAL_REP_NTF_FLG

C1EM

ENG

Email

C1_PPB_MIN_BAL_REP_NTF_FLG

C1TX

ENG

Text

C1_PPB_PAYMENT_METHOD_FLG

C1AP

ENG

Automatic Payment

C1_PPB_PAYMENT_METHOD_FLG

C1ML

ENG

By Mail

C1_PPB_PAYMENT_METHOD_FLG

C1PR

ENG

In Person

C1_PPB_USAGE_CALC_NTF_FLG

C1DN

ENG

Do Not Notify

C1_PPB_USAGE_CALC_NTF_FLG

C1EM

ENG

Email

C1_PPB_USAGE_CALC_NTF_FLG

C1TX

ENG

Text

C1_PREPAID_METER_FLG

C1PP

ENG

Prepaid Smart Meter

C1_SVC_REQ_COMP_ACT_FLG

C1CN

ENG

Cancel

C1_SVC_REQ_COMP_ACT_FLG

C1CP

ENG

Complete

C1_SVC_REQ_UPD_EVT_FLG

C1AN

ENG

Appointment Notification

C1_SVC_REQ_UPD_EVT_FLG

C1CC

ENG

Customer Contact

C1_SVC_REQ_UPD_EVT_FLG

C1MA

ENG

Missed Appointment

C1_SVC_REQ_UPD_FLG

C1AN

ENG

Appointment Notification

C1_SVC_REQ_UPD_FLG

C1CC

ENG

Customer Contact

C1_SVC_REQ_UPD_FLG

C1MA

ENG

Missed Appointment

C1_TARGET_PORTAL_FLG

C1AC

ENG

Account

C1_TARGET_PORTAL_FLG

C1CC

ENG

Control Central

C1_USAGE_TYPE_FLG

C1IS

ENG

Both

CALC_FAIL_ACTION_FLG

C1ER

ENG

Error

CALC_FAIL_ACTION_FLG

C1SK

ENG

Skip

CALC_ONLY_FLG

C1NO

ENG

No

CALC_ONLY_FLG

C1YE

ENG

Yes

CALC_RULE_OUTPUT_FLG

C1BT

ENG

Both

CALC_RULE_OUTPUT_FLG

C1CL

ENG

Calculation Line

CALC_RULE_OUTPUT_FLG

C1SQ

ENG

Service Quantity

CALC_RULE_PROC_FLG

C1AL

ENG

Always

CALC_RULE_PROC_FLG

C1IN

ENG

Initial SQ Calculation

CALC_SQ_AGG_FUNC_FLG

C1AV

ENG

Average

CALC_SQ_AGG_FUNC_FLG

C1MA

ENG

Maximum

CALC_SQ_AGG_FUNC_FLG

C1MI

ENG

Minimum

CALC_SQ_AGG_FUNC_FLG

C1SU

ENG

Sum

CALC_SQ_CHAR_SRC_FLG

C1AC

ENG

Account

CALC_SQ_CHAR_SRC_FLG

C1PR

ENG

Premise

CALC_SQ_CHAR_SRC_FLG

C1SA

ENG

Service Agreement

CALC_SQ_CHAR_SRC_FLG

C1SP

ENG

Service Point

CALC_SQ_VAR_TYPE_FLG

C1AL

ENG

Algorithm

CALC_SQ_VAR_TYPE_FLG

C1BF

ENG

Bill Factor

CALC_SQ_VAR_TYPE_FLG

C1CL

ENG

Calculated Line

CALC_SQ_VAR_TYPE_FLG

C1CQ

ENG

Contract Quantity

CALC_SQ_VAR_TYPE_FLG

C1CV

ENG

Characteristic Value

CALC_SQ_VAR_TYPE_FLG

C1HQ

ENG

Historical Service Quantity

CALC_SQ_VAR_TYPE_FLG

C1SQ

ENG

Service Quantity

CHAR_ENTITY_FLG

C1CG

ENG

Calculation Group

CHAR_ENTITY_FLG

C1CR

ENG

Calculation Rule

CHAR_ENTITY_FLG

C1CT

ENG

Calculation Line Category Type

CHAR_ENTITY_FLG

C1EL

ENG

Calculation Rule Eligibility Criteria

CHAR_ENTITY_FLG

C1TD

ENG

TOU Map Data

CHAR_ENTITY_FLG

C1TL

ENG

TOU Map Log

CHAR_ENTITY_FLG

C1TM

ENG

TOU Map

CHAR_ENTITY_FLG

C1TT

ENG

TOU Map Template

CHAR_ENTITY_FLG

C1TY

ENG

TOU Map Type

CHG_LIMIT_TYPE_FLG

C1MN

ENG

Minimum

CHG_LIMIT_TYPE_FLG

C1MX

ENG

Maximum

COMPARISON_FORMAT_FLG

C1NM

ENG

Compare Numeric

COMPARISON_FORMAT_FLG

C1ST

ENG

Compare String

CONDITIONAL_OPERATOR_FLG

C1BE

ENG

Between

CONDITIONAL_OPERATOR_FLG

C1EQ

ENG

=

CONDITIONAL_OPERATOR_FLG

C1GE

ENG

>=

CONDITIONAL_OPERATOR_FLG

C1GT

ENG

>

CONDITIONAL_OPERATOR_FLG

C1IN

ENG

In

CONDITIONAL_OPERATOR_FLG

C1LE

ENG

<=

CONDITIONAL_OPERATOR_FLG

C1LT

ENG

<

CONDITIONAL_OPERATOR_FLG

C1NE

ENG

<>

CONT_QTY_PRORATE_METHOD_FLG

C1CE

ENG

Consumption End Date

CONT_QTY_PRORATE_METHOD_FLG

C1CS

ENG

Consumption Start Date

CONT_QTY_PRORATE_METHOD_FLG

C1MA

ENG

Maximum

CONT_QTY_PRORATE_METHOD_FLG

C1MI

ENG

Minimum

CONT_QTY_PRORATE_METHOD_FLG

C1PR

ENG

Prorate

CREATE_STEP_SUMM_FLG

C1NO

ENG

Do Not Create Summary

CREATE_STEP_SUMM_FLG

C1YE

ENG

Create Summary, Do Not Print

CREATE_STEP_SUMM_FLG

C1YP

ENG

Create Summary, Print

CRE_BILL_LN_FLG

C1NO

ENG

No

CRE_BILL_LN_FLG

C1YE

ENG

Yes

CRE_OPT_FLG

C1CC

ENG

Check Calc Header Existence

CRE_OPT_FLG

C1CI

ENG

Create Immediate

CR_CRT_CHAR_ENT_FLG

C1AC

ENG

Account

CR_CRT_CHAR_ENT_FLG

C1BL

ENG

Bill

CR_CRT_CHAR_ENT_FLG

C1CH

ENG

Characteristic Collection

CR_CRT_CHAR_ENT_FLG

C1PR

ENG

Premise

CR_CRT_CHAR_ENT_FLG

C1PS

ENG

Main Person

CR_CRT_CHAR_ENT_FLG

C1SA

ENG

Service Agreement

CR_CRT_CHAR_ENT_FLG

C1SP

ENG

Service Point

CR_CRT_CMP_EVAL_FLG

C1FL

ENG

False

CR_CRT_CMP_EVAL_FLG

C1IN

ENG

Insufficient Data

CR_CRT_CMP_EVAL_FLG

C1TR

ENG

True

CR_CRT_CMP_OPR_FLG

C1BW

ENG

Between

CR_CRT_CMP_OPR_FLG

C1EQ

ENG

=

CR_CRT_CMP_OPR_FLG

C1GE

ENG

>=

CR_CRT_CMP_OPR_FLG

C1GT

ENG

>

CR_CRT_CMP_OPR_FLG

C1IN

ENG

In

CR_CRT_CMP_OPR_FLG

C1LE

ENG

<=

CR_CRT_CMP_OPR_FLG

C1LT

ENG

<

CR_CRT_CMP_OPR_FLG

C1NE

ENG

<>

CR_CRT_FALSE_FLG

C1AR

ENG

Apply Rule

CR_CRT_FALSE_FLG

C1CK

ENG

Check Next Condition

CR_CRT_FALSE_FLG

C1DN

ENG

Do Not Apply Rule

CR_CRT_FLD_TYPE_FLG

C1AL

ENG

Algorithm

CR_CRT_FLD_TYPE_FLG

C1BF

ENG

Bill Factor

CR_CRT_FLD_TYPE_FLG

C1CH

ENG

Characteristic

CR_CRT_FLD_TYPE_FLG

C1CL

ENG

Calc Line

CR_CRT_FLD_TYPE_FLG

C1CQ

ENG

Contract Quantity

CR_CRT_FLD_TYPE_FLG

C1HQ

ENG

Historic Quantity

CR_CRT_FLD_TYPE_FLG

C1SQ

ENG

Service Quantity

CR_CRT_INSF_FLG

C1AR

ENG

Apply Rule

CR_CRT_INSF_FLG

C1CK

ENG

Check Next Condition

CR_CRT_INSF_FLG

C1DN

ENG

Do Not Apply Rule

CR_CRT_INSF_FLG

C1ER

ENG

Error

CR_CRT_TRUE_FLG

C1AR

ENG

Apply Rule

CR_CRT_TRUE_FLG

C1CK

ENG

Check Next Condition

CR_CRT_TRUE_FLG

C1DN

ENG

Do Not Apply Rule

DST_CD_SRC_FLG

C1RC

ENG

Revenue Class

DST_CD_SRC_FLG

C1SD

ENG

Specific Distribution Code

DT_RND_METHOD_FLG

C1DO

ENG

Round Down

DT_RND_METHOD_FLG

C1UP

ENG

Round Up

ERR_IF_NO_T_VAL_FLG

C1NO

ENG

No

ERR_IF_NO_T_VAL_FLG

C1YE

ENG

Yes

ERR_IF_NO_VAL_FLG

C1NO

ENG

No

ERR_IF_NO_VAL_FLG

C1YE

ENG

Yes

EXEC_OVR_PROR_FLG

C1NO

ENG

No

EXEC_OVR_PROR_FLG

C1YE

ENG

Yes

EXT_CALL_TYPE_FLG

C1AC

ENG

Field Activity Information

EXT_CALL_TYPE_FLG

C1DC

ENG

Device Configuration Overview

EXT_CALL_TYPE_FLG

C1DV

ENG

Device Overview

EXT_CALL_TYPE_FLG

C1SR

ENG

Service Request Overview

EXT_SERV_REQ_FLG

C1NO

ENG

Customer Care & Billing

EXT_SERV_REQ_FLG

C1YE

ENG

Service Order Management

F1CN_OPT_TYP_FLG

C1LL

ENG

Lat/Long Geographic Type

F1EM_OPT_TYP_FLG

C1EF

ENG

Email From

F1EM_OPT_TYP_FLG

C1XS

ENG

XAI Sender

F1GC_OPT_TYP_FLG

C1AS

ENG

Address Validation Script

F1GC_OPT_TYP_FLG

C1AV

ENG

Allow Address Validation

F1MONTH_ABBR

13

ENG

test

F1_SVC_TASK_CL_FLG

C1MI

ENG

Miscellaneous

F1_SVC_TASK_CL_FLG

C1SR

ENG

Service Request Integration

F1_SYNC_REQ_DISCARD_RSN_FLG

F1FA

ENG

Synchronization not required for FA

FACAN_SYS_DFLT_FLG

C1SR

ENG

Service Request canceled

FALSE_ACT_FLG

C1CN

ENG

Check Next

FALSE_ACT_FLG

C1FF

ENG

Apply False Formula

FCPO_RETN_RULE_FLG

C1RT

ENG

Retain amount on bill line

FCPO_RETN_RULE_FLG

C1ZR

ENG

Set bill line amount to zero

FORMULA_TYPE_FLG

C1CO

ENG

Conditional Formula

FORMULA_TYPE_FLG

C1SI

ENG

Simple Formula

FORMULA_VALUE_TYPE_FLG

C1AE

ENG

Arithmetic Expression

FORMULA_VALUE_TYPE_FLG

C1CO

ENG

Constant

FORMULA_VALUE_TYPE_FLG

C1IC

ENG

Interval Condition

FORMULA_VALUE_TYPE_FLG

C1IV

ENG

Interval Value

FORMULA_VALUE_TYPE_FLG

C1SS

ENG

Scalar String

FORMULA_VALUE_TYPE_FLG

C1SV

ENG

Scalar Value

FORMULA_VALUE_TYPE_FLG

C1VD

ENG

Variable Definition

INCLUDE_DT_FLG

C1NO

ENG

Date Exclusive

INCLUDE_DT_FLG

C1YS

ENG

Date Inclusive

INS_ALG_ENTITY_FLG

C1DS

ENG

Digital Signature

INS_ALG_ENTITY_FLG

C1PE

ENG

Payment Event Information

KEEP_SQ_IN_GL_FLG

C1NO

ENG

No

KEEP_SQ_IN_GL_FLG

C1YE

ENG

Yes

MAINT_OBJ_OPT_FLG

C1RF

ENG

Rate Check Function

MAINT_OBJ_OPT_FLG

C1V2

ENG

Rate Schedule BO

MAP_CHART_ACTION_FLG

C1IN

ENG

Initialize Chart

MAP_CHART_ACTION_FLG

C1OL

ENG

Overlay

MAP_CHART_ACTION_FLG

C1RE

ENG

Refresh

MISSING_INTV_DATA_ACTION_FLG

C1ER

ENG

Error

MISSING_INTV_DATA_ACTION_FLG

C1SK

ENG

Skip

MISSING_VAL_ACTION_FLG

C1CO

ENG

Use Default Value

MISSING_VAL_ACTION_FLG

C1ER

ENG

Error

MISSING_VAL_ACTION_FLG

C1SK

ENG

Skip

MSR_PEAK_FLG

C1NO

ENG

No

MSR_PEAK_FLG

C1YE

ENG

Yes

NORMALIZE_BILL_PERIOD_FLG

C1NO

ENG

No

NORMALIZE_BILL_PERIOD_FLG

C1YE

ENG

Yes

PAY_CHAR_ENT_FLG

C1PE

ENG

Payment Event

PAY_CHAR_ENT_FLG

C1PT

ENG

Payment Tender

PAY_CHAR_ENT_FLG

C1PY

ENG

Payment

PRT_FLG

C1NO

ENG

No

PRT_FLG

C1YE

ENG

Yes

PRT_IF_ZERO_FLG

C1NO

ENG

No

PRT_IF_ZERO_FLG

C1YE

ENG

Yes

RATE_APP_PROC_SRC_FLG

C1PO

ENG

Post Processing

RATE_APP_PROC_SRC_FLG

C1PR

ENG

Pre Processing

RATE_APP_PROC_SRC_FLG

C1RV

ENG

Rate Version

RATE_ENGINE_IMPL_FLG

C1BT

ENG

Both

RATE_ENGINE_IMPL_FLG

C1V1

ENG

Classic

RATE_ENGINE_IMPL_FLG

C1V2

ENG

New

RATE_EXT_REQ_TYPE_FLG

C1RC

ENG

Rate Check Usage

RESULT_SOURCE_FLG

C1FN

ENG

Set Function Against Derived Vector

RESULT_SOURCE_FLG

C1SF

ENG

Scalar Formula Result

RETAIN_CALC_SQ_FLG

C1NO

ENG

No

RETAIN_CALC_SQ_FLG

C1YE

ENG

Yes

RETAIN_MEASURED_SQ_FLG

C1NO

ENG

No

RETAIN_MEASURED_SQ_FLG

C1YE

ENG

Yes

RE_HELPER_OPT_FLG

C1AT

ENG

Accumulate Target Category Values

RS_VERSION_FLG

C1V1

ENG

Classic

RS_VERSION_FLG

C1V2

ENG

New

SAT_ALG_ENTITY_FLG

C1HB

ENG

High Bill Amount

SCLR_TYPE_FLG

C1BF

ENG

Bill Factor

SCLR_TYPE_FLG

C1SF

ENG

Set Function

SCLR_TYPE_FLG

C1SQ

ENG

Service Quantity

SEASONAL_FLG

C1NO

ENG

No

SEASONAL_FLG

C1YE

ENG

Yes

SEASON_PROR_MTHD_FLG

C1AC

ENG

Accounting Date

SEASON_PROR_MTHD_FLG

C1CE

ENG

Consumption End Date

SEASON_PROR_MTHD_FLG

C1CS

ENG

Consumption Start Date

SEASON_PROR_MTHD_FLG

C1PR

ENG

Prorate

SEASON_PROR_MTHD_FLG

C1PS

ENG

Prorate Seasonal SQ

SET_FUNCTION_FLG

C1AV

ENG

Average

SET_FUNCTION_FLG

C1CN

ENG

Count

SET_FUNCTION_FLG

C1MA

ENG

Maximum

SET_FUNCTION_FLG

C1MI

ENG

Minimum

SET_FUNCTION_FLG

C1TO

ENG

Total

SKIP_SA_RSN_FLG

17

ENG

Prepay bill segment generation outside of the PPB

SP_COND_FLG

35

ENG

External Fieldwork Orchestration

SQ_TO_USE_FLG

C1BI

ENG

Billable

SQ_TO_USE_FLG

C1IN

ENG

Initial

STEP_PROR_METH_FLG

C1AF

ENG

Value Days Over Base Days

STEP_PROR_METH_FLG

C1VF

ENG

Value Days Over Rate Version Days

TOU_MAP_FUNC_FLG

C1MA

ENG

Maximum

TOU_MAP_FUNC_FLG

C1SU

ENG

Sum

TRC_ON_FLG

C1NO

ENG

Off

TRC_ON_FLG

C1YS

ENG

On

TRUE_ACT_FLG

C1CN

ENG

Check Next

TRUE_ACT_FLG

C1TF

ENG

Apply True Formula

TYPE_OF_CHAR_SRCH_OPT

C1AP

ENG

Adhoc and Predefined Only

USAGE_REQ_METH_FLG

C1EU

ENG

Existing Usage

USAGE_REQ_METH_FLG

C1NU

ENG

New Usage

USG_CONSUM_PERIOD_OPT_FLG

C1RP

ENG

Get Rate Application Period

USG_CONSUM_PERIOD_OPT_FLG

C1TP

ENG

Get Total Usage Consumption Period

USG_CONSUM_PERIOD_OPT_FLG

C1UP

ENG

Get Usage Periods

VAL_SOURCE_FLG

C1BF

ENG

Bill Factor

VAL_SOURCE_FLG

C1VA

ENG

Algorithm

VAL_SOURCE_FLG

C1VL

ENG

Value

VECTR_FLG

C1FV

ENG

FV - Final Vector Interval Value

VECTR_FLG

C1V1

ENG

IV1 - Vector 1 Interval Value

VECTR_FLG

C1V2

ENG

IV2 - Vector 2 Interval Value

VECTR_FLG

C1V3

ENG

IV3 - Vector 3 Interval Value

VECTR_FLG

C1V4

ENG

IV4 - Vector 4 Interval Value

VECTR_FLG

C1V5

ENG

IV5 - Vector 5 Interval Value

VECTR_TYPE_FLG

C1BF

ENG

Interval Bill Factor

VECTR_TYPE_FLG

C1SQ

ENG

Interval Service Quantity

Maintenance Object

The following Maintenance Objects are new to V2.4.0.

MO code

Description

C1-CALC-GRP

Calculation Group

C1-CALC-R-EL

Calculation Rule Eligibility Criteria

C1-CALC-RULE

Calculation Rule

C1-CL-CAT

Calc Line Category Type

C1-INITIATIV

Initiative

C1-ITVLD-ELI

Initiative Lead Eligibility Criteria

C1-ITVPT-CRI

Initiative Participation Criteria

C1-LEAD

Lead

C1-LEAD-EVTY

Lead Event Type

C1-LEADEVENT

Lead Event

C1-TOUMAP

TOU Map

C1-TOUMAPDAT

TOU Map Data

C1-TOUMAPTM

TOU Map Template

C1-TOUMAPTYP

TOU Map Type

Script

The following Scripts are new to V2.4.0..

Script

Description

C1-AMPrAccts

Account Management - Process Account List

C1-AMPrSAs

Account Management - Process SAs for Update

C1-AMPrepAcc

Account Management - Prepare Account Update Data

C1-AMPrepSA

Account Management - Prepare SA Update Data

C1-AMRdTAcct

Account Management - Read Template Account

C1-AMRdTPrem

Account Management - Read Template Address

C1-AMRdTSA

Account Management - Read Template Service Agreement

C1-AMUpAccts

Account Management - Update Accounts - driver

C1-AMUpSAs

Account Management - Update Service Agreements - driver

C1-AMUpdAcct

Account Management - Update Acount

C1-AMUpdSA

Account Management - Update Service Agreement

C1-AMValAccQ

Account Management Query Filter Validation

C1-AMValSAQ

Account Management - SA Query Filter Validation

C1-ActvtyInf

This service script is responsible for

C1-AddTMLog

TOU Map Add Log Entry

C1-AddlFAInf

Capture Additional FA Information

C1-AppGoMDM2

Service Request Appointment Link from FA Portal

C1-BOProc

Business Object Processing

C1-BldSQUP

Build Service Quantities for a Usage Period

C1-CAPFASSF

Capture FA Final Snapshot

C1-CAPFASSI

Capture FA-Based Initial Snapshot

C1-CCByAcct

Launch Control Central Given an Account ID

C1-CCByPhone

Launch Control Central Given a Phone Number

C1-CUrUBSkSa

Cancel Usage Request and Update BS Exception for Skipped SA

C1-CalCrMain

Calculation Rule Eligibility Criteria Maintenance

C1-CalLnCtMt

Calculation Line Category Type Maintenance

C1-CalRlMain

Calculation Rule Maintenance

C1-CalcBlDys

Calculate Bill Days

C1-CalcGMain

Calculation Group Maintenance

C1-CalcPPBBS

Generate PPB Bill Segment

C1-CalcRlDsp

Calculation Rule - Retrieve Details for Display

C1-CalcRlVal

Calculation Rule Validation

C1-CanTUM

Cancel Active True Up Monitors

C1-CapAddSPI

Capture Additional SP Information

C1-ChkAcExSR

Service Request Overview - Check SP Type's External Service Request Indicat

C1-ChkBSStat

Check PPB Bill Segment Status

C1-ChkDvExSR

Device Overview - Check SP Type's External Service Request Indicator

C1-ChkFrzBS

Check for Freezable Bill Segments

C1-ChkPPBSA

Check PPB's SA Status

C1-ChkTOUTMT

Check TOU Of TOU Map Template

C1-ChkTOUTMp

Check TOU Of TOU Map

C1-CkTRUPEli

Check Eligibility For True Up

C1-CkTUMElig

Check True Up Monitor Eligibility For Cancellation

C1-ClcFVPre

Calculate Final Value Pre-processing

C1-ClcFnPost

Calculate Final Value Post-processing

C1-ClcRlePre

Calculation Rule Common Pre-processing Script

C1-ClcSQDisp

Calculate Service Quantity Display Details

C1-ClcSQPost

Calculate Service Quantity Post-processing

C1-ClcSQPre

Calculate Service Quantity Pre-processing

C1-ClrRetryI

Clear Retry Information

C1-CorrTD

Create Corrected Read Notification To Do Entry

C1-CrTUMSAR

Create Sub SA and SA Relationship For Next True Up Period

C1-CreCustCn

Create Customer Contact

C1-CreMisApp

Create Missed Appointment Notification Task

C1-CreNfyApp

Create Appointment Notification Task

C1-CrePPBBM

Create Prepay Biller Bill Message

C1-CreSARel

Create SA Relationship Sub SA For Master SA

C1-CreTUM

Create True Up Monitor

C1-CreTUMAdj

NEM True Up - Create Adjustments

C1-CreateCC

Create Customer Contact Task

C1-CreatePPB

Create Prepay Biller

C1-DetBSCalc

Determine Bill Segment Calculation Schedule

C1-DetTopUp

Determine if Top Up Needed

C1-DeviceInf

Retrieve Device Information

C1-DfltBseg

Rate Check - Default Bill Segment

C1-DfltSA

Rate Check - Default SA Details

C1-DfltUsage

Rate Check - Default Usage

C1-DisPPBAP

Disable PPB Automatic Payment

C1-DupCalcGr

Duplicate Calculation Group

C1-DupCalcRl

Duplicate Calculation Rule

C1-DupRSV2

Duplicate Rate Schedule V2

C1-DvcGoMDM2

Service Request Device Link from SP Portal

C1-EnterType

Common Enter Type Processing - Select Type from dropdown

C1-FAGoMDM2

Service Request Activity Link from FA Portal

C1-FASyncElg

Check FA Sync Eligibility

C1-FTCrGL

Current Amt = 0 / Payoff Amt = Bill Amt (GL affected)

C1-FTCrNOGL

Current Amt = 0 / Payoff Amt = Bill Amt (no GL)

C1-GenDss

Retrieve Business Object, Display Map and Script

C1-GetCfTypH

Get Meter Configuration Type from SP/Meter History

C1-GetCfgTyp

Get Meter Configuration Type from Meter Configuration

C1-GetConTyp

Get Contact Type from Person

C1-GetGeoLL

Retrieve Latitude/Longitude Geographic Value

C1-GetRECfg

Retrieve Rate Engine Configuration

C1-GetRSFlg

Determine Rate Engine Version

C1-GetSAType

Get SA Type from SA

C1-GetSPType

Get SP Type from SP

C1-GetUsgDtl

Rate Check - Determine Usage Request Details

C1-GncAcZnVs

Generic Show or Hide Actions Zone - Action Zone UI Map

C1-GoToCCB

Go to CCB

C1-GoToRSMrg

Navigate to Rate Schedule Merge

C1-GoToRVM

Navigate to Rate Version

C1-GoToRVMrg

Navigate to Rate Version Merge

C1-GoToRtCoA

Navigate to Rate Component (Add)

C1-GoToRtCom

Navigate to Rate Component

C1-GoToRtSch

Navigate to Rate Schedule

C1-GoToRtVer

Navigate to Rate Version

C1-GoToRtVrA

Navigate to Rate Version (Add)

C1-IdNbrMask

Mask Person ID Number

C1-InsCharGt

Rate Check Result - Insert Characteristics to GTT

C1-InsClcGtt

Rate Check Result - Insert Calc to GTT

C1-InsReadGt

Rate Check Result - Insert Reads to GTT

C1-InsSQGtt

Rate Check Result - Insert SQ to GTT

C1-InsTrcGtt

Rate Check Result - Insert Trace Log to GTT

C1-IntvDtPro

Rate Check - Process Interval Data

C1-ListTOUTM

Retrieve TOU Map's TOU List

C1-MainRSAdd

Add Rate Schedule

C1-MainRSV2

Rate Schedule V2 Maintenance

C1-MathDisp

Math Rule Display Script

C1-MathPost

Math Rule Post-processing

C1-MathPre

Math Rule Pre-processing

C1-MissedApp

Process Missed Appointment Notification

C1-MultPKVis

Zone Visibility - Display Zone in Portal for Multi-part PK

C1-MultStpSQ

Multiply Step by SQ

C1-NMTskDisp

NEM Task Display

C1-NoPror

No Proration

C1-NotifyCst

Prepay Biller - Notify Customer

C1-NtfyAppt

Process Appointment Notification

C1-OvrInMain

Adjust usage and check rate

C1-OvrIntPro

Rate Check - Override SQ and Interval Processing

C1-PPBBoMain

Service Task Business Object Processing

C1-PPBBsegs

Prepay Bill Segments Graph

C1-PPBInfo

Prepay Biller Information

C1-PPBTypVal

Prepay Biller Type Validation

C1-PPBValid

Prepay Biller Validation

C1-PreTOUMTY

TOU Map Type Pre-processing

C1-ProcSPFWO

Process SP Fieldwork Orchestration

C1-RCMainRes

Rate Check Result - Main details

C1-RChkDtl

Rate Check - Retrieve Main Details

C1-RChkErr

Rate Check - Handle Error

C1-RChkInpV

Rate Check - Validate Input

C1-RChkMain

Standard rate check

C1-RChkPerf

Rate Check Perform Processing

C1-RChkProc

Rate Check Processing

C1-RSDetBO

Rate Schedule Determine BO

C1-RSInfo

Rate Schedule Information

C1-RSPortNav

Rate Schedule Navigation

C1-RSV2Disp

Retrieve Rate Schedule Details for Display

C1-RT-CNFZAD

Reverse True Up - Cancel Frozen Adjustments

C1-ReactvPPB

Reactivate PPB

C1-ReqFundNt

Prepay Biller Request Fund and Notification

C1-RetCCPrmI

Retrieve Control Central Premise Information

C1-RetFAMCD

Retrieve FA Profile and FA Type Master Config Details

C1-RetMoTyps

Common Retrieve Types for MO

C1-RetSRCCC

Retrieve Service Request Customer Contact Class

C1-RsqCalcRl

Resequence Calculation Rules For Group

C1-RtCfgDisp

Rate Engine Master Config Display Details

C1-RtScDss

Retrieve Business Object, Display Map and Script

C1-RvTrueUp

Reverse True Up - Cancel Frozen Adjustments

C1-RvTrupSS

Transition TUM to Reverse True Up

C1-SPLatLong

Retrieve Latitude/Longitude Geographic Value

C1-SQPost

Service Quantity Post-processing

C1-SRFinInfo

Service Request Financial Information

C1-SRTskInfo

Service Request Task Information

C1-SRTskTDSK

Service Request Task To Do Sort Key Retriever

C1-SSumPost

Simple Summary Post-processing

C1-SSumPre

Simple Summary Pre-processing

C1-STSK-MINF

Service Task MO Information

C1-STskAlSAC

Service Task Alert by SA Characteristic

C1-ShldShwSQ

Zone Visibility - Should Display Zone in Portal for SQ Overlay

C1-ShwPPBPay

Zone Visibility - Display prepay financial history on service task portal

C1-StpSQPost

Stepped Service Quantity Post-processing

C1-SvcReqUpd

Service Request Update Request

C1-SynReqPre

Sync Request - Pre-processing Plug-In Script

C1-TOUMDGen

TOU Map Data Generation

C1-TOUMDMain

TOU Map Data Maintenance

C1-TOUMTMain

TOU Map Template Maintenance

C1-TOUMTpVal

TOU Map Template Validation

C1-TOUMTyVal

TOU Map Type Validation

C1-TOUMYMain

TOU Map Type Maintenance

C1-TOUMapDis

TOU Map Display

C1-TOUMapVal

TOU Map Validation

C1-TOUMpDVal

TOU Map Data Validation

C1-TOUMpMain

TOU Map Maintenance

C1-TRU-ELIG

Check Eligibility For True Up

C1-TUMRvTrUp

Transition TUM to Reverse True Up

C1-TnDtPPBSS

Transfer Debt to Prepaid SA

C1-TnDtVldtn

Transfer Debt Validation

C1-TranRelSy

Transition Sync Requests with same MO and PKs

C1-TransFASA

Transition Related FA From SA Sync

C1-TransFASP

Transition Related FA From SP Sync

C1-TransTUM

Transition TUM

C1-TrnDbtPPB

Transfer debt to PPB

C1-TrnRelPPB

Transition Related PPB

C1-TrnUsgSAN

Transition Related Usage Requests from SA Sync in a new session

C1-URIntDl

Usage Request - Download Interval Data

C1-URSQOvly

Usage Request SQ Overlay

C1-UplIntvDt

Rate Check - Upload Interval Data

C1-VALCALGRP

Validate Calculation Group Input

C1-VCRITMTYP

Validate Calculation Rule - Item Type

C1-VCRMNMX

Validate Calculation Rule - Maximum/Minimum

C1-VLCRAPLTO

Validate Calculation Rule - Apply To

C1-VLCRMNMX

Validate Calculation Rule - Minimum/Maximum

C1-ValAddr

Address Validation Using Geocoding

C1-ValCalCrt

Validate Calc Rule Eligibility Criteria

C1-ValCalFnl

Validate Calculate Final Value

C1-ValCalcSQ

Validate Calculate Service Quantity

C1-ValDstRvC

Validate Distribution Code and Revenue Class List

C1-ValFc

Validate Flat Charge

C1-ValFlTy

Validate Calc Rule Field Type

C1-ValInputs

Validate Inputs for Drill Back Script

C1-ValPrcCom

FCPO Validation

C1-ValPrcLvl

Validate Precision Level

C1-ValRChk

Rate Check - Validate

C1-ValSSum

Validate Simple Summary

C1-ValSeaDtl

Seasonal Details Validation

C1-ValSq

Validate Service Quantity

C1-ValStpDtl

Calculation Rule Step Details Validation

C1-ValStpSq

Validate Stepped SQ

C1-ValSumm

Validate Summary

C1-ValType

Common Enter Type Processing - Type Validation

C1-ValUoToSq

Validate UOM/TOU/SQI Combination

C1-ValValDtl

Calc Rule Value Source Validation

C1-ValVectMa

Validate Math Rule

C1-VecChart

Vector Chart with Page-specific Parameter Substitution

C1-VecChartN

Vector Chart with Page-specific Parameter Substitution - No SPI

CMCASECOMM

CMCASECOMM

PSM-testBPA

test bpa - ZZ-EntMOOpt

To Do Type

The following To Do types are new to V2.4.0.

Todo Type Code

Description

C1-CRDBS

Corrected Read with Freezable Bill Segment

C1-PPBTD

Prepay Biller Task Errors

C1-SRAPP

Appointment Notification

C1-SRTTD

Service Request Task Errors

Portal

The following Portals are new to V2.4.0.

Portal

Description

C1ACCMGT

Account Management

C1CALCAT

Calculation Line Category Type

C1CALGRP

Calculation Group

C1CALGRQ

Calculation Group Query

C1CALRLE

Calculation Rule

C1CALRLQ

Calculation Rule Query

C1RCHKRS

Rate Check - Results

C1RSQRY

Rate Schedule Query

C1RSV2M

Rate Schedule

C1RTCHK

Rate Check

C1TMTYP

TOU Map Type

C1TOUMAP

TOU Map

C1TOUMPLG

TOU Map Log

C1TOUMPQ

TOU Map Query

C1TOUMPT

TOU Map Template

C1_ACCTTREE

Account Tree Portal

C1_ADJ_PRTL

Adjustment Portal Page

C1_BP_TREE

Bill/Payment Tree Portal

C1_BSEG_PRTL

Bill Segment Portal Page

C1_CC_PRTL

Customer Contact Portal Page

C1_MR_PRTL

Meter Read Portal Page

C1_MTRC_PRTL

Meter Configuration Portal Page

C1_MTR_PRTL

Meter Portal Page

C1_PER_PRTL

Person Portal Page

C1_PP_TREE

Pay Plan Tree Portal

C1_PREMTREE

Premise Tree Portal

C1_PREM_PRTL

Premise Portal Page

C1_SA_PRTL

Service Agreement Portal Page

Portal Zone

The following Portal Zones are added to V2.4.0

Portal

Zone

C1ACCMGT

C1-ACMGMQRY

C1ACCMGT

C1-ACMGPERT

C1ACCMGT

C1-ACMGSAQ

C1CALCAT

C1-CLCATDISP

C1CALCAT

C1-CLCATLST

C1CALGRP

C1-CALCGRDSP

C1CALGRP

C1-CALCREFGL

C1CALGRP

C1-CALCRLLST

C1CALGRP

C1-CALCRSL

C1CALGRQ

C1-CALCGMLTQ

C1CALRLE

C1-CALCECLST

C1CALRLE

C1-CALCRLDSP

C1CALRLQ

C1-CALCRMLTQ

C1RCHKRS

C1-RCCALCGTT

C1RCHKRS

C1-RCCHARGTT

C1RCHKRS

C1-RCMAINRS

C1RCHKRS

C1-RCREADGTT

C1RCHKRS

C1-RCSQGTT

C1RCHKRS

C1-RCTRCEGTT

C1RSQRY

C1-RATESCHQ

C1RSV2M

C1-RSV2DISP

C1RTCHK

C1-RTCHKMAIN

C1SITASK

C1-PPBBSEGS

C1SITASK

C1-PPBFINHST

C1TMTYP

C1-TOUMYDISP

C1TMTYP

C1-TOUMYLIST

C1TOUMAP

C1-TOUMDLIST

C1TOUMAP

C1-TOUMPDISP

C1TOUMPLG

C1-TOUMPLOG

C1TOUMPQ

C1-TOUMPQRY

C1TOUMPT

C1-TOUMTDISP

C1TOUMPT

C1-TOUMTLIST

C1USGRM

C1-USGINTVDS

C1_ACCTTREE

C1_ACCTTREE

C1_ADJ_PRTL

C1-ADJ-INFO

C1_BP_TREE

C1_BP_TREE

C1_BSEG_PRTL

C1-BSEG-INFO

C1_CC_PRTL

C1-CC-INFO

C1_FA_PRTL

C1-FA-SRINFO

C1_MR_PRTL

C1-MR-INFO

C1_MTRC_PRTL

C1-MTRC-INFO

C1_MTR_PRTL

C1-MTR-INFO

C1_PER_PRTL

C1-PER-INFO

C1_PP_TREE

C1_PP_TREE

C1_PREMTREE

C1_PREMTREE

C1_PREM_PRTL

C1-PREM-INFO

C1_SA_PRTL

C1-SA-INFO

C1_SP_PRTL

C1-SP-DEVICE

CI_ACCTINFO

C1-RETCCPRMI

CI_CUSTINFO

CI_CCINFO

CI_PP_TREE

C1_PP_TREE

F1SYNCRQ

C1-SYNREQQRY

UI Map

The following UI Maps are new to V2.4.0.

Map

Description

C1-AccSATypeFilter

SA search using Account and SA type

C1-AccountManagementAQ1

Account Management Query Filters

C1-AccountManagementAQ2

Account - Query Filter - Char Type/ Value

C1-AccountManagementAcctSumm

Account Management Update Summary

C1-AccountManagementSAQ

Account SAs - Query Filter

C1-AccountManagementSASumm

Account Management - Update SA - Summ

C1-AccountManagementUpdtAcct

Account Management - Account Update Detail

C1-AccountManagementUpdtSA

Account Management - Update SA

C1-AcctAsOfBillDateFilter

Bill search using Account and Bill Date

C1-AcctIdQryFltr

Filter by Account

C1-AddressValidationResults

Validation Results Display Map

C1-BillCharacteristicFilter

Bill search using Characteristic Type

C1-BillFactorQueryFilters

Bill Factor Query Filters

C1-BillIdQryFltr

Filter by Bill

C1-CCPremiseInfo

Retrieve Control Central Premise Info

C1-CalcLineCatTypeQueryFilters

Calc Line Category Type Query Filters

C1-CalcLineCategoryTypeDisplay

Calculation Line Category Type Display

C1-CalcLineCategoryTypeMaint

Calculation Line Category Type Maintenance

C1-CalcRuleApplyToDisplay

Apply To Display

C1-CalcRuleApplyToMaint

Apply To Maintenance

C1-CalcRuleBOFilter

Calculation Rule BO Filter

C1-CalcRuleBillPrintDisplay

Calculation Rule - Bill Print Display

C1-CalcRuleBillPrintMaint

Calculation Rule - Bill Print Maintenance

C1-CalcRuleCharDisplay

Calculation Rule Characteristics - Display

C1-CalcRuleCharMaint

Calculation Rule - Characteristic Maint

C1-CalcRuleCommonDisplay

Calculation Rule - Common Display

C1-CalcRuleCommonDisplayJS

Calculation Rule - Common Display JS

C1-CalcRuleCommonMaint

Calculation Rule - Common Maintenance

C1-CalcRuleDisp

Calculation Rule - Display Fragment

C1-CalcRuleDistCdDisplay

Calc Rule - Distribution Code Display

C1-CalcRuleDistCdMaint

Calculation Rule - Distribution Code Maint

C1-CalcRuleEligibilityCritMain

Calc Rule Eligibility Criteria Maintenance

C1-CalcRuleFCPODisplay

Calculation Rule - FCPO Display

C1-CalcRuleFCPOMaint

Calculation Rule - FCPO Maintenance

C1-CalcRuleItemTypeDisplay

Item Type Display

C1-CalcRuleItemTypeMaint

Item Type Maintenance

C1-CalcRuleMaint

Calculation Rule - Maintenance Fragment

C1-CalcRuleMaintCommonJS

Calculation Rule - Common Maintenance JS

C1-CalcRuleMaxDisplay

Maximum Charge Display

C1-CalcRuleMaxMaint

Maximum Charge Maintenance

C1-CalcRuleMemberCatDisplay

Calculation Rule - Member Category Display

C1-CalcRuleMemberCatMaint

Calculation Rule - Member Category Maint

C1-CalcRuleMinDisplay

Minimum Charge Display

C1-CalcRuleMinMaint

Minimum Charge Maintenance

C1-CalcRuleQueryFilters

Calculation Rule Query Filters

C1-CalcRuleRefGrpDisplay

Referred Calculation Group Display

C1-CalcRuleReferredGrpMaint

Referred Calculation Group Maintenance

C1-CalcRuleRoundAmtDisplay

Calculation Rule - Rounding Display

C1-CalcRuleRoundAmtMaint

Calculation Rule - Round Amount Maint

C1-CalcRuleSeasonalDisplay

Calculation Rule - Seasonal Display

C1-CalcRuleSeasonalMaint

Calculation Rule - Seasonal Maintenance

C1-CalcRuleTargetCatDisplay

Calculation Rule - Target Category Display

C1-CalcRuleTargetCatMaint

Calculation Rule -Target Category Maint

C1-CalcRuleValueDisplay

Calculation Rule - Value Display

C1-CalcRuleValueMaint

Calculation Rule - Value Maintenance

C1-CalculateFinalValueDisplay

Calculate Final Value Display

C1-CalculateFinalValueMaint

Calculate Final Value Maintenance

C1-CalculateSQDispMap

Calculate Service Quantity Display

C1-CalculateSQMaintMap

Calculate Service Quantity Maintenance

C1-CharValueMaint

Char Value Maintenance - List

C1-CharacteristicTypeInfo

Characteristic Type Information - List

C1-ChartFormatter

Formatter for Tooltip

C1-CreateCustContactTaskDisp

Create Customer Contact Task Display

C1-DeviceDisplay

Device Display

C1-DuplicateCalcGroup

Duplicate Calculation Group

C1-DuplicateCalcRule

Duplicate Calculation Rule

C1-DuplicateRateScheduleV2

Duplicate Rate Schedule V2

C1-EnterCalcRule

Enter Calculation Rule

C1-EnterTypeUIMap

Common Enter Type Processing - Select Type

C1-ErrorMessage

Error Message

C1-FlatChargeDispMap

Flat Charge Display

C1-FlatChargeMaintMap

Flat Charge Maintenance

C1-HoverTextFragment

Hover Text, Tracker Line and Helpers

C1-MDM2LinkApp

Navigate to MDM from FA

C1-MDM2LinkDevice

Navigate to MDM from SP Portal

C1-MDM2LinkFa

Navigate to MDM from FA

C1-MathDispMap

Math Rule Display Map

C1-MathMaintMap

Math Maintenance Map

C1-NEMTrueUpTaskDisplay

NEM True Up Task Display

C1-NotifyAppointmentTaskDisp

Appointment Notification Task Display

C1-NotifyMissedApptTaskDisp

Missed Appointment Notification Task Display

C1-OverrideIntervalDataFunc

Rate Check - Override Interval Data

C1-PerIdQryFltr

Filter by Person

C1-PostalDefaultFragment

Postal Default Fragment

C1-PrepayBillerBillSegments

Prepay Biller Bill Segments

C1-PrepayBillerTaskDisplay

Prepay Biller Task Display

C1-PrepayBillerTaskMaint

Prepay Biller Task Maintenance

C1-RateCheckMain

Rate Check - Main

C1-RateCheckResultMain

Rate Check Results - Main

C1-RateEngineMasterConfigDisp

Rate Engine Master Configuration Display

C1-RateEngineMasterConfigMaint

Rate Engine Master Configuration Maint

C1-RateScheduleFilter

Rate Schedule Search

C1-RateScheduleV2Display

Rate Schedule Display

C1-RateScheduleV2Maint

Rate Schedule Maintenance

C1-ReseqCalcRules

Resequence Calculation Rules for Group

C1-SACharacteristicFilter

SA search using Characteristic Type

C1-SAIdQryFltr

Filter by Service Agreement (SA)

C1-SQDtlsDispFragment

Service Quantity Details Display Fragment

C1-SQDtlsMaintFragment

Service Quantity Details Maint Fragment

C1-SRCustContClassFragment

Service Request Customer Contact Class UI Map Frag

C1-ServiceQuantityDispMap

Service Quantity Display Map

C1-ServiceQuantityMaintMap

Service Quantity Maintenance Map

C1-ServiceReqCancelReasonInp

Service Request - Enter Cancel Reason

C1-ServiceRequestDisplay

Service Request Display UI Map

C1-ServiceRequestIntegDisplay

Service Request Integration Display

C1-ServiceRequestIntegMaint

Service Request Integration Maintenance

C1-ServiceRequestTaskActions

Service Request Task Actions

C1-ServiceTaskTypRecordActions

Service Task Type Record Actions HTML Fragment

C1-ServiceTaskTypeRecordInfo

Service Task Type Record Information Fragment

C1-SimpleSummaryDispMap

Simple Summary Display

C1-SimpleSummaryMaintMap

Simple Summary Maintenance

C1-SteppedSQDispMap

Stepped Service Quantity Display

C1-SteppedSQMaintMap

Stepped Service Quantity Maintenance

C1-SummaryDispMap

Summary Display

C1-SummaryMaintMap

Summary Maintenance

C1-SvcTaskTypeDisplay

Service Task Type Display Fragment

C1-TOUMapAddUserLog

TOU Map - Add User Log Entry

C1-TOUMapDataGen

TOU Map Data - Generation

C1-TOUMapDataMaint

TOU Map Data - Maintenance

C1-TOUMapDisplay

TOU Map - Display

C1-TOUMapFilter

TOU Map Data List Filter

C1-TOUMapMaint

TOU Map - Maintenance

C1-TOUMapQ1Filter

TOU Map - Query 1 Filter

C1-TOUMapQ2Filter

TOU Map - Query 2 Filter

C1-TOUMapTemplateDisplay

TOU Map Template - Display

C1-TOUMapTemplateMaint

TOU Map Template - Maintenance

C1-TOUMapTypeDisplay

TOU Map Type - Display

C1-TOUMapTypeMaint

TOU Map Type - Maintenance

C1-TransferDebtToPPB

Transfer Debt to PPB

C1-UploadUsageIntervalData

Upload Usage Interval Data

C1-UsageRequestSQOverlay

Usage Request SQ Overlay

XAI Inbound Service

The following XAI Inbound Service is are new to V2.4.0.

XAI Inbound Service ID

Zone Type

Description

C126800279

WXServiceDetails

Retrieve Service Details

C137628894

WXProcessPayArrangementRequest

Process Payment Arrangement Request

C143716799

C1FACompletionServiceRequest

Service Request FA Completion

C157127114

C1-CustomerMaintenanceRequest

Customer Maintenance Request

C160549912

C1FACompletionFieldWork

FA Completion - Field Work (MWM via PIP)

C175706652

C1-ServiceRequestUpdateRequest

Process Service Request Update Request

C176872824

C1-ServiceRequestFinancialInfo

Service Request Financial Information

C179156189

WXPremiseSearch

Premise Search

C195599240

WXProcessStartStopRequest

Process Start Stop Request

Zone Type

The following Zone Types are new to V2.4.0.

None

Zone

The following Zones are new to V2.4.0.

Zone

Zone Type

Description

C1-ACCOUNTQ

F1-DE-MULQRY

Account Search

C1-ACCOUNTQ1

F1-DE-QUERY

Person name

C1-ACCOUNTQ2

F1-DE-QUERY

Person ID

C1-ACMGAQ1

F1-DE-QUERY

Default

C1-ACMGAQ2

F1-DE-QUERY

Account Characteristic

C1-ACMGMQRY

F1-DE-MULQRY

Account Search

C1-ACMGPERT

F1-DE

Person Tree

C1-ACMGSAQ

F1-DE

Service Agreement List

C1-ADJ-INFO

F1-FIELDVALS

General Information

C1-ADJTYPEQ

F1-DE-QUERY

Adjustment Type

C1-BFQ

F1-DE-QUERY

Bill Factor Search

C1-BILLQ

F1-DE-MULQRY

Bill search

C1-BILLQ1

F1-DE-QUERY

Person name

C1-BILLQ2

F1-DE-QUERY

Account ID

C1-BILLQ3

F1-DE-QUERY

Characteristic Type

C1-BILLSEGQ

F1-DE-MULQRY

Bill Segment search

C1-BILLSEGQ1

F1-DE-QUERY

Person Name

C1-BILLSEGQ2

F1-DE-QUERY

Account

C1-BILLSEGQ3

F1-DE-QUERY

Service Agreement

C1-BILLSEGQ4

F1-DE-QUERY

Bill

C1-BSACCTGDT

F1-DE-SINGLE

Retrieve Bill Segment's Accounting Date

C1-BSEG-INFO

F1-FIELDVALS

General Information

C1-CALCECLST

F1-DE-SINGLE

Eligibility Criteria List

C1-CALCGMLTQ

F1-DE-MULQRY

Calculation Group Search

C1-CALCGRDSP

F1-MAPDERV

Calculation Group

C1-CALCREFGL

F1-DE-SINGLE

Referencing Calculation Rules List

C1-CALCRGLST

F1-DE

Calculation Rules

C1-CALCRLDSP

F1-MAPDERV

Calculation Rule

C1-CALCRLLST

F1-DE

Calculation Rules List

C1-CALCRMLTQ

F1-DE-MULQRY

Calculation Rule Search

C1-CALCRQ2

F1-DE-QUERY

Calculation Rule BO

C1-CALCRQRY

F1-DE-QUERY

Calculation Rule

C1-CALCRSL

F1-DE

Referencing Rate Schedule List

C1-CALGQRY

F1-DE-QUERY

Calculation Group

C1-CC-INFO

F1-FIELDVALS

General Information

C1-CHARTYPQ

F1-DE-MULQRY

Characteristic Type by Entity Search

C1-CHARTYPQ1

F1-DE-QUERY

Characteristic Type

C1-CHARTYPQ2

F1-DE-QUERY

Characteristic Entity

C1-CHKCRSQ

F1-DE-SINGLE

Check Calculation Rule Sequence

C1-CHKSSYNRQ

F1-DE-SINGLE

Check Related Syncronized Sync Request

C1-CHKUSGBS

F1-DE-SINGLE

Get Bill Segment linked to the Usage

C1-CLCATDISP

F1-MAPDERV

Calculation Line Category Type

C1-CLCATLST

F1-DE-SINGLE

Calculation Line Category Type List

C1-CLCATQ

F1-DE-MULQRY

Calc Line Category Type Search

C1-CLCATQ1

F1-DE-QUERY

Calc Line Category Type

C1-CRSEQMAX

F1-DE-SINGLE

Retrieve Maximum Calculation Rule Sequence

C1-CRSSQRY

F1-DE-QUERY

Calculation Group's Calculation Rules

C1-DAYTILDUE

F1-DE-SINGLE

Retrieve Customer Class Days Till Due

C1-DISTCDQ

F1-DE-MULQRY

Distribution Code Search

C1-DISTCDQ1

F1-DE-QUERY

Distribution Code

C1-FA-SRINFO

F1-MAPEXPL

Service Request Information

C1-GETACCPAY

F1-DE-SINGLE

Retrieve Account's Last Six Payments

C1-GETBSDST

F1-DE-SINGLE

Get Distribution Code For A/R

C1-GETBSEGDT

F1-DE-SINGLE

Get Start/End Date For Frozen Bill Segment

C1-GETEXTSR

F1-DE-SINGLE

Retrieve Ext Service Req Ind from SP Type

C1-GETFACAN

F1-DE-SINGLE

Retrieve FA Cancel Reason

C1-GETFAEXSR

F1-DE-SINGLE

Retrieve External Service Requests Indicator from FA

C1-GETFAPRTY

F1-DE-SINGLE

Retrieve FA Type Profile/FA Type

C1-GETMOALG

F1-DE-SINGLE

Retrieve MO Algorithm

C1-GETPPBTOT

F1-DE-SINGLE

Retrieve PPB SA's Total Amount

C1-GETPREMFA

F1-DE-SINGLE

Retrieve Premise Address Linked to FA's SP

C1-GETRELSFA

F1-DE-SINGLE

Get FA Sync Request in Pending State

C1-GETRFOPT

F1-DE-SINGLE

Get MO Option - Rate Check Function

C1-GETSAREL

F1-DE-SINGLE

Get SA Relationship effective in future

C1-GETSASPFA

F1-DE-SINGLE

Retrieve SAs Linked to SP/FA

C1-GETSUBSA

F1-DE-SINGLE

Get Sub SA's for an SA Relationship

C1-GETUSGBP

F1-DE-SINGLE

Retrieve Usage in BD Proc using Bill Segment Id

C1-ITEMTYPQ

F1-DE-MULQRY

Item Type Search

C1-ITEMTYPQ1

F1-DE-QUERY

Item Type

C1-LSTOTMTTY

F1-DE-SINGLE

List Override TOU Map Temp of TOU Map Type

C1-LSTTOUMPT

F1-DE-SINGLE

List TOU Map Templates

C1-LSTTOUTGR

F1-DE-SINGLE

Retrieve TOU Map's TOU List

C1-LTTOUMPTY

F1-DE-SINGLE

List TOU Map Types

C1-MR-INFO

F1-FIELDVALS

General Information

C1-MTR-INFO

F1-FIELDVALS

General Information

C1-MTRC-INFO

F1-FIELDVALS

General Information

C1-ORDWKDAY

F1-DE-SINGLE

Ordered week days

C1-PER-INFO

F1-FIELDVALS

General Information

C1-PERSONQ

F1-DE-MULQRY

Person Search

C1-PERSONQ1

F1-DE-QUERY

Person Name

C1-PERSONQ2

F1-DE-QUERY

Person ID Type / ID Number

C1-PPBBSEGS

F1-MAPEXPL

Prepay Bill Segments

C1-PPBFINHST

F1-DE

Prepay Financial History

C1-PREM-INFO

F1-FIELDVALS

General Information

C1-PREMQ

F1-DE-MULQRY

Premise Search

C1-PREMQ1

F1-DE-QUERY

Address

C1-RATESCHQ

F1-DE-MULQRY

Rate Schedule Search

C1-RATESCHQ1

F1-DE-QUERY

Rate Schedule

C1-RCCALCGTT

F1-DE

Calculation Lines

C1-RCCHARGTT

F1-DE

Characteristics

C1-RCMAINRS

F1-MAPEXPL

Main

C1-RCREADGTT

F1-DE

Read Details

C1-RCSQGTT

F1-DE

SQ Details

C1-RCTRCEGTT

F1-DE

Trace Log

C1-RETAPDET

F1-DE-SINGLE

Retrieve Account Auto Pay Details

C1-RETCALCRG

F1-DE-SINGLE

Retrieve calculation rules for calc group

C1-RETCALCVA

F1-DE-SINGLE

Retrieve Category Values for Category Type

C1-RETCCPRMI

F1-MAPEXPL

Premise Information

C1-RETCVDESC

F1-DE-SINGLE

Get Calc Line Category Value Description

C1-RETLSTBS

F1-DE-SINGLE

Retrieve Latest Frozen Bill Segments for SA

C1-RETMOTYPS

F1-DE-SINGLE

Retrieve MO Types

C1-RETPERPH

F1-DE-SINGLE

Retrieve person phone by phone type

C1-RETPHFMT

F1-DE-SINGLE

Retrieve Phone Formats

C1-RETPOSTAL

F1-DE

Retrieve Address Postal Defaults

C1-RETPOSTD1

F1-DE-SINGLE

Retrieve Address Postal Defaults - Exact

C1-RETPOSTD2

F1-DE-SINGLE

Retrieve Address Postal Defaults - Range

C1-RETRELPPB

F1-DE-SINGLE

Retrieve Related PPBs for Usage

C1-RETRELSYN

F1-DE-SINGLE

Retrieve Sync Requests with same MO and PKs

C1-RETTSKSAC

F1-DE-SINGLE

Retrieve Outstanding Tasks by SA Characteristic

C1-RETTZTOU

F1-DE

Retrieve TOU Map Time Zone

C1-RSV2DISP

F1-MAPDERV

Rate Schedule

C1-RTCHKMAIN

F1-MAPEXPL

Rate Check

C1-SA-INFO

F1-FIELDVALS

General Information

C1-SABAL

F1-DE-SINGLE

Get SA Payoff Balance

C1-SAQ

F1-DE-MULQRY

SA Search

C1-SAQ1

F1-DE-QUERY

Person Name

C1-SAQ2

F1-DE-QUERY

Account Id / SA Type

C1-SAQ3

F1-DE-QUERY

Characteristic Type

C1-SATUM

F1-DE-SINGLE

Get TUM linked to Sub SAs for Master SA

C1-SP-DEVICE

F1-MAPEXPL

Device Information

C1-SP-PRTL

F1-XMLEDITOR

Object Portal

C1-SPQ

F1-DE-MULQRY

SP Search

C1-SPQ1

F1-DE-QUERY

Address

C1-SYNREQQRY

F1-DE-MULQRY

Sync Request Search

C1-TDS-OPEN

F1-DE-SINGLE

Check If Open To Do Entries Exist

C1-TMDPRD

F1-DE-SINGLE

Date period for which TOU map data exists

C1-TOUMDLIST

F1-DE

TOU Map Data List

C1-TOUMDMY

F1-DE-SINGLE

Check TOU Map Of TOU Map Type

C1-TOUMPDISP

F1-MAPDERV

TOU Map

C1-TOUMPLOG

F1-DE

TOU Map Log

C1-TOUMPQ1

F1-DE-QUERY

TOU Map ID

C1-TOUMPQ2

F1-DE-QUERY

TOU Map Description, Creation Date

C1-TOUMPQRY

F1-DE-MULQRY

TOU Map Search

C1-TOUMTDISP

F1-MAPDERV

TOU Map Template

C1-TOUMTLIST

F1-DE-SINGLE

TOU Map Template List

C1-TOUMYDISP

F1-MAPDERV

TOU Map Type

C1-TOUMYLIST

F1-DE-SINGLE

TOU Map Type List

C1-TOUMYMT

F1-DE-SINGLE

Check TOU Map Type Of TOU Map Template

C1-TUMADJ

F1-DE-SINGLE

Get Frozen Adjustments Linked To TUM

C1-USAGEQ2

F1-DE-QUERY

Usage ID

C1-USGINTVDS

F1-MAPEXPL

Usage Interval Overlay

C1-VALSSA

F1-DE-SINGLE

Get Sub SA Type SPR for Master SA

C1_ACCTTREE

SIMPLE

Account Tree

C1_BP_TREE

SIMPLE

Bill/Payment Tree

C1_PP_TREE

SIMPLE

Pay Plan Tree

C1_PREMTREE

SIMPLE

Premise Tree

KC1-GETEXTSR

F1-DE-SINGLE

Retrieve Ext Service Req Ind from SP Type

Upgrades to the Oracle Utilities Application Framework 4.2.0.2 Database

This section describes the database upgrade process for the Oracle Utilities Application Framework database from V4.2.0.1 to V4.2.0 Service Pack 2 (v4.2.0.2). It highlights changes made to the administrative tables and how those changes should be applied to the data in order for your current database to work with the V4.2.0.2 application, and to preserve the business logic implemented in the previous version of the application. The changes that do not require data upgrade are not described in this document. The tasks that need to be performed after running the upgrade scripts are included.

The added functionality of V4.2.0.2 is not the scope of this documentation. The upgrade scripts do not turn on the newly added functionality by default. For new functionality, refer the V4.2.0.2 User Guides. In the last section of this appendix, you will find a list of the new tables that are added in V4.2.0.2.

This section includes:

•

Automatic Data Upgrade

•

Schema Change

•

New System Data

Automatic Data Upgrade

This section describes what the upgrade script will populate in new tables and columns to preserve the existing base product application functions of the previous version of Oracle Utilities Application Framework.

Long Context Value on XAI Receiver

A new field Context Value Long (F1_CTXT_VAL_LONG) is added to XAI Receiver Table (CI_XAI_RCVR_CTX). This new field is a longer version of the existing field CTXT_VAL. CTXT_VAL which supported only 50 characters. To accommodate long encryption key generated by the Java key generator for keystore, the new column is added on the XAI Receiver Table to store the encrypted key. The existing column CTXT_VAL on this table would be unsupported. For this to be possible, as a part of upgrade script, all the current data in CTXT_VAL column would be updated into F1_CTXT_VAL_LONG column. The CTXT_VAL is deprecated and will be dropped in subsequent release.

Schema Change

New Tables

The following new tables are added to Oracle Utilities Application Framework.

Tables

Description

F1_BKT_CONFIG

Bucket Configuration

F1_BKT_CONFIG_L

Bucket Configuration Language

F1_BKT_CONFIG_REL_OBJ

Bucket Configuration Related Object

F1_BKT_CONFIG_VAL

Bucket Configuration Value

F1_BKT_CONFIG_VAL_L

Bucket Configuration Value Language

F1_IWS_ANN

Inbound Web Service Annotation

F1_IWS_ANN_CHAR

Inbound Web Service Annotation Characteristics

F1_IWS_ANN_L

Inbound Web Service Annotation Language

F1_IWS_ANN_PARM

Inbound Web Service Annotation Parameter

F1_IWS_ANN_TYPE

Inbound Web Service Annotation Type

F1_IWS_ANN_TYPE_CHAR

Inbound Web Service Annotation Type Characteristics

F1_IWS_ANN_TYPE_L

Inbound Web Service Annotation Type Language

F1_IWS_ANN_TYPE_PARM

Inbound Web Service Annotation Type Parm

F1_IWS_ANN_TYPE_PARM_L

Inbound Web Service Annotation Type Parameter Language

F1_IWS_SVC

Inbound Web Service

F1_IWS_SVC_ANN

Inbound Web Service Link to Annotation

F1_IWS_SVC_CHAR

Inbound Web Service Characteristics

F1_IWS_SVC_L

Inbound Web Service Language

F1_IWS_SVC_LOG

Inbound Web Service Log

F1_IWS_SVC_LOG_PARM

Inbound Web Service Log Parameter

F1_IWS_SVC_OPER

Inbound Web Service Operations

F1_IWS_SVC_OPER_L

Inbound Web Service Operations Language

F1_MAP_OVRD

UI Map Override

New Views

None

Dropped Tables

None

Unsupported Tables

None

Added Columns

The following table columns are added to Oracle Utilities Application Framework.

Table

Column

Required

CI_XAI_RCVR_CTX

F1_CTXT_VAL_LONG

Y

Dropped Columns

None

Unsupported Table Columns

These columns will be deprecated in a future release.

•

CI_XAI_SNDR_CTX: CTXT_VAL column is not used.

Column Format Change

Table Name

Column Name

From

To

CI_XAI_JDBC_CON

DATABASE_PASSWORD

VARCHAR2:64

VARCHAR2:128

New System Data

This section lists the new system data that are added for business process configuration.

Algorithm Type

The following algorithm types are new to Oracle Utilities Application Framework V4.2.0.1.

Algorithm Type

Description

F1-ANPRMDFLT

Default required annotation parameters

F1-IWSACT

Mark Inbound Web Service for deployment/undeployment

F1-MIGBCI

Batch Control Import

F1-NOTRNLOG

Suppress Status Transition Messages

Algorithm

The following Algorithms are Oracle Utilities Application Framework owned system data in V4.2.0.1.

Algorithm

Description

F1-IWSDEPLOY

Mark for deployment

F1-IWSUNDEPL

Mark for undeployment

F1-MIGBCI

Batch Control Import

F1-NOTRNLOG

Suppress Status Transition Messages

F1-OVRDT-ALG

Date format (YYYY-MM-DD) validation for ad hoc Characteristic value

Application Service

The following application services are added after Oracle Utilities Application Framework v 4.2.0.1.

Application Service

Description

CILQTDCP

To Do Entry Creator for Business Service

F1-ANNTYPBOAS

Inbound Web Service Annotation Type BO

F1-BKTCONFIG

Bucket Configuration MO

F1ANN

Inbound Web Service Annotation MO

F1ANNBOAS

Inbound Web Service Annotation BO

F1ANNTPM

Inbound Web Service Annotation Type

F1ANNTPS

Inbound Web Service Annotation Type Query

F1ANNTYPS

Inbound Web Service Annotation Type Query

F1BKTCFG

Bucket Configuration

F1BKTCFQ

Bucket Configuration Query

F1IWSANM

Inbound Web Service Annotation

F1IWSDPL

Inbound Web Service Deployment

F1IWSDPLY

Inbound Web Service Deployment

F1IWSSVC

Inbound Web Service MO

F1IWSVCBOAS

Inbound Web Service BO

F1IWSVCP

Inbound Web Service

F1IWSVCS

Inbound Web Service Query

Access Mode Added to Application Service

None

Batch Control

The following batch controls are added.

Batch Control

Description

F1-NDPUR

Notification Download Purge

F1-TDPG

Purge Completed To Do Entries

Business Object

The following Business Objects are Oracle Utilities Application Framework owned system data in V4.2.0.1.

Business Object

Description

F1-BatchJob

Batch Job

F1-BooleanValues

Generic Boolean Values

F1-BucketConfigBundlingAddBO

Bundling Add BO for Bucket Configuration

F1-BucketConfigPhysicalBO

Physical BO for Bucket Configuration

F1-EnvironmentRefPhysicalBO

Physical BO for Environment Reference

F1-ExternalSystemPhysicalBO

Physical BO for External System

F1-InbWebSvcAnnotation

Inbound Web Service Annotation

F1-InbWebSvcAnnotationType

Inbound Web Service Annotation Type

F1-InboundWebService

Inbound Web Service

F1-LanguagePhysicalBO

Physical BO for Language

F1-MessageCategoryPhysicalBO

Physical BO for Message Category

F1-OutboundMsgTypePhysicalBO

Physical BO for Outbound Message Type

F1-RequestTypePhysicalBO

Physical BO for Request Type

F1-SchemaActionValues

Schema Action Values

F1-SchemaProtectKey

Schema Protect Key

F1-SeasonalTimeShiftPhysicalBO

Physical BO for Seasonal Time Shift

F1-SecurityTypePhysicalBO

Physical BO for Security Type

F1-ServiceProgramPhysicalBO

Physical BO for Service Program

F1-TabMenuPhysicalBO

Physical BO for Tab Menu

F1-UIPagePhysicalBO

Physical BO for UI Page

F1-WebServiceAdapterPhysicalBO

Physical BO for Web Service Adapter

F1-XAIAdapterPhysicalBO

Physical BO for XAI Adapter

F1-XAIFormatPhysicalBO

Physical BO for XAI Format

F1-XAIJMSConnectionPhysicalBO

Physical BO for XAI JMS Connection

F1-XAIReceiverPhysicalBO

Physical BO for XAI Receiver

F1-XAIRouteTypePhysicalBO

Physical Bo for XAI Route Type

F1-XAIRuleGroupPhysicalBO

Physical BO for XAI Rule Group

F1-XAISenderPhysicalBO

Physical BO for XAI Sender

F1-ZoneTypePhysicalBO

Physical BO for Zone Type

FK Reference

The following FK References are new to Oracle Utilities Application Framework V4.2.0.1.

FK Reference

Description

F1-BKCFG

Bucket Configuration

F1-IWSAN

Inbound Web Service Annotation

F1-IWSAT

Inbound Web Service Annotation Type

F1-IWSVC

Inbound Web Service

F1-IWSVS

cmw test schema info plugin

F1-LANG

Language

F1-MGO

Migration Object

F1-SEATM

Seasonal Time Shift

F1-SECTP

Security Type

F1-SSCSR

Service Script Search Zone

F1ENVREF

Environment Reference

F1IG-MO

MO Option - Maintenance Object Tables

F1JMSCON

JMS Connection

F1MB-BO

BO Option - Maintenance BPA Script

F1XAIRG

XAI Rule Group

F1XAIRTT

XAI Route Type

Lookups

The following Lookups are added to Oracle Utilities Application Framework V4.2.0.1.

Lookup Field Name

Field Value

Language

Description

ANN_TYPE_STATUS_FLG

F1AC

ENG

Active

ANN_TYPE_STATUS_FLG

F1IN

ENG

Inactive

BUS_OBJ_OPT_FLG

F1MB

ENG

Maintenance BPA Script

CHAR_ENTITY_FLG

F1IL

ENG

Inbound Web Service Log

CHAR_ENTITY_FLG

F1IW

ENG

Inbound Web Service

F1_IWS_STATUS_FLG

F1DP

ENG

Deployed

F1_IWS_STATUS_FLG

F1ER

ENG

Error

F1_IWS_STATUS_FLG

F1ND

ENG

Needs Deploy

F1_IWS_STATUS_FLG

F1NU

ENG

Needs Undeploy

F1_IWS_STATUS_FLG

F1UD

ENG

Undeployed

MAINT_OBJ_OPT_FLG

F1IG

ENG

Non-Migrated Table

MANAG_CONTENT_TYPE_FLG

F1HT

ENG

HTML

TD_ALL_DELETE_FLG

N

ENG

No

TD_ALL_DELETE_FLG

Y

ENG

Yes

XAI_OPTION_FLG

XSDC

ENG

XSD Compliance

Maintenance Object

The following maintenance objects are added in this release.

MO code

Description

F1-BKTCONFIG

Bucket Configuration

F1-IWSANN

Inbound Web Service Annotation

F1-IWSANNTYP

Inbound Web Service Annotation Type

F1-IWSSVC

Inbound Web Service

Script

The following scripts are owned by Oracle Utilities Application Framework and added in this release.

Script

Description

F1-AdRevCtrl

Revision Control

F1-BktCfgMnt

Bucket Configuration Maintenance

F1-ChkOut

Checked out object

F1-DflAnTPrm

Defaut required annotation parameters

F1-GetFkRef

Get foreign key reference information via a service script

F1-IwSvcMain

Inbound Web Service - Maintain

F1-IwsATMain

Inbound Web Service Annotation Type Maintenance

F1-IwsAct

Mark Inbound Webservice for deployment/undeployment

F1-IwsAnMain

Inbound Web Service Annotation Maintenance

F1-IwsSvcDtl

Popualate Service Staus

F1-IwsSvcPre

Populate Service Status

F1-NoTrnLog

Suppress logging of Maint Obj status transition messages

F1-NotifyUsr

Send Email Notification

F1-OVRD-VISI

Html Override Zone visibility script

F1-RevChkOut

Revision Control Check Out

F1-RevCtlFrc

Revision Control Fore Check-In

F1-RevCtrlSS

Revision Control Script

F1-SHOW-OVRD

Html Override Zone visibility script

F1-ValChkOut

Validate Check Out Query Filters

F1-VlChcFltr

Validate Check in Query Filters

F1-VlFrcFltr

Validate Force Check in / Restore Query Filters

F1LanchAtch

Launch Attachment

To do Type

None

Portal

The following portals are added in this release.

Portal

Description

F1ANNTPM

Inbound Web Service Annotation Type

F1ANNTPS

Inbound Web Service Annotation Type Query

F1BKTCFG

Bucket Configuration

F1BKTCFQ

Bucket Configuration Query

F1IWSANM

Inbound Web Service Annotation

F1IWSDPL

Inbound Web Service Deployment

F1IWSLP

Inbound Web Service Log

F1IWSVCP

Inbound Web Service

F1IWSVCS

Inbound Web Service Query

Portal Zone

The following Portal Zones are added in this release.

Portal

Zone

F1ANNTPM

F1-IWSANTDSP

F1ANNTPS

F1-ANNTYPEQ

F1BKTCFG

F1-BKTCFGDSP

F1BKTCFQ

F1-BKTCFQRY

F1IWSANM

F1-IWSANLST

F1IWSANM

F1-IWSANN

F1IWSDPL

F1-IWSDEPLOY

F1IWSDPL

F1-IWSDODPLY

F1IWSDPL

F1-IWSSVCM

F1IWSDPL

F1-IWSUNSYNC

F1IWSLP

F1IWSLG

F1IWSVCP

F1-IWSSVCM

F1IWSVCS

F1-IWSVCQ

F1_SCHEMA_MP

F1-HTML-OVRD

UI Map

The following UI Maps are Oracle Utilities Application Framework owned system data in this release.

Map

Description

F1-AttachmentFileSizeFormatter

Format the attachment file size

F1-BktCfgQueryByInformation

Bucket Configuration Info - Query Filter

F1-IWSDeploymentDetails

UIMAP to Display IWS Deployment Details

F1-InbWebServiceDeploymentZone

Inbound Web Service Deployment

F1-IwsAnnParametersDisplay

Inbound Web Service Annotation Parameters - Display

F1-IwsAnnParametersInput

Inbound Web Service Annotation Parameters - Input

F1-IwsOperationsDisplay

Inbound Web Service Operations - Display

F1-IwsOperationsInput

Inbound Web Service Operations - Input

F1-IwsSearchFilter

Inbound Web Service - Query Filters

F1-RevCntrlChkOutConfirm

Check out confirmation

F1-RevCntrlConfirm

Check in confirmation

F1-RevCntrlForceCheckinConfirm

Force Check in confirmation

F1-RevCntrlFrcChckInFilterMap

Revision Control Query Filter

F1-RevisionControlChkOutQryFlt

Revision Control Check Out - Query Filter

F1-RevisionControlQueryFilter

Revision Control Query Filter

F1-SE-RowFlatPropsDisplayMapFr

Row Flattening Attributes for Display

F1-SE-RowFlatPropsInputMapFr

Row Flattening Attributes for Input

XAI Inbound Service

There are no new XAI Inbound Services new to Oracle Utilities Application Framework V4.2.0.1.

Zone Type

None

Zone

The following new Zones are added to Oracle Utilities Application Framework V4.2.0.1.

Zone

Zone Type

Description

F1-ANNTPARMR

F1-DE-SINGLE

Retrieve Annotation Type Required Parameters

F1-ANNTPARMS

F1-DE-SINGLE

Retrieve Annotation Type Parameters

F1-ANNTPARMV

F1-DE-QUERY

Retrieve Annotation Type Parameters and Values

F1-ANNTYPEQ

F1-DE-MULQRY

Inbound Web Service Annotation Type Search

F1-ANNTYPEQ1

F1-DE-QUERY

Name / Description / Status

F1-ANNTYPEQ2

F1-DE-QUERY

Annotation / Parent / Java Package

F1-BKTCFGDSP

F1-MAPDERV

Bucket Configuration

F1-BKTCFGQ1

F1-DE-QUERY

Bucket Configuration Information

F1-BKTCFQRY

F1-DE-MULQRY

Bucket Configuration Search

F1-HTML-OVRD

F1-XMLEDITOR

Override HTML Editor

F1-IWSANLG

F1-DE

Inbound Web Service Annotation Log

F1-IWSANLST

F1-DE-SINGLE

Inbound Web Service Annotation List

F1-IWSANN

F1-MAPDERV

Inbound Web Service Annotation

F1-IWSANTDSP

F1-MAPDERV

Inbound Web Service Annotation Type

F1-IWSDEPLOY

F1-DE-SINGLE

Deployment Status

F1-IWSDODPLY

F1-MAPEXPL

Deploy Inbound Web Services

F1-IWSSCHS

F1-DE-MULQRY

Search for Schema/Schema Type Supported by IWS

F1-IWSSCHS1

F1-DE-QUERY

Search by Business Service

F1-IWSSCHS2

F1-DE-QUERY

Search by Service Script

F1-IWSSCHS3

F1-DE-QUERY

Search by Business Object

F1-IWSSVCM

F1-MAPDERV

Inbound Web Service

F1-IWSUNSYNC

F1-MAPEXPL

Inbound Web Services

F1-IWSVCQ

F1-DE-MULQRY

Inbound Web Service Search

F1-IWSVCQ1

F1-DE-QUERY

Name / Description / Status

F1-REVCONQRY

F1-DE-MULQRY

Revision Control Search

F1-REVCTRLQ

F1-DE-QUERY

Check In

F1-REVCTRLQ2

F1-DE-QUERY

Force Check In

F1-REVCTRLQ3

F1-DE-QUERY

Check Out

F1-SSCSRCH

F1-DE-QUERY

Service Script Search

F1-USREMAIL

F1-DE-SINGLE

Retrieve user's e-mail id

Upgrades to the Oracle Utilities Application Framework 4.2.0.1 Database

This section describes the database upgrade process for the Oracle Utilities Application Framework database from V4.2.0.0 to V4.2.0.1. It highlights changes made to the administrative tables and how those changes should be applied to the data in order for your current database to work with the V4.2.0.1 application, and to preserve the business logic implemented in the previous version of the application. The changes that do not require data upgrade are not described in this document. The tasks that need to be performed after running the upgrade scripts are included.

The added functionality of V4.2.0.1 is not the scope of this documentation. The upgrade scripts do not turn on the newly added functionality by default. For new functionality, refer the V4.2.0.1 User Guides. In the last section of this document you will find a list of the new tables that are added in V4.2.0.1.

This section includes:

•

Automatic Data Upgrade

•

Schema Change

•

New System Data

Automatic Data Upgrade

This section describes what the upgrade script will populate in new tables and columns to preserve the existing base product application functions of the previous version of Oracle Utilities Application Framework.

Java Class Generation for Lookups

From Oracle Utilities Application Framework 4.2.0 Service Pack 1 (v4.2.0.1) onwards, the system generates Java classes for all lookups. This requires that the Java names ("Java Field Name" and "Java Value Name") should be populated for all lookup fields and its values must be valid values. If this is not done, the generated classes would result in compile errors.

Oracle Utilities Application Framework has fixed all lookup field and its values so that no compilation errors occur when Artifact Generator generates these classes.

Oracle Utilities Application Framework delivers a set of SQLs, which when executed, populate the Java names on the fields and their values, if the field names and values were earlier missing.

New User-Friendly Schema Editor

From Oracle Utilities Application Framework 4.2.0 Service Pack 1 (v4.2.0.1) onwards, Oracle Utilities introduces a new schema editor called Schema Designer. The Schema Designer is a graphical tool used to maintain a schema. It is available for use on the Business Object, UI Map, Service Script and Data Area maintenance pages. It helps the user in defining a schema without the need for typing an XML document, and provides easy reference to schema element attributes and their default values.

Schema Change

New Tables

None

New Views

None

Dropped Tables

None

Unsupported Tables

None

Added Columns

None

Dropped Columns

None

Unsupported Table Columns

None

Column Format Change

None

New System Data

This section lists the new system data that are added for business process configuration.

Algorithm Type

The following algorithm types are new to Oracle Utilities Application Framework V4.2.0.1.

Algorithm Type

Description

F1-BAT-LVSVC

Batch Control Level of Service for Periodic Batch Jobs

F1-LDAPPREPR

Ldap Import callback to process data retreived from LDAP

Algorithm

The following Algorithms are Oracle Utilities Application Framework owned system data in V4.2.0.1.

Algorithm

Description

F1-BAT-LSDEF

Batch Level of Service Algorithm

F1-LDAPPREPR

LDAP Import Preprocess Sample Algorithm

Application Service

None

Access Mode Added to Application Service

None

Batch Control

None

Business Object

The following Business Objects are Oracle Utilities Application Framework owned system data in V4.2.0.1.

Business Object

Description

F1-SchemaBoolTrue

Schema Boolean True

F1-SchemaBooleanValues

Schema Boolean Values

F1-SchemaDataTypes

Field Element Data Types

F1-SchemaDefaultSysVariables

Default System Variables

F1-SchemaDefaultTypes

Default AttributeTypes

F1-SchemaDispNoneKey

Schema Display None Key

F1-SchemaDispNoneOperator

Schema Display None Operator

F1-SchemaElementSuppress

Schema Element Suppress

F1-SchemaElementVisibleOn

Schema Element Visible on

F1-SchemaFlatFieldRowValues

Flattened Field Row Values

F1-SchemaFlatRowType

Flattened Row Types

F1-SchemaListOrderBy

Schema List Order By

F1-SchemaPageActions

Schema Page Actions

F1-SchemaSearchBy

Schema Search by

F1-SchemaSectColumns

Schema Section Columns

F1-SchemaSelectKey

Schema Select Key

F1-SchemaXMLNameSpaces

Schema XML Name Spaces

FK Reference

The following FK References are new to Oracle Utilities Application Framework V4.2.0.1.

FK Reference

Description

F1-MOCFL

MO CLOB Field

F1-MOTBL

Table with Search Zone

F1EX-BO

BO Option - External System

Lookups

The following Lookups are added to Oracle Utilities Application Framework V4.2.0.1.

Lookup Field Name

Field Value

Language

Description

ALG_ENTITY_FLG

F1ES

ENG

Installation - Email Service

ALG_ENTITY_FLG

F1LP

ENG

Installation - Ldap Import Preprocess

ALG_ENTITY_FLG

F1LS

ENG

Batch - Level of Service

EXT_SYS_TYP_FLG

F1BC

ENG

Business Intelligence Configuration

F1BC_OPT_TYP_FLG

F1D1

ENG

External Data Source Indicator 1

F1BC_OPT_TYP_FLG

F1D2

ENG

External Data Source Indicator 2

F1_BATCH_CTRL_SEVT_FLG

F1LS

ENG

Get Level of Service

F1_BATCH_LEVEL_OF_SERVICE_FLG

DISA

ENG

Disabled

F1_BATCH_LEVEL_OF_SERVICE_FLG

ERRO

ENG

Error

F1_BATCH_LEVEL_OF_SERVICE_FLG

NORM

ENG

Normal

F1_BATCH_LEVEL_OF_SERVICE_FLG

WARN

ENG

Warning

F1_SVC_TASK_CL_FLG

WXSS

ENG

Self-Service

INS_ALG_ENTITY_FLG

F1ES

ENG

Email Service - Validate Attachments

INS_ALG_ENTITY_FLG

F1LP

ENG

Ldap Import Preprocess

MANAG_CONTENT_TYPE_FLG

F1HT

ENG

HTML

Maintenance Object

None.

Script

None

To do Type

None

Portal

None

Portal Zone

The following Portal Zones are added to V4.2.0.1

Portal

Zone

F1_SCHEMA_BS

F1-SE-GUI

F1_SCHEMA_DA

F1-SE-GUI

F1_SCHEMA_MP

F1-SE-GUI

F1_SCHEMA_SS

F1-SE-GUI

UI Map

The following UI Maps are Oracle Utilities Application Framework owned system data in V4.2.0.1.

Map

Description

F1-MoFldSearchFilter

Field Search by Mo Filter Area

F1-MoTblSearchFilter

Table Search by MO Filter Area

F1-SE-HideDefaultButtons

Hide Save and Cancel buttons

F1-SE-InputButtons

Apply schema node attribute changes

F1-SE-NestRowConditionalAtts

Nested Row conditional attributes

F1-SE-NestRowFlatPropsMapFr

Nested Row Flattening Attributes

F1-SE-RowConditionalAtts

Row conditional attributes

F1-SE-RowFilterFlatPropsMapFr

Row Filter Flattening Attributes

F1-SE-RowFlatPropsMapFr

Row Flattening Attributes Map Fragement

XAI Inbound Service

There are no new XAI Inbound Services new to Oracle Utilities Application Framework V4.2.0.1.

Zone Type

None

Zone

The following new Zones are added to Oracle Utilities Application Framework V4.2.0.1.

Zone

Zone Type

Description

F1-MOCLBFLDS

F1-DE-QUERY

Field (Clob) Search by Maintenance Object

F1-MOTBLS

F1-DE-QUERY

Table Search by Maintenance Object

F1-RETFCONFG

F1-DE-SINGLE

Retrieve Feature Config from Feature Type

F1-ZONSRCH

F1-DE-QUERY

Zone Code/ Description

F1_TBLFLDS

F1-DE-SINGLE

Table's field search

Upgrades to the Oracle Utilities Application Framework 4.2.0 Database

This document describes the database upgrade process for the Oracle Utilities Application Framework database from V2.2.0 Service Pack16 to V4.2.0. It highlights changes made to the administrative tables and how those changes should be applied to the data in order for your current database to work with the V4.2.0 application, and to preserve the business logic implemented in the previous version of the application. The changes that do not require data upgrade are not described in this document. The tasks that need to be performed after running the upgrade scripts are included.

The added functionality of V4.2.0 is not the scope of this documentation. The upgrade scripts do not turn on the newly added functionality by default. For new functionality, refer the V4.2.0 User Guides. In the last section of this document you will find a list of the new tables that are added in V4.2.0.

This section includes:

•

Automatic Data Upgrade

•

Schema Changes

•

New System Data

Automatic Data Upgrade

This section describes what the upgrade script will populate in new tables and columns to preserve the existing base product application functions of the previous version of Oracle Utilities Application Framework.

Display/Expand Zones in Portal

To allow the user to display or hide zones in the portal, we need to provide an extra field on the Field Maintenance Page of Portal Zone (CI_PORTAL_ZONE). The new field added to Portal Zone is called Display Switch (DISPLAY_SW ). It defines a display switch value of Y or N to display or hide a zone within the portal.

Also to allow the user to expand or collapse the zones in the portal, we need to provide an extra field on the Field Maintenance Page of Portal Zone. ). The new field added to Portal Zone is called Zone Collapsed Switch (ZONE_COLLAPSED_SW). It defines a Zone Collapsed switch value of Y or N to collapse or display a zone within the portal.

As a part of the Upgrade Process DISPLAY_SW is set to 'Y' and ZONE_COLLAPSED_SW is set to 'N'.

Long Userid Support

To support Long Userid other than the fixed 8 Character Userid, a new column External Userid (EXT_USER_ID) is added to the User Table (SC_USER) Table. The External Userid column has unique values and it is mapped to Userid (USER_ID). Users are authenticated using External Userid and there after the Userid would be used by the Application. The External Userid (EXT_USER_ID) would be populated as Userid (USER_ID) wherever the External Userid is not populated as a part of the Upgrade Process.

Long Context Value on XAI Sender

A new field Context Value Long (F1_CTXT_VAL_LONG) is added to XAI Sender Table (CI_XAI_SNDR_CTX). This new field is a longer version of the existing field CTXT_VAL. CTXT_VAL supports only 50 characters. To accommodate the long Value for the SOAP Action URL (for making third party web service calls) and long encrypted passwords, the new column is added on the XAI Sender Table. The existing column CTXT_VAL on this table would be unsupported. For this to be possible, as a part of upgrade script, all the current data in CTXT_VAL column would be updated into F1_CTXT_VAL_LONG column. There after the column CTXT_VAL would be updated with a single Blank.

Metadata For Translation

Two new Flags Translatable Flag (F1_TRANSLATABLE_FLG) and Extract for Translation Flag (F1_EXTRACT_TRANSLATION_FLG) are added to aid in Translation, which was originally handled in a Text file. Translatable Flag is added in CI_MD_FLD and indicates whether we translate the label on this field or not and the valid values are yes (F1YS) and no (F1NO). Extract for Translation Flag is added to CI_MD_TBL and CI_MD_TBL_FLD and has a valid values of yes (F1YS) and no (F1NO). A table or a table field, which is marked for extraction, would be included in the extraction process to be sent to WPTG. As a part of upgrade process the flag F1_TRANSLATABLE_FLGis defaulted to yes (F1YS) and F1_EXTRACT_TRANSLATION_FLGis defaulted to no (F1NO).

Online Help

To follow Oracle documentation standards, TUGBU Word documentation for CCB and Framework is converted into DITA XML format. This will involve Conversion of old word files and indexes to DITA xml, Online help generation using DITA open toolkit and Integration of the new online help with Framework. The DITA documentation architecture requires small individual topics that are built up into topic hierarchies. To support this for Help related Navigation keys in CI_MD_NAV Table, the URL (field- URL_OVRD) is updated based on the set naming strategy. The similar update script is added for HELP_TEXT_URL on CI_MD_TBL as well.

Performance Metadata Flags

Two new Flags Cache Flag (CACHE_FLG) and Key Validation Flag (KEY_VALIDATION_FLG) are added to the Metadata Table (CI_MD_TBL). The Cache FLGwill enable L2 Caching of the Tables and the Key Validation Flag determines if Key Uniqueness is being issued by Framework before Inserting into the database. The valid values for cache flag are not Cached (NONE) and cachedForBatch (BTCH). The valid values for key validation flag are always (ALL), never (NONE) and onlineOnly (ONLI). These Flags can be changed by CM. As a part of the upgrade process the Initial values for CACHE_FLGand KEY_VALIDATION_FLGwould be populated.

Precise Time for Holiday Dates

Two new Fields named Holiday Start Date (F1_HOLIDAY_START_DTTM) Holiday End Date (F1_HOLIDAY_END_DTTM) are added to the Metadata Table (CI_CAL_HOL). This will help in defining the holiday begin and end dates with time. This is different from the existing Holiday dates where we just specify the date. As a part of the upgrade process the field F1_HOLIDAY_START_DTTM would be populated with HOLIDAY_DT with Time as 00:00:00. For F1_HOLIDAY_END_DTTM the default value would be F1_HOLIDAY_START_DTTM+24 Hours.

Portal Display Rule

A new flag Allow User Configuration (USER_CONFIG_FLG) is added to the Portal Table (CI_PORTAL). User Configuration Flag indicates if a user is allowed to have individual control of the zones on this portal. This flag is defaulted to 'Y' for all existing Portals during the upgrade process. If the Override User Configuration flag on CI_PORTAL is Blank and Allow User Configuration Flag is set to Y, then display the Portal, else if it set to 'N' then the Portal should not get displayed.

Rownum in Explorer Zones

The number of Records retrieved by the Query in Data Explorer Zone Types would be limited. This is because the entire result is neither required to be displayed and nor required for downloads. The existing Zone Parameter Values for Zone Type-Data Explorer and Zone Type Parameter- NBROFROWS and ROWSTOEXPORT would be updated. As a part of upgrade process when Zone Parameter values do not exists then limitFetch=false would be set. For existing non-blank Zone Parameter values, limitFetch=false count=ZONE_PARM_VAL would be updated.

Script Eligibility Option

As a part of the Upgrade the Script Eligibility option for BPA Scripts is set to "Not Eligible" for Non-CM owned scripts. This will make sure that the product owned BPA script will not be visible through UI.

Search For Old Style Entities

Searches for old style entities design introduces new search zones and updates existing FK references with the new zone searches. As Zone Code is a Cmable column on CI_FK_REF Table so an upgrade script is used to update the new search zone code for the existing FKs where Zone code is not yet populated

Secure Business Services and Service Scripts

Application Services (APP_SVC_ID) is added to Business Service Table (F1_BUS_SVC). Based on the Application Service, the ability to execute a Business Service and a Service Script by different user groups would be controlled. As a part of upgrade process the APP_SVC_ID column for existing Business Services (F1_BUS_SVC) and Service scripts (CI_SCR) would be populated with a Default Application Service (F1-DFLTAPS) where there is no Application Service associated. The default Application Service would be added to all the existing User groups and the 'Execute' Access MODEon this Service would be granted to all the user groups.

Security On User Access

A new flag User Enable (USER_ENABLE_FLG) is added to user Table (SC_USER). The valid values are Enable (ENBL) and Disable (DSBL). When a user depart or is no longer associated with the system then the BO Web service after confirming the status of the user and immediately deny user access to all "authorized" application services when the user is disabled. As a part of the upgrade process the USER_ENABLE_FLGwill be set to 'ENBL' for the existing users in the Users table(SC_USER).

Support Child XML Storage

The child list elements are allowed to contain XML mappings to XML storage fields. The existing implementation of Business Objects storing any XML mapped fields under groups stored the field in the physical storage field as a top-level xml element. This may result in conflict in their storage. So the new Implementation will store the fields like so in the physical CLOB field. The existing Business Object schemas that exist will remain. As a part of Upgrade Process an attribute "fwRel="2" would be added to the root "schema" to provide backward compatibility to already existing Business Object schemas.

Nullable column support

We do support Nullable columns. This means that FW will write NULLs instead of a blank space or zero (for numeric columns). NULLABLE_SW (which already exists) on CI_MD_TBL_FLD is going to be used for this. If the REQUIRED_SW is 'N' and the NULLABLE_SW ='Y' then FW will write a NULL in that column. The artifact generator will create hibernate mapping files with appropriate parameters so that the OUAF hibernate mapping types will know whether a given property supports null value or not.

NULLABLE_SW has existed for a while, but has only been actually read and used for certain fields (dates, and some string and number foreign-key columns). This means that there is the possibility that there is incorrect meta-data for some columns, and that turning on this new feature that uses the suspect meta-data could result in incorrect behavior. As a part of upgrade script all existing Metadata will be fixed which will make sure that the existing tables will not get affected with this change.

This new feature of allowing null values to be stored on table columns will only be supported by Java maintained tables. Thus, enhancing any existing tables to use null columns must take place after ensuring that the tables are maintained directly by Java, and not COBOL code.

Date Time format for ext sys outbound msg type

To support different date time format for external system outbound, a new column date time format (DTTM_FORMAT_FLG) is added to the External System Outbound Message Type (F1_EXTSYS_OUTMSG_PROF) Table. The allowed values are F1OU and F1XS. The date time format (DTTM_FORMAT_FLG) would be populated as 'F1OU' (OUAF format) wherever the it is not populated as a part of the Upgrade Process.

Add char values to product owned char types

To support CM to add char values to product owned characteristic types, a new column custom switch (CUSTOM_SW) is added to char type (CI_CHAR_TYPE) table. The allowed values are customizable ('Y) and Non-customizable ('N'). As a part of upgrade process, CUSTOM_SW will be set as 'N' where this column is not populated.

Database Health Check

From FW420 we created a database health check utility. This feature is going to be shipped with Oracle Enterprise Manager. To support this, a new table named F1_DB_OBJECTS_REPO is introduced which will store metadata information which we do not store explicitly in our preexisting tables. An upgrade script added in FW 420 will add the metadata information about Indexes, Sequences and Triggers added by the customers into F1_DB_OBJECTS_REPO table.

Table Classification Flags

Two new Fields are added to CI_MD_TBL to make explicit Classification of Tables. First is table classification flag (TBL_CLASSIFICATION_FLG) and the second is table volume flag (TBL_VOLUME_FLG). The valid values for Table Classification flag are Admin System Table (F1AS), Admin Non System Table (F1AN), Master Table (F1MT), Transaction Table (F1TT) and Unclassified (F1UC). The valid values for Table Volume flag (which can be modified by the customer) are Low Volume (F1LV), Medium Volume (F1MV), High Volume (F1HV) and Unclassified (F1UC). The UI and the Metadata for these columns are also added. As a part of the upgrade script the Initial values would be populated in these columns.

Timed Batch Jobs

Two New flag Batch Control Type (F1_BATCH_CTRL_TYPE_FLG) and Batch Category Flag (F1_BATCH_CTGY_FLG) are added to Batch Control Table (CI_BATCH_CTRL). The valid values for F1_BATCH_CTRL_TYPE_FLGare Not Timed (F1NT) and Timed (F1TM). The valid values for F1_BATCH_CTGY_FLGare 'Ad Hoc', 'Conversion', 'Extract', 'Monitor' ,'Object Validation', 'Process What's Ready', 'Referential Integrity' and 'To Do Entry'. Along with this there are additional new columns added to the Batch Control Table. Based on this the batch controls will be automatically initialized on a timed basis. As a part of the upgrade process the F1_BATCH_CTRL_TYPE_FLGwill be set to 'F1NT' for the existing data in the Batch Control Table. Similarly the initial values for the column F1_BATCH_CTGY_FLG(which customer can Modify) would be populated.

Update Zone Parameter

A new field Zone Parameter Value override (ZONE_PARM_VAL_OVRD) is added to zone parameter Table (CI_ZONE_PRM). The users would be able to override the existing value for Zone Parameter. For this to be possible, as a part of upgrade script, all Zone Type Parameters with usage as zone, which are not found in Zone parameter, a record needs to be inserted in Zone Parameter with Zone Parameter value as blank.

Schema Changes

New Tables

The following new tables are added to Oracle Utilities Application Framework V4.2.0.

Tables

Description

CI_BATCH_CTRL_ALG

Batch Control Algorithm

F1_ATTACHMENT

Attachment

F1_ATTACHMENT_CHAR

Attachment Characteristics

F1_BUS_OBJ_STATUS_RSN

Status Reason

F1_BUS_OBJ_STATUS_RSN_CHAR

Status Reason Characteristic

F1_BUS_OBJ_STATUS_RSN_L

Status Reason Language

F1_DB_OBJECTS_REPO

Database Objects Repository

F1_EXT_LOOKUP_VAL

Extendable Lookup

F1_EXT_LOOKUP_VAL_L

Extendable Lookup Language

F1_GENERIC_GTT

Generic Global Temporary Table

F1_GEN_PROC

General Process

F1_GEN_PROC_K

General Process Key Table

F1_MANAG_CONTENT

Managed Content

F1_MANAG_CONTENT_L

Managed Content Language

F1_MIGR_DATA_ST

Migration Data Set

F1_MIGR_DATA_ST_ALG

Migration Data Set Algorithm

F1_MIGR_DATA_ST_K

Migration Data Set Key

F1_MIGR_DATA_ST_LOG

Migration Data Set Log

F1_MIGR_DATA_ST_LOG_PARM

Migration Data Set Log Parameter

F1_MIGR_DATA_ST_TBL

Migration Data Set Table

F1_MIGR_OBJ

Migration Object

F1_MIGR_OBJ_ALG

Migration Object Algorithm

F1_MIGR_OBJ_CLOB

Migration Object CLOB

F1_MIGR_OBJ_K

Migration Object Key

F1_MIGR_OBJ_LOG

Migration Object Log

F1_MIGR_OBJ_LOG_PARM

Migration Object Log Parameter

F1_MIGR_OBJ_SQL

Migration Object SQL

F1_MIGR_PLAN

Migration Plan

F1_MIGR_PLAN_INSTR

Migration Plan Instruction

F1_MIGR_PLAN_INSTR_ALG

Migration Plan Instruction Algorithm

F1_MIGR_PLAN_INSTR_L

Migration Plan Instruction Language

F1_MIGR_PLAN_L

Migration Plan Language

F1_MIGR_REQ

Migration Request

F1_MIGR_REQ_INSTR

Migration Request Instruction

F1_MIGR_REQ_INSTR_ENTITY

Migration Request Instruction Entity

F1_MIGR_REQ_INSTR_L

Migration Request Instruction Language

F1_MIGR_REQ_L

Migration Request Language

F1_MIGR_TRANS

Migration Transaction

F1_MIGR_TRANS_K

Migration Transaction Key

F1_MIGR_TRANS_LOG

Migration Transaction Log

F1_MIGR_TRANS_LOG_PARM

Migration Transaction Log Parameter

F1_REQ

Request

F1_REQ_K

Request Key

F1_REQ_LOG

Request Log

F1_REQ_LOG_PARM

Request Log Parameters

F1_REQ_TYPE

Request Type

F1_REQ_TYPE_L

Request Type Language

F1_REQ_TYPE_LOG

Request Type Log

F1_REQ_TYPE_LOG_PARM

Request Type Log Parameters

F1_SVC_TASK

Service Task

F1_SVC_TASK_CHAR

Service Task Characteristics

F1_SVC_TASK_K

Service Task Key

F1_SVC_TASK_LOG

Service Task Log

F1_SVC_TASK_LOG_PARM

Service Task Log Parameters

F1_SVC_TASK_REL_OBJ

Service Task Related Objects

F1_SVC_TASK_TYPE

Service Task Type

F1_SVC_TASK_TYPE_CHAR

Service Task Type Characteristics

F1_SVC_TASK_TYPE_L

Service Task Type Language

F1_SYNC_REQ

Sync Request

F1_SYNC_REQ_CHAR

Sync Request Characteristic

F1_SYNC_REQ_EXTRACT

Sync Request Extract

F1_SYNC_REQ_IN

Inbound Sync Request

F1_SYNC_REQ_IN_CHAR

Inbound Sync Request Characteristic

F1_SYNC_REQ_IN_EXCP

Inbound Sync Request Exception

F1_SYNC_REQ_IN_EXCP_PARM

Inbound Sync Request Exception Parameters

F1_SYNC_REQ_IN_K

Inbound Sync Request Key Table

F1_SYNC_REQ_IN_LOG

Inbound Sync Request Log

F1_SYNC_REQ_IN_LOG_PARM

Inbound Sync Request Log Parameter

F1_SYNC_REQ_IN_REL_OBJ

Inbound Sync Request Related Object

F1_SYNC_REQ_K

Sync Request Key Table

F1_SYNC_REQ_LOG

Sync Request Log

F1_SYNC_REQ_LOG_PARM

Sync Request Log Parameter

F1_WEB_SVC

Web Service Adapter

F1_WEB_SVC_CHAR

Web Service Adapter Characteristics

F1_WEB_SVC_GTT

Web Services Global Temporary Table

F1_WEB_SVC_L

Web Service Adapter Language

F1_WEB_SVC_LOG

Web Service Adapter Log

F1_WEB_SVC_LOG_PARM

Web Service Adapter Log Parameter

F1_WEB_SVC_OPERATIONS

Web Service Adapter Operations

New Views

View

Description

CI_USR_ACC_GRP_VW

Access Group by User View

F1_ATTACHMENT_VW

Attachment View

Dropped Tables

CI_MD_LOOKUP

CI_MODULE

CI_SCR_STEP_K

CI_XAI_SVC_VERS

CI_XAI_SVC_VERS_L

Unsupported Tables

None

Added Columns

The following Table Columns are added to Oracle Utilities Application Framework V4.2.0.

Table

Column

Required

CI_BATCH_CTRL

BATCH_LANGUAGE_CD

N

CI_BATCH_CTRL

BATCH_THREAD_CNT

N

CI_BATCH_CTRL

EMAILID

N

CI_BATCH_CTRL

F1_BATCH_CTGY_FLG

N

CI_BATCH_CTRL

F1_BATCH_CTRL_TYPE_FLG

Y

CI_BATCH_CTRL

F1_TIMER_ACTIVE_FLG

N

CI_BATCH_CTRL

MAX_COMMIT_RECS

N

CI_BATCH_CTRL

TIMER_INTERVAL

N

CI_BATCH_CTRL

TRC_PGM_END_SW

N

CI_BATCH_CTRL

TRC_PGM_STRT_SW

N

CI_BATCH_CTRL

TRC_SQL_SW

N

CI_BATCH_CTRL

TRC_STD_SW

N

CI_BATCH_CTRL

USER_ID

N

CI_BATCH_JOB

BATCH_NBR

N

CI_CAL_HOL

F1_HOLIDAY_END_DTTM

Y

CI_CAL_HOL

F1_HOLIDAY_START_DTTM

Y

CI_CHAR_TYPE

CUSTOM_SW

Y

CI_FK_REF

ZONE_CD

N

CI_INSTALL_PROD

PROD_TYPE_FLG

N

CI_MD_FLD

F1_TRANSLATABLE_FLG

Y

CI_MD_FLD

F1_TRANSLATION_CONTEXT

N

CI_MD_FLD_L

DESCRLONG_OVRD

N

CI_MD_MENU_ITEM

ACCESS_MODE

N

CI_MD_MENU_ITEM

APP_SVC_ID

N

CI_MD_TBL

CACHE_FLG

Y

CI_MD_TBL

F1_EXTRACT_TRANSLATION_FLG

Y

CI_MD_TBL

F1_TRANSLATION_CONTEXT

N

CI_MD_TBL

KEY_VALIDATION_FLG

Y

CI_MD_TBL

TBL_CLASSIFICATION_FLG

Y

CI_MD_TBL

TBL_VOLUME_FLG

Y

CI_MD_TBL_FLD

F1_EXTRACT_TRANSLATION_FLG

Y

CI_MD_TBL_FLD

F1_TRANSLATION_CONTEXT

N

CI_MSG

F1_TRANSLATION_CONTEXT

N

CI_PORTAL

USER_CONFIG_FLG

Y

CI_PORTAL_ZONE

DISPLAY_SW

Y

CI_PORTAL_ZONE

SORT_SEQ

N

CI_PORTAL_ZONE

SORT_SEQ_OVRD

N

CI_PORTAL_ZONE

ZONE_COLLAPSED_SW

Y

CI_PORTAL_ZONE

ZONE_REFRESH_PERIOD

N

CI_SYSDATA_LOG

GROUP_FIX_NAME

N

CI_TIME_ZONE

F1_TIMEZONE_NAME

N

CI_TIME_ZONE_L

DFLT_TIME_ZONE_LABEL

N

CI_TIME_ZONE_L

SHIFT_TIME_ZONE_LABEL

N

CI_USR_ZONE

ZONE_DATA_AREA

N

CI_USR_ZONE

ZONE_REFRESH_PERIOD

N

CI_XAI_RCVR_CTX

F1_CTXT_VAL_LONG

Y

CI_XAI_SNDR_CTX

F1_CTXT_VAL_LONG

Y

CI_ZONE_L

DESCRLONG_OVRD

N

CI_ZONE_PRM

ZONE_PARM_VAL_OVRD

N

Dropped Columns

Table Name

Column Name

CI_SCR_PRMPT

SCR_STEP_ID

CI_SCR_STEP_L

SCR_STEP_ID

F1_MAP_L

HTML_DEFN

CI_SCR_PRMPT_L

SCR_STEP_ID

CI_XAI_IN_SVC_L

DESCR254

CI_XAI_IN_SVC

XAI_VERSION_ID

CI_SCR_STEP

SCR_STEP_ID

CI_XAI_JDBC_CO

DATABASE_NAME

CI_SCR_FLD_MAP

SCR_STEP_ID

CI_XAI_SNDR_CTX

CTXT_VAL

Unsupported Table Columns

None

Column Format Change

Table Name

Column Name

From

To

CI_ALG_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_ALG_TYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_ARC_ROOT_PK

FIELD_VAL

VARCHAR2:50

VARCHAR2:254

CI_BATCH_CTRL_P_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_DATA_DIFF

DATA_DIFF_INFO

VARCHAR2:200

VARCHAR2:512

CI_DATA_DIFF_PK

FIELD_VAL

VARCHAR2:50

VARCHAR2:254

CI_MD_MENU_ITEM_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_MD_MENU_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_MSG_L

MESSAGE_TEXT

VARCHAR2:100

VARCHAR2:254

CI_MSG_L

MESSAGE_TEXT_OVRD

VARCHAR2:100

VARCHAR2:254

CI_NT_DWN_PROF_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_DWN_TYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_UP_XTYPE_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_NT_XID_L

DESCR50

VARCHAR2:50

VARCHAR2:100

CI_ROOT_OBJ_PK

FIELD_VAL

VARCHAR2:50

VARCHAR2:254

New System Data

This section lists the new system data that are added for business process configuration.

Algorithm Type

The following algorithm types are new to V4.2.0.

Algorithm Type

Description

F1-ACTIVEWS

Web Service - Verify Active Operations

F1-ATCHM-INF

Attachment Information

F1-BOSTATFS

Take BO Status/Reason Final Snapshot

F1-CMPSNAPSR

Compare Initial and Final Snapshot, with Status Reason

F1-COMPSNAPS

Compare Initial and Final Snapshot, with Discard Reason

F1-DECRT-INF

Decision Report Information

F1-EXTL-CDCP

Extendable Lookup Change Data Capture

F1-FINALSNAP

Take Final Snapshot

F1-GCHG-CDCP

Generic Change Data Capture

F1-GEN-BOMNJ

Generic Business Object Status Monitor Java

F1-GENPRINFO

Maintenance Object - Information

F1-INITSNAPS

Take Initial Snapshot

F1-LDAPIMPRT

Ldap Import callback after manipulating user, group, or membership

F1-MGDEXPCMB

Migration Data Set Export - Combine Transactions

F1-MGDEXPSET

Migration Data Set Export - Set Up Data

F1-MGDEXPWRF

Migration Data Set Export - Write File

F1-MGDIMPAPP

Migration Data Set Import - Apply Changes

F1-MGDIMPCMP

Migration Data Set Import - Comparing Objects

F1-MGDIMPR2C

Migration Data Set Import - Ready to Compare

F1-MGDIMPRDY

Migration Data Set Import - Ready to Apply

F1-MGOEXPADT

Migration Object Export - Add Table Data

F1-MGOGENSQL

Generate SQLs for the migration object

F1-MGOIMPAPP

Migration Object Import - Apply Changes

F1-MGOIMPNRV

Migration Object Import - Needs Review

F1-MGPINFO

Migration Plan Information

F1-MGTCMP

Compare migration objects in the transaction

F1-MGTEXPADO

Migration Transaction Export - Add Objects

F1-MGTIMPAPP

Migration Transaction Import - Apply Changes

F1-MIGDEXP

Migration Data Set Export Information Algorithm Type

F1-MTR-EM

To Do Summary Email Monitor

F1-ORAGEOCD

Oracle Spatial Geocoding

F1-PRPETDATA

Prepare Extract Data

F1-REQ-INF

Request Information

F1-REQTY-VAL

Request Type Validation

F1-SMSSEND

Send SMS Message Using Oracle BPEL

F1-SYNC-INFO

Sync Information

F1-SYNRCLREX

Clear Exceptions on Sync Request

F1-TD-SM-EM

Email Users on Outstanding To Dos

F1-TODORETRY

Retry for To Dos

F1-TRNDF-CS

Transition to Default Next State if Custom Snapshot is False

F1-WAITFRSRE

Wait for Finalized Related Sync Request to be Extracted

F1-WAITRELSR

Wait For Related Sync To Complete

Algorithm

The following Algorithms are Framework Owned system data in V4.2.0.

Algorithm

Description

F1-ACTIVEWS

Web Service - Verify Active Operations

F1-AT-RQ

Transition to Default Next Status (Script)

F1-AT-RQJ

Transition to Default Next Status (Java)

F1-ATCHM-INF

Attachment Information

F1-BOSTATFS

Take BO Status/Reason Final Snapshot

F1-CMPSNAPSR

Compare Sync Request Snapshots, populate status reason if discarded

F1-COMPSNAPS

Compare Initial and Final Snapshots

F1-DECRT-INF

Decision Report Information

F1-FINALSNAP

Take Final Snapshot

F1-GCHG-CDCP

Generic Change Data Capture

F1-GENPRINFO

General Process

F1-INITSNAPS

Take Initial Snapshot

F1-LDAPIMPRT

LDAP Import Sample Algorithm

F1-MGDEXPCMB

Migration Data Set Export - Combine Transactions

F1-MGDEXPSET

Migration Data Set Export - Set Up Data

F1-MGDEXPWRF

Migration Data Set Export - Write File

F1-MGDIMPAPP

Migration Data Set Import - Apply Changes

F1-MGDIMPCMP

Migration Data Set Import - Comparing Objects

F1-MGDIMPR2C

Migration Data Set Import - Ready to Compare

F1-MGDIMPRDY

Migration Data Set Import - Ready to Apply

F1-MGOEXPADT

Migration Object Export - Add Table Data

F1-MGOGENSQL

Generate SQLs for the migration object

F1-MGOIMPAPP

Migration Object Import - Apply Changes

F1-MGOIMPNRV

Migration Object Import - Needs Review

F1-MGPINFO

Migration Plan Information

F1-MGTCMP

Compare migration objects in the transaction

F1-MGTEXPADO

Migration Transaction Export - Add Objects

F1-MGTIMPAPP

Migration Transaction Import - Apply Changes

F1-MIGDEXP

Migration Data Set Export Information Algorithm

F1-MTR-EM

To Do Summary Email Monitor

F1-ORAGEOCD

Oracle Spatial Geocoding

F1-PRPETDATA

Prepare Extract Data

F1-REQ-INF

Request Information

F1-REQTY-VAL

Request Type Validation

F1-SMSSNDBPL

Oracle SMS Send

F1-SYNC-INFO

Sync Information

F1-SYNRCLREX

Clear Exceptions on Sync Request

F1-TD-SM-EM

Email Users on Outstanding To Dos

F1-TODOCOMPL

Generic To Do Completion

F1-TRN-DF-NS

Generic Business Object Status Monitor

F1-TRNDF-CS

Transition to Default Next State if Custom Snapshot is False

F1-WAITFRSRE

Wait for Finalized Related Sync Request to be Extracted

F1-WAITRELSR

Wait For Related Sync To Complete

Application Service

The following Application Services are new to V4.2.0.

Application Service

Description

F1-APAYEXPCRTYPEBOAS

Request Type - To Do Summary Email Type

F1-ATTACHMENTBOAS

Attachment Based BO

F1-DECRPTBOAS

Decision Report BO

F1-EXPUSERSREQBOAS

Request - To Do Summary Email BO

F1-GENPROC

General Process MO

F1-MIGROBJBOAS

Migration Object Export BO

F1-MIGROBJIMP

Migration Object Import BO

F1-MIGRTXBOAS

Migration Transaction Export BO

F1-STASKTYPE

Service Task Type MO

F1-SVCTASK

Service Task MO

F1-SYNCREQ

Sync Request MO

F1-SYNCREQIN

Inbound Sync Request MO

F1-SYNCREQUESTBOAS

Sync Request BO

F1-WEBSVCBOAS

Web Service Adapter BO

F1ADMIN

System Admin Functions via Browser Client

F1APPSEC

Application Security Portal

F1ATTACH

Attachment Information

F1ATTACHMENT

Attachment

F1BTCLSP

Batch Cluster

F1CATTCH

Attachment Search Portal

F1CLTHDP

Batch Cluster Thread Details

F1CLUSTP

Batch Cluster

F1CONFIGLOG

Show User Config Log (Debugging Tool)

F1DEBUG

Debug Option Access via Browser Client

F1EMHLAU

Embedded Help Portal

F1EXLKP

Extendable Lookup Portal

F1EXLKPS

Extendable Lookup Query Portal

F1LCAMRP

Request MO

F1LEXTLKUP

Extended Lookup Value MO

F1LTAMTP

Request Type MO

F1MGDEXP

Migration Data Set Export

F1MGDEXS

Migration Data Set Export Query

F1MGDIMP

Migration Data Set Import

F1MGDIMS

Migration Data Set Import Query

F1MGOIMP

Migration Object Import

F1MGPLNM

Migration Plan

F1MGPLNS

Migration Plan Query

F1MGREQM

Migration Request

F1MGREQS

Migration Request Query

F1MIGRDEXP

Migration Data Set Export BO

F1MIGRDIMP

Migration Data Set Import BO

F1MIGRDS

Migration Data Set MO

F1MIGROBJ

Migration Object MO

F1MIGRPLAN

Migration Plan MO

F1MIGRREQ

Migration Request MO

F1MIGRTIMP

Migration Transaction Import BO

F1MIGRTX

Migration Transaction MO

F1MTXIMP

Migration Transaction Import

F1REQ

Request Portal

F1REQTYP

Request Type Portal

F1STRDIS

Status Reason Display Portal

F1STREAS

Status Reason Portal

F1SUBRQQ

Request Query Portal

F1SYNCRM

Sync Request Portal

F1SYNCRQ

Sync Request Query Portal

F1TBLEXC

Translatable Strings Exceeding Capacity

F1UIZONE

Context Sensitive Zone

F1WBSVCM

Web Service Adapter

F1WBSVCS

Web Service Adapter Query Portal

F1WEBSVC

Web Service

F1_BTST

Batch Run Statistics Portal

FWLSTRJP

Status Reason MO

FWLTMGCT

Managed Content

Access MODEAdded to Application Service

The following Access MODEis added to existing Application Services and is new to V4.2.0.

Application Service

Description

Access Mode

CILTUSEP

User

Enable/Disable (ENBL)

CILTWSDP

Feature Configuration

Super User (F1SU)

Batch Control

The following Batch Controls are new to V4.2.0.

Batch Control

Description

F1-ARQPR

Request Monitor

F1-LKPIL

Standard Lookup Initial Load

F1-MGDPR

Migration Data Set Monitor

F1-REQTY

Request Type Monitor

F1-SAKRQ

Sync Request Allocate Keys Monitor

F1-SRLRQ

Sync Request Load Records Monitor

F1-STKDF

Service Task Monitor (Deferred)

F1-STKTR

Service Task Monitor

F1-SUBRQ

Request Monitor (Deferred)

F1-SYNEF

Sync Request Extract

F1-SYNIL

Sync Request Initial Load

F1-SYNRQ

Sync Request Monitor

F1-SYSRQ

Sync Request Monitor (Deferred)

LDAPIMP

ZZ Ldap Import Example

WX-NOTIF

Self-Service Notification Monitor

Business Object

The following Business Objects are Framework Owned system data in V4.2.0.

Business Object

Description

F1-AccessGroupPhysicalBO

Physical BO for Access Group

F1-BIGeneralMasterConfig

Generic BI Configuration

F1-BOStatusReason

Status Reason

F1-BatchRunStatistics

Batch Run Statistics Snapshot

F1-COUNTRY

Country

F1-ContextZonePhysicalBO

Physical BO for Context Sensitive Zone

F1-CountryPhysicalBO

Physical BO for Country

F1-CurrencyCodePhysicalBO

Physical BO for a Currency Code

F1-DataAccessSCPhysicalBO

Physical BO for Data Access Role-no users

F1-DecRpt

Decision Report

F1-DisplayProfilePhysicalBO

Physical BO for Display Profile

F1-ExcelSpreadsheet

Excel Spreadsheet

F1-ExtLkpPhysicalBO

Physical BO for Extended Lookup

F1-GenericAttachment

Generic attachment - schema only

F1-GenericBISyncRequest

Generic BI Sync Request

F1-GeographicTypePhysicalBO

Physical BO for Geographic Type

F1-InstallAlgorithmPhysicalBO

Physical BO for Installation Algorithm

F1-Installation

Installation Options - Framework

F1-JpegImage

Jpeg Image

F1-MORevisionControl

MO - Enable/Disable Revision Control

F1-ManagedContPhysicalBO

Physical BO for Managed Content

F1-MicrosoftVideo

Microsoft Video

F1-MigrDataSetExport

Migration Data Set Export

F1-MigrDataSetImport

Migration Data Set Import

F1-MigrObjectExport

Migration Object Export

F1-MigrObjectImport

Migration Object Import

F1-MigrPlan

Migration Plan

F1-MigrPlanBundlingAddBO

Physical BO for Migration Plan

F1-MigrPlanPhysicalBO

Physical BO for Migration Plan

F1-MigrReq

Migration Request

F1-MigrRequestPhysicalBO

Physical BO for Migration Request

F1-MigrTransactionExport

Migration Transaction Export

F1-MigrTransactionImport

Migration Transaction Import

F1-MigrationAssistantConfig

Migration Assistant Configuration

F1-Mp3Audio

MP3 Audio

F1-OpaWebSvc

Rulebase Web Service Adapter

F1-OutcomeStyleLookup

Outcome Style

F1-PDF

PDF Document

F1-PhoneTypePhysicalBO

Physical BO for Phone Type

F1-ReportPhysicalBO

Physical BO for Report

F1-SchemaNodes

Graphical Schema Editor Control

F1-ServiceTaskTypeBundlingAdd

Bundling Add BO for Service Task Type

F1-ServiceTaskTypePhysical

Physical BO for Service Task Type

F1-StatusReasonPhysicalBO

Physical BO for Status Reason

F1-SyncCfgBO

Master Data Synchronization Configuration

F1-SyncRequest

Sync Request

F1-SyncRequestMO

Sync Request Determine MO

F1-Text

Text Document

F1-TimeZonePhysicalBO

Physical BO for Time Zone

F1-ToDoRoleSCPhysicalBO

Physical BO for To-Do Role SC (no users)

F1-ToDoTypePhysicalBO

Physical BO for To Do Type

F1-TodoSumEmailReq

To Do Summary Email Request

F1-TodoSumEmailTyp

To Do Summary Email

F1-User

User

F1-UserGroupPhysicalBO

Physical BO for User Group

F1-UserPhysicalBO

Physical BO for User

F1-UserSCPhysicalBO

Physical BO for User-SC (no user groups)

F1-VideoMPEG

Video MPEG

F1-WavAudio

Wav Audio

F1-WebSvc

Web Service Adapter

F1-WordDocument

Word Document

F1-WorkCalendarPhysicalBO

Physical BO for Work Calendar

F1-XAI_Inbound_Service

XAI Inbound Service

FK Reference

The following FK References are new to V4.2.0.

FK Reference

Description

C1-BOMO

Business Objects for MO

F1-ACCGP

Access Group

F1-ACTTY

Request Type

F1-ATCHB

Common Attachments Business Object

F1-ATCHI

Attachment Information

F1-ATHVW

Attachment View

F1-BOMO

Business Object

F1-BOSRC

BO with Search Zone

F1-BTCCT

Batch Control w/ context menu

F1-BUS

Business Object

F1-CAL

Work Calendar

F1-CHARV

Characteristic Value

F1-CNSTR

Constraint

F1-CNTRY

Country

F1-CTXZN

Context Sensitive Zone

F1-CURCY

Currency

F1-DASRC

Data Area with Search Zone

F1-DISPR

Display Profile

F1-ESSRC

External System with Search Zone

F1-EXLKP

Extendable Lookup value list

F1-EXLKU

Extendable Lookup

F1-FKSRC

Foreign Key Reference with Search Zone

F1-GENPR

General Process

F1-MANCT

Managed Content

F1-MDSO

Meta-data Search Object

F1-MGDEX

Migration Data Set Export

F1-MGDIM

Migration Data Set Import

F1-MGPLN

Migration Plan

F1-MGREQ

Migration Request

F1-MGTIM

Migration Transaction Import

F1-MOFLD

MO Field

F1-MOSRC

MO with Search Zone

F1-PHONE

Phone Type

F1-REQTY

Request Type

F1-SCSRC

Script with Search Zone

F1-STASK

Service Task

F1-STKTY

Service Task Type

F1-STRDS

Status Reason Display

F1-STRSN

Status Reason

F1-SUBRQ

Request

F1-SYNRQ

Sync Request

F1-TBSRC

Table with Search Zone

F1-TZONE

Time Zone

F1-UISRC

UI Map with Search Zone

F1-USSRC

User Id With Search Zone

F1-WBSVC

Web Service Adapter

F1-XAIAD

XAI Adapter

F1-XAICL

XAI Class

F1-XAIEH

XAI Envelope Handler

F1-XAIEX

XAI Executer

F1-XAIFM

XAI Format

F1-XAIRC

XAI Receiver

F1-XAISV

XAI Inbound Service

F1-ZONHD

Zone Type

F1ATTACH

Attachment Information Display

F1BO-BO

BO Option - Business Object to Read

F1DA-BO

BO Options - Snapshot Data Area

F1DATAC

Data Access Role

F1ET-BO

BO Options - Batch Process for Extract

F1GEOTYP

Geographic Type

F1INSALG

Installation Algorithm

F1MC-BO

BO Option - Managed Content XSL

F1MP-BO

Business Service

F1OM-BO

BO Option - Outbound Message Type

F1PD-BO

BO Option - Request Preview Script

F1PS-BO

BO Option - Post Script For Extract

F1PV-BO

BO Option - Request Preview Map

F1SB-MO

MO Option - Sync Request BO

F1SR-BO

BO Option - Status Reason Business Object

F1SR-MO

MO Option - Status Reason

F1SY-BO

BO Option - Star Schema Type

F1USRINF

User Id Info

Z1-MGPLN

Migration Plan

Lookups

The following Lookups are added to Oracle Utilities Application Framework V4.2.0.

Lookup Field Name

Field Value

Lang.

Description

ACCESS_MODE

ENBL

ENG

Enable/Disable

ACCESS_MODE

F1AA

ENG

Awaiting Acknowledgement

ACCESS_MODE

F1AC

ENG

Active

ACCESS_MODE

F1DC

ENG

Discarded

ACCESS_MODE

F1DS

ENG

Determine If Sync Needed

ACCESS_MODE

F1ER

ENG

Sync Error

ACCESS_MODE

F1IN

ENG

Inactive

ACCESS_MODE

F1MA

ENG

Migration Approved

ACCESS_MODE

F1MC

ENG

Migration Cancel Apply

ACCESS_MODE

F1MI

ENG

Migration Cannot Apply

ACCESS_MODE

F1MN

ENG

Migration Needs Review

ACCESS_MODE

F1MR

ENG

Migration Rejected

ACCESS_MODE

F1SR

ENG

Send Request

ACCESS_MODE

F1SU

ENG

Super User

ACCESS_MODE

F1SY

ENG

Synchronized

ACCESS_MODE

PE

ENG

Pending

ALG_ENTITY_FLG

F1GS

ENG

Installation - Address Geocoding

ALG_ENTITY_FLG

F1LD

ENG

Installation - Ldap Import

ALG_ENTITY_FLG

F1M1

ENG

Migration - Export

ALG_ENTITY_FLG

F1M2

ENG

Migration - Import

ALG_ENTITY_FLG

F1MS

ENG

Migration - Select

ALG_ENTITY_FLG

F1SE

ENG

Sync Request - Initial Load Eligibility

ALG_ENTITY_FLG

F1SF

ENG

Sync Request - Initial Load Filter

ALG_ENTITY_FLG

F1SR

ENG

Installation - SMS Receive

ALG_ENTITY_FLG

F1SS

ENG

Installation - SMS Send

ALG_PROC_TYPE_FLG

F1M1

ENG

Export

ALG_PROC_TYPE_FLG

F1M2

ENG

Import

BO_ACTION_FLG

RWOV

ENG

Read without Version

BO_OPT_FLG

F1MR

ENG

To Do Maximum Retries

BO_OPT_FLG

F1RF

ENG

To Do Retry Frequency

BO_TR_COND_FLG

F1NR

ENG

Needs Review

BUS_OBJ_OPT_FLG

F1BI

ENG

Binary

BUS_OBJ_OPT_FLG

F1BO

ENG

Business Object to Read

BUS_OBJ_OPT_FLG

F1CT

ENG

Content Type

BUS_OBJ_OPT_FLG

F1DA

ENG

Snapshot Data Area

BUS_OBJ_OPT_FLG

F1EP

ENG

Element Population Rule

BUS_OBJ_OPT_FLG

F1ET

ENG

Batch Process for Extract

BUS_OBJ_OPT_FLG

F1EX

ENG

External System

BUS_OBJ_OPT_FLG

F1MC

ENG

Managed Content XSL

BUS_OBJ_OPT_FLG

F1MP

ENG

WSDL Mapping Business Service

BUS_OBJ_OPT_FLG

F1OM

ENG

Outbound Message Type

BUS_OBJ_OPT_FLG

F1OS

ENG

Oracle Web Determinations Server Location

BUS_OBJ_OPT_FLG

F1PD

ENG

Request Preview Service Script

BUS_OBJ_OPT_FLG

F1PS

ENG

Post Service Script For Extract

BUS_OBJ_OPT_FLG

F1PV

ENG

Request Preview Map

BUS_OBJ_OPT_FLG

F1RB

ENG

Oracle Policy Automation Rulebase Location

BUS_OBJ_OPT_FLG

F1SE

ENG

Supported File Extension

BUS_OBJ_OPT_FLG

F1SR

ENG

Status Reason Business Object

BUS_OBJ_OPT_FLG

F1SY

ENG

Star Schema Type

BUS_OBJ_OPT_FLG

F1WT

ENG

Web Service Simple Type

CACHE_FLG

BTCH

ENG

Cached for Batch

CACHE_FLG

NONE

ENG

Not Cached

CHANGE_TYPE_FLG

D

ENG

Delete

CHANGE_TYPE_FLG

I

ENG

Update / Insert

CHAR_ENTITY_FLG

F1AT

ENG

Attachment

CHAR_ENTITY_FLG

F1MD

ENG

Migration Data Set Log

CHAR_ENTITY_FLG

F1MO

ENG

Migration Object Log

CHAR_ENTITY_FLG

F1MT

ENG

Migration Transaction Log

CHAR_ENTITY_FLG

F1RT

ENG

Request Type Log

CHAR_ENTITY_FLG

F1SE

ENG

Sync Request Inbound Exception

CHAR_ENTITY_FLG

F1SG

ENG

Sync Request Ibound Log

CHAR_ENTITY_FLG

F1SI

ENG

Sync Request Inbound

CHAR_ENTITY_FLG

F1SK

ENG

Service Task

CHAR_ENTITY_FLG

F1SL

ENG

Service Task Log

CHAR_ENTITY_FLG

F1SR

ENG

Sync Request Log

CHAR_ENTITY_FLG

F1ST

ENG

Service Task Type

CHAR_ENTITY_FLG

F1SY

ENG

Sync Request

CHAR_ENTITY_FLG

F1WL

ENG

Web Service Log

CHAR_ENTITY_FLG

F1WS

ENG

Web Service

DATA_TYPE_FLG

XML

ENG

XML Type

DEST_FLD_TYPE_FLG

GBLC

ENG

Global Context

DEST_FLD_TYPE_FLG

PRTC

ENG

Portal Context

DML_STMT_TYPE_FLG

F1DL

ENG

Delete

DML_STMT_TYPE_FLG

F1IN

ENG

Insert

DML_STMT_TYPE_FLG

F1UP

ENG

Update

DTTM_FORMAT_FLG

F1OU

ENG

OUAF

DTTM_FORMAT_FLG

F1XS

ENG

XSD

ENV_TYPE_FLG

CUST

ENG

Custom SOAP Envelope

ENV_TYPE_FLG

DFLT

ENG

Default

EXT_DATA_TYPE_FLG

DUR

ENG

Duration

EXT_SYS_TYP_FLG

F1CF

ENG

Custom Format

EXT_SYS_TYP_FLG

F1CR

ENG

Application Context Root

EXT_SYS_TYP_FLG

F1DB

ENG

Database Connection Information

EXT_SYS_TYP_FLG

F1EN

ENG

Encryption

EXT_SYS_TYP_FLG

F1SS

ENG

SMS Send Configuration

F1AW_OPT_TYP_FLG

F1LP

ENG

Lookup Patching Test DO NOT SHIP

F1CF_OPT_TYP_FLG

F1CR

ENG

Reader

F1CF_OPT_TYP_FLG

F1CW

ENG

Writer

F1DB_OPT_TYP_FLG

F1DP

ENG

Schema Password

F1DB_OPT_TYP_FLG

F1DU

ENG

Schema Owner

F1EN_OPT_TYP_FLG

F1AI

ENG

Algorithm Info

F1EN_OPT_TYP_FLG

F1FE

ENG

Field Encryption

F1GC_OPT_TYP_FLG

F1BI

ENG

Data Source Indicator

F1LF_OPT_TYP_FLG

F1DO

ENG

Display XSL uiHint Override

F1LF_OPT_TYP_FLG

F1EO

ENG

Input XSL uiHint Override

F1SS_OPT_TYP_FLG

F1OP

ENG

Operation Name

F1SS_OPT_TYP_FLG

F1PT

ENG

Port Type

F1SS_OPT_TYP_FLG

F1PW

ENG

Password

F1SS_OPT_TYP_FLG

F1SN

ENG

Service Name

F1SS_OPT_TYP_FLG

F1SU

ENG

Server URL

F1SS_OPT_TYP_FLG

F1UN

ENG

User Name

F1_BATCH_CTGY_FLG

F1AD

ENG

Ad Hoc

F1_BATCH_CTGY_FLG

F1CV

ENG

Conversion

F1_BATCH_CTGY_FLG

F1EX

ENG

Extract

F1_BATCH_CTGY_FLG

F1MN

ENG

Monitor

F1_BATCH_CTGY_FLG

F1OV

ENG

Object Validation

F1_BATCH_CTGY_FLG

F1PR

ENG

Process What's Ready

F1_BATCH_CTGY_FLG

F1RI

ENG

Referential Integrity

F1_BATCH_CTGY_FLG

F1TD

ENG

To Do Entry

F1_BATCH_CTRL_TYPE_FLG

F1NT

ENG

Not Timed

F1_BATCH_CTRL_TYPE_FLG

F1TM

ENG

Timed

F1_COMPOSITE_SYNC_FLG

F1CS

ENG

Composite Sync Request

F1_COMPOSITE_SYNC_FLG

F1SS

ENG

Single Sync Request

F1_DATA_SYNC_FLG

F1CM

ENG

Conversion MODE

F1_DATA_SYNC_FLG

F1EA

ENG

Execute Validation Algorithm

F1_DATA_SYNC_FLG

F1RK

ENG

Resolve Keys

F1_DATA_SYNC_FLG

F1VS

ENG

Validate Schema

F1_DATE_MATH_OPTION_FLG

F1AB

ENG

Add Business Days

F1_DATE_MATH_OPTION_FLG

F1AD

ENG

Add Days

F1_DATE_MATH_OPTION_FLG

F1AT

ENG

Add Times

F1_DATE_MATH_OPTION_FLG

F1DD

ENG

Date Difference

F1_DATE_MATH_OPTION_FLG

F1DT

ENG

Date Time Difference

F1_DATE_MATH_OPTION_FLG

F1FL

ENG

Force Last Day

F1_DATE_MATH_OPTION_FLG

F1MD

ENG

Days in Month

F1_DATE_MATH_OPTION_FLG

F1WD

ENG

Day of Week

F1_EXTRACT_TRANSLATION_FLG

F1NO

ENG

No

F1_EXTRACT_TRANSLATION_FLG

F1YS

ENG

Yes

F1_EXT_LOOKUP_USAGE_FLG

F1AC

ENG

Active

F1_EXT_LOOKUP_USAGE_FLG

F1IN

ENG

Inactive

F1_FLD_MERGE_TYPE_FLG

F1DE

ENG

Destructive

F1_FLD_MERGE_TYPE_FLG

F1KP

ENG

Keep

F1_FLD_MERGE_TYPE_FLG

F1ME

ENG

Merge

F1_FORCE_SYNC_FLG

F1FS

ENG

Force Synchonization

F1_INITIAL_LOAD_SYNC_FLG

F1IC

ENG

Incremental Synchronization

F1_INITIAL_LOAD_SYNC_FLG

F1IL

ENG

Initial Load Synchronization

F1_INPUT_IS_IN_DST_FLG

F1AN

ENG

Assume Not in Shift

F1_INPUT_IS_IN_DST_FLG

F1AY

ENG

Assume In Shift

F1_INPUT_IS_IN_DST_FLG

F1N

ENG

No

F1_INPUT_IS_IN_DST_FLG

F1Y

ENG

Yes

F1_LIST_MERGE_TYPE_FLG

F1DE

ENG

Destructive

F1_LIST_MERGE_TYPE_FLG

F1MD

ENG

Merge Delete Unreferenced

F1_LIST_MERGE_TYPE_FLG

F1ME

ENG

Merge

F1_PROD_TYPE_FLG

F1PL

ENG

Parallel application

F1_RAW_MERGE_TYPE_FLG

F1DE

ENG

Destructive

F1_RAW_MERGE_TYPE_FLG

F1KP

ENG

Keep

F1_RAW_MERGE_TYPE_FLG

F1ME

ENG

Merge

F1_SE_APPSECURITY

F1SF

ENG

false

F1_SE_APPSECURITY

F1ST

ENG

true

F1_SE_DATA_TYPE

F1BL

ENG

boolean

F1_SE_DATA_TYPE

F1DA

ENG

date

F1_SE_DATA_TYPE

F1DT

ENG

dateTime

F1_SE_DATA_TYPE

F1LB

ENG

lookupBO

F1_SE_DATA_TYPE

F1LP

ENG

lookup

F1_SE_DATA_TYPE

F1MO

ENG

money

F1_SE_DATA_TYPE

F1NM

ENG

number

F1_SE_DATA_TYPE

F1ST

ENG

string

F1_SE_PAGEACT

F1AD

ENG

add

F1_SE_PAGEACT

F1CH

ENG

change

F1_SE_PAGEACT

F1DL

ENG

delete

F1_SE_PAGEACT

F1RD

ENG

read

F1_SE_SCOL_FLG

F1FW

ENG

fullWidth

F1_SE_SCOL_FLG

F1LT

ENG

left

F1_SE_SCOL_FLG

F1RT

ENG

right

F1_SE_SEARCHBY

F1A2

ENG

alt2

F1_SE_SEARCHBY

F1A3

ENG

alt3

F1_SE_SEARCHBY

F1AT

ENG

alt

F1_SE_SEARCHBY

F1MN

ENG

main

F1_SE_SUPPRESS

F1BL

ENG

blank

F1_SE_SUPPRESS

F1IN

ENG

input

F1_SE_SUPPRESS

F1TR

ENG

true

F1_SE_TRUEFALSE_FLG

F1FL

ENG

false

F1_SE_TRUEFALSE_FLG

F1TR

ENG

true

F1_SE_UIHINT_SECTOPEN

F1FL

ENG

false

F1_SE_VISIBLEON

F1DM

ENG

displayMap

F1_SE_VISIBLEON

F1IM

ENG

inputMap

F1_SE_XML_NAME_SPACE

F1UH

ENG

uiHint

F1_SHOW_ALL_REQ_FLG

F1YE

ENG

Yes

F1_STAR_SCHEMA_TYPE_FLG

F1DM

ENG

Dimension

F1_STAR_SCHEMA_TYPE_FLG

F1FC

ENG

Fact

F1_STASK_TYPE_STATUS_FLG

F1AC

ENG

Active

F1_STASK_TYPE_STATUS_FLG

F1IN

ENG

Inactive

F1_STATE_CONDITION_FLG

F1AC

ENG

Active

F1_STATE_CONDITION_FLG

F1CN

ENG

Cancel

F1_STATE_CONDITION_FLG

F1IN

ENG

Inactive

F1_STATE_CONDITION_FLG

F1PE

ENG

Pending

F1_SVC_TASK_CL_FLG

F1DF

ENG

Default

F1_SYNC_REQUIRED_FLG

F1NQ

ENG

Synchronization not required

F1_SYNC_REQUIRED_FLG

F1RQ

ENG

Synchronization required

F1_SYNC_REQ_DISCARD_RSN_FLG

F1NC

ENG

No changes detected

F1_TIMER_ACTIVE_FLG

F1DS

ENG

No

F1_TIMER_ACTIVE_FLG

F1EN

ENG

Yes

F1_TRANSLATABLE_FLG

F1NO

ENG

No

F1_TRANSLATABLE_FLG

F1YS

ENG

Yes

GEO_MTCH_QLTY_FLG

1

ENG

Exact match

GEO_MTCH_QLTY_FLG

10

ENG

Postal code does not match

GEO_MTCH_QLTY_FLG

11

ENG

City does not match

GEO_MTCH_QLTY_FLG

2

ENG

Street type does not match

GEO_MTCH_QLTY_FLG

3

ENG

House does not match

GEO_MTCH_QLTY_FLG

4

ENG

Street address does not match

ICON_TYPE_FLG

LBTN

ENG

32 x 32 pixels

ICON_TYPE_FLG

MBTN

ENG

24 x 24 pixels

ICON_TYPE_FLG

SBTN

ENG

16 x 16 pixels

INSTR_TYPE_FLG

F1PR

ENG

Primary

INSTR_TYPE_FLG

F1SD

ENG

Subordinate

INS_ALG_ENTITY_FLG

F1GS

ENG

Geocoding Service

INS_ALG_ENTITY_FLG

F1LD

ENG

Ldap Import

INS_ALG_ENTITY_FLG

F1SR

ENG

SMS Receive Service

INS_ALG_ENTITY_FLG

F1SS

ENG

SMS Send Service

KEY_VALIDATION_FLG

ALL

ENG

Always Check Uniqueness

KEY_VALIDATION_FLG

NONE

ENG

Never Perform Uniqueness Checking

KEY_VALIDATION_FLG

ONLI

ENG

Check Uniqueness Online Only

MAINT_OBJ_OPT_FLG

F1AM

ENG

Auxiliary Maint Object for Service (Y/N)

MAINT_OBJ_OPT_FLG

F1RB

ENG

Replace BO Option

MAINT_OBJ_OPT_FLG

F1RM

ENG

Replace MO Option

MAINT_OBJ_OPT_FLG

F1RS

ENG

Replace BO Status Option

MAINT_OBJ_OPT_FLG

F1SR

ENG

Status Reason Field

MANAG_CONTENT_TYPE_FLG

F1CS

ENG

CSS Definitions

MANAG_CONTENT_TYPE_FLG

F1JS

ENG

Javascript

MANAG_CONTENT_TYPE_FLG

F1SD

ENG

XSD

MANAG_CONTENT_TYPE_FLG

F1WL

ENG

Whitelist

MANAG_CONTENT_TYPE_FLG

F1X

ENG

XSLT

MANAG_CONTENT_TYPE_FLG

F1XC

ENG

XSLTC

MANAG_CONTENT_TYPE_FLG

F1XM

ENG

XML

MSG_PARM_TYP_FLG

DUR

ENG

Duration parameter

NAV_OPT_TYPE_FLG

F1AT

ENG

Attachment

NT_PROC_METH_FLG

S

ENG

SOA

OBJ_ACT_FLG

F1A

ENG

Add

OBJ_ACT_FLG

F1C

ENG

Change

OBJ_ACT_FLG

F1UC

ENG

Unchanged

OPERATION_ACTIVE_FLG

F1AC

ENG

Active

OPERATION_ACTIVE_FLG

F1IA

ENG

Inactive

OUTMSG_PROC_METH_FLG

SOA

ENG

SOA

PK_SELECT_TYPE_FLG

ALGM

ENG

Algorithm

PK_SELECT_TYPE_FLG

HRCD

ENG

Specific Key

PK_SELECT_TYPE_FLG

SQLS

ENG

SQL Statement

PROD_TYPE_FLG

F1PL

ENG

Parallel Application

SCR_ENGINE_VER_FLG

F130

ENG

3.0

SRC_FLD_TYPE_FLG

GBLC

ENG

Global Context

SRC_FLD_TYPE_FLG

PRTC

ENG

Portal Context

STATUS_REASON_FLG

F1OT

ENG

Optional

STATUS_REASON_FLG

F1RD

ENG

Required

STATUS_REASON_SELECT_FLG

F1SL

ENG

Selectable

STATUS_REASON_SELECT_FLG

F1US

ENG

Not Selectable

STD_TM_SRC_FLG

F1RF

ENG

Referenced Time Zone

STEP_TYPE_FLG

DCBG

ENG

Declare Business Object With BO Group

STEP_TYPE_FLG

GBEM

ENG

Generate business object edit map

STEP_TYPE_FLG

GBSM

ENG

Generate business service edit map

STEP_TYPE_FLG

GDAM

ENG

Generate data area edit map

STEP_TYPE_FLG

GSSM

ENG

Generate service script edit map

STEP_TYPE_FLG

NVRD

ENG

Navigate and refresh dashboard

TBL_CLASSIFICATION_FLG

F1AN

ENG

Admin Non System Table

TBL_CLASSIFICATION_FLG

F1AS

ENG

Admin System Table

TBL_CLASSIFICATION_FLG

F1MT

ENG

Master Table

TBL_CLASSIFICATION_FLG

F1TT

ENG

Transaction Table

TBL_CLASSIFICATION_FLG

F1UC

ENG

Unclassified

TBL_VOLUME_FLG

F1HV

ENG

High Volume

TBL_VOLUME_FLG

F1LV

ENG

Low Volume

TBL_VOLUME_FLG

F1MV

ENG

Medium Volume

TBL_VOLUME_FLG

F1UC

ENG

Unclassified

TRAVERSAL_CRT_TYPE_FLG

F1CN

ENG

Constraint

TRAVERSAL_CRT_TYPE_FLG

F1SQ

ENG

SQL

TRAVERSAL_CRT_TYPE_FLG

F1XP

ENG

XPath

UI_MAP_TYPE_FLG

F1XL

ENG

Complete XHTML Document

UI_MAP_TYPE_FLG

F1XR

ENG

XHTML Fragment

USER_CONFIG_FLG

N

ENG

No

USER_CONFIG_FLG

Y

ENG

Yes

USER_ENABLE_FLG

DSBL

ENG

Disable

USER_ENABLE_FLG

ENBL

ENG

Enable

WEBSVC_STATUS_FLG

F1FL

ENG

Active

WEBSVC_STATUS_FLG

F1IN

ENG

Pending

WEB_SVC_SECURITY_TYPE_FLG

F1HB

ENG

HTTP Basic

WEB_SVC_SECURITY_TYPE_FLG

F1NO

ENG

None

WEB_SVC_SECURITY_TYPE_FLG

F1WS

ENG

WS-Security

XAI_OPTION_FLG

SUSR

ENG

Privileged Users

ZONE_HPRM_USG_FLG

ZOVR

ENG

Zone - Override Allowed

ZONE_HPRM_USG_FLG

ZTOR

ENG

Zone Type - Override Allowed

Maintenance Object

The following Maintenance Objects are new to V4.2.0.

MO code

Description

F1-ATCHMT

Attachment

F1-EXT LKUP

Extendable Lookup

F1-GENPROC

General Process

F1-MAN CONT

Managed Content

F1-MIGRDS

Migration Data Set

F1-MIGROBJ

Migration Object

F1-MIGRPLAN

Migration Plan

F1-MIGRREQ

Migration Request

F1-MIGRTX

Migration Transaction

F1-REQ

Request

F1-REQ-TYPE

Request Type

F1-STASKTYPE

Service Task Type

F1-STSREASON

Status Reason

F1-SVCTASK

Service Task

F1-SYNC REQ

Sync Request

F1-SYNCREQIN

Inbound Sync Request

F1-UI ZONE

Context Sensitive Zone - Single Row

F1-WEBSVC

Web Service Adapter

Script

The following Scripts are Framework-owned system data in V4.2.0.

Script

Description

F1-ACTIVEWS

Web Service Adapter - Verify Active Operations

F1-ATTACHGT

Go To Attachment

F1-ActShowZn

Generic Show or Hide Actions Zone

F1-AppSerDet

Get Application Service Details

F1-AtchUplod

Attachment Upload BPA

F1-AttchDtlU

Display Attachment via uiHints

F1-AttchMain

Attachment Maintenance

F1-AttchPost

Attachment post-processing: restore data element

F1-AttchPre

Attachment pre-processing: clear data element

F1-BOStatFS

Take BO Status/Reason Final Snapshot

F1-BOStatus

Status Reason Drop Down populate - Pre Processing

F1-BRGetStat

Retrieve batch run statistics from the fact holding the batch run's stat

F1-BRStatGra

Update and retrieve batch run statistics

F1-CFSCGP

Convert Final Snapshots of Sync Request and Create General Process

F1-CmpSnapSR

Compare Initial and Final Snapshot, with Status Reason

F1-CompSnaps

Compare Initial and Final Snapshot, with Discard Reason

F1-CondShwZn

Zone Visibility - Display Zone in Portal Conditionally

F1-CreEmail

Request - Create Email

F1-DecRptInf

Decision Report - Information

F1-DelUsrGrp

Deny Access

F1-EdtMDFld

Edit MD Field

F1-ExLkActn

Extendable Lookup Actions

F1-ExLkpValD

Extendable Lookup Value Derivation Script

F1-ExLkpZ

Extended Lookup - Action Map Derivation

F1-ExtDA

Visibility script for Extended Data Area

F1-ExtLCDCP

Extendable Lookup Change Data Capture

F1-FinalSnap

Take Final Snapshot

F1-FltrSQL

Zone User Filters - SQL Condition

F1-GENPRINFO

General Process MO Information

F1-GenDss

Retrieve Business Object, Display Map and Script

F1-GenWsOpDA

Web Service Adapter Operation - Generate Mapping Data Areas

F1-GetBRStat

Get Batch Run Statistics

F1-GetThdSta

Get Thread Statistics

F1-GetUsrInf

Retrieves the user information with user id appended

F1-GnChgDCap

Generic Change Data Capture

F1-GotoPrtl

Navigate to portal for an MO and key values

F1-InitSnaps

Take Initial Snapshot

F1-MORevCPos

Enable MO Revision Control - Post-processing

F1-MORevCPre

Enable MO Revision Control - Pre-processing

F1-MORevCtl

Enable/Disable MO Revision Control

F1-MainRqTyp

Request Type - Maintain

F1-MainSynRq

Sync Request - Maintain

F1-MaintStRs

Status Reason - Maintain

F1-MgPlnInf

Migration Plan Info String

F1-MgPlnMain

Migration Plan - Maintenance

F1-MgReqMain

Migration Request - Maintenance

F1-MgdObjZnV

Migration Data Set Object Zone Visibility

F1-MtrEmail

Request Type - To Do Summary Email Monitor

F1-OpaUrlSrh

OPA WSDL URL Search

F1-PopMDFld

Populate MD Field

F1-PrpEtData

Prepare Extract Data

F1-ReqAdd

Request - Add

F1-ReqCan

Request - Cancel

F1-ReqChg

Request - Change

F1-ReqDisp

Request - BO and Map Derivation

F1-ReqInf

Request - Information

F1-ReqTyDisp

Request Type - Retrieve Details for Display

F1-ReqTypSel

Request Type - Select Active

F1-ReqValTyp

Request - Validate Request Type

F1-RetChrDet

Retrieve Characteristic Type Information Details

F1-RetSchDef

Retrieves schema definition

F1-RqTypActn

Request Type - Retrieve Action Details for Display

F1-RqTypZ

Request Type - Action Map Derivation

F1-RqUsrLgAd

Request - Add User Log Entry

F1-RtUsrLgAd

Request Type - Add User Log Entry

F1-SReqQryV

Validate Sync Request Query filters

F1-STRLONG

String Too Long

F1-SecAthLvl

Security Type with Authorization Level Info

F1-StRsnDspD

Status Reason Display Derivation Script

F1-StsReqRsn

BO Statuses

F1-SynRClrEx

Sync Request - Clear Exception Info

F1-SyncInfo

Sync Request - Information

F1-SyncRActn

Sync Request - Retrieve Action Details

F1-SyncRqLog

Sync Request - Add User Log Entry

F1-TRANSTB

Inhibit tables with fields not exceeding capacity

F1-TdSumText

To Do Summary Text Message

F1-TodoRqDsp

To Do Summary Email Request - Retrieve Details for Display

F1-TodoSmPrv

Request - Preview To Do Summary Email

F1-TodoSumEm

To Do Summary Email

F1-TodoTyDsp

Retrieve To Do Summary Email for Display

F1-TrnDef-CS

Transition to Default Next State if Custom Snapshot is False

F1-UpdMDFld

Update MD Field

F1-UsrGrpCds

User Group Access Codes

F1-VSyncBoOp

Validate Sync BO Options

F1-ValTdsTyp

To Do Summary Email Request Type Validation

F1-ViewThrhd

Cluster Thread Attributes Viewer

F1-ViewWSDL

WSDL Source Viewer

F1-WaitFRSRE

Wait for Finalized Related Sync Request to be Extracted

F1-WaitRelSR

Wait For Related Sync To Complete

F1-WbSvcLgAd

Web Service - Add User Log Entry

F1-WbSvcMain

Web Service Adapter - Maintain

F1-WebSvcDtl

Web Service Adapter - Retrieve Details for Display

F1-XMLSnapBO

Return XML Snapshot of a BO Instance

F1ExpMgReq

Export Migration Request

F1ExtLkMaint

Extended Lookup - Maintain

F1MTXImpDesc

Migration Transaction - Retrieve Status Description for Display

F1MgImpReq

Migration Import Request

F1MgOImpDesc

Migration Object - Retrieve Status Description for Display

F1MgOSqlShwZ

Migration Object - SQL List Zone Visibility

F1MgTXShwZn

Migration Transaction List Zone Visibility

F1MgdMnt

Migration Data Set Maintenance

F1MgoMnt

Migration Object - Maintenance

F1MigCf

Retrieve Migration Assistant Configuration

To do Type

The following To Do type is new to V4.2.0.

Todo Type Code

Description

F1-ARQPR

Request Monitor Errors

F1-REQTY

Request Type Monitor Errors

F1-SUBRQ

Request Monitor (Deferred) Errors

F1-SYNRQ

Sync Request Error

F1-SYNTD

Sync Request Monitor Errors

Portal

The following Portal is new to V4.2.0.

Portal

Description

F1APPSEC

Application Security

F1ATTACH

Attachment Information

F1CATTCH

Attachments Query

F1EMHLAU

Embedded Help

F1EXLKP

Extendable Lookup

F1EXLKPS

Extendable Lookup Query

F1MGDEXP

Migration Data Set Export

F1MGDEXS

Migration Data Set Export Query

F1MGDIML

Migration Data Set Log

F1MGDIMP

Migration Data Set Import

F1MGDIMS

Migration Data Set Import Query

F1MGOIML

Migration Object Log

F1MGOIMP

Migration Object Import

F1MGPLNM

Migration Plan

F1MGPLNS

Migration Plan Query

F1MGREQM

Migration Request

F1MGREQS

Migration Request Query

F1MTXIML

Migration Transaction Log

F1MTXIMP

Migration Transaction Import

F1REQ

Request

F1REQTYP

Request Type

F1STRDIS

Status Reason Display

F1STREAS

Status Reason

F1SUBRQQ

Request Query

F1SYNCRL

Sync Request Log

F1SYNCRM

Sync Request

F1SYNCRQ

Sync Request Query

F1TBLEXC

Translatable Strings Exceeding Capacity

F1WBSVCL

Web Service Log

F1WBSVCM

Web Service Adapter

F1WBSVCS

Web Service Query

F1_BTST

Batch Run Statistics

F1_MAN_CON

Managed Content

Portal Zone

The following Portal Zones are added to V4.2.0

Portal

Zone

F1APPSEC

F1-APSVDTL

F1APPSEC

F1-USGRPWSR

F1APPSEC

F1-USGRPWTSR

F1ATTACH

F1-ATTCHDISP

F1CATTCH

F1-CATTCHMZ

F1EMHLAU

F1-UISRC

F1EXLKP

F1-EXLKPLST

F1EXLKP

F1-EXLKPVALD

F1EXLKPS

F1-EXLKPSRCH

F1MGDEXP

F1MGDEXP

F1MGDEXS

F1MGDEXS

F1MGDIML

F1MGDLOGL

F1MGDIMP

F1MGDIMP

F1MGDIMP

F1MGDOBJS

F1MGDIMP

F1MGDTXS

F1MGDIMS

F1MGDIMS

F1MGOIML

F1MGOLOGL

F1MGOIMP

F1MGOALGL

F1MGOIMP

F1MGOIMP

F1MGOIMP

F1MGOSQLL

F1MGPLNM

F1-MGPLNDISP

F1MGPLNS

F1-MGPLNQRY

F1MGREQM

F1-MGREQDISP

F1MGREQS

F1-MIGRREQ

F1MTXIML

F1MTXLOGL

F1MTXIMP

F1MTXIMP

F1MTXIMP

F1MTXOBJS

F1REQ

F1-SUBRQL

F1REQ

F1-SUBRQZ

F1REQTYP

F1-REQTYL

F1REQTYP

F1-RQTACTN

F1REQTYP

F1-SUBRQD

F1REQTYP

F1-SUBRQT

F1STRDIS

F1-STRDS

F1STREAS

F1-BORFOL

F1STREAS

F1-SREBO

F1SUBRQQ

F1-SUBREQ

F1SYNCRL

F1-SYNCRQSTL

F1SYNCRM

F1-SYNCRQSTA

F1SYNCRM

F1-SYNCRQSTD

F1SYNCRQ

F1-SYNREQQRY

F1TBLEXC

F1-STRLONG

F1TBLEXC

F1-TRANSTBL

F1WBSVCL

F1-WBSVCLOG

F1WBSVCM

F1-WBSVCDISP

F1WBSVCS

F1-WBSVCQ

F1_BTST

F1-BATCHCTL

F1_BTST

F1-BATCHRUN

F1_BTST

F1-BRSTATGRA

F1_MAN_CON

F1-MAN-CON

F1_MAN_CON

F1-SCHHDR-MC

F1_SCHEMA_BO

F1-SCHEMA-US

F1_SCHEMA_BO

F1-SE-GUI

F1_SCHEMA_DA

F1-EXTDA

UI Map

The following UI Maps are Framework Owned system data in V4.2.0.

Map

Description

F1-AddSyncRequestLog

Sync Request - Add User Log Entry

F1-AddressMaintenanceFragment

Address Maintenance (with defaulting)

F1-AppSrvDetDisp

Application Service Details Display

F1-AppSrvUsGrpFilter

Application Service User Group Filter Area

F1-AppZoneHeaderMenu

Application URL Zone Header Menu

F1-AttachmentActions

Actions for Attachment BOs

F1-AttachmentIDFrag

Attachment ID Record Info Frag

F1-AttachmentUploadPopup

Attachment Upload

F1-AttachmentUploadStatus

Attachment Upload

F1-BIGeneralMasterConfigDisp

Master configuration for BI - Display

F1-BIGeneralMasterConfigMaint

Master configuration for BI - Maint

F1-BatchRunStatisticsGraph

Batch Run Statistics

F1-CAttachmentSearch

Common Attachment Search

F1-CancelRequest

Request - Cancel Confirmation

F1-CharAddDeleteButton

Characteristics Add/Delete Button

F1-CharValueDisplay

Characteristic Value Display

F1-CharValueMaint

Characteristic Value Maintenance

F1-CharacteristicTypeInfo

Characteristic Type Information

F1-CommonAttachmentSearch

Common Attachment Search

F1-ContextBOUIMap

Preview the UIMap from the Schema

F1-DAExplorerHeaderFrameAction

Explorer Header Actions

F1-DeleteActionFusion

Delete XHTML Fragment

F1-DisplayRecordActionHeader

Record Actions Header

F1-DisplayRecordActions

Record Actions HTML Fragment

F1-DisplayRecordActionsFusion

Record Actions HTML Fragment Fusion

F1-DuplicateActionFusion

Duplicate XHTML Fragment

F1-Edit

Edit - no actions

F1-EditActionFusion

Edit Action XHTML Fragment

F1-EditActions

Edit and actions

F1-EditDelete

Edit, delete

F1-EditDeleteActions

Edit, delete, actions

F1-EditDeleteDuplicate

Edit, delete and duplicate - no actions

F1-EditDeleteDuplicateActions

Edit, delete, duplicate and actions

F1-EditMDField

Edit MD Field

F1-EditorHeader

HTML Editor Zone Header

F1-EnableMORevisionControlMap

Enable MO Revision Control UI Map

F1-EnterRequestType

Request - Select Request Type

F1-ExportMigrReqInput

Export Migration Request Input

F1-ExtDAHeader

Default Header for Data Explorers

F1-ExtLkupInputHdr

Display banner in edit map - fragment

F1-ExtLookupLeftColumnDisplay

Extendable Lookup Left Column - Display

F1-ExtLookupRightColumnDisplay

Extendable Lookup Right Column - Display

F1-ExtendableLookupActions

Extendable Lookup - Actions

F1-ExtendedLookupCommonMaint

Extendable Lookup Common - Maintenance

F1-ExtendedLookupMaintScripts

Javascript for extended lookup maintenance

F1-GenDA

Generate Mapping Data Areas

F1-GenericZoneHdrActions

Generic Zone Header Actions

F1-MQueryExpHeaderFrameActions

Multi Query Explorer Header Action UI Map

F1-MasterConfigInputHdr

Display banner in edit map - fragment

F1-MessageQueryFilter

Message Query Filter

F1-MigrDataSetObjsFilter

Migration Objects Filter

F1-MigrDataSetTxFilter

Migration Data Set Transactions Filter

F1-MigrExportSearchFilter

Migration Data Set Export - Query Filters

F1-MigrImportSearchFilter

Migration Data Set Import - Query Filters

F1-MigrObjectImportDisplay

Migration Object Import Display

F1-MigrPlanDisplay

Migration Plan - Display

F1-MigrPlanMaintenance

Migration Plan Maintenance

F1-MigrPlanSearchFilter

Migration Plan - Query Filters

F1-MigrReqDisplay

Migration Request - Display

F1-MigrReqMaintenance

Migration Request - Maintenance

F1-MigrReqSearchFilter

Migration Request - Query Filters

F1-MigrTxImportDisplay

Migration Transaction Import Display

F1-MigrationImportRequest

Migration Request Import Input

F1-MultiExplorerHeadFrameAct

Explorer Header Action UI Map Fragment

F1-OkCancelButtons

Submit Ok or Cancel buttons

F1-OutcomeStyleLookupDisplay

Outcome Style - Display

F1-OutcomeStyleLookupMaint

Outcome Style - Maintenance

F1-RecordActionsFusion

Record Actions XHTML Fragment

F1-RecordInfo

Record Information Fragment

F1-RecordInfoFusion

Fusion Record Information Fragment

F1-RecordInfoHeader

Record Information Header Fragment

F1-ReqTypeInputHdr

Display banner in edit map - fragment

F1-RequestActions

Request - Actions

F1-RequestTypeActions

Request Type - Actions

F1-RequestTypeUserLogAdd

Request Type - Add User Log Entry

F1-RequestUserLogAdd

Request - Add User Log Entry

F1-SE-Buttons

Buttons

F1-SE-FieldConditionalAtts

Field conditional attributes

F1-SE-FieldUIHintConditionAtts

Field uiHint conditional attributes

F1-SE-GLUIHintConditionalAtts

Group, list uiHint conditional attributes

F1-SE-Header

Schema Editor Zone Header

F1-SE-ListConditionalAtts

List conditional attributes

F1-SE-SchemaConditionalAtts

Root node conditional attributes

F1-SaveCancelButtons

Save and Cancel Buttons

F1-StatusReasonDisplay

Status Reason - Display

F1-StatusReasonInput

State Transition - Enter Reason

F1-StatusReasonInputHdr

Display banner in edit map - fragment

F1-StatusReasonMaintenance

Status Reason - Maintenance

F1-StringLongDetails

Display fields exceeding 70% capacity

F1-SyncCfgBOMaint

Master Data Synchronization Configuration

F1-SyncReqCancelReasonInput

Sync Request - Enter Cancel Reason

F1-SyncRequestActions

Sync Request - Actions

F1-ToDoSumEmailDisp

To Do Summary Email Request - Display

F1-ToDoSumEmailPreview

Request - Preview To Do Summary Email

F1-ToDoSumEmailReqMaint

Request - To Do Summary Email Maintenance

F1-ToDoSumEmailTypMaint

To Do Summary Email Type - Maintenance

F1-TodoSumEmailTypeDisp

To Do Summary Email Request Type - Display

F1-WSDLViewer

WSDL Source Viewer

F1-WbSvcSearchFilter

Web Service Adapter - Query Filters

F1-WebSvcDisplay

Web Service Adapter - Display

F1-WebSvcInputHdr

Display banner in edit map - fragment

F1-WebSvcLogAdd

Web Service Adapter - Add User Log Entry

F1-WebSvcMain

Web Service Adapter - Maintenance

F1-WebSvcOperationsFrag

Operation list fragment for web service BO

F1-WebSvcOperationsFragInput

Operation list frag for web svc BO - Input

F1-WebSvcWsdlSourceFrag

WSDL source fragment for web service BO

F1-WebSvcWsdlURLFrag

WSDL URL fragment for web service BO.

XML MAP test

XML MAP test

XAI Inbound Service

The following XAI Inbound Service is new to V4.2.0.

XAI Inbound Svc Id

Zone Type

Description

F113943194

F1-UpdateAndTransitionSyncRequest

Update Master Data Sync Request

F118739517

F1-SmsReceive

Receive SMS Message XAI Service

F156528210

F1-ORAGEOCD

Geocode Address XAI Inbound Service

Zone Type

The following Zone Types are new to V4.2.0.

Zone Handle Code

Description

F1-SE-GUI

GUI Schema Editor

F1-APP-URL

Application URL

Zone

The following new Zones are added to V4.2.0.

Zone

Zone Type

Description

F1-ALGSQ1

F1-DE-QUERY

Algorithm Code/ Description

F1-ALGSRCH

F1-DE-MULQRY

Algorithm Search

F1-APSRVSEC

F1-DE

Get Application Service Security

F1-APSVCSRCH

F1-DE-QUERY

Application Service Search

F1-APSVDTL

F1-MAPEXPL

Application Service Details

F1-ATTCHDISP

F1-MAPDERV

Attachment Information

F1-ATTCHSCH

F1-DE-QUERY

Record / File Type / ID

F1-BATCHCTL

F1-DE-QUERY

Batch Control Query

F1-BATCHRUN

F1-DE-SINGLE

Batch Runs (Last 20)

F1-BATCHRUNS

F1-DE-SINGLE

Thread Statistics

F1-BATCHSTAT

F1-DE-SINGLE

Batch Run Statistics

F1-BNCTXZS

F1-DE-QUERY

Context Sensitive Zone Search

F1-BNEXLKPS

F1-DE-QUERY

Extended Lookup Search

F1-BNMANCONS

F1-DE-QUERY

Managed Content Search

F1-BNMGPS

F1-DE-QUERY

Migration Plan Search

F1-BNMGRS

F1-DE-QUERY

Migration Request Search

F1-BNSTSRSNS

F1-DE-QUERY

Status Reason Search

F1-BOMOSRC

F1-DE-QUERY

Business Object Search for MO

F1-BOMOSRCH

F1-DE-QUERY

Business Object Search for Add

F1-BORFOL

F1-DE-SINGLE

Business Objects with Status Reason

F1-BOSRCH

F1-DE-QUERY

Business Object Search

F1-BOSRCH2

F1-DE-QUERY

Business Object Search

F1-BOSTSLST

F1-DE-SINGLE

Retrieve BO Statuses Allowing Reason

F1-BRFACT

F1-DE-SINGLE

Get Fact Id for a Batch Run's Statistics

F1-BRSTATGRA

F1-MAPEXPL

Batch Run, RPS Graph and Thread Statistics

F1-BSRDRS

F1-DE-SINGLE

Get required status reasons

F1-BSSLRS

F1-DE-SINGLE

Get all selected Reasons

F1-BSSRC

F1-DE-QUERY

Business Service Search

F1-CATCHSCH

F1-DE-QUERY

Common Attachment - FileName/FileType(BO)

F1-CATTCHBOS

F1-DE-QUERY

Common Attachments Business Object Search

F1-CATTCHMZ

F1-DE-MULQRY

Attachments Search

F1-CHVAL

F1-DE-QUERY

Predefined Characteristic Search

F1-CLSDETAIL

F1-MAPEXPL

Cluster Details

F1-CLSMEMBER

F1-MAPEXPL

Cluster Members

F1-CLSTHPOOL

F1-MAPEXPL

Cluster Thread Pools

F1-CLUSJOBS

F1-MAPEXPL

Batch Jobs

F1-CLUSTER

F1-MAPEXPL

Batch Cluster

F1-CLUSTHRD

F1-MAPEXPL

Batch Threads

F1-CNSTRSRCH

F1-DE

Constraint Search

F1-CONDSHWZN

F1-DE-SINGLE

Application Service Details

F1-DASRCH

F1-DE-QUERY

Data Area Search

F1-DBBATSTAT

F1-DE-SINGLE

Batch Run Statistics (DB)

F1-DISSTS

F1-DE-SINGLE

Retrieve BO States with Reasons

F1-ESSRCH

F1-DE-QUERY

External System Search

F1-EXLKPLST

F1-DE-SINGLE

Extendable Lookup Value List

F1-EXLKPSRCH

F1-DE-QUERY

Extendable Lookup Search

F1-EXLKPVALD

F1-MAPDERV

Extendable Lookup Value

F1-EXTDA

F1-DE-SINGLE

Extension Data Areas

F1-FKSRC

F1-DE-QUERY

Foreign Key Search

F1-FLDSRCH

F1-DE-MULQRY

Field Search

F1-FLDSRCHQ1

F1-DE-QUERY

Field Name/ Description

F1-GENBOMP

F1-MAPEXPL

View UI Rendering

F1-GETACTTYP

F1-DE-SINGLE

Retrieve Active Request Types

F1-GETBOSTRS

F1-DE-SINGLE

Get BO statuses, conditions and reasons.

F1-GETEXLKPD

F1-DE-SINGLE

Get Extended Lookup Value details

F1-GETEXTSYS

F1-DE-SINGLE

Retrieve External Systems

F1-GETFINLSR

F1-DE-SINGLE

Get Finalized Sync Request

F1-GETINITSR

F1-DE-SINGLE

Get Initial Sync Requests

F1-GETMAXEND

F1-DE-SINGLE

Get Maximum End for the batch run

F1-GETMAXTHR

F1-DE-SINGLE

Get Maximum Thread Number for Batch Run

F1-GETMINSTR

F1-DE-SINGLE

Get Minimum Start for the batch run

F1-GETNONFSR

F1-DE-SINGLE

Get Non-Final Sync Requests

F1-GETRECREQ

F1-DE-SINGLE

Retrieve Latest Request for Request Type

F1-GETTHDEND

F1-DE-SINGLE

Get Thread End

F1-GETTHDSTR

F1-DE-SINGLE

Get Thread Start

F1-GPINFO

F1-DE-SINGLE

Retrieve General Process Information

F1-LKUPFS

F1-DE-QUERY

Field Search

F1-MAN-CON

F1-XMLEDITOR

Editor

F1-MGPLNDISP

F1-MAPDERV

Migration Plan

F1-MGPLNQ1

F1-DE-QUERY

Migration Plan

F1-MGPLNQRY

F1-DE-MULQRY

Migration Plan Search

F1-MGREQDISP

F1-MAPDERV

Migration Request

F1-MGRREQDSP

F1-MAPDERV

Migration Request to be deleted

F1-MIGRREQ

F1-DE-MULQRY

Migration Request Search

F1-MIGRREQ1

F1-DE-QUERY

Code / Description

F1-MOFLDS

F1-DE-QUERY

Field Search

F1-MONAVKEY

F1-DE-SINGLE

Get Tab Menu Navigation Key for MO

F1-MOSRCH

F1-DE-QUERY

Maintenance Object Search

F1-MSGCATSCH

F1-DE-QUERY

Message Category Search

F1-MSGSRCH

F1-DE-MULQRY

Message Search

F1-MSGSRCHQ1

F1-DE-QUERY

Message Category/ Number/ Description

F1-OPAWSSRCH

F1-DE-QUERY

OPA WSDL URL Search

F1-OUTMSGTYS

F1-DE-QUERY

Outbound Message Type Search

F1-REQTYL

F1-DE-SINGLE

Request Type Log

F1-RETSTATES

F1-DE-SINGLE

Retrieves BO states for Access Modes

F1-RQTACTN

F1-MAPDERV

Actions

F1-SCHHDR-MC

F1-FIELDVALS

General Information

F1-SCSRCH

F1-DE-QUERY

Script Search

F1-SE-GUI

F1-SE-GUI

GUI Schema Editor

F1-SREBO

F1-DE-SINGLE

Status Reasons

F1-STRDS

F1-MAPDERV

Status Reason Display

F1-STRLONG

F1-MAPEXPL

Translatable Strings Exceeding Capacity

F1-SUBREQ

F1-DE-QUERY

Request Search

F1-SUBRQD

F1-MAPDERV

Request Type

F1-SUBRQL

F1-DE-SINGLE

Request Log

F1-SUBRQT

F1-DE-SINGLE

Request Type List

F1-SUBRQZ

F1-MAPDERV

Request

F1-SYNCRQSTA

F1-MAPDERV

Actions

F1-SYNCRQSTD

F1-MAPDERV

Sync Request

F1-SYNCRQSTL

F1-DE

Sync Request Log

F1-SYNREQQ1

F1-DE-QUERY

Sync Request Id

F1-SYNREQQ3

F1-DE-QUERY

Maintenance Object

F1-SYNREQQRY

F1-DE-MULQRY

Sync Request Search

F1-TBLSRCH

F1-DE-QUERY

Table Search

F1-TDS-ALL

F1-DE-SINGLE

To Do Summary Email All

F1-TDS-CNT

F1-DE-SINGLE

To Do Summary Email Count

F1-TDS-OPN

F1-DE-SINGLE

To Do Summary Email - Open To Dos by Type

F1-TDS-PRV

F1-DE-SINGLE

To Do Summary Email Preview

F1-TRANSTBL

F1-DE-SINGLE

Translatable Tables

F1-TZSRCH

F1-DE-QUERY

Time Zone Search

F1-UISRC

F1-DE-QUERY

UI Map Search

F1-UISRCH

F1-DE-QUERY

UI Map Search

F1-USGRACML

F1-DE

Get User Group Access Modes

F1-USGRPWSR

F1-DE

User Groups with Access

F1-USGRPWTSR

F1-DE

User Groups without Access

F1-USGRSECL

F1-DE

Get Security Type Access for User Group

F1-USGRSRCH

F1-DE-QUERY

User Group Search

F1-USSRCH

F1-DE-QUERY

User Search

F1-WBSVCDISP

F1-MAPDERV

Web Service Adapter

F1-WBSVCLOG

F1-DE

Web Service Adapter Log

F1-WBSVCQ

F1-DE-MULQRY

Web Service Adapter Search

F1-WBSVCQ1

F1-DE-QUERY

Name / Description / Status

F1-WORKCAL

F1-DE-QUERY

Work Calendar Search

F1HRBOTREE

F1-DE

BOs Linked To The MO

F1MGALGS

F1-DE-QUERY

Migration Selection Algorithms

F1MGDEXP

F1-MAPDERV

Migration Data Set Export Details

F1MGDEXS

F1-DE-MULQRY

Migration Data Set Export Query

F1MGDEXS1

F1-DE-QUERY

Migration Data Set Export Search

F1MGDIMP

F1-MAPDERV

Migration Data Set Import Details

F1MGDIMS

F1-DE-MULQRY

Migration Data Set Import Query

F1MGDIMS1

F1-DE-QUERY

Migration Data Set Import Search

F1MGDLOGL

F1-DE

Migration Data Set Logs

F1MGDOBJS

F1-DE

Migration Data Set Impacted Object Summary

F1MGDTXS

F1-DE

Migration Data Set Transactions

F1MGOALGL

F1-DE-SINGLE

Migration Object - Algorithms

F1MGOIMP

F1-MAPDERV

Migration Object Details

F1MGOLOGL

F1-DE

Migration Object Logs

F1MGOSQLL

F1-DE-SINGLE

Migration Object - List of SQL Statements

F1MTXIMP

F1-MAPDERV

Migration Transaction Import Details

F1MTXLOGL

F1-DE

Migration Transaction Logs

F1MTXLSTCNT

F1-DE-SINGLE

Migration Transaction List count

F1MTXOBJS

F1-DE

Migration Transaction Objects

F1_MOREVCTRL

F1-DE

Get the list of MOs that have physical BOs

Oracle Application Framework System Table Guide

This section lists the system tables owned by the Oracle Utilities Application Framework V4.2.0.2 and explains the data standards of the system tables. The data standards are required for the installation of Oracle Utilities Application Framework, development within the Oracle Utilities Application Framework, and the configuration and customization of Oracle Utilities products. Adhering to the data standards is a prerequisite for seamless upgrade to future releases.

This section includes:

•

About the Application Framework System Tables

•

System Table Standards

•

Guidelines for System Table Updates

•

System Table List

About the Application Framework System Tables

System tables are a subset of the tables that must be populated at the time the product is installed. They include Metadata and configuration tables. The data stored in the system tables are the information that Oracle Utilities Application Framework product operations are based on.

As the product adds more functionality, the list of system tables can grow. The complete list of the system tables can be found in the System Table List section.

System Table Standards

System table standards must be observed for the following reasons:

•

The product installation and upgrade process and customer modification data extract processes depend on the data prefix and owner flag values to determine the system data owned by each product.

•

The standards ensure that there will be no data conflict in the product being developed and the future Oracle Utilities Application Framework release.

•

The standards ensure that there will be no data conflict between customer modifications and future Oracle Utilities product releases.

•

The data prefix is used to prevent test data from being released to production.

Developer's Note: All test data added to the system data tables must be prefixed by ZZ (all upper case) in order for the installation and upgrade utility to recognize them as test data.

Guidelines for System Table Updates

This section describes guidelines regarding the updating of the system table properties.

Business Configuration Tables

The majority of data in the tables in this group belongs to the customer. But these tables are shipped with some initial data in order for the customer to login to the system and begin configuring the product. Unless specified otherwise, the initial data is maintained by Oracle Utilities Application Framework and subject to subsequent upgrade.

Application Security and User Profile

These tables define the access rights of a User Group to Application Services and Application Users.

Properties

Description

Tables

SC_ACCESS_CNTL, SC USER, SC_USR_GRP_PROF, SC_USR_GRP_USR, SC_USER_GROUP, SC_USER_GROUP_L

Initial Data

User Group All SERVICES and default system user SYSUSER. Upon installation the system default User Group All SERVICES is given unrestricted accesses to all services defined in Oracle Utilities Application Framework.

Developer's Note: When a new service is added to the system, all actions defined for the service must be made available to the User Group All SERVICES.

Currency Code

The ISO 4217 three-letter codes are taken as the standard code for the representation of each currency.

Properties

Description

Tables

CI_CURRENCY_CD, CI_CURRENCY_CD_L

Initial Data

United States Dollar (USD).

DB Process

Properties

Description

Tables

CI_DB_PROC, CI_DB_PROC_L, CI_DB_INSTR, CI_DB_INSTR_L, L, CI_DB_INSTR_OVRD

Initial Data

Copy DB Process (CL-COPDB). This DB process allows users to copy a DB process from one database to another using Config Lab utility.

Display Profile

The Display Profile Code is referenced in the User (SC_USER) table.

Properties

Description

Tables

CI_DISP_PROF, CI_DISP_PROF_L

Initial Data

North America (NORTHAM) and Europe (EURO).

Installation Options

Installation Option has only one row that is shipped with the initial installation of the Oracle Utilities Application Framework. The updatable columns in these tables are customer data and will not be overridden by the upgrade process unless a special script is written and included in the upgrade process.

Properties

Description

Tables

F1_INSTALLATION, CI_INSTALL_ALG, CI_INSTALL_MSG, CI_INSTALL_MSG_L, CI_INSTALL_PROD

Initial Data

Option 11111.

Developer's Note: The system data owner of an environment is defined in the Installation Option. This Owner Flag value is stamped on all system data that is added to this environment. The installation default value is Customer Modification (CM). This value must be changed in the base product development environments.

Language Code

Language Code must be a valid code defined in ISO 639-2 Alpha-3. Adding a new language code to the table without translating all language dependent objects in the system can cause errors when a user chooses the language.

Properties

Description

Tables

CI_LANGUAGE

Initial Data

English (ENG).

To Do Priority and Role

New To Do Types released will be linked to the default To Do Role and set to the product assigned priority value initially. These initial settings can be overridden by the implementation.

Properties

Description

Tables

CI_ROLE(L), CI_TD_VAL_ROLE

Initial Data

F1_DFLT

Development and Implementation System Tables

This section defines the standards for the system tables that contain data for application development. The data in these tables implement business logic and UI functions shared by various products and product extensions in the same database.

Standards

When adding new data, the owner flag value of the environment must prefix certain fields of these tables. For example, when a developer adds a new algorithm type to an Product Name environment, C1 should prefix the new Algorithm Type code. The fields that are subject to this rule are listed in Standard Data Fields property.

The data that is already in these tables cannot be modified if the data owner is different than the environment owner. This prevents the developers from accidentally modifying system data that belongs to the Oracle Utilities Application Framework or the base products. However, some fields are exempt from this rule and can be modified by Customer Modification. These fields are listed in the Customer Modification Fields property.

Starting with version 2.2 of the framework a new system data upgrade rule was introduced - Override Owner flag. If duplicate data rows (data row with same primary key values) are found at the time of upgrade, the owner flag values will get overridden. The lower level application system data will override the upper level system data. For example, F1 overrides C1, F1&C1 override CM, and so on. This rule will be applied to the following tables: CI_CHAR_ENTITY, CI_MD_MO_ALG, F1_BUS_OBJ_ALG, F1_BUS_OBJ_STATUS_ALG, CI_MD_MO_OPT, F1_BUS_OBJ_OPT, F1_BUS_OBJ_STATUS_OPT, F1_BUS_OBJ_STATUS, F1_BUS_OBJ_STATUS_L

Algorithm Type

Properties

Description

Tables

CI_ALG_TYPE, CI_ALG_TYPE_L, CI_ALG_TYPE_PRM, CI_ALG_TYPE_PRM_L

Standard Data Fields

Algorithm Type (ALG_TYPE_CD)

Customer Modification

None

Algorithm

Properties

Description

Tables

CI_ALG, CI_ALG_L, CI_ALG_PARM, CI_ALG_VER

Standard Data Fields

Algorithm (ALG_CD)

Customer Modification

None

Application Security

Properties

Description

Tables

SC_APP_SERVICE, SC_APP_SERVICE_L, CI_APP_SVC_ACC

Standard Data Fields

Application Service ID (APP_SVC_ID). Customer care and billing products prior to version 2.0 will continue to use CI as a prefix for the application service.

Customer Modification

None

Batch Control

Properties

Description

Tables

CI_BATCH_CTRL, CI_BATCH_CTRL_L, CI_BATCH_CTRL_P, CI_BATCH_CTRL_P_L

Standard Data Fields

Batch Process (BATCH_CD), Program Name (PROGRAM_NAME)

Customer Modification

Next Batch Number (NEXT_BATCH_NBR), Last Update Instance (LAST_UPDATE_INST), Last Update Date time (LAST_UPDATE_DTTM) and the batch process update these columns. Time Interval (TIMER_INTERVAL), Thread Count (BATCH_THREAD_CNT), Maximum Commit Records (MAX_COMMIT_RECS), User (USER_ID), Language (LANGUAGE_CD), Email Address (EMAILID), Start program debug tracing (TRC_PGM_STRT_SW), End Program Debug trace (TRC_PGM_END_SW), SQL debug tracing (TRC_SQL_SW) and Standard debug tracing (TRC_STD_SW) on CI_BATCH_CTRL Table.

Batch Parameter Value (BATCH_PARM_VAL) on Batch Control Parameters Table (CI_BATCH_CTRL_P)

Business Object

Properties

Description

Tables

F1_BUS_OBJ, F1_BUS_OBJ_L, F1_BUS_OBJ_ALG, F1_BUS_OBJ_OPT, F1_BUS_OBJ_STATUS, F1_BUS_OBJ_STATUS_L, F1_BUS_OBJ_STATUS_ALG, F1_BUS_OBJ_STATUS_OPT, F1_BUS_OBJ_STATUS_RSN, F1_BUS_OBJ_STATUS_RSN_L, F1_BUS_OBJ_STATUS_RSN_CHAR F1_BUS_OBJ_TR_RULE, F1_BUS_OBJ_TR_RULE_L

Standard Data Fields

Business Object (BUS_OBJ_CD), Status Reason (BO_STATUS_REASON_CD)

Customer Modification

Batch Control (BATCH_CD), Alert (BO_ALERT_FLG), Sequence (SORT_SEQ5), Status Reason (STATUS_REASON_FLG) fields on Business Object Status Table (F1_BUS_OBJ_STATUS). Instance Control (INSTANCE_CTRL_FLG), Application Service (APP_SVC_ID) on Business Object Table (F1_BUS_OBJ). Status Reason Selection (STATUS_REASON_SELECT_FLG) on Status Reason Table (F1_BUS_OBJ_STATUS_RSN)

Business Service

Properties

Description

Tables

F1_BUS_SVC, F1_BUS_SVC_L

Standard Data Fields

Business Service (BUS_SVC_CD)

Customer Modification

Application Service (APP_SVC_ID)

Characteristics

Properties

Description

Tables

CI_CHAR_TYPE, CI_CHAR_TYPE_L, CI_CHAR_ENTITY, CI_CHAR_VAL, CI_CHAR_VAL_L

Standard Data Fields

Characteristic Type (CHAR_TYPE_CD)

Customer Modification

Adhoc Characteristic Value Validation Rule (ADHOC_VAL_ALG_CD) on Characteristic Entity Table (CI_CHAR_ENTITY)

Configuration Migration Assistant

Properties

Description

Tables

F1_MIGR_PLAN,F1_MIGR_PLAN_L,F1_MIGR_PLAN_INSTR,F1_MIGR_PLAN_INSTR_L, F1_MIGR_PLAN_INSTR_ALG, F1_MIGR_REQ, F1_MIGR_REQ_L, F1_MIGR_REQ_INSTR, F1_MIGR_REQ_INST R_L, F1_MIGR_REQ_INSTR_ENTITY

Standard Data Fields

Migration Plan Code (MIGR_PLAN_CD), Migration Request Code (MIGR_REQ_CD)

Customer Modification

None

Data Area

Properties

Description

Tables

F1_DATA_AREA, F1_DATA_AREA_L

Standard Data Fields

Data Area Code (DATA_AREA_CD)

Customer Modification

None

Display Icon

Properties

Description

Tables

CI_DISP_ICON, CI_DISP_ICON_L

Standard Data Fields

Display Icon Code (DISP_ICON_CD)

Customer Modification

None

Extendable Lookup

Properties

Description

Tables

F1_EXT_LOOKUP_VAL, F1_EXT_LOOKUP_VAL_L

Standard Data Fields

Business Object (BUS_OBJ_CD), Extendable Lookup Value (F1_EXT_LOOKUP_VALUE)

Customer Modification

Override Description (DESCR_OVRD) on Extendable Lookup Field Value Language Table (F1_EXT_LOOKUP_VAL_L)

Foreign Key Reference

Properties

Description

Tables

CI_FK_REF, CI_FK_REF_L

Standard Data Fields

FK reference code (FK_REF_CD)

Customer Modification

Info Program Name (INFO_PRG), Zone (ZONE_CD)

Inbound Web Service

Properties

Description

Tables

F1_IWS_SVC_L,F1_IWS_SVC,F1_IWS_SVC_OPER_L,F1_IWS_SVC_OPER, F1_IWS_ANN_L,F1_IWS_ANN_PARM,F1_IWS_ANN,F1_IWS_ANN_TYPE_L,F1_IWS_ANN_TYPE, F1_IWS_ANN_TYPE_PARM,F1_IWS_ANN_TYPE_PARM_L

Standard Data Fields

Webservice Name (IN_SVC_NAME), Annotation (ANN_CD), Annotation Type (ANN_TYPE_CD)

Customer Modification

Debug (DEBUG_SW), Active (ACTIVE_SW), Trace (TRACE_SW), Post Error (POST_ERROR_SW), Request XSL (REQUEST_XSL), Response XSL (RESPONSE_XSL)

Lookup

Properties

Description

Tables

CI_LOOKUP_FIELD, CI_LOOKUP_VAL, CI_LOOKUP_VAL_L,

Standard Data Fields

Field Name (FIELD_NAME)

•

A lookup field name must have corresponding field metadata. The name of the lookup field column must be assigned to avoid conflicts among different products. If you follow the standards for database field names, a Customer Modification lookup field name will be automatically Customer Modification prefixed.

Field Value (FIELD_VALUE)

•

If a lookup field is customizable, Customer Modification can insert new lookup values. X or Y must prefix when implementers introduce a new lookup value.

•

Product development can extend the Oracle Utilities Application Framework owned lookup field's value with caution. When it needs to be extended, prefix the first letter of the Owner Flag to the value. For example, when adding a new value to the algorithm entity flag (ALG_ENTITY_FLG), prefix with C1 if you are developing an Oracle Utilities Customer Care and Billing product.

Customer Modification

Override Description (DESCR_OVRD) on Lookup Field Value Language Table (CI_LOOKUP_VAL_L)

Map

Properties

Description

Tables

F1_MAP, F1_MAP_L

Standard Data Fields

UI Map (MAP_CD)

Customer Modification

None

Managed Content

Properties

Description

Tables

F1_MANAG_CONTENT, F1_MANAG_CONTENT_L

Standard Data Fields

Managed Content (MANAG_CONTENT_CD)

Customer Modification

None

Messages

Properties

Description

Tables

CI_MSG_CATEGORY, CI_MSG_CATEGORY_L, CI_MSG, CI_MSG_L

Standard Data Fields

Message Category (MESSAGE_CAT_NBR)

•

Messages are grouped in categories and each category has message numbers between 1 and 99999. A range of message categories is assigned to a product. You must use only the assigned category for your product.

•

Oracle Utilities Customer Care and Billing and Oracle Utilities Business Intelligence - 00001 thru 00100

•

Oracle Utilities Application Framework Java - 11001 thru 11100

•

Oracle Utilities Customer Care and Billing Java - 11101 thru 11200

•

Oracle Utilities Business Intelligence Java - 11201 thru 11300

•

Implementer COBOL - 90000

•

Implementer WSS - 90001

•

Implementer Java - 90002

•

Reserved for Tests - 99999

Message Number (MESSAGE_NBR) for COBOL message categories

•

Message numbers below 1000 are reserved for common messages. Implementers must not use message numbers below 1000.

Message Number (MESSAGE_NBR) for Java message categories

•

Subsystem Standard Messages - 00001 thru 02000

•

Reserved - 02001 thru 09999

•

Published Messages - 10001 thru 11000

•

Package Messages - 10001 thru 90000

•

Reserved - 90001 thru 99999

•

Each package is allocated 100 message numbers, each starting from 101.

•

Published Messages are messages that are special-interest messages that implementations need to know about and are therefore published in the user docs. Examples of these include messages that are highly likely to be changed for an implementation, or messages that are embedded into other texts/messages and therefore the message number is never shown

•

Reserved message number ranges are for future use and therefore must not be used by all products.

Customer Modification

Override Description (DESCRLONG_OVRD), Message Text Override (MESSAGE_TEXT_OVRD)

Meta Data - Table and Field

Properties

Description

Tables

CI_MD_TBL, CI_MD_TBL_FLD, CI_MD_TBL_L, CI_MD_TBL_FLD_L, CI_MD_FLD, CI_MD_FLD_L, F1_DB_OBJECTS_REPO

Standard Data Fields

Table Name (TBL_NAME)

•

Table names must match with the physical table name or view name in the database.

•

Field Name (FLD_NAME) Field name must match with the physical column name in the database unless the field is a work field. Field name does not have to follow the prefixing standard unless the field is a work field or customer modification field.

•

F1_DB_OBJECTS_REPO Table stores information about Indexes, Sequences, Triggers and other database objects excluding Tables and Fields (as they are already stored in the other Metadata tables)

Customer Modification

Audit Switches (AUDIT_INSERT_SW, AUDIT_UPDATE_SW, AUDIT_DELETE_SW), Override label (OVRD_LABEL) on MD Table Field Table (CI_MD_TBL_FLD). Audit Program Name (AUDIT_PGM_NAME), Audit Table Name (AUDIT_TBL_NAME), Audit Program Type (AUDIT_PGM_TYPE_FLG), Key Validation (KEY_VALIDATION_FLG) and Caching strategy (CACHE_FLG) on MD Table (CI_MD_TBL). Override Label (OVRD_LABEL) and Customer Specific Description (DESCRLONG_OVRD) on Field Table.

Meta Data - Constraints

Properties

Description

Tables

CI_MD_CONST, CI_MD_CONST_FLD

Standard Data Fields

Constraint Id (CONST_ID)

•

Index Name for Primary Constraints

•

<Index Name>Rnn for Foreign Key Constraints Where

•

nn: integer, 01 through 99

Customer Modification

None

Meta Data - Menu

Menus can be extended to support multiple products by adding a new menu line to an existing menu. The sequence number on the menu line language table (CI_MD_MENU_LINE_L) determines the order the menu lines appear. Within the same sequence, alphabetic sorting is used.

Properties

Description

Tables

CI_MD_MENU, CI_MD_MENU_L, CI_MD_MENU_ITEM, CI_MD_MENU_ITEM_L, CI_MD_MENU_LINE, CI_MD_MENU_LINE_L

Standard Data Fields

Menu Name (MENU_NAME), Menu Item Id (MENU_ITEM_ID), Menu Line Id (MENU_LINE_ID)

Customer Modification

Override Label (OVRD_LABEL) on Menu Line Language Table (CI_MD_MENU_LINE_L)

Meta Data - Program, Location and Services

Properties

Description

Tables

CI_MD_PRG_COM, CI_MD_PRG_LOC, CI_MD_SVC, CI_MD_SVC_L, CI_MD_SVC_PRG, CI_MD_PRG_MOD, CI_MD_PRG_EL_AT, CI_MD_PRG_ELEM, CI_MD_PRG_SEC, CI_MD_PRG_SQL, CI_MD_PRG_VAR, CI_MD_PRG_TAB

Standard Data Fields

Program Component Id (PROG_COM_ID), Location Id (LOC_ID), Program Component Name (PROG_COM_NAME), Service Name (SVC_NAME), Navigation Key (NAVIGATION_KEY)

Customer Modification

User Exit Program Name (USER_EXIT_PGM_NAME) on Program Components Table (CI_MD_PRG_COM),

Meta Data - Maintenance Object

Properties

Description

Tables

CI_MD_MO, CI_MD_MO_L, CI_MD_MO_TBL, CI_MD_MO_OPT, CI_MD_MO_ALG

Standard Data Fields

Maintenance Object (MAINT_OBJ_CD)

Customer Modification

None

Meta Data - Work Tables

Properties

Description

Tables

CI_MD_WRK_TBL, CI_MD_WRK_TBL_L, CI_MD_WRK_TBLFLD, CI_MD_MO_WRK

Standard Data Fields

Work Table Name (WRK_TBL_NAME)

Customer Modification

None

Meta Data - Search Object

Properties

Description

Tables

CI_MD_SO, CI_MD_SO_L, CI_MD_SO_RSFLD, CI_MD_SO_RSFLDAT, CI_MD_SOCG, CI_MD_SOCG_FLD, CI_MD_SOCG_FLDAT, CI_MD_SOCG_L, CI_MD_SOCG_SORT

Standard Data Fields

Search Object (SO_CD)

Customer Modification

None

Navigation Option

Properties

Description

Tables

CI_NAV_OPT, CI_NAV_OPT_L, CI_NAV_OPT_CTXT, CI_NAV_OPT_USG, CI_MD_NAV

Standard Data Fields

Navigation Option Code (NAV_OPT_CD), Navigation Key (NAVIGATION_KEY)

Customer Modification

None

Portal and Zone

Properties

Description

Tables

CI_PORTAL, CI_PORTAL_L, CI_PORTAL_ZONE, CI_ZONE, CI_ZONE_L, CI_ZONE_PRM, CI_ZONE_HDL, CI_ZONE_HDL_L, CI_ZONE_HDL_PRM, CI_ZONE_HDL_PRM_L, CI_UI_ZONE

Standard Data Fields

Portal Code (PORTAL_CD), Zone Code (ZONE_CD), Zone Type Code (ZONE_HDL_CD)

•

A new Zone can be added to the Product owned Portal Pages.

•

The existing Zones cannot be removed from the Product owned Portal Pages.

Customer Modification

Sort Sequence (SORT_SEQ) on Context Sensitive Zone Table (CI_UI_ZONE). Show on Portal Preferences (USER_CONFIG_FLG) on Portal Table (CI_PORTAL). Override Sequence (SORT_SEQ_OVRD) on Portal Zone Table (CI_PORTAL_ZONE). Customer Specific Description (DESCRLONG_OVRD) on Zone Language Table (CI_ZONE_L). Override Parameter Value (ZONE_HDL_PARM_OVRD) on Zone Type Parameters Table (CI_ZONE_HDL_PRM). Override Parameter Value (ZONE_PARM_VAL_OVRD) on Zone Parameters Table (CI_ZONE_PRM).

Sequence

Properties

Description

Tables

CI_SEQ

Standard Data Fields

Sequence Name (SEQ_NAME)

Customer Modification

Sequence Number (SEQ_NBR)

This field is updated by the application process and must be set to 1 initially.

Schema

Properties

Description

Tables

F1_SCHEMA

Standard Data Fields

Schema Name (SCHEMA_NAME)

Customer Modification

None

Script

Properties

Description

Tables

CI_SCR, CI_SCR_L, CI_SCR_CRT, CI_SCR_CRT_GRP, CI_SCR_CRT_GRP_L, CI_SCR_DA, CI_SCR_FLD_MAP, CI_SCR_PRMPT, CI_SCR_PRMPT_L, CI_SCR_STEP, CI_SCR_STEP_L

Standard Data Fields

Script (SCR_CD)

Customer Modification

None

To Do Type

Properties

Description

Tables

CI_TD_TYPE, CI_TD_TYPE_L, CI_TD_SRTKEY_TY, CI_TD_DRLKEY_TY, CI_TD_SRTKEY_TY_L

Standard Data Fields

To Do Type Code (TD_TYPE_CD)

Customer Modification

Creation Batch Code (CRE_BATCH_CD), Route Batch Code (RTE_BATCH_CD), Priority Flag (TD_PRIORITY_FLG) on To Do Type Table (CI_TD_TYPE)

XAI Configuration

Properties

Description

Tables

CI_XAI_ADAPTER, CI_XAI_ADAPTER_L, CI_XAI_CLASS, CI_XAI_CLASS_L, CI_XAI_ENV_HNDL, CI_XAI_ENV_HNDL_L, CI_XAI_FORMAT, CI_XAI_FORMAT_L, CI_XAI_RCVR, CI_XAI_RCVR_L, CI_XAI_RCVR_CTX, CI_XAI_RCVR_RSP, CI_XAI_RCVR_RGRP, CI_XAI_SENDER, CI_XAI_SERNDER_L, CI_XAI_SNDR_CTX, CI_XAI_OPTION

Standard Data Fields

Adapter Id (XAI_ADAPTER_ID), Class Id (XAI_CLASS_ID), Envelope Handler Id (XAI_ENV_HNDL_ID), XAI Format Id (XAI_FORMAT_ID), Receiver Id (XAI_RCVR_ID), Sender Id (XAI_SENDER_ID)

Customer Modification

Option Value (OPTION_VALUE) on XAI Option Table (CI_XAI_OPTION)

The following XAI tables might have system data installed upon the initial installation but a subsequence system data upgrade process will not update the content of these table unless the change is documented in the database upgrade guide: CI_XAI_RCVR, CI_XAI_RCVR_L, CI_XAI_RCVR_CTX, CI_XAI_RCVR_RSP, CI_XAI_RCVR_RGRP, CI_XAI_SENDER, CI_XAI_SERNDER_L, CI_XAI_SNDR_CTX

XAI Services

Properties

Description

Tables

CI_XAI_IN_SVC, CI_XAI_IN_SVC_L, CI_XAI_SVC_PARM

Standard Data Fields

XAI Inbound Service Id (XAI_IN_SVC_ID), XAI Inbound Service Name (XAI_IN_SVC_NAME)

Customer Modification

XAI Version (XAI_VERSION_ID), Trace (TRACE_SW), Debug (DEBUG_SW), Request XSL (INPUT_XSL), Response XSL (RESPONSE_XSL), Record XSL (RECORD_XSL and Post Error (POST_ERROR_SW) on XAI Inbound Service Table (CI_XAI_IN_SVC)

Oracle Utilities Application Framework Only Tables

All data of the tables in this group belong to the Oracle Utilities Application Framework. No data modification or addition is allowed for these tables by base product development and customer modification. When an environment is upgraded to the next release of the Oracle Utilities Application Framework, the upgrade process will refresh the data in these tables.

•

CI_MD_AT_DTL / CI_MD_AT_DTL_L

•

CI_MD_ATT_TY

•

CI_MD_CTL / CI_MD_CTL_L

•

CI_MD_CTL_TMPL

•

CI_MD_ELTY / CI_MD_ELTY_L

•

CI_MD_ELTY_AT

•

CI_MD_LOOKUP / CI_MD_LOOKUP_F

•

CI_MD_PDF / CI_MD_PDF_VAL

•

CI_MD_MSG / CI_MD_MSG_L

•

CI_MD_SRC_TYPE / CI_MD_SRC_TYPE_L

•

CI_MD_TMPL / CI_MD_TMPL_L

•

CI_MD_TMPL_ELTY

•

CI_MD_TMPL_VAR / CI_MD_TMPL_VAR_L

•

CI_MD_VAR / CI_MD_VAR_DTL / CI_MD_VAR_DTL_L

•

CI_XAI_EXECUTER / CI_XAI_EXECUTER_L

System Table List

This section contains names of system tables, upgrade actions, and a brief description of tables. The upgrade actions are explained below.

Keep (KP): The data in the table in the customer's database is kept untouched. No insert or delete is performed to this table by the upgrade process. The initial installation will add necessary data for the system

Merge (MG): The non-base product data in the table in the database is kept untouched. If the data belongs to the base product, any changes pertaining to the new version of the software are performed.

Refresh (RF): The existing data in the table is replaced with the data from the base product table.

Note. New product data is also inserted into tables marked as 'Merge'. If implementers add rows for a customer specific enhancement, it can cause duplication when the system data gets upgraded to the next version. We strongly recommend following the guidelines on how to use designated range of values or prefixes to segregate the implementation data from the base product data.

Table Name

Upgrade Action

Description

CI_ALG

MG

Algorithm

CI_ALG_L

MG

Algorithm Language

CI_ALG_PARM

MG

Algorithm Parameters

CI_ALG_TYPE

MG

Algorithm Type

CI_ALG_TYPE_L

MG

Algorithm Type Language

CI_ALG_TYPE_PRM

MG

Algorithm Type Parameter

CI_ALG_TYPE_PRM_L

MG

Algorithm Type Parameter Language

CI_ALG_VER

MG

Algorithm Version

CI_APP_SVC_ACC

MG

Application Service Access Mode

CI_BATCH_CTRL

MG

Batch Control

CI_BATCH_CTRL_ALG

MG

Batch Control Algorithm

CI_BATCH_CTRL_L

MG

Batch Control Language

CI_BATCH_CTRL_P

MG

Batch Control Parameters

CI_BATCH_CTRL_P_L

MG

Batch Control Parameters Language

CI_CHAR_ENTITY

MG

Characteristic Type Entity

CI_CHAR_TYPE

MG

Characteristic Type

CI_CHAR_TYPE_L

MG

Characteristic Type Language

CI_CHAR_VAL

MG

Characteristic Type Value

CI_CHAR_VAL_L

MG

Characteristic Type Value Language

CI_DISP_ICON

MG

Display Icon

CI_DISP_ICON_L

MG

Display Icon Language

CI_FK_REF

MG

Foreign Key Reference

CI_FK_REF_L

MG

Foreign Key Reference Language

CI_LANGUAGE

MG

Language Code

CI_LOOKUP_FIELD

MG

Lookup Field

CI_LOOKUP_VAL

MG

Lookup Field Value

CI_LOOKUP_VAL_L

MG

Lookup Field Value Language

CI_MD_CONST

MG

Constraints

CI_MD_CONST_FLD

MG

Constraint Fields

CI_MD_FLD

MG

Field

CI_MD_FLD_L

MG

Field Language

CI_MD_MENU

MG

Menu Information

CI_MD_MENU_IMOD

MG

Menu Item Module Maint

CI_MD_MENU_ITEM

MG

Menu Item

CI_MD_MENU_ITEM_L

MG

Menu Item Language

CI_MD_MENU_L

MG

Menu Language

CI_MD_MENU_LINE

MG

Menu Line

CI_MD_MENU_LINE_L

MG

Menu Line Language

CI_MD_MENU_MOD

MG

Menu Product Components

CI_MD_MO

MG

Maintenance Object

CI_MD_MO_ALG

MG

Maintenance Object Algorithm

CI_MD_MO_L

MG

Maintenance Object Language

CI_MD_MO_OPT

MG

Maintenance Object Option

CI_MD_MO_TBL

MG

Maintenance Object Table

CI_MD_MO_WRK

MG

Maintenance Object Work Tables

CI_MD_NAV

MG

Navigation Key

CI_MD_PRG_COM

MG

Program Components

CI_MD_PRG_ELEM

MG

UI Page Elements

CI_MD_PRG_EL_AT

MG

UI Page Element Attributes

CI_MD_PRG_LOC

MG

Program Location

CI_MD_PRG_MOD

MG

Program Module

CI_MD_PRG_SEC

MG

UI Page Sections

CI_MD_PRG_SQL

MG

MD SQL Meta Data

CI_MD_PRG_TAB

MG

UI Tab Meta Data

CI_MD_PRG_VAR

MG

Program Variable

CI_MD_SO

MG

Search Object

CI_MD_SOCG

MG

Search Object Criteria Group

CI_MD_SOCG_FLD

MG

Search Object Criteria Group Field

CI_MD_SOCG_FLDAT

MG

Search Criteria Group Field Attribute

CI_MD_SOCG_L

MG

Search Object Criteria Group Language

CI_MD_SOCG_SORT

MG

Search Criteria Group Result Sort Order

CI_MD_SO_L

MG

Search Object Language

CI_MD_SO_RSFLD

MG

Search Object Result Field

CI_MD_SO_RSFLDAT

MG

Search Object Result Field Attribute

CI_MD_SVC

MG

MD Service

CI_MD_SVC_L

MG

MD Service Language

CI_MD_SVC_PRG

MG

MD Service Program

CI_MD_TAB_MOD

MG

UI Tab Module

CI_MD_TBL

MG

MD Table

CI_MD_TBL_FLD

MG

MD Table Field

CI_MD_TBL_FLD_L

MG

MD Table Field Language

CI_MD_TBL_L

MG

MD Table Language

CI_MD_WRK_TBL

MG

Work Table

CI_MD_WRK_TBLFLD

MG

Work Table Field

CI_MD_WRK_TBL_L

MG

Work Table Language

CI_MSG

MG

Message

CI_MSG_CATEGORY

MG

Message Category

CI_MSG_CATEGORY_L

MG

Message Category Language

CI_MSG_L

MG

Message Language

CI_NAV_OPT

MG

Navigation Option

CI_NAV_OPT_CTXT

MG

Navigation Option Context

CI_NAV_OPT_L

MG

Navigation Option Language

CI_NAV_OPT_USG

MG

Navigation Option Usage

CI_PORTAL

MG

Portal

CI_PORTAL_L

MG

Portal Language

CI_PORTAL_ZONE

MG

Portal Zone

CI_SCR

MG

Script

CI_SCR_CRT

MG

Script Criteria

CI_SCR_CRT_GRP

MG

Script Criteria Group

CI_SCR_CRT_GRP_L

MG

Script Criteria Group Language

CI_SCR_DA

MG

Script Data Area

CI_SCR_FLD_MAP

MG

Script Field Mapping

CI_SCR_L

MG

Script Language

CI_SCR_PRMPT

MG

Script Prompt

CI_SCR_PRMPT_L

MG

Script Prompt Language

CI_SCR_STEP

MG

Script Step

CI_SCR_STEP_L

MG

Script Step Language

CI_SEQ

MG

Sequence

CI_TD_DRLKEY_TY

MG

To Do Type Drill Key

CI_TD_SRTKEY_TY

MG

To Do Type Sort Key

CI_TD_SRTKEY_TY_L

MG

To Do Type Sort Key Language

CI_TD_TYPE

MG

To Do Type

CI_TD_TYPE_L

MG

To Do Type Language

CI_UI_ZONE

MG

Context Sensitive Zone

CI_USR_NAV_LINK

MG

User Favorite Links

CI_XAI_ADAPTER

MG

XAI Adapter

CI_XAI_ADAPTER_L

MG

XAI Adapter Lang

CI_XAI_CLASS

MG

XAI Class

CI_XAI_CLASS_L

MG

XAI Class Language

CI_XAI_ENV_HNDL

MG

XAI Envelope Handler

CI_XAI_ENV_HNDL_L

MG

XAI Envelope Handler Language

CI_XAI_IN_SVC

MG

XAI Inbound Service

CI_XAI_IN_SVC_L

MG

XAI Inbound Service Language

CI_XAI_SVC_PARM

MG

XAI Inbound Service Parameters

CI_ZONE

MG

Zone

CI_ZONE_HDL

MG

Zone Type

CI_ZONE_HDL_L

MG

Zone Type Language

CI_ZONE_HDL_PRM

MG

Zone Type Parameters

CI_ZONE_HDL_PRM_L

MG

Zone Type Parameters Language

CI_ZONE_L

MG

Zone Language

CI_ZONE_PRM

MG

Zone Parameters

F1_BUS_OBJ

MG

Business Object

F1_BUS_OBJ_ALG

MG

Business Object Algorithm

F1_BUS_OBJ_L

MG

Business Object Language

F1_BUS_OBJ_OPT

MG

Business Object Option

F1_BUS_OBJ_STATUS

MG

Business Object Status

F1_BUS_OBJ_STATUS_ALG

MG

Business Object Status Algorithm

F1_BUS_OBJ_STATUS_L

MG

Business Object Status Language

F1_BUS_OBJ_STATUS_OPT

MG

Business Object Status Option

F1_BUS_OBJ_STATUS_RSN

MG

Status Reason

F1_BUS_OBJ_STATUS_RSN_L

MG

Status Reason Language

F1_BUS_OBJ_TR_RULE

MG

Business Object Transition Rule

F1_BUS_OBJ_TR_RULE_L

MG

Business Object Transition Rule Language

F1_BUS_SVC

MG

Business Service

F1_BUS_SVC_L

MG

Business Service Language

F1_DATA_AREA

MG

Data Area

F1_DATA_AREA_L

MG

Data Area Language

F1_DB_OBJECTS_REPO

MG

Database Objects Repository

F1_EXT_LOOKUP_VAL

MG

Extendable Lookup

F1_EXT_LOOKUP_VAL_L

MG

Extendable Lookup Language

F1_IWS_ANN

MG

Inbound Web Service Annotation

F1_IWS_ANN_L

MG

Inbound Web Service Annotation Language

F1_IWS_ANN_PARM

MG

Inbound Web Service Annotation Parameter

F1_IWS_ANN_TYPE

MG

Inbound Web Service Annotation Type

F1_IWS_ANN_TYPE_L

MG

Inbound Web Service Annotation Type Language

F1_IWS_ANN_TYPE_PARM

MG

Inbound Web Service Annotation Type Parm

F1_IWS_ANN_TYPE_PARM_L

MG

Inbound Web Service Annotation Type Parameter Language

F1_IWS_SVC

MG

Inbound Web Service

F1_IWS_SVC_L

MG

Inbound Web Service Language

F1_IWS_SVC_OPER

MG

Inbound Web Service Operations

F1_IWS_SVC_OPER_L

MG

Inbound Web Service Operations Language

F1_MANAG_CONTENT

MG

Managed Content

F1_MANAG_CONTENT_L

MG

Managed Content Language

F1_MAP

MG

UI Map

F1_MAP_L

MG

UI Map Language

F1_MIGR_PLAN

MG

Migration Plan

F1_MIGR_PLAN_INSTR

MG

Migration Plan Instruction

F1_MIGR_PLAN_INSTR_ALG

MG

Migration Plan Instruction Algorithm

F1_MIGR_PLAN_INSTR_L

MG

Migration Plan Instruction Language

F1_MIGR_PLAN_L

MG

Migration Plan Language

F1_MIGR_REQ

MG

Migration Request

F1_MIGR_REQ_INSTR

MG

Migration Request Instruction

F1_MIGR_REQ_INSTR_ENTITY

MG

Migration Request Instruction Entity

F1_MIGR_REQ_INSTR_L

MG

Migration Request Instruction Language

F1_MIGR_REQ_L

MG

Migration Request Language

F1_SCHEMA

MG

Schema

SC_ACCESS_CNTL

MG

User Group Access Control

SC_APP_SERVICE

MG

Application Service

SC_APP_SERVICE_L

MG

Application Service Language

SC_USR_GRP_PROF

MG

User Group Profile

CI_ACC_GRP

KP

Access Group

CI_ACC_GRP_DAR

KP

Access Group / Data Access Group

CI_ACC_GRP_L

KP

Access Group Language

CI_APP_SVC_SCTY

KP

Security Type Application Service

CI_CAL_HOL

KP

Work Calendar Holidays

CI_CAL_HOL_L

KP

Work Calendar Holidays Language

CI_CAL_WORK

KP

Work Calendar

CI_CAL_WORK_L

KP

Work Calendar Language

CI_CHTY_TDTY

KP

To Do Type Template Characteristics

CI_COUNTRY

KP

Country

CI_COUNTRY_L

KP

Country Language

CI_CURRENCY_CD

KP

Currency Code

CI_CURRENCY_CD_L

KP

Currency Code Language

CI_DAR

KP

Data Access Role

CI_DAR_L

KP

Data Access Language

CI_DAR_USR

KP

Data Access User

CI_DB_INSTR

KP

DB Process Instruction

CI_DB_INSTR_ALG

KP

DB Process Instruction Algorithm

CI_DB_INSTR_L

KP

DB Process Instruction Language

CI_DB_INST_OVRD

KP

DB Process Instruction Override

CI_DB_PROC

KP

DB Process

CI_DB_PROC_L

KP

DB Process Language

CI_DISP_PROF

KP

Display Profile

CI_DISP_PROF_L

KP

Display Profile Language

CI_ENV_REF

KP

Environment Reference

CI_ENV_REF_L

KP

Environment Reference Language

CI_FUNC

KP

Function

CI_FUNC_FLD

KP

Function Field

CI_FUNC_FLD_L

KP

Function Field Language

CI_FUNC_L

KP

Function Language

CI_GEO_TYPE

KP

Geographic Type

CI_GEO_TYPE_L

KP

Geographic Type Language

CI_INSTALL_ALG

KP

Installation Algorithm

CI_INSTALL_MSG

KP

Installation Message

CI_INSTALL_MSG_L

KP

Installation Message Language

CI_INSTALL_PROD

KP

Installation Product

CI_MD_RPT

KP

Report Definition

CI_MD_RPT_L

KP

Report Language

CI_MD_RPT_LBL

KP

Report Labels

CI_MD_RPT_PARM

KP

Report Parameters

CI_MD_RPT_PARM_L

KP

Report Parameters Language

CI_MD_TOOLREP_XML

KP

MD Tool Reference XML

CI_MD_TOOL_REP

KP

MD Tool Reference

CI_NT_DNTY_CTXT

KP

Notification Download Type Context

CI_NT_DWN_FORM

KP

Notification Download Format

CI_NT_DWN_FORM_L

KP

Notification Download Format Language

CI_NT_DWN_PROF

KP

Notification Download Profile

CI_NT_DWN_PROF_L

KP

Notification Download Profile Language

CI_NT_DWN_TYPE

KP

Notification Download Type

CI_NT_DWN_TYPE_L

KP

Notification Download Type Language

CI_NT_UP_XTYPE

KP

Notification Upload Type

CI_NT_UP_XTYPE_L

KP

Notification Upload Type Language

CI_NT_XID

KP

External System

CI_NT_XID_L

KP

External System Language

CI_PHONE_TYPE

KP

Phone Type

CI_PHONE_TYPE_L

KP

Phone Type Language

CI_ROLE

KP

Role

CI_ROLE_L

KP

Role Language

CI_ROLE_USER

KP

Role User

CI_RPT_OPTION

KP

Report Options

CI_SC_AUTH_LVL

KP

Security Type Auth Level

CI_SC_AUTH_LVL_L

KP

Security Type Auth Level Language

CI_SC_TYPE

KP

Security Type

CI_SC_TYPE_L

KP

Security Type Language

CI_SEAS_SHIFT

KP

Seasonal Time Shift Schedule

CI_SEAS_TM_SHIFT

KP

Seasonal Time Shift

CI_SEAS_TM_SHIFT_L

KP

Seasonal Shift Language

CI_STATE

KP

State

CI_STATE_L

KP

State Language

CI_TD_EX_LIST

KP

To Do Type Message Overrides

CI_TD_TYPE_ALG

KP

To Do Type Algorithms

CI_TD_TYPE_CHAR

KP

To Do Type Characteristic

CI_TD_VAL_ROLE

KP

To Do Type Role

CI_TIME_ZONE

KP

Time Zone

CI_TIME_ZONE_L

KP

Time Zone Language

CI_USR_GRP_SC

KP

User Group Security Type

CI_USR_PORTAL

KP

User Portal

CI_USR_SCR

KP

User Scripts

CI_USR_ZONE

KP

User Zone

CI_WFM

KP

Feature Configuration

CI_WFM_L

KP

Feature Configuration Language

CI_WFM_MSG

KP

Feature Configuration Message

CI_WFM_OPT

KP

Feature Configuration Options

CI_WF_EVT_TYPE

KP

WF Event Type

CI_WF_EVT_TYPE_L

KP

WF Event Type Language

CI_WF_PP

KP

WF Process Profile

CI_WF_PP_L

KP

WF Process Profile Language

CI_WF_PP_NT

KP

WF Process Notification

CI_WF_PP_NT_CRT

KP

WF Process Notification Criteria

CI_WF_PROC_SCHED

KP

WF Process Creation Schedule

CI_WF_PROC_SCHED_K

KP

WF Process Creation Schedule Key

CI_WF_PROC_TMPL

KP

WF Process Template

CI_WF_PROC_TMPL_L

KP

WF Process Template Language

CI_WF_RESP

KP

WF Response

CI_WF_RESP_DEP

KP

WF Response Dependency

CI_XAI_JDBC_CON

KP

XAI JDBC Connection

CI_XAI_JDBC_CON_L

KP

XAI JDBC Connection Language

CI_XAI_JMS_CON

KP

XAI JMS Connection

CI_XAI_JMS_CON_L

KP

XAI JMS Connection Language

CI_XAI_JMS_Q

KP

XAI JMS Queue

CI_XAI_JMS_Q_L

KP

XAI JMS Queue Language

CI_XAI_JMS_TPC

KP

XAI JMS Topic

CI_XAI_JMS_TPC_L

KP

XAI JMS Topic Language

CI_XAI_JNDI_SVR

KP

XAI JNDI Server

CI_XAI_JNDI_SVR_L

KP

XAI JNDI Server Language

CI_XAI_OPTION

KP

XAI Option

CI_XAI_RCVR

KP

XAI Receiver

CI_XAI_RCVR_CTX

KP

XAI Receiver Context

CI_XAI_RCVR_L

KP

XAI Receiver Language

CI_XAI_RCVR_RGRP

KP

XAI Receiver Rule Group

CI_XAI_RCVR_RSP

KP

XAI Receiver Response

CI_XAI_RGRP

KP

XAI Rule Group

CI_XAI_RGRP_ATT

KP

XAI Rule Group Attachment

CI_XAI_RGRP_L

KP

XAI Rule Group Language

CI_XAI_ROUTING

KP

XAI Routing

CI_XAI_RT_TYPE

KP

XAI Route Type

CI_XAI_RT_TYPE_L

KP

XAI Route Type Language

CI_XAI_RULE

KP

XAI Rule

CI_XAI_SENDER

KP

XAI Sender

CI_XAI_SENDER_L

KP

XAI Sender Language

CI_XAI_SNDR_CTX

KP

XAI Sender Context

F1_BKT_CONFIG

KP

Bucket Configuration

F1_BKT_CONFIG_L

KP

Bucket Configuration Language

F1_BKT_CONFIG_REL_OBJ

KP

Bucket Configuration Related Object

F1_BKT_CONFIG_VAL

KP

Bucket Configuration Value

F1_BKT_CONFIG_VAL_L

KP

Bucket Configuration Value Language

F1_BUS_OBJ_STATUS_RSN_CHAR

KP

Status Reason Characteristic

F1_EXTSYS_OUTMSG_PROF

KP

External System Outbound Message Type

F1_INSTALLATION

KP

Installation Option - Framework

F1_IWS_ANN_CHAR

KP

Inbound Web Service Annotation Characteristics

F1_IWS_ANN_TYPE_CHAR

KP

Inbound Web Service Annotation Type Characteristics

F1_IWS_SVC_ANN

KP

Inbound Web Service Link to Annotation

F1_IWS_SVC_CHAR

KP

Inbound Web Service Characteristics

F1_IWS_SVC_LOG

KP

Inbound Web Service Log

F1_IWS_SVC_LOG_PARM

KP

Inbound Web Service Log Parameter

F1_MAP_OVRD

KP

UI Map Override

F1_MD_DB_OBJ

KP

MD Database Object

F1_MST_CONFIG

KP

Master Configuration

F1_OUTMSG_TYPE

KP

Outbound Message Type

F1_OUTMSG_TYPE_L

KP

Outbound Message Type Language

F1_REQ_TYPE

KP

Request Type

F1_REQ_TYPE_L

KP

Request Type Language

F1_REQ_TYPE_LOG

KP

Request Type Log

F1_REQ_TYPE_LOG_PARM

KP

Request Type Log Parameters

F1_SVC_TASK_TYPE

KP

Service Task Type

F1_SVC_TASK_TYPE_CHAR

KP

Service Task Type Characteristics

F1_SVC_TASK_TYPE_L

KP

Service Task Type Language

F1_WEB_SVC

KP

Web Service Adapter

F1_WEB_SVC_CHAR

KP

Web Service Adapter Characteristics

F1_WEB_SVC_L

KP

Web Service Adapter Language

F1_WEB_SVC_LOG

KP

Web Service Adapter Log

F1_WEB_SVC_LOG_PARM

KP

Web Service Adapter Log Parameter

F1_WEB_SVC_OPERATIONS

KP

Web Service Adapter Operations

SC_USER

KP

User

SC_USER_CHAR

KP

User Characteristic

SC_USER_GROUP

KP

User Group

SC_USER_GROUP_L

KP

User Group Language

SC_USR_GRP_USR

KP

User Group User

CI_MD_ATT_TY

RF

MD Element Attribute Type

CI_MD_AT_DTL

RF

MD Element Attribute Type Detail

CI_MD_AT_DTL_L

RF

MD Element Attribute Type Detail Language

CI_MD_CTL

RF

Generator Control

CI_MD_CTL_L

RF

Generator Control Language

CI_MD_CTL_TMPL

RF

Generator Control Template

CI_MD_ELTY

RF

MD Element Type

CI_MD_ELTY_AT

RF

Element Type Attributes

CI_MD_ELTY_L

RF

Element Type Language

CI_MD_LOOKUP_F

RF

MD Lookup Field

CI_MD_MSG

RF

MD Message

CI_MD_MSG_L

RF

MD Message Language

CI_MD_PDF

RF

Predefined Fields

CI_MD_PDF_VAL

RF

Predefined Values

CI_MD_SRC_TYPE

RF

Source Type

CI_MD_SRC_TYPE_L

RF

Source Type Language

CI_MD_TMPL

RF

Template

CI_MD_TMPL_ELTY

RF

Template Element Types

CI_MD_TMPL_L

RF

Template Language

CI_MD_TMPL_VAR

RF

Template Variable

CI_MD_TMPL_VAR_L

RF

Template Variable Language

CI_MD_VAR

RF

Variable

CI_MD_VAR_DTL

RF

Variable Detail

CI_MD_VAR_DTL_L

RF

Variable Detail Language

CI_XAI_EXECUTER

RF

XAI Executer

CI_XAI_EXECUTER_L

RF

XAI Executer Language

License and Copyright Notices

This section provides license and copyright information for the associated products. This includes the following:

•

Notice Concerning Usage of ANTLR

•

Notice Concerning Usage of Apache Software

•

Notice Concerning Usage of ASM

•

Notice Concerning Usage of Concurrent

•

Notice Concerning Usage of DOM4J

•

Notice Concerning Usage of International Components for Unicode (ICU4J)

•

Notice Concerning Usage of Jaxen

•

Notice Concerning Usage of JCIP Annotations

•

Notice Concerning Usage of SLF4J

•

Notice Concerning Usage of Staxmate

•

Notice Concerning Usage of XMLPULL

•

Notice Concerning Usage of XMLUnit

•

Notice Concerning Usage of XStream

•

Notice Concerning Usage of YUI

Third-Party Products

The following sections provide notices and information about the third party products indicated.

Notice Concerning Usage of ANTLR

[The BSD License]

Copyright (c) 2010 Terence Parr

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

\THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of Apache Software

The following files are covered under the Apache 2.0 license:

•

bsf-2.4.0.jar

•

castor-1.3.2-core.jar

•

castor-1.3.2-xml-schema.jar

•

castor-1.3.2-xml.jar

•

cglib-2.2.jar

•

commonj-3.7.1.jar

•

commons-beanutils-core-1.8.3.jar

•

commons-cli-1.1.jar

•

commons-codec-1.6.jar

•

commons-collections-3.2.1.jar

•

commons-fileupload-1.2.2.jar

•

commons-httpclient-3.0.1.jar

•

commons-io-1.3.2.jar

•

commons-lang-2.2.jar

•

log4j-1.2.17.jar

•

serializer-2.7.1.jar

•

stax2-2.1.jar

•

stax2-api-3.0.4.jar

•

wstx-asl-3.2.7.jar

•

xalan-mod-2.7.1.jar

•

xmlparserv2-11.1.1.3.0.jar

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and

You must cause any modified files to carry prominent notices stating that You changed the files; and

You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Notice Concerning Usage of ASM

Copyright (c) 2000-2005 INRIA, France Telecom

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of Concurrent

All classes are released to the public domain and may be used for any purpose whatsoever without permission or acknowledgment. http://g.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html

Notice Concerning Usage of DOM4J

Copyright 2001-2010 (C) MetaStuff, Ltd. All Rights Reserved.

Redistribution and use of this software and associated documentation ("Software"), with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The name "DOM4J" must not be used to endorse or promote products derived from this Software without prior written permission of MetaStuff, Ltd. For written permission, please contact dom4j-info@metastuff.com.

4. Products derived from this Software may not be called "DOM4J" nor may "DOM4J" appear in their names without prior written permission of MetaStuff, Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.

5. Due credit should be given to the DOM4J Project - http://dom4j.sourceforge.net

THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS

``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT

NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of International Components for Unicode (ICU4J)

COPYRIGHT AND PERMISSION NOTICE

Copyright (c) 1995-2010 International Business Machines Corporation and others

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.

Notice Concerning Usage of Jaxen

Copyright 2003-2006 The Werken Company. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of the Jaxen Project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of JCIP Annotations

Attribution 2.5

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.

License

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

1. "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.

2. "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.

3. "Licensor" means the individual or entity that offers the Work under the terms of this License.

4. "Original Author" means the individual or entity who created the Work.

5. "Work" means the copyrightable work of authorship offered under the terms of this License.

6. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.

2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

1. to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;

2. to create and reproduce Derivative Works;

3. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;

4. to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.

5.

For the avoidance of doubt, where the work is a musical composition:

1. Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.

2. Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights agency or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).

6. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).

The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions.The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

1. You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(b), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(b), as requested.

2. If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

1. This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.

2. Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

1. Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.

2. Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.

3. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

4. No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.

5. This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.

Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor.

Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, neither party will use the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time.

Creative Commons may be contacted at http://creativecommons.org/.

Notice Concerning Usage of SLF4J

SLF4J source code and binaries are distributed under the MIT license.

Copyright (c) 2004-2008 QOS.ch

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDE "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Notice Concerning Usage of Staxmate

Copyright (c) 2007, Tatu Saloranta

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of the <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY <copyright holder> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of XMLPULL

XMLPULL API IS FREE

All of the XMLPULL API source code, compiled code, and documentation contained in this distribution *except* for tests (see separate LICENSE_TESTS.txt) are in the Public Domain.

XMLPULL API comes with NO WARRANTY or guarantee of fitness for any purpose.

Initial authors: Stefan Haustein and Aleksander Slominski

2001-12-12

Notice Concerning Usage of XMLUnit

Copyright (c) 2001-2007, Jeff Martin, Tim Bacon

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of the xmlunit.sourceforge.net nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of XStream

Copyright (c) 2003-2006, Joe Walnes

Copyright (c) 2006-2007, XStream Committers

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of

conditions and the following disclaimer. Redistributions in binary form must reproduce

the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of XStream nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRE CT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Notice Concerning Usage of YUI

Copyright © 2012 Yahoo! Inc. All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Yahoo! Inc. nor the names of YUI's contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.