5 Customizing the Application

Oracle Communications MetaSolv Solution (MSS) provides the ability for the administrator to customize the application. You can:

  • Customize the Navbar

  • Customize the error and warning messages

  • Customize reports

  • Code stored procedures in user exits

    Note:

    Coding the user exits is a developer task and usually requires DBA assistance.

Customizing the Navbar

The Navbar tab on the GUI navigation bar contains the standard navigation for MetaSolv Solution. Use the My Navbar tab on the navigation bar to display a custom configuration of groups and links. After you customize the My Navbar tab, it becomes the default navigation for all users. You can select the Navbar tab on the navigation bar to return to the original navigation.

To allow users to customize the default navigation bare, ensure the Allow users to customize My Desktop preference is set to Y.

To customize My Navbar:

  1. Click My Desktop at the top of the navigation bar.

  2. Select Options > Customize Navigation Bar from the menu.

  3. To modify the My Navbar tab on the navigation bar, do one of the following:

    • Click the Add a new group link.

      Enter the group name, select each link you want to add, and click the right arrow button to add.

      To add external links to documents, Web pages, or applications, click the Add your own links link at the bottom of the window. After entering the link name and file location, you can click the Test Link button before adding it to the list.

    • Click the Edit a group link.

    • Click the Change the order of groups link.

  4. Complete the necessary windows, following instructions in the online Help.

To delete all My Navbar changes:

  1. Display My Navbar.

  2. Open the Options menu.

  3. Click Customize My Navigation Bar.

  4. Click the Reset My Navbar button.

Customizing the Error and Warning Messages

You can customize the error and warning messages that you see in the MSS application. You can personalize the messages to better direct your users on how to resolve the problem. For example, when the users are unable to log in to the MSS application, you can replace the standard error such as contact your administrator with a customized text that points to a self-service portal to reset the password. To enable the customization of messages, set the system preference Enable Display of Custom Messages to Y in System Information in the MSS application.

Note:

You can customize the error and warning messages only when running the application in English language as the existing localization process already supports this capability when running in other languages.

You can use MSS database tables to customize all the error and warning messages after you log in to the MSS application. You must use tbs.ini file to customize the error and warning login messages such as invalid username/password, that you see while logging in the MSS application.

Customizing the Application Messages

You can use MSS database tables to customize the error and warning messages that you see after you log in to the MSS application.

To set up custom error and warning messages:

  1. Prepare the application to support message customization.

    Locate and run the custom_msgs.sql in the prodfixsql directory using ASAP user. 
    @driveletter:installation_directory/prodfixsql/custom_msgs.sql

    This script creates the standard text entries for all of the messages that you can customize within the application. They are represented within the ASAP.MSGS table having the LANGUAGE_CD as '0409'.

    Review the log files in the same prodfixsql directory that is generated for each SQL file in custom_msgs.sql.

  2. Configure the custom messages to be displayed in place of the standard messages.

    1. Run the following SQL statement to get all the standard English messages that can be customized. 
      SELECT * FROM ASAP.MSGS WHERE LANGUAGE_CD = '0409';

    2. Identify the messages that you want to customize from the result.

    3. Insert new rows into the ASAP.MSGS table with LANGUAGE_CD = '0000' for the messages that you want to customize. For example, 
      INSERT INTO ASAP.MSGS(MSG_ID, LANGUAGE_CD, MSG_STRING, OBJECT_NM, CONTEXT, LAST_MODIFIED_USERID, LAST_MODIFIED_DATE) 
           VALUES(MSG_ID,'0000','Customized message','Object_name_that_messagebox_is_in','Notes','userID', sysdate)

      Ensure that you insert the rows in ASAP.MSGS table for all the messages that you want to customize.

      Note:

      When inserting the customized text in the ASAP.MSGS table, ensure that the MSG_ID for the inserted rows with the LANGUAGE_CD as '0000' is same as the MSG_ID of the English row with the LANGUAGE_CD as '0409'.

  3. Configure the MSS application to enable customization.

    To enable customization of messages:

    1. Log in to the MSS application with the user who has ASAP privileges.

    2. Set the system preference Enable Display of Custom Messages to Y in System Information.

    3. Log out of the MSS application.

When the system preference is set to Y, the application displays the customized messages from the ASAP.MSGS table. When the preference is set to Y and there is no corresponding custom messages in ASAP.MSGS table, the application displays the standard error and warning messages.

Customizing Login Messages

As there is no database connection prior to logging into the application, an alternative method must be used to customize the potential errors displayed from the login window. To customize these messages, you must add the customized error messages in the section [Custom Login Messages] in tbs.ini file. The following is the sample from tbs.ini:
[Custom Login Messages]       
invalid username/password; logon denied=Customized error message       
Please enter a User ID to logon.=Customized error message

In the tbs.ini file, you must enter the standard English message in the left hand side and enter the equivalent custom error message on the right hand side.

If you do not enter the custom message in tbs.ini file, the application displays the standard messages while logging in.

Note:

The [Custom Login Messages] section in tbs.ini in the /appserver/config directory is added by the installation process for new installations for MSS 6.3.1.818 or later. When you upgrade to MSS 6.3.1.818 or later from an earlier version of MSS, you must add the [Custom Login Messages] section manually in tbs.ini.

Producing Custom Reports

MetaSolv Solution provides preloaded GUI reports through the reporting, trouble management, and security functions. The reporting function provides a variety of reports that can be selected. Instructions for producing these reports appear in the online Help.

When MetaSolv Solution is installed, the installation process deploys a PowerBuilder file named I_rpt.pbl, a file that contains predefined MetaSolv Solution reports in the form of datawindows.

You can also create custom reports that you add to the Selected Report list.To create customized reports for MetaSolv Solution, you must purchase and install PowerBuilder or InfoMaker and follow directions in that documentation to create a report and copy it to the reporting pbl.

For information on using PowerBuilder or InfoMaker, investigate the Appeon website at:

https://www.appeon.com

Creating a Customized Report

To create a customized report and add it to MetaSolv Solution:

  1. Create the report using PowerBuilder or InfoMaker.

    See the third-party documentation for instructions. Use PowerBuilder to copy the report datawindow to I_rpt.pbl on the machine where Tbs.exe runs.

  2. Log in to MetaSolv Solution.

  3. Click the Reporting group.

  4. Click Register Reports and follow directions in the Help to add a new report.

Once registered, the customized report can be selected from the Selected Report drop-down on the Reports window. See the online Help topic about generating a custom report for instructions.

Retaining Customized Reports After an Upgrade

When a new release is installed, the installation process deploys a new copy of I_rpt.pbl. Pre-existing customized reports must then be manually added to the new I_rpt.pbl using PowerBuilder.

To retain customized reports:

  1. Copy the existing copy of I_rpt.pbl with a different name and save it.

  2. Open the copy of I_rpt.pbl in PowerBuilder.

  3. Copy the datawindows for pre-existing custom reports to the new I_rpt.pbl.

  4. Manually distribute the updated I_rpt.pbl to all client machines.

If you select a report, you may get the following error message:

The selected report does not have a datawindow object in I_RPT.BPL.

This error message indicates that the datawindow has not been added to the I_rpt.pbl file on your machine.

If a data window name for a custom report cannot be found in the drop-down after an upgrade:

  1. Unregister the report through the application by deleting the row in the Register Reports window.

  2. Register the report again in the new version of MetaSolv Solution.

Using Stored Procedure Exits

MetaSolv Solution provides user exits for the purpose of making database calls. The exits are empty shells of stored procedures that are already part of the application code. To code these exits, you should be familiar with PL/SQL. Because these are empty shells, you are responsible for any impact a user exit has on performance or data. You must optimize your company's code.

Note:

  • Oracle Global Customer Support (GCS) supports user exits as they are written within the delivered code. GCS does not support any customer-developed code that is stored within these shells nor do we support any residual affects to our delivered code or to any data stored in the database caused by customer-derived code.
  • Oracle recommends COMMIT or ROLLBACK statements NOT be used in the custom logic implemented in the custom stored procedure exit point code or subsequent third party code called from within them unless it has been separated from the main transaction using AUTONOMOUS_TRANSACTION Pragma. The MetaSolv Solution client issues COMMIT and ROLLBACK statements as necessary and their use in the custom logic can cause data integrity problems resulting from an "incremental commit or rollback" within the transaction used by the application. This restriction also applies to custom triggers created on tables.

With these exits, you can have MetaSolv Solution perform tasks that are specific to your business needs, such as:

  • Performing custom validation and pre-PSR validation

  • Defining dependencies

  • Changing optional fields to required

  • Defining default fields, such as a Web host user ID

  • Generating free-format circuit IDs

  • Validate e-mail, ID, and password entries on e-mail service items and Web host items

  • Supplement canceling a PSR order

You cannot use these exits to perform other functions or to call other applications.

Retaining User Exits After an Upgrade

When a new release is installed, the installation process deploys new stored procedures. Pre-existing customized stored procedures (exits) must be saved before the service pack or new release is installed.

To retain existing user exits:

  1. Copy the existing stored procedures with different names.

  2. Install the service pack or new release.

  3. Copy the customized user exits files back to the updated version of the application.

Coding User Exits

These exits are stored in files in the procs directory. The procs directory is installed at the location where the database installer was run. Contact a DBA to find the location.

The following sections provide information for each user exit, including:

  • Description

  • Exit name

  • File name

To add code to a stored procedure exit:

  1. Locate the appropriate file for the exit you want to use.

  2. Open the file with Notepad or other basic text editor.

  3. Add lines of SQL code to define the task you want the application to perform.

  4. Save the file.

  5. Run the file, so the proc with the new code can exist on the database.

Generate a Circuit ID

You can add code to this exit to set the format for a custom circuit ID. The exit is only available for OTF and OTS circuit format types. To call this procedure, the user must first set the Customer Generated Freeformat Circuit ID preference to Y. After setting the preference to Y, the user can access the Connection Identification Maintenance window for a circuit and see an option called Generate Circuit ID.

Table 5-1 describes the circuit ID exit.

Table 5-1 Circuit ID Exit

Identifier Description

GUI location

Connection Identification Maintenance window

Exit name

pkg_generate_freeformat_ecckt.sp_generate_ecckt

File name

paecckt.sql
Generate a Custom Customer Account Number

You can add code to this exit to generate a custom customer account number when creating or selecting a customer for a new Product Service Request. If the user is in Customer Maintenance, the procedure is called by clicking the Apply button or moving from the General tab. If the user is creating the customer directly from the PSR, the procedure is called by clicking OK after entering all of the customer information or selecting an existing customer.

Table 5-2 describes the customer account number exit.

Table 5-2 Customer Account Number Exit

Identifier Description

GUI location

Customer Account Maintenance window

Exit name

sp_PSR_cust_acct_number

File name

custacct.sql
Perform Custom Validation on Network Locations

You can add code to this exit to create custom validations for network locations. This procedure functions when the user clicks the OK button on the Network Location window for a new or existing network location.

Table 5-3 describes the custom validation on network locations exit.

Table 5-3 Custom Validation on Network Locations Exit

Identifier Description

GUI location

Network Location New window

Exit name

sp_NL_custom_validation

File name

nlcustom.sql
PSR Custom Pre-Validation

You can add code to this exit to automatically pre-validate a PSR order. This stored procedure exit is called when validating or finishing a PSR order and is called prior to MetaSolv Solution's validation and prior to the other PSR custom validation user exit discussed in "Perform Custom Validation on a PSR Order".

Table 5-4 describes the PSR custom pre-validation exit.

Table 5-4 PSR Custom Pre-Validation Exit

Identifier Description

GUI location

PSR order

Exit name

Sp_psr_custom_pre_validation

File name

soppreval.sql
Perform Custom Validation on a PSR Order

You can add code to this exit to perform custom validation on a PSR order. To call this procedure, the user validates or finishes a PSR order.

Table 5-5 describes the PSR custom validation exit.

Table 5-5 PSR Custom Validation Exit

Identifier Description

GUI location

PSR Order

Exit name

Sp_psr_custom_validation

File name

socustom.sql
Perform Custom Validation at Task Completion

You can add code to this exit to perform a custom validation at task completion. This stored procedure is called when a user completes any Work Management task, if the Perform Custom Validation at Task Completion preference is set to Y.

Table 5-6 describes the custom validation at task completion exit.

Table 5-6 Custom Validation at Task Completion Exit

Identifier Description

GUI location

Task Completion Maintenance window

Exit name

sp_wm_custom_validation

File name

wmcustom.sql
Populate the Internet Dial Up User ID

You can add code to this exit to automatically populate the Internet Dial Up user ID. This stored procedure is called when a user first accesses the Dial Up Info tab on a PSR, including an Internet Dial Up service item.

Table 5-7 describes the Internet Dial Up user ID exit.

Table 5-7 Internet Dial Up User ID Exit

Identifier Description

GUI location

Dial Up Info tab

Exit name

pkg_psr_custom_keys.sp_custom_dialup_userid

File name

papsrcky.sql
Populate the Internet Dial Up Password

You can add code to this exit to automatically populate the Internet Dial Up password. This stored procedure is called when a user first accesses the Dial Up Info tab on a PSR, including an Internet Dial Up service item.

Table 5-8 describes the Internet Dial Up password exit.

Table 5-8 Internet Dial Up Password Exit

Identifier Description

GUI location

Dial Up Info tab

Exit name

pkg_psr_custom_keys.sp_custom_dialup_password

File name

papsrcky.sql
Populate the PSR Email Password

You can add code to this exit to automatically populate the PSR email password. This stored procedure is called when a user first accesses an Email item's Email Info tab on a PSR order.

Table 5-9 describes the PSR email password exit.

Table 5-9 PSR Email Password Exit

Identifier Description

GUI location

Email Info tab

Exit name

pkg_psr_custom_keys.sp_custom_email_password

File name

papsrcky.sql
Populate the Web Hosting User ID

You can add code to this exit to automatically populate the Web Hosting user ID. This stored procedure is called when a user first accesses the Web Host Info tab on a PSR for a Web Hosting item.

Table 5-10 describes the Web Hosting user ID exit.

Table 5-10 Web Hosting User ID Exit

Identifier Description

GUI location

Web Host Info tab

Exit name

pkg_psr_custom_keys.sp_custom_webhost_userid

File name

papsrcky.sql
Populate the Web Hosting Password

You can add code to this exit to automatically populate the Web Hosting password. This stored procedure is called when a user first accesses the Web Host Info tab on a PSR for a Web Hosting item.

Table 5-11 describes the web hosting password exit.

Table 5-11 Web Hosting Password Exit

Identifier Description

GUI location

Web Host Info tab

Exit name

pkg_psr_custom_keys.sp_custom_webhost_password

File name

papsrcky.sql
Populate the URL

You can add code to this exit to automatically populate the URL on the Dial Up Info tab. This stored procedure exit is called when a user first accesses the Dial Up Info tab on a PSR for an Internet Dial Up service item.

Table 5-12 describes the Dial Up URL exit.

Table 5-12 Dial Up URL Exit

Identifier Description

GUI location

Dial Up Info tab

Exit name

pkg_psr_custom_keys.sp_custom_url

File name

papsrcky.sql
Validate an Email Address

You can add code to this exit to automatically validate the email address entered on an Email service item email Info tab. This stored procedure exit is called on a save, when the user tries to move to another service item or when the user validates.

Table 5-13 describes the email address validation exit.

Table 5-13 Email Address Validation Exit

Identifier Description

GUI location

Email tab of email service item

Exit name

pkg_psr_custom_keys.sp_custom_email_validation

File name

papsrsky.sql
Validate a User ID

You can add code to this exit to automatically validate the user ID entered in the GUI locations listed below. This stored procedure exit is called on a save, when the user tries to move to another service item or when the user validates.

Table 5-14 describes the user ID validation exit.

Table 5-14 User ID Validation Exit

Identifier Description

GUI location

  • Dial up Info tab

  • Web Host Info tab

Exit name

pkg_psr_custom_keys.sp_custom_userid_ validation

File name

papsrcky.sql
Validate a Password

You can add code to this exit to automatically validate the password entered the GUI locations listed in the table below. This stored procedure exit is called on a save, when the user tries to move to another service item or when the user clicks validate.

Table 5-15 describes the password validation exit.

Table 5-15 Password Validation Exit

Identifier Description

GUI location

  • Email tab of Email service item

  • Dial up tab of Dial up service item

  • Web Host tab of Web Host service item

Exit name

pkg_psr_custom_keys.sp_custom_password_validation

File name

papsrcky.sql
Generate an MSAG Validation Audit Trail

You can add code to this exit to generate an MSAG validation audit trail. The stored procedure is called from the End User Location Maintenance window, after the MSAG validation occurs.

Table 5-16 describes the MSAG validation audit trail exit.

Table 5-16 MSAG Validation Audit Trail Exit

Identifier Description

GUI location

End User Location Maintenance window

Exit name

sp_psr_msag_custom_validation

File name

somsagcustom.sql

Supplement Canceling a PSR Order

You can add code to this exit to perform a custom operation when supplement canceling a PSR order.

This functionality is supported only through the GUI.

Table 5-17 describes the PSR custom supplement cancel exit.

Table 5-17 PSR Custom Supplement Cancel Exit

Item Description
GUI location PSR Order
Exit name sp_psr_custom_supp_cancel
File name socustsuppcan.sql

The socustsuppcan.sql file is stored in the installation_directory/procs directory, where installation_directory is the directory on a client machine or on the database server where you extract the contents of the MSS.R6_3_x.byyy_DBInstall.zip file; yyy is the build number.