Oracle Install Base Implementation

______________________________________________Process Flow Diagram

April 2013

1

Table of Contents

1. OVERVIEW OF ORACLE INSTALL BASE..................................................................4

2. PRODUCT DEPENDANCIES.......................................................................................5

3. SETUP REQUIRED.......................................................................................................63.1 Setup within Other Oracle Applications.............................................................................................6

3.1.1 Set Up Oracle Install Base Items in the Item Master......................................................................63.1.2 Set Up Party Contacts.....................................................................................................................63.1.3 Setup to Ensure the Serializability of transactions processed in Oracle Install Base (One Time). 6

3.2 Setup Steps Within Oracle Install Base..............................................................................................73.2.1 Setup Installation Parameters..........................................................................................................83.2.2 Verify Extended Attribute-Level Codes.........................................................................................93.2.3 Setup Extended Attribute Pools....................................................................................................103.2.4 Setup Extended Attribute Classifications.....................................................................................113.2.5 Verify Accounting Classification Codes......................................................................................123.2.6 Setup Instance Type Codes...........................................................................................................133.2.7 Verify Party Sources.....................................................................................................................143.2.8 Setup Codes for Instance-Operating Unit Relationship Types.....................................................153.2.9 Setup Version Labels....................................................................................................................163.2.10 Setup System Type Codes........................................................................................................173.2.11 Setup Split Process Reasons.....................................................................................................183.2.12 Verify Oracle Configurator Enabled Values............................................................................193.2.13 Verify Instance Class Values...................................................................................................203.2.14 Verify Values for the Resubmit Interface Process...................................................................213.2.15 Verify Values for CSI: Propogate Systems Changes...............................................................223.2.16 Setup Regions for the Advanced Search Page.........................................................................233.2.17 Setup the Results of the Search Products Page........................................................................243.2.18 Setup Instance Statuses............................................................................................................253.2.19 Set Up Source Transaction Types............................................................................................263.2.20 Set Up Transaction Subtypes...................................................................................................273.2.21 Verify Transaction Status Codes..............................................................................................283.2.22 Verify Transaction Error Source Types...................................................................................293.2.23 Create Business Users..............................................................................................................303.2.24 Create Agent Users..........................................................................................................................303.2.25 Schedule the Expire End Dated Instances Program.................................................................30

2

3.2.26 Schedule the Install Base Open Interface Program..................................................................313.2.27 Schedule the Initiate Mass Edit Program.................................................................................323.2.28 Schedule the Process Mass Edit Program................................................................................323.2.29 Schedule the Resubmit Interface Process.................................................................................323.2.30 Schedule the Resubmit Waiting Transactions Program...........................................................323.2.31 Schedule the Install Base and Inventory Data Discrepancies Program....................................323.2.32 Schedule the Install Base Error Correction and Synchronization Program.............................33

3.3 Profile Options.................................................................................................................................33

3

1. OVERVIEW OF ORACLE INSTALL BASE

Oracle Install Base is a separate module for Oracle E-Business Suite which is basically used to track the complete life cycle of an item. The item can be an inventory item ie tangible item or intangible item such as License or Service. We can view following details from the Item Instance through the Oracle Install Base View and maintain general information about the item instance as system name,

service id number, owner and location View and update values for additional attributes for an item or instance. View and define associated asset information such as asset number, date placed in

service and employee. View and define names, types and effective dates for additional parties that can be

associated with an instance. View extended pricing attributes that come from Order Management sales order lines at

the sale of an item instance. Review and update counter readings associated with the instance. Create and view notes associated with an item instance. View and create service request associated with the item instance. View open, closed and hold repair orders for an item instance. Retrieve and view the history of an item instance based on a data range or a version

label. Display and maintain operating units associated with the item instance. Displays the item instance configuration page. There you can view the various

configurations and define children for an instance.

4

2. PRODUCT DEPENDANCIES

The following modules must be installed and set up Oracle Install Base to work.

Oracle Inventories

Oracle Enterprise Install Base

Oracle Service Fulfillment Manager

Oracle Order Management

Oracle Purchasing (Optional)

Oracle Accounts Receivable

Oracle Work in Process (Optional)

Oracle Bills of Material

5

3. SETUP REQUIREDFollowing setup are required for configuring the Oracle Install Base

3.1 SETUP WITHIN OTHER ORACLE APPLICATIONS

3.1.1 Set Up Oracle Install Base Items in the Item Master

All the items that need to be tracked in Oracle Install Base are set up as Oracle Install Base track able. For an item to be set up as track able in Oracle Install Base, the Install Base tracking checkbox must be selected on the Service tabbed page of the Master Item window.

Navigation: Inventory > Items > Master Items >

Go to Service Tab on this page and select the check box for Install Base Tracking.

3.1.2 Set Up Party Contacts

Oracle Install Base can maintain the contacts to parties associated with item instance. These contacts to parties must be defined in the HZ_PARTIES table using the Contact Center window before referencing them in Oracle Install Base.

3.1.3 Setup to Ensure the Serializability of transactions processed in Oracle Install Base (One Time)

1. Log into Oracle Applications2. Navigate to System Administrator > Concurrent > Manager > Define

6

3. Query for the Manager SFM Event Manager Queue Service4. Click Work Shifts5. Change the processes to 16. In the Parameter field, change the value of XDP_DQ_INIT_NUM_THREADS to 1 7. Stop and restart the SFM Event Manager Queue.

Figure 3.1.3 Setup to Ensure the Serializability of transactions processed in Oracle Installed Base

3.2 SETUP STEPS WITHIN ORACLE INSTALL BASE

Most of these steps are performed through navigation to Oracle Install Base Setups and Lookups.

Login to the Oracle application with Oracle Installed Base Admin responsibility.

7

Figure 3.2 Navigation for Oracle Install Base Setups

3.2.1 Setup Installation Parameters

Login Oracle Application with Oracle Install Base Admin Responsibility :Setups > Install Parameters

The following list defines the fields in the Installed Parameters window.1. Party Name: The name of your own enterprise that you defined in

TCA as an internal organization2. Full Dump Frequency: The number of updates of an Oracle Installed

Base record before a full image of the record is dumped into the history table.

3. Project Location: The location defined for the use of Instance in Project

4. WIP Location: The location defined for use of instance in WIP5. In-Transit Location: The location defined for use of instances in

transit between organizations.6. PO Location: The location defined for use of instances in WIP

outside processing.7. Category Set Name: The name of the category set to be used in the

additional attributes setup.8. All Parties: If selected, then all parties and locations are made

available for transfer and location change.9. Freeze: After this is selected, the parameters cannot be changed.10. Allocate a WIP: If selected, conditionally allocates component

quantities when completing a multi-quantity assembly WIP job.11. Override Ownership: If selected, allows Oracle Install Base

processing of RMA receipts, order shipment, and miscellaneous receipts regardless of ownership.

8

12. SFM Bypass: Replaces the previous CSE: Bypass Event Queue profile option.

Figure 3.2.1 Installed Parameter Window

3.2.2 Verify Extended Attribute-Level Codes

Type: CSI LookupLookup Type: CSI_IEA_LEVEL_CODEAccess Level: System (non-extensible)Verify that the following values are already seeded for CSI_IEA_LEVEL_CODE

9

Figure 3.2.2 Verify Extended Attribute Level Codes

3.2.3 Setup Extended Attribute Pools

Type: CSI LookupLookup Type: CSI_EXTEND_ATTRIB_POOLAccess Level: Extensible

This is used to define an attribute’s name, code and description to be used in the LOV when the extended attribute is set up.

10

Figure 3.2.3 Setup Extended Attribute Pools

3.2.4 Setup Extended Attribute Classifications

Type: CSI LookupLookup Type: CSI_IEA_CATEGORYAccess Level: Extensible

This is used to define the categories by which an attribute can be classified from a LOV in the extended attribute setup.

11

Figure 3.2.4 Setup Extended Attribute Classifications

3.2.5 Verify Accounting Classification Codes

Type: CSI LookupLookup Type: CSI_ACCOUNTING_CLASS_CODEAccess Level: System

Verify that the following values are already seeded for CSI_ACCOUNTING_CLASS_CODE

12

Figure 3.2.5 Verify Accounting Classification Codes

3.2.6 Setup Instance Type Codes

Type: CSI LookupLookup Type: CSI_INST_LOCATION_SOURCE_CODEAccess Level: System

Verify that the following values are already seeded for CSI_INST_LOCATION_SOURCE_CODE

13

Figure 3.2.6 Setup Instance Type Codes

3.2.7 Verify Party Sources

Type: CSI LookupLookup Type: CSI_PARTY_SOURCE_TABLEAccess Level: System

Verify that the following values are already seeded for CSI_PARTY_SOURCE_TABLE

14

Figure 3.2.7 Verify Party Source

3.2.8 Setup Codes for Instance-Operating Unit Relationship Types

Type: CSI LookupLookup Type: CSI_IO_RELATIONSHIP_CODEAccess Level: Extensible

Verify that the following values are already seeded for the CSI_IO_RELATIONSHIP_TYPE_CODE

15

Figure 3.2.8 Verify Codes for Instance Operating Unit Relationship Type

3.2.9 Setup Version Labels

Type: CSI LookupLookup Type: CSI_INSTANCE_VERSION_LABELSAccess Level: Extensible

Verify that the following values are already seeded for CSI_INSTACNE_VERSION_LABELS

16

Figure 3.2.9 Setup Version Labels

Define new version label codes to be used for your organization. This table of codes is used as a source of the LOV for profile option setup in Default Version Label.

3.2.10 Setup System Type Codes

Type: CSI LookupLookup Type: CSI_SYSTEM_TYPEAccess Level: Extensible

17

Figure 3.2.10 Setup System Type Codes

This table is used for user-defined system types which can be set up for use in the LOV. Use this setup window to define types for your organization. They are used in the Systems page of the application to define systems.

3.2.11 Setup Split Process Reasons

Type: CSI LookupLookup Type: CSI_SPLIT_REASON_CODEAccess Level: User

18

Figure 3.2.11 Setup Split Process Reasons

Define split reasons for your organization. When an instance with a quantity greater than 1 is split, a reason code can be selected for the reason for the split. This is the window where the reason codes can be set up for use in an LOV.

3.2.12 Verify Oracle Configurator Enabled Values

Type: CSI LookupLookup Type: CSI_CONFIG_ENABLED_VALUESAccess Level: System

19

Figure 3.2.12 Verify Oracle Configurator Enables Values

This setup maintains the LOV for the profile option CSI: Configurator Enabled and is used for integration.

3.2.13 Verify Instance Class Values

Type: CSI LookupLookup Type: CSI_ITEM_CLASSAccess Level: System

This setup maintains the LOV for the Instance class field in the Service tab in the Inventory Item Setup. It is used for integration with Oracle Telecommunications Service Ordering solution and Oracle Configurator.

20

Figure 3.2.13 Verify Instance Class Values

3.2.14 Verify Values for the Resubmit Interface Process

Type: CSI LookupLookup Type: CSI_RESUBMIT_OPTIONSAccess Level: System

This setup maintains the LOV for the Oracle Install Base concurrent request Resubmit Interface process.

21

Figure 3.2.14 Verify Values for the Resubmit Interface Process

3.2.15 Verify Values for CSI: Propogate Systems Changes

Type: CSI LookupLookup Type: CSI_SYSTEM_WINDOW_DISPLAYAccess Level: System

This setup maintains the LOV for the profile option CSI: Propogate Systems Changes- Window Display. The Maintain System window uses these values when displaying a confirmation window.

22

Figure 3.2.15 Verify Values for CSI: Propogate Systems Changes

3.2.16 Setup Regions for the Advanced Search Page

Type: CSI LookupLookup Type: CSI_ADV_SEARCH_DEF_SHOWAccess Level: System

Unlike the navigation for the other lookups you must use the application developer responsibility to navigate to this lookup. This setup lists regions that are shown by default in the Advanced Search Page.

23

Figure 3.2.16 Regions for Advanced Search Page

3.2.17 Setup the Results of the Search Products Page

Type: CSI LookupLookup Type: CSI_PRODUCTS_TABLE_DEF_COLSAccess Level: SystemNavigation: Application Developer > Application Object Library

This setup customizes the display of the search results of the Search Products page by indicating the display and order of viewable columns.

24

Figure 3.2.17 Set up the Results of the Search Products Page

3.2.18 Setup Instance Statuses

Instance statuses are user extensible and are defined using a combination of settable checkboxes. There are 16 seeded statuses. Login with Oracle Installed Base Admin Responsibility > Setups > Instance Statuses

The meaning of the checkboxes is as follows:

Terminated: Sets the instance to be terminated.Status Change Allowed: The status can be changed for an instance

currently bearing this status.Service Allowed: Service contract can be active for the instance

with this status. If set to No, then the service contract will be called to terminate the contract.

Requests Allowed: Service request can be created for an instance with this status.

Pre-Defined: SeededUpdatable: The checkboxes on this status can be

updated.

25

Figure 3.2.18 Set up Instance Statuses

3.2.19 Set Up Source Transaction Types

Before any source transaction can be used in the LOV for a transaction subtype, it must be defined in this setup in the Source Transaction Types window. All integration sources and transaction types must be defined here before they can be used to update Oracle Installed Base. Values can be seeded or user defined. Login in Oracle Installed Base with Oracle Installed Base Admin Responsibility > Setups > Source Transactions Types

Application Name: An LOV of Oracle Applications that can be set up to integrate into Oracle Install Base.

Transaction Type: The user-defined name of the kind of transaction that integrates with Oracle Install Base from the application named.

Transaction Name: The user-defined name of the transaction.Description: The user-defined description of the transaction.Source Object: Reserved is for the future use.In Out: Reserved for future use.

26

Figure 3.2.19 Set up Source Transaction Types

3.2.20 Set Up Transaction Subtypes

Transaction types and subtypes are used to specify the kinds of transactions that the interface program can use. The main purpose of the Source Transactions Subtypes window is to specify what kind of update can be done to an Oracle Install Base instance when transactions come from other applications.

27

Figure 3.2.20 Set up Transaction Subtypes

Transaction subtype region is used to define the name of the transaction subtype. The name comes from two sources depending whether the Service Type checkbox is selected or not. If Service Type is selected, then the LOV comes from Service Transaction Billing Types setup. If the Service Type is not selected then the LOV comes from Oracle Install Base Transaction Type code setup.

3.2.21 Verify Transaction Status Codes

Type: CSI LookupLookup Type: CSI_TRANSACTION_STATUS_CODEAccess Level: System

28

Figure 3.2.21 Verify Transaction Status Codes

3.2.22 Verify Transaction Error Source Types

Type: CSI LookupLookup Type: CSI_TXN_ERRORS_SOURCE_TYPESAccess Level: System Values are seeded for this codeWhen an integration transaction is processed with an error, it is posted to the error table with one of these error source types which indicate where an error comes from.

29

Figure 3.2.22 Verify Transaction Error Source Codes

3.2.23 Create Business Users

Create business users as needed for Oracle Install Base. To do so, you must create business users and assign them the responsibility of an Oracle Install Base customer and the predefined role of CSI_END_USER, CSI_READ_ONLY_USER, or CSI_CUSTOMER_USER.

3.2.24 Create Agent Users

Create agent users as needed for Oracle Install Base. To do so, you must create internal users and assign them the predefined CSI_NORMAL_USER role and the responsibility of an Oracle Install Base user.

3.2.25 Schedule the Expire End Dated Instances Program

This program goes through the end dates set up for instances to be expired. If the end date is past due, then the instances are set to expire. Schedule this program to run at least once a day. To schedule the program

Steps:1. Login as Oracle Installed Base Admin in the forms mode.2. Choose Others > Requests

New Request window appears3. Select single request and click OK

30

The Installed Base Requests window appears.4. From the name LOV, select Expire End Dated Instances.5. Click OK6. In the At these Times region, click Schedule.

The scheduler window appears.7. Select the desired running schedule.8. Click OK.

The Installed Base Requests window appears.9. Click Submit.

Figure 3.2.25 Schedule the Expire End Dated Instance Program

3.2.26 Schedule the Install Base Open Interface Program

This program imports significant volumes of data into Oracle Installed Base application tables through its mass load feature. Through its incremental load feature, it synchronizes Oracle Installed Base with subsystems by importing item instances from different feeder systems on a frequent, on-going basis. Through its change functionality, it automates the process of adding as well as updating changes to the attributes of item instances. It also validates imported data to ensure data integrity with Oracle applications. Use the same steps mentioned in 3.2.25 for scheduling the concurrent program. Modify step 4 as follows:

4. Form the Name LOV, select either Installed Base Open Interface or Installed Base Open Interface- Parallel Concurrent Workers.

31

3.2.27 Schedule the Initiate Mass Edit Program

This program polls the submitted mass edit sessions and calls the Process Mass Edit program to process eligible sessions. In order to process mass edit transactions, run the Initiate Mass Edit Concurrent program or schedule it to run at regular intervals. Oracle recommends that you schedule it to run at least once a day. Use the same steps mentioned in 3.2.25 for scheduling the concurrent program. Modify step 4 as follows:

4. Form the Name LOV, select Initiate Mass Edit.

3.2.28 Schedule the Process Mass Edit Program

This is the program that is called automatically to process the mass edit sessions. Schedule it to run at a regular interval to pick up mass edit sessions due to be processed. To schedule this program use the same steps as described in Section 3.2.25. Modify step 4 as follows:

4. From the Name LOV, select Process Mass Edit Transaction.

3.2.29 Schedule the Resubmit Interface Process

This program processes the transactions in the Error processing table. It can be set up to process selected lines or all lines in the table. This program can be called to run by user request or can set up to run at a regular interval. To schedule this program use the same steps as mentioned in 3.2.25. Modify step 4 as follows:

4. From the Name LOV, select Resubmit Interface Process.

3.2.30 Schedule the Resubmit Waiting Transactions Program

This program processes the transactions that are set as waiting status in the Oracle Installed Base update process. The program can be scheduled to run at a regular interval. To schedule this program use the same steps as mentioned in 3.2.25. Modify step 4 as follows:

4. From the Name LOV, select Resubmit Waiting Transactions.

3.2.31 Schedule the Install Base and Inventory Data Discrepancies Program

The Install Base and Inventory Data Discrepancies program picks up the discrepancy data from the tables of Oracle Installed Base and Oracle Inventory and displays it on a report. The program can be scheduled to run at regular interval. To schedule this program use the same steps as mentioned in 3.2.25. Modify step 4 as follows:

32

4. From the Name LOV, select Installed Base and Inventory Data Discrepancies.

3.2.32 Schedule the Install Base Error Correction and Synchronization Program

The Install Base Error Correction and Synchronization program is concurrent program to correct and reprocess the transactions that failed to update item instances in Oracle Install Base. These are the errored transactions that you can view through the Transaction Error Summary and Details window in the application. The program can be scheduled to run at a regular interval. To schedule this program use the steps as mentioned in 3.2.25. Modify step 4 as follows:

4. From the Name LOV, select Install Base Error Correction and Synchronization Program.

3.3 PROFILE OPTIONS

The table below shows the profile options are required to setup at Site Level for using Oracle Installed Base:

SR No.

Name of the Profile Option Comments

1. CSI: Allow_Install_Parameter_Update

The default value=N. Do not alter this setting until instructed to do so as a part of patching or by Oracle Customer Support or Development. Changing the default can cause irrecoverable data corruption. (The profile option is set to Y after migration to allow a one-time update to install parameters. Then it is set to N.)

2. CSI: Auto-Generate System Name

Auto generate system number at a time of system creation.

3. CSI: Auto-split Instances During Instantiation

Auto split instances with multiple quantities to 1 per instance at time of instance creation

4. CSI: Cascade System Termination

Cascade system termination to instacnces

5. CSI: Configurator Enabled Default=Network Models Only. Used for integration with the TSO solution and the Oracle Configurator product.

6. CSI: Counters Enabled Enables Oracle Install Base integration with Oracle Counters.

7. CSI: Debug Level For Debug. Set 9 or 10 to start.

33

8. CSI: Default Instance Status Default Instance Status at the time of instance creation.

9. CSI: Default Version Label Default version label at the time of instance creation.

10. CSI: Display HTML UI Option to use Oracle Installed Base HTML for display

11. CSI: Enable SQL Trace For debug. Set to Y to start the debug.

12. CSI: Forms to SSWA Default Responsibility

Default user for applications to launch HTML from forms. Default Installed base user or from the LOV.

13. CSI: Instance Termination Status

Default Termination Status

14 CSI: Log file Name The name of the log file for debug15. CSI: Log file path For debug (‘utl-file-dir’ parameter in

init.ora)16. CSI: OE Line Processing

DelayDelay between OE Line processing. Time between order line processing to allow for Oracle Install Base update completion to avoid record locking.

17 CSI: Open Interface Commit Record Limit

Used to commit Open Interface transactions to the data base. Default=1000

18. CSI: Restrict LOV’s on Site Usage

Default=N. Set at Site Level. For value=Y, the application restricts the Installed Locations LOV in the System page to customer addresses with locations identified as Install At.

19. CSI: Show Expired Instances Default=N. Enables user to default the value of the Show Expired Products. Checkbox in the Advance Search page.

20 CSI: Stop at Errors Set to Y to start the debug21. CSI: System Name Update

AllowedSystem name update allowed after system name creation.

22 CSI: UI Default Selection of View Details Dropdown

Defines the default link populated in the ‘speed menu’ for summary results displayed in the Search Products page.

23 SERVICE: Master Inventory Validation Organization

Replaces the ASO: Product Organization profile option obsolete in the prior release.

34