Axioss 6.1 Asi Java User Guide

AXIOSS® Service Inventory
Java Client
User Guide
Software Release Number 6.1
Document Version Number 1.2
Axiom Part No. 61u5205
Axiom Systems Ltd

www.axiomsystems.com
®
AXIOSS Service Inventory Java Client i
Documentation Feedback
You are invited to submit by email any constructive comments that
may assist in the improvement of this documentation for the future.
Please include the following information with your feedback:
The name of the publication and Axiom Part Number (shown on

the front cover of the document).
The page number, if applicable.
A brief description of the content (for example, are you reviewing

step-by-step instructions that are inaccurate, grammatical errors
in a specific paragraph, or information that requires clarification
or more detail).
Your suggestion for correcting or improving the documentation.
Email to: documentation@axiomsystems.com
This document is the property of Axiom Systems Ltd and the information contained herein is confidential. This
document, either in whole or in part, must not be reproduced or disclosed to others or used for purposes other
than that for which it has been supplied, without prior written permission from Axiom Systems Ltd, or, if any part
hereof is furnished by virtue of a contract with a third party, as expressly authorized under that contract. Axiom
Systems Ltd shall not be liable for any errors or omissions.
AXIOM SYSTEMS LTD PROVIDES THIS DOCUMENT AS IS, WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.
Axiom Systems Ltd. may make improvements and changes to the products described in this document at any
time without notice. Axiom Systems Ltd assumes no responsibility for the use of the product or this document
except as expressly set forth in the applicable Axiom Systems Ltd agreement or agreements and subject to
terms and conditions set forth therein and applicable Axiom Systems Ltd policies and procedures. Periodic
changes are made to the information contained herein; these changes will be incorporated in new editions of the
document.
This document contains confidential information, which is proprietary to Axiom Systems Limited. No part of its contents may be used,
copied, disclosed, or conveyed to any party in any manner whatsoever without prior written permission from Axiom Systems Limited.
®
AXIOSS is a registered trademark of Axiom Systems Limited.
All other trademarks are the property of their respective owners.
Copyright © 2008 Axiom Systems Limited. All rights reserved.
© Axiom Systems Ltd 2008

®
AXIOSS Service Inventory Java Client ii
Contents
Preface........................................................................................................................ viii
Document conventions ............................................................................................... viii
Text ..................................................................................................................... viii
Warnings, Notes and Information ........................................................................ viii
Keyboard Functionality .................................................................................................ix
Tab Order......................................................................................................................ix
Status Information.........................................................................................................ix
Java Features ...............................................................................................................ix
Internationalization........................................................................................................ x
Language............................................................................................................... x
Dates ..................................................................................................................... x
Special Note Concerning Branding........................................................................ x
Contacting Axiom Systems Limited...............................................................................xi
Chapter 1 ....................................................................................................................... 1
Introduction ................................................................................................................... 1
Application Overview .................................................................................................... 1
Features........................................................................................................................ 1
System Requirements................................................................................................... 2
Chapter 2 ....................................................................................................................... 3
Access .......................................................................................................................... 3
Logon Procedure .......................................................................................................... 5
First Logon............................................................................................................. 7
Authorization Message .......................................................................................... 7
Logout Procedure ......................................................................................................... 8
Timeout ......................................................................................................................... 9
Chapter 3 ..................................................................................................................... 10
Application Interface ................................................................................................... 10
Tooltips and Shortcuts ................................................................................................ 12
Error Messages........................................................................................................... 12
Chapter 4 ..................................................................................................................... 13
Object Browser ........................................................................................................... 13
Object Tree ................................................................................................................. 14
Object Browser Checkboxes ............................................................................... 15
Object Details.............................................................................................................. 16
Properties ............................................................................................................ 17
Links .................................................................................................................... 18
ASI Search.................................................................................................................. 20
Parent Object....................................................................................................... 21
Object Name........................................................................................................ 22
Class Selection.................................................................................................... 22
Available Attributes .............................................................................................. 22
Object Description ............................................................................................... 25
Running the Search ............................................................................................. 25
Topology ..................................................................................................................... 26
View..................................................................................................................... 27

®
AXIOSS Service Inventory Java Client iii
Locate an Object ................................................................................................. 27

Passwords .................................................................................................................. 28
Password Options ............................................................................................... 28
SAFE Monitor.............................................................................................................. 29
Methods ...................................................................................................................... 30
Chapter 5 ..................................................................................................................... 34
Run Module Utility....................................................................................................... 34
Parameter Values ....................................................................................................... 35
Copy and Paste .......................................................................................................... 37
Run the Module........................................................................................................... 37
Chapter 6 ..................................................................................................................... 39
Queries ....................................................................................................................... 39
Parameters ................................................................................................................. 39
Reset Parameter Values ............................................................................................. 40
Run the Query............................................................................................................. 40
Chapter 7 ..................................................................................................................... 43
Telephone Management ............................................................................................. 43
Maintenance ............................................................................................................... 44
Allocation Range ................................................................................................. 45
Operators............................................................................................................. 46
Switches .............................................................................................................. 47
Close the Form .................................................................................................... 47
Bulk Load .................................................................................................................... 47
Delete a Range of Numbers ................................................................................ 49
Add a Range of Numbers .................................................................................... 49
Single Load ................................................................................................................. 50
Adding a Number................................................................................................. 51
Query Number ............................................................................................................ 51
Select Numbers ................................................................................................... 53
Modify Number Information ................................................................................. 53
History ................................................................................................................. 53
Geographic Number Portability............................................................................ 54
Attributes ............................................................................................................. 54
Clear Selections .................................................................................................. 55
Chapter 8 ..................................................................................................................... 56
Using Java Help.......................................................................................................... 56
Hyperlinks ................................................................................................................... 56
Table of Contents........................................................................................................ 57
Index ........................................................................................................................... 58
Keyword Searching..................................................................................................... 58
Toolbar........................................................................................................................ 59
Related Topics ............................................................................................................ 59
Changing the Help View ............................................................................................. 59
Appendix A .............................................................................................................. 60
ASI Discrepancy Highlighting...................................................................................... 60
Appendix B .............................................................................................................. 61
XML Structure ............................................................................................................. 61
Upload XML ................................................................................................................ 61

®
AXIOSS Service Inventory Java Client iv
Element Details........................................................................................................... 64

®
AXIOSS Service Inventory Java Client v
List of Illustrations
Figure 2-1: Logon Process ....................................................................................................... 4
Figure 2-2: Loading Message................................................................................................... 5
Figure 2-3: Login Screen.......................................................................................................... 5
Figure 2-4: Invalid Username or Password.............................................................................. 6
Figure 2-5: Change Password Dialog ...................................................................................... 7
Figure 2-6: Password Changed................................................................................................ 7
Figure 2-7: Authorization Message .......................................................................................... 8
Figure 2-8: Exit Confirmation.................................................................................................... 8
Figure 2-9: Close Applet Warning ............................................................................................ 9
Figure 2-10: Timeout Message ................................................................................................ 9
Figure 2-11: Timeout Password Entry...................................................................................... 9
Figure 3-1: Java ASI Interface................................................................................................ 10
Figure 3-2: Hide Toolbar ........................................................................................................ 11
Figure 3-3: Show Toolbar or Select an Option....................................................................... 11
Figure 3-4: Tooltip and Shortcut............................................................................................. 12
Figure 4-1: Object Browser .................................................................................................... 13
Figure 4-2: Object Tree Sample ............................................................................................. 14
Figure 4-3: Compressed and Expanded Objects ................................................................... 15
Figure 4-4: Compressed and Expanded Objects with Class ................................................. 16
Figure 4-5: Object Details Button ........................................................................................... 16
Figure 4-6: Object Details....................................................................................................... 17
Figure 4-7: Object Details Links Tab ...................................................................................... 19
Figure 4-8: Search Button ...................................................................................................... 20
Figure 4-9: ASI Search........................................................................................................... 21
Figure 4-10: Available Attributes ............................................................................................ 23
Figure 4-11: AND/OR Selection Error .................................................................................... 23
Figure 4-12: Completed Available Attributes.......................................................................... 24
Figure 4-13: ASI Search Results............................................................................................ 25
Figure 4-14: Display Results Panel Button ............................................................................ 26
Figure 4-15: Display Topology Panel Button.......................................................................... 27
Figure 4-16: Topology ............................................................................................................ 27
Figure 4-17: Topology Zoom Controls ................................................................................... 27
Figure 4-18: Change Password Button .................................................................................. 28
Figure 4-19: Change Password Dialog .................................................................................. 28
Figure 4-20: Incorrect Old Password...................................................................................... 29
Figure 4-21: New Password Mismatch .................................................................................. 29
Figure 4-22: SAFE Monitor Button ......................................................................................... 30
Figure 4-23: SAFE Monitor..................................................................................................... 30
Figure 4-24: Sample Method Popup ...................................................................................... 31
Figure 4-25: Confirm Run Method Example........................................................................... 31

®
AXIOSS Service Inventory Java Client vi
Figure 4-26: Method Requiring Parameters........................................................................... 32

Figure 4-27: Run Method Success......................................................................................... 32
Figure 4-28: Run Method Error Example ............................................................................... 33
Figure 5-1: Run Module Utility................................................................................................ 35
Figure 5-2: Module Parameters.............................................................................................. 36
Figure 5-3: Delete Parameter Values..................................................................................... 36
Figure 5-4: Module Run Successfully..................................................................................... 37
Figure 5-5: Re-Run Module Confirmation .............................................................................. 38
Figure 6-1: Queries Button ..................................................................................................... 39
Figure 6-2: Query Results Example ....................................................................................... 41
Figure 6-3: No Results Message............................................................................................ 41
Figure 7-1: Telephone Management Button .......................................................................... 43
Figure 7-2: Telephone Number Allocation Form .................................................................... 44
Figure 7-3: Allocation Range Tab........................................................................................... 45
Figure 7-4: Deletion Successful ............................................................................................. 49
Figure 7-5: Single Load Tab................................................................................................... 50
Figure 7-6: Single Load Success ........................................................................................... 51
Figure 7-7: Query Results Example ....................................................................................... 52
Figure 7-8: Telephone History................................................................................................ 54
Figure 8-1: Hyperlink Mouse Pointer...................................................................................... 56
Figure 8-2: Table of Contents Tab ......................................................................................... 57
Figure 8-3: Folder ................................................................................................................... 57
Figure 8-4: Topic Icon ............................................................................................................ 57
Figure 8-5: Index Tab ............................................................................................................. 58
Figure 8-6: Search Tab .......................................................................................................... 58

®
AXIOSS Service Inventory Java Client vii
List of Tables
Table 1-1: Keyboard Functionality........................................................................................... ix
Table 3-1: Icons for Java Windows ........................................................................................ 12
Table 4-1: Attribute Search Operators ................................................................................... 24
Table 6-1: Data Types............................................................................................................ 40
Table 7-1: Bulk Load Boxes ................................................................................................... 48
Table 7-2: Bulk Load Buttons ................................................................................................. 49
Table 7-3: Single Load Boxes ................................................................................................ 51
Table 8-1: Java Help Toolbar ................................................................................................. 59
Appendix A Table 1: ASI Discrepancy Highlighting ............................................................... 60
Appendix B Table 1: XML Element Details ............................................................................ 66

®
AXIOSS Service Inventory Java Client viii
Preface
Document conventions
The following conventions are used throughout the AXIOSS® Suite documentation.
Text
Elements of your user interface, including buttons, menu items, dialog boxes and
windows are shown in bold text.
Example: Click Cancel to close the dialog box.
Example: On the File menu, click Open.
Example code, directory paths, and values that must be entered literally are shown in
green text
Example: Select the file O2SEJBAPI.ear from the ..\ O2S\api\wls9\ directory on your
AXIOSS installation CD.
Warnings, Notes and Information
0 Warnings alert you to items that may have a critical impact on your AXIOSS System
and tells you how to avoid the problem.
Notes provide you with more detailed information that helps you make decisions
appropriate to your business needs
! Important information for understanding the context in which any test, results or
conclusions are presented in the text.

®
AXIOSS Service Inventory Java Client ix
Keyboard Functionality
A number of standard keyboard shortcuts are available throughout the application.
Some may be indicated on menus while others are not.
Shortcut Description of Action

CTRL +X Copy the selected data to the Windows clipboard and remove from original location.
CTRL +C Copy the selected data to the Windows clipboard and leave in place.
CTRL +V Paste the contents of the Windows clipboard at the position of the cursor.
ALT +F4 Exit the browser.
Table 1-1: Keyboard Functionality
Tab Order
The TAB key can be used to move through boxes on a form in the normal manner. A
combination of the SHIFT key and the TAB key will move through the boxes in the
reverse order.
The order in which the boxes are selected with the tab key will normally be from top to
bottom and from left to right unless otherwise indicated.
Status Information
Information on process status and the current background activity is posted on a
floating toolbar that will appear in the centre of the application window, much like a
tooltip although carrying out the function used by the status bar in many applications.
Java Features
You may notice some features of Java that may present slight differences, depending
on circumstances. For example, if the number of items from which you can select in a
box is less than 20, a list will be provided.

®
AXIOSS Service Inventory Java Client x
Internationalization
This section will describe features of localized conventions such as language and
dates that may affect your setup.
Language
Internationalization allows the AXIOSS® Suite applications to adopt the language of
the Oracle server installation.
Dates
The formatting of dates is set on the database server. Users may have different
setting and use these on their local workstations, but when the data is returned to the
server, it will be stored in the format specified on that server.
Special Note Concerning Branding

Internal abbreviations are sometimes used and referred to for clients. This is O2S for
Order to Service and ASI for AXIOSS® Service Inventory. However, in some cases,
the older OMS or HOMS may prevail for the Order to Service clients and IMS and
EMS may prevail for the Service Inventory clients. This is in situations where it has
been deemed inappropriate, unnecessary or impossible to change from the older
abbreviations.

®
AXIOSS Service Inventory Java Client xi
Contacting Axiom Systems Limited

World Wide Web Sites
Axiom Systems Ltd. www.axiomsystems.com
Global Head Office
Address Axiom Systems Limited,
69 Suttons Business Park,
Sutton Park Avenue,
READING,
Berkshire,
RG6 1AZ,
United Kingdom.
Telephone +44 (0)118 929-4000
Support
Axiom Systems Ltd – Support Division
Support Tracker is the web based support interface for reporting and
tracking all issues logged with Axiom Systems.
To obtain your Support Tracker login details contact your Axiom
Account Manager or Axiom Project Manager.
Support Tracker https://support.axiomsystems.com/SupportTracker/
If you have problems accessing Support Tracker contact Axiom
Support by e-mail.
E-mail support@axiomsystems.com
Telephone +44 (0)118 929-4100
Available Monday to Friday, 08:00 to 17:30.
Training
Axiom Systems Ltd – Training Division
Axiom Systems offers a wide range of training courses designed to
meet your business needs.
Our range of training courses is constantly extended, current course
information is available from our website.
Contact the Axiom Training Team by e-mail to discuss your training
needs.
Training Website http://www.axiomsystems.com/services/training.aspx
E-mail training@axiomsystems.com

Chapter 1 Introduction 1
Chapter 1
Introduction
This document is designed to outline the functions of all aspects of the AXIOSS®
Service Inventory Java client (Java ASI).
Application Overview
Java ASI is an application designed to work with the inventory stored on a database
and run actions against this inventory. It runs inside a web browser.
Features
Features include:
• Object Browser
A window for viewing the inventory including the following tools:
• Object Details panel
• Search panel
• Topology panel
• SAFE Monitor
• Password modification tools
• Run Module Utility
A tool for running modular code configured for the purpose of manipulating the
Object Tree

Chapter 1 Introduction 2
• Queries
A tool for running custom built, pre-configured parameter queries
• Telephone Number Management
System Requirements
In order to use Java ASI, your workstation must comply with the minimum
requirements described below:
• IBM-compatible workstation with Pentium 2 class CPU 300Mhz
• MS Windows NT/2000/XP
• 128MB RAM
• Recommended minimum screen resolution of 1024 x 768
• Microsoft Internet Explorer 5 or later
0 If the workstation does not comply with the minimum requirement for 128MB RAM
there will be serious performance issues. This is governed directly by system
requirements made by Java.

Chapter 2 Access 3
Chapter 2
Access
Access and login procedure is governed by your administrative settings and a suitable
shortcut stored in the Windows Start menu and/or the desktop.
The Administration client is used to specify if you have permission to access Java ASI,
which aspects of Java ASI you will see, and which features you can use.
You must hold a valid username and associated password. The process is described
in the following diagram:

Chapter 2 Access 4
Access URL
Login Form
Input UserName,
Password, select
database
Validation of the
UserName and
Password against Validation Fails
database
administration
Functional
Security Applied
First time User

Login or Exit Return to Desktop
Changes Password
Open Warning
Accept or
Decline
Warning
Open Application
Figure 2-1: Logon Process

Chapter 2 Access 5
Logon Procedure
Using a suitable shortcut from the desktop, Windows Start menu or Favorites, you will
need to specify the correct URL for your web browser to load Java ASI. It is designed
as a web interface and will appear as a web page in the web browser. Illustrations
used here will demonstrate the view when using Windows Internet Explorer 6.0. The
version used should be IE5 or later.
When you select the URL, the application security will load which will take a short
while. During this time, a graphic will appear in the centre of the web browser:
Figure 2-2: Loading Message
Once loaded, a login screen will appear, as shown below:
Figure 2-3: Login Screen

Chapter 2 Access 6
If you click the Cancel button on the Login screen at any time, the Login screen will
close and your browser will be redirected to a default web page.
1. Enter a valid User Name.
2. Enter the valid Password associated with the User Name.
3. Normally the correct database name will already appear in the Database SID
field, but if necessary, use the filter arrow provided to select a suitable
alternative.
4. When the correct information has been entered, click Login or press the
ENTER key to activate this button.
You can use the TAB key to move through the fields on the form or point and
click with the mouse.
The entered User Name and Password are now validated against the list of users in
the database and if security access is correct, the form will close and Java ASI will
load within the web browser. If either the username or the password is entered
incorrectly, the following message will load:
Figure 2-4: Invalid Username or Password
Click the OK button to close the message and clear the Login box ready for another
attempt.
If the User Name and Password are valid for this database but you do not have
permission to access Java ASI, a message will inform you of the fact. If you feel you
should have access, contact your system administrator.
If the username and/or password are entered incorrectly or are not valid for this
database, a message will load to state this.
When you click the OK button, the message will close as will the Login screen. Your
web browser will be directed to a default web address.
If the password has expired (the System Administrator sets the length of time for
which a password is valid), the Change Password dialog box will be displayed. This
is described below.
0 For security purposes, if this is the first time you are accessing the database, your
password will expire automatically and you will be required to change the password at
that time. Once changed, the normal rules for password expiry will apply, depending
on the normal expiry time specified for the database passwords (normally 60 days,
although your expiry time may be set differently).

Chapter 2 Access 7
First Logon
If this is the first time you have logged on, the following dialog will load:
Figure 2-5: Change Password Dialog
Type the password you were given by your system administrator in the Old Password
field. Type your new password in the New Password field and repeat the new
password in the Repeat Password field. Click the OK button to close the dialog. If the
change is successful, the following message will load:
Figure 2-6: Password Changed
Passwords must be at least eight characters in length and include at least three
letters and three numbers. The maximum password length is 30 characters.
Passwords may be case sensitive, depending on database settings.
Authorization Message
When you have successfully logged on the following notice will load:

Chapter 2 Access 8
Figure 2-7: Authorization Message
Click Yes to confirm acceptance. The message will close and Java ASI client will load.
If you click No, the message will close and you will not be permitted to access the
database.
Logout Procedure
To logout of the application, click Exit displayed in the application window or use the
keyboard shortcut ALT +X. The following message will load:
Figure 2-8: Exit Confirmation
Click Yes to confirm and close the connection or No to keep the application
connected. When you choose Yes, Internet Explorer will display the message,
“Connection closed”.
Alternatively, you can close the web browser or switch to a completely different web
page. This will log you out of Java ASI automatically. The following message will load:

Chapter 2 Access 9
Figure 2-9: Close Applet Warning
Timeout
Depending on a system parameter set by your system administrator, if you leave the
system without making any changes for the time specified (the default period is 10
minutes), the system will timeout. This will mean that any action you may have left
incomplete will not be carried out. Before continuing, you must log back into the
system, at which time you must recommence any incomplete action that you may
have started before the timeout. You will not be able to continue with that action. This
will impact on any action you may have undertaken. The following message will load:
Figure 2-10: Timeout Message
Click OK to reconnect. The following will load:
Figure 2-11: Timeout Password Entry
Enter the password and click OK to continue. If you do not choose to reconnect, the
applet will close and a message will be displayed in its place to that effect.

Chapter 3 Application Interface 10
Chapter 3
Application Interface
When the application window loads within your web browser, its appearance will be
similar to that shown below:
Figure 3-1: Java ASI Interface
The view within Java ASI may vary slightly depending on the security settings of
your user identity.
At the top of Java ASI window, there are several buttons for you to access the
different aspects of its functionality. These are:
•
Displays the Inventory in a hierarchical, Explorer style, tree structure and
provides tools for viewing selected object details, running searches and viewing
topologies.

•
Provides tools for running pre-designed modules that will manipulate the
inventory.
•
Provides tools for querying the database content.
•
Provides tools for management of telephone numbers.
•
Accesses the online help system.
•
Closes Java ASI application window within the web browser.
The toolbar can be hidden if required. To do so, move the mouse pointer to the blank
grey area directly to the right of the toolbar and right click. A popup menu with a single
item, Hide toolbar, will load, as shown below:
Figure 3-2: Hide Toolbar
To access the toolbar functions or redisplay the toolbar, right click in the thin line
above the application window, below the browser toolbar. The following popup menu
will load:
Figure 3-3: Show Toolbar or Select an Option
Each toolbar button is now represented by a menu item that you can select.
Alternatively, you can redisplay the toolbar by selecting Show toolbar.
When a window is open within the main application window in the web browser, its title
will be displayed in its top left corner and Minimize, Maximize/Restore and Close icons
in the top right, as described in the following table. Most sub-windows will be
resizable.

Icon Name Function

Minimize Reduces the window to an icon within the application browser window.
Maximize Expands the window to fill the application browser window.
Restore Reduces the window to a window that can be resized using drag and drop around the
edges.
Close Closes the window.
Table 3-1: Icons for Java Windows
Any window can also be maximized or restored by double clicking its title bar.
Tooltips and Shortcuts

When the mouse pointer is hovered over some items, a tooltip will appear as
explanation. This may also include the keyboard shortcut to activate an item. For
example, when the mouse pointer is hovered over the Object Browser button, a
tooltip will appear as shown below:
Figure 3-4: Tooltip and Shortcut
The tooltip in this case indicates that this button will load the Object Browser. The
tooltip also indicates that holding down the ALT key and pressing the F1 key will also
achieve this.
Error Messages
If an error occurs, a message will load with the title: “The following error has occurred”.
A simple list of the error will be displayed with two buttons at the bottom. The OK
button will close the error message. The details button will expand the error message
so that in the lower section the error will include a description of the Java Stack Trace.

Chapter 4 Object Browser 13
Chapter 4
Object Browser
Access the ASI Object Browser by clicking Object Browser at the top of the applet
window. When the Object Browser window opens it will resemble that shown below:
Figure 4-1: Object Browser
The ASI Object Browser loads as a window below Java ASI main toolbar buttons. This
new window displays its own title bar and toolbar.

Object Tree
The inventory is displayed in a pane on the left in a hierarchical structure referred to
as the Object Tree. By default, ‘top’ is displayed, and any main containers at the first
level, as shown above. The icons used may vary depending on the properties of the
objects.
To the left of object icons, you may see an expand icon, if the object contains one or
more child objects. This appears as a plus symbol in a box. If you click this symbol,
the tree will expand to show its child object(s). Once expanded, the symbol will
change to a collapse icon, a minus symbol in a box. If you click this, the tree will
collapse again, hiding the child object(s). The following illustration shows a possible
sample of this:
Figure 4-2: Object Tree Sample 1
Expanding and collapsing can also be achieved by double clicking objects.

As the hierarchy is expanded, scroll bars will appear vertically and horizontally to
assist you in viewing the objects. The left hand pane can be resized in proportion to
the right hand pane, currently empty, by dragging and dropping the dividing line to the
left or the right as required.
Depending on the item selected in the Object Tree, a Status bar at the bottom of the
window will display its path in the tree. This will also include, in brackets at the end,
the class of the selected object.
At the top of the applet window are additional buttons, accessing further tools, and a
number of checkboxes that will affect the Object Tree display.
1
The icons displayed for each object may vary considerably.

Object Browser Checkboxes
Show Class
Not checked by default, checking show class will allow the display of the class name
of the object as well as its individual name. When selected, the object name will be
displayed in brackets to the right of the class name.
When selected, the change is not displayed until the Object Tree is refreshed. To
refresh the Object Tree, double click ‘top’.
Geographical Only
The geographical only checkbox is checked by default. However, it is unlikely that
you will be able to view this checkbox at all as its visibility is based on Functional
Security set by your system administrator. If you do have visibility, removing the
checkmark will change the display so that objects specified as system objects
(normally invisible) will become visible when the Object Tree is refreshed.
Show Discrepancies
The show discrepancies checkbox refers to a comparison between real-time network
elements, information extracted using the Service Activation Framework Environment
(SAFE), and objects within the inventory that have been marked with the property,
Network Element. When populated, a third column appears in the Object Details
sub-window, Properties tab to show upload values.
Show Compressed or Expanded

Checked by default, the Show Compressed or Expanded checkbox specifies that if
a class property has been set as ‘compressible’, instead of an object of this class
appearing as separate objects, when it has one or more child objects, its name will
appear as joined to each of the child objects in order to simplify the view. If you
remove the checkmark and refresh the Object Tree, compressible objects will then
appear as separate objects in the Object Tree, i.e. expanded. To demonstrate this, the
left hand illustration below shows what happens when a path is compressed. The right
hand illustration shows the same group of objects when uncompressed. As can be
seen compressing reduces the number of levels that need to be expanded in order to
view the entire tree.
Figure 4-3: Compressed and Expanded Objects

If the show class checkbox is checked, the two views will appear as shown below:
Figure 4-4: Compressed and Expanded Objects with Class
Object Details
The Object Details window is normally open by default, but if not, the first of the
buttons provided at the top of the Object Tree provides the tooltip View Selected
Object Details with the keyboard shortcut ALT +I.
Figure 4-5: Object Details Button
Using this will open a further window in the right hand pane of the ASI Object
Browser. Once opened, the information visible will be directly relevant to the object
selected in the tree.

Figure 4-6: Object Details
The Object Details window is divided into two tabs, Properties and Links.
Properties
The Properties tab describes the properties of the selected object including: Name,
Class and Description, whether or not it is Set Geographically and whether or not it
is Restricted. If you have not been granted permissions to view system or restricted
objects, neither of these checkboxes will be visible.
The lower section of this tab displays in a grid format the Name of any attributes held
by the object and their Values.
When the Show Discrepancies checkbox is checked, an additional column will appear
in the grid for Upload Values. If an upload from the Service Activation Framework
Environment (SAFE) has been conducted, the date and time of that upload is
displayed above the grid. If this is blank, then an upload has not taken place. The
Upload Values are any values that may have been uploaded from the real-time
network using SAFE. These values can then be compared with the Values that were
set before uploading. This is used to bring the inventory network elements in line with
the real-time inventory to ensure accuracy and consistency and is covered later in this
document. Detail on the colors used to highlight this is provided at Appendix A.
The properties listed here are not normally enabled for change, but are
displayed for reference purposes only.
Within the grid, each of the columns can be resized by moving the mouse pointer over
the edges of the column labels and using drag and drop when the double-headed
arrow mouse pointer can be seen.

Double clicking an attribute in the attributes table will display the value of that attribute
in a popup box (to allow large values to be viewed).
If the attribute is of type CLOB 2 (indicated by the attribute name being prefixed
"CLOB_" 3 ) then double clicking that entry in the table will display the contents of the
associated CLOB in a popup box.
This CLOB can be updated depending on the functional security settings for the
current user.
Multiple rows can be selected by using a combination of the CTRL or the SHIFT key
with the mouse.
URL Attributes
An attribute type of URL may be encountered. This allows items such as web
addresses to be used as attribute values.
Links
There are two types of links available in ASI:
• Simple Peer Links: These are directional, they go from one object to a second
object. There can only be one simple peer-link from one object to another. For
example, you can create a simple peer link from Objects AÆB, but you cannot
then create another simple peer link from the same objects AÆB. You can have
two simple peer links between the same two objects if the links are in opposite
directions. So you may see peer links that run BÆA and AÆB on the same
objects.
• Peer Links with Attributes. They are also directional linking two objects, and
have the advantage of allowing the association of a name, description, and
attributes with the link itself. Multiple links between the same two objects are
permitted for links with attributes, so you may see multiple links that run AÆB
on the same two objects.
You can view the links to either another object or class in the Links tab.
2
Character Large Object – used for storing exceptionally large text strings that may be greater in size than 32k.
3
This prefix will not be displayed in the table

Figure 4-7: Object Details Links Tab
Some objects may not have any links, in which case this tab will remain blank. For
those that have one or more links, they are displayed in a grid format of five columns.
The first column displays an arrow to show the link direction, right facing to show a
parent link and left facing to show a child link. The second column displays the Object
Name. The third column displays the Link Name, this is blank for peer links and
displays the name of the object for object links. The fourth column displays the Link
Class this is also blank for Simple Peer links, but displays the class for Links with
attributes. The fourth column lists the path in the Object Tree of the item named in the
Object column.
The lower half of the Links tab displays the attributes available of any selected link
object.
The widths of the columns are equal by default, but can be resized by moving the
mouse pointer over the edges of the column labels and using drag and drop when the
double headed arrow mouse pointer can be seen.
You can quickly locate the object in the tree that is at the other end of any listed link by
double clicking on its arrow. This is particularly useful when the hierarchy is large and
the ‘other end’ object may be in a completely different location in the tree.

Multiple Selections
Multiple links can be selected by using a combination of the CTRL or the SHIFT key
and clicking with the mouse as required. The SHIFT key allows selection of
contiguous rows while the CTRL key allows selection and de-selection of non-
contiguous rows.
Delete Link
A link can be deleted from this window by right clicking on it in the grid and selecting
Delete Link from the popup menu.
If required you can select multiple links for deletion at the same time.
Copy or Export
Once one or more row(s) are selected, right click one of them to open a popup menu
from which you have a number of possible options. You can copy the selected
information with or without the labels (header row) to the Windows clipboard, or export
the information directly, with or without the labels, to a text file.
Links that have been exported or copied display, at the beginning of the
exported/copied row of data, a chevron or angle bracket indicating the direction of the
link.
ASI Search
Tools are provided to assist you when searching for an object. To open the ASI
Search window, click the button with the tooltip Display Search Panel. This can also
be activated with the shortcut ALT +S.
Figure 4-8: Search Button
A window will open in the right hand pane of the ASI Object Browser. This may be in
addition to other windows or previous windows can be closed or minimized first.
If you open multiple windows, you can minimize some or all of them or tile them
on screen as required.

Figure 4-9: ASI Search
The ASI Search features a number of alternatives to assist you in locating an object in
the tree.
To assist use of this feature, a suitable tooltip will appear when you hover the
mouse over any of the list boxes in the ASI Search window.
Parent Object
Whatever object is already selected in the Object Tree, you can accept the default
option of Top to begin the search, or you can specify that the search begins at the
currently selected object by choosing Current, in which case the search will
commence at this location and continue further down this particular branch of the tree.
The remainder of the Object Tree will be ignored. If the Object Tree contains a large
number of objects, this option will be preferable to use if possible in order to speed up
the search. When the Current option is selected, the name of the selected object then
appears to the right of the option button.

Object Name
If known the actual object name can be entered here. The * wildcard can be used to
replace character strings when searching. The checkbox to the right will allow you to
specify whether the text you have entered should have its case ignored (default) or
observed. If the case is ignored, whether you typed the Object Name in capitals or not
will not be considered in the search. Remove the checkmark for the case to be
considered.
Class Selection
The Class Selection area is utilized quite simply by locating the class you wish to use
by scrolling through the list of available classes on the left or by clicking on this list and
typing the first letter(s) of the class for which you are searching. As the classes are
stored in alphanumeric order, this will move quickly to an appropriate area of the list.
When you have located the class, double click its name. The class name then appears
in the right hand box. You can add more class names as required. As you add a class
name to the right hand list, it will disappear from the left hand list.
You can select more than one class by holding down the CTRL key as you click with
the mouse on each class you wish to include. Alternatively, select the first item in a
range you want to include, hold down the SHIFT key and click the last item in the
range. This will select all classes between the two points. Once selected, click
to add all the classes you just selected.
If you wish to add all possible classes, click .

To remove a class from the right hand list, double click its name. You can scroll
through the list as before or select the list and type initial letter(s) as before to locate
quickly a class to be removed.
As with adding classes, you can select more than one, described above, from the right
hand list and then click to remove all items selected.
To remove all classes from the right hand list, click .
Available Attributes
If one or more classes have been selected, the attributes for those classes will be
listed in the left hand box in the Available Attributes area. Locate the attribute you
wish to use by scrolling through the list of available attributes on the left or by clicking
on this list and typing the first letter(s) of the attribute for which you are searching. As
the attributes are displayed in alphanumeric order, this will move quickly to an
appropriate area of the list. When you have located the attribute you wish to use,
double click its name. The section to the left is then populated with an appropriate
formula for that attribute. An example is shown below:

Figure 4-10: Available Attributes
Parenthesis
If you are going to use more than one attribute, or possibly the same attribute more
than once, in your search, you may wish to priorities the action of each attribute
search by using parenthesis (brackets). These are accessed in the first and last
columns of the formula grid. Click once inside the bracket box for the row to which you
wish to apply brackets. A list of two options will drop down. The first item is empty, a
null value (to be used if you do not want to use brackets), the second is the bracket.
Click the bracket to use it.
And/Or
If you are going to use more than one attribute, or possibly the same attribute more
than once, in your search, you can specify if the results will be based on AND or OR.
In other words, must the value you specify in each attribute be true in both (or all
cases) or can the values be alternative (one or the other).
The first row in an attribute search must be AND. If you use OR, the following error
message will load when the search is run:
Figure 4-11: AND/OR Selection Error
The default value is AND.
Click the OK button to close the message and return to the search criteria.
Operator
By default, the operator used is =, but by clicking on this symbol, you can select from
a list of alternatives. The following table describes the function of each operator:

Operator Function
= Is equal to
!= Is not equal to
<= Is less than or equal to
>= Is greater than or equal to
< Is less than
> Is greater than
LIKE Is similar to
NOT LIKE Is not similar to
IS NULL Has no value
IS NOT NULL Must have a value
Table 4-1: Attribute Search Operators
Value
Type the value to be compared directly into the Value column.
Ignore Case
If you wish the case of the text that you have typed in the Value column to be ignored,
click the checkbox in the Ignore Case column. By default, this is not checked and the
significance of whether you typed in capitals or will be considered.
The following example shows two attributes for a single class in use. The window was
widened as much as possible so that all the columns can be viewed clearly.
Figure 4-12: Completed Available Attributes
Remove an Attribute
If you have added an attribute and later wish to remove it from the search, right click
on the attribute row. A popup menu will appear with a single item, Remove Attribute.
Select this and the row is removed from the grid.

Object Description
The Object Description field refers directly to text that may have been typed as a
description when creating the object. The entire text of the description must be
entered accurately. The * wildcard can be used to replace character strings when
searching.
Running the Search

Once you have completed the search criteria as required, click the Run Search
button. Depending on the criteria used and the amount of data to be searched, the
results will be displayed after a short period in a separate window entitled ASI Search
Results. The grid displays three columns of information: the Name of the object
found, its Class and its location path in the Object Tree.
At the bottom of the window, the number of rows returned by the search is displayed.
Figure 4-13: ASI Search Results
As soon as the ASI Search Results window opens, an additional button will appear
on the right of the toolbar area. If you switch to another window or close the ASI
Search Results window, clicking this button will reactivate the ASI Search Results
window and bring it to the front again.

Figure 4-14: Display Results Panel Button
Jump to an Object
To jump to any object listed in the ASI Search Results in the Object Tree, double
click its row in the grid. The Hierarchy will open with that object selected.
Multiple Selections
Multiple rows can be selected by using a combination of the CTRL or the SHIFT key
contiguous rows.
Copy or Export
Once one or more results row(s) are selected, right click one of them to open a popup
menu from which you have a number of possible options. You can copy the selected
Encrypted Data
If any of the search results is encrypted, it will not normally be visible. If you have
permission to view the encrypted data, you can click the View Encrypted Data button
provided. Once the encrypted data is visible, it can be treated in the same manner and
non-encrypted data, viewed, copied or exported.
Topology
The Topology is a visual tool designed to simplify the appearance of a network of
objects in a diagrammatic format. A Topology is pre-configured for your use in Java
ASI. Normally objects in the Topology will display suitable icons, but may display
simple rectangles instead, depending on the configuration.
To open a Topology, an object that has been configured to hold a Topology is
selected in the ASI Object Browser. The Display Topology Panel button is then
clicked (or you can use the keyboard shortcut ALT +T).

Figure 4-15: Display Topology Panel Button
The Topology pane will load. If the object selected in the Object Tree does not have
an associated topology, the panel will be blank, but if it does have an associated
topology, you will be able to view it. An example follows:
Figure 4-16: Topology
View
You can use the scrollbars provided to view the full extent of the Topology or adjust
the zoom value by using buttons provided above the Topology, on the ASI Object
Browser window.
Figure 4-17: Topology Zoom Controls
The left pointing arrow button will decrease the zoom value and the right pointing
arrow will increase the zoom value. Using these in conjunction with the scrollbars, you
should be able to optimize the view.
Locate an Object
Using the Topology, you can locate an object in the Object Tree by double clicking its
representation in the diagram.

Passwords
The password access for Java ASI is governed by settings in the Administration client,
however, you can change your password if required by using the Change Password
button provided:
Figure 4-18: Change Password Button
When you click this button, the following dialog will load:
Figure 4-19: Change Password Dialog
You must supply your existing password in the Old Password field and then type the
new password in the New Password field. To verify the new password and ensure
that you have not made any typing errors, you must type it again in the Repeat
Password field.
Password Options
The password you choose must include at least three letters and at least three
numbers. The first character must be a letter.
Passwords must be of at least six characters in total length.
If you decide not to change the password, click the Cancel button to close the dialog
without making any changes.
Once the three fields are complete, click the OK button to close the dialog and confirm
the change.
If the password typed in the Old Password field is incorrect, the following message will
load:

Figure 4-20: Incorrect Old Password
Click the OK button to close the message and return to the Change Password dialog
where you can re-enter the old password.
If you do not type the new password the same in the New Password and Repeat
Password fields, the following message will load:
Figure 4-21: New Password Mismatch
Click the OK button to close the message and return to the Change Password dialog
where you can re-enter the new password in each of the New Password and Repeat
Password fields.
Once the new password is entered correctly and accepted, a message will load to
confirm the change.
Click the OK button to close the message and continue working in Java ASI.
SAFE Monitor
A feature is provided that will allow you to view activity present between Service
Inventory (viewed in Java ASI) and the Service Activation Framework Environment
(SAFE) functionality. To load this feature, click the SAFE Monitor button.

Figure 4-22: SAFE Monitor Button
The SAFE Monitor window will load, displaying a grid of any activity, if applicable. This
is divided into four columns of information: Id, Location, Status and Error Message.
The display can be refreshed if activity changes by clicking the Refresh button at the
bottom of the window.
Double clicking a row will display an error message in a popup box for ease of viewing
if applicable.
In the following illustration, the SAFE Monitor displays a message to show that there
was an upload failure.
Figure 4-23: SAFE Monitor
Methods
In order to further the functionality of the application, individual methods can be
assigned to classes. The methods are created and assigned independently of Java
ASI, but once set up, can be used wherever they have been applied to the class of an
object in the Object Tree.
For example, if methods are assigned to a class called SDH Node, right clicking on
any object of that class in the Object Tree will load a popup menu with the methods
listed. This means that the popup menu may vary for different classes and some
classes may not have any methods assigned, in which case a popup menu will not
appear.

In order that the popup menu methods can be controlled, access to the methods is
assigned as part of your access permissions. Each method that has been written can
be controlled individually so that you may be able to view some methods, but not all.
As each method is custom designed, it is not possible to give a detailed overview.
Using the SDH Node class example, a screenshot is shown below:
Figure 4-24: Sample Method Popup
Once the popup is visible, you select the method you wish to run. This may have a
dynamic effect on the Object Tree, updating information, or return information from the
tree, depending on the design and purpose of the method. Types of method vary
enormously. You may be asked to confirm that you wish to run the method:
Figure 4-25: Confirm Run Method Example
You may be asked to enter values:

Figure 4-26: Method Requiring Parameters
Once the method is run, if it is successful, a message will be displayed to show this:
Figure 4-27: Run Method Success
If there are errors in the method, you will be informed.

Figure 4-28: Run Method Error Example
In the above example, it is possible to click OK and correct the error. This may not
always be possible, depending on the method and its configuration.
It must be stressed that the methods available for each object within the tree may vary
and as each can be custom built for a specific purpose it is not possible to describe all
the possible methods that may be available to you.
The popup boxes associated with methods are user configurable. The box will always
be displayed at the same size and position as the last time it was viewed. This is
maintained between sessions.

Chapter 5 Run Module Utility 34
Chapter 5
Run Module Utility
The Service Inventory Run Module Utility (RMU) is designed for the simple running
of actions, working on the data stored in the inventory. This data has been designed
specifically in modules for this purpose. For example, one of these modules could be
designed to adjust the inventory automatically, creating objects, moving objects and
even deleting objects if required.
Modules are designed in the ASI Designer client. Some modules may require user
input and this information is specified when the module is chosen in the Run Module
Utility.
To load the RMU, either click the RMU button on the toolbar or use the keyboard
shortcut ALT +U.
When RMU loads, it will appear as shown below.

Figure 5-1: Run Module Utility
All modules available for running have been checked with Active status in the ASI
Designer client and will be listed in the combo box at the top of the window where it
states, Select a module. Click anywhere on this panel to open the list of available
modules. They are displayed in alphanumeric order with, if necessary, a scroll bar to
the right. You can scroll through to locate the required module or type the first letter of
the module name to jump to that area of the list. Select the module to be run.
Parameter Values
Once a module is selected, if any parameter values are required, either for input or
output, these will be listed in the boxes in the centre of the window. The required input
parameters will appear in the upper list and output parameters in the lower list.

Figure 5-2: Module Parameters
Any values that have been set as default will already appear in the Values column.
You enter the remaining parameters, or altered default values, as required by clicking
in the Values column for the appropriate parameter. Some will require direct input
from you while others will supply a list from which you can choose.
Mandatory values are indicated with bold labels in the PARAMETERS column.
If you have entered parameter values, including changing any default values, you can
reset these by clicking the Reset button. The following message will load:
Figure 5-3: Delete Parameter Values
Click the Yes button to close the message, clear values and return any defaults. Click
the No button to close the message and return to RMU without losing values you have
entered or changed.
If you have failed to supply a required parameter value when the module is run, a
message will appear to this effect. Click the OK button to close the message and
return to the RMU.

Copy and Paste

A copy-and-paste interface is provided to take a text string from the Windows
clipboard, and paste it into the input variables of a module. The outputs from the
module can then be copied to the Windows clipboard ready to be pasted into another
application.
Information to be pasted must first be copied from its source onto the Windows
clipboard. It must be in CSV 4 format, i.e. a comma must separate each successive
column item and each row of information must be on a separate line. The order must
be that of the rows in the Input grid. Click the Paste CSV button to paste in the
information you have copied. Any default values that were displayed in the Values
column are replaced with the values set up in the CSV string.
If you wish the outputs to be copied to the clipboard, click the Copy CSV button. Any
outputs you have entered will be copied to the Windows clipboard.
Run the Module

When you are ready, click the Run button to run the module. Depending on the
complexity of the module and the size of the inventory, running the module will vary in
the amount of time it takes to complete.
When the module has run successfully, the following message will load:
Figure 5-4: Module Run Successfully
If there are problems and the module cannot run successfully, an appropriate
message will load, with details accessible if required.
If you run the same module a second time after a successful run, on clicking the Run
button the following message will load:
4
Comma Separated Values

Figure 5-5: Re-Run Module Confirmation
Click the Yes button to close the dialog and run the module again. Click the No button
to close the dialog without running the module.

Chapter 6 Queries 39
Chapter 6
Queries
Queries are custom designed tools to assist you in locating a specific item, much like
the Object Browser Search tools. However, all criteria, apart from values, have already
been specified in a particular manner so that the search becomes very easy.
Normally, a query will be designed for a specific purpose, such as, to find the details of
a specific telephone line.
Because queries are custom built, the selection available will vary immensely
depending on your system requirements.
To open the ASI Queries window, click the Queries button or use the keyboard
shortcut ALT +Q.
Figure 6-1: Queries Button
When the Queries window loads, it will not have a query currently loaded. Those
available will be listed in a dropdown box at the top. To load a query, choose from this
list.
Parameters
The upper pane will have one or more rows for any required parameters. They are
listed in columns: the parameter Name, the Type of data the parameter requires and
the Value. Values may be mandatory or optional, depending on the configuration of
the query. Some values may already be provided as default values. You can edit
these and add your own values as required in the Value column provided.
0 The parameter values are case sensitive.

Data types are described in the following table:
Data Type Description

Varchar2 A text string of any Numbers, letters or punctuation marks.
Number Numbers of any type including decimals.
Long Long Integers only.
Date A date value only.
Table 6-1: Data Types
Reset Parameter Values

If, at any time, you wish to reset values you have entered, click the Reset button at the
bottom of the window. This will remove added values and restore any defaults.
Run the Query

To run the query, click the Run button at the bottom of the window. The time taken for
the query to run is dependent on the complexity of the query and the amount of data
queried.
The results are displayed in the lower pane in a grid format, a row for each object
found that complies with the query criteria.
The number and type of columns that will appear in the results is entirely dependent
on the design of the query and so cannot be detailed here. An example is shown
below:

Figure 6-2: Query Results Example
If the results table contains a column entitled Object Id then double clicking one of the
rows that result will expand the tree to display that object.
If the query does not locate any results, the following message will load:
Figure 6-3: No Results Message
Click the OK button to close the message and return to the Query window.

Multiple Selections
Multiple links can be selected by using a combination of the CTRL or the SHIFT key
contiguous rows.
Copy or Export
Once one or more row(s) are selected, right click one of them to open a popup menu
from which you have a number of possible options. You can copy the selected

Chapter 7 Telephone Management 43
Chapter 7
Telephone Management
Telephone management tools are provided to assist in managing telephone numbers,

reserving, allocating and marking for specific purposes, those numbers that may be
required.
To access the Telephone Management facility, in the main window, click the
Telephone Management button.
Figure 7-1: Telephone Management Button
The following form will load:

Figure 7-2: Telephone Number Allocation Form
You may wish to resize the form in order to view all the fields effectively.
Maintenance
Maintenance can be carried out for three features of Telephone Number Management.
The Telephone Maintenance form is accessed by clicking the Maintain button in the
bottom right corner of the Telephone Number Management form.
This form has three tabs: Allocation Range, Operators and Switches. By default,
the Allocation Range tab is active on first opening.

Figure 7-3: Allocation Range Tab
Allocation Range
In order to keep a logical ‘handle’ on large ranges of numbers, codes can be assigned
to common numbers that may be used for a specific region and/or purpose, according
to requirements.
Create New
To create a new allocation range, click the Add button at the bottom of the form. The
cursor will move to the Allocation Code field. Enter a suitable code. This field is
mandatory. The Allocation Range Description field is also enabled and is also
mandatory. Use this field to enter a helpful description for the range. For example, if
this range will be used solely for a specific region, enter the name of the region.
Although the Allocation Range Description field value does not have to be unique,
the Allocation Code field must be unique.
When ready, click the Save button. The new allocation range code is added to the
Current Allocation Ranges list below.
Edit
Although allocation ranges cannot be deleted, the Allocation Code and Allocation
Range Description fields can be modified.
1. Select the allocation range to be modified in the Current Allocation Ranges
field.
2. Click the Edit button.

The Allocation Code and Allocation Range Description fields are enabled for
modification.
3. Make any changes you wish.
4. Click the Save button to save the changes.
All numbers in the edited range will remain and can be accessed through the new
details.
Once an allocation range has been created, it cannot be deleted.
Operators
A record of operators can be maintained in the Operators tab of the Telephone
Maintenance dialog. This information is for recording only and does not link into other
areas of Telephone Number Management.
Create New
To create a new operator record:
1. Click the Add button.
The Operator Ref and Operator Name fields empty and the focus moves to
the Operator Ref field. Both fields are mandatory.
2. Type a reference in the Operator Ref field.
3. Type a name in the Operator Name field.
4. Click the Save button or press the ENTER key.
The operator record is saved.
Delete
There is an additional Delete button for the Operator tab. When an operator name is
selected in the Current Operators field, this button can be clicked to delete that
operator.
0 The operator is removed without requiring confirmation.
Edit
To edit operator information, select the operator from the list of Current Operators
and click the Edit button. Make the required changes and click the Save button to
save the changes or the Cancel button to abandon the changes.

Switches
A record of switches can be maintained in the Switches tab of the Telephone
Maintenance dialog. This information is for recording only and does not link into other
areas of Telephone Number Management.
Create New
To create a new switch record:
1. Click the Add button.
The Switch Prefix and Switch Name fields empty and the focus moves to the
Switch Prefix field.
2. Type a reference in the Switch Prefix field.
3. Type a name in the Switch Name field.
Click the Save button to save the switch record.
Delete
There is an additional Delete button for the Switches tab. When an operator name is
selected in the Current Switches field, this button can be clicked to delete that switch.
0 The switch is removed without requiring confirmation.
Edit
To edit switch information, select the operator from the list of Current Switches and
click the Edit button. Make the required changes and click the Save button to save the
changes or the Cancel button to abandon the changes.
Close the Form

Click Cancel to close the form. If you are abandoning changes, you will need to click
the Cancel button twice.
Bulk Load
This is the default tab and enables the simple storing of large ranges of numbers
within the database. The following table describes the fields available and what they
are used for:

Field Description
National Number The group locale or dialing code. This is mandatory.
Group
Number Start The first number in the range to be used following the specified National Number Group.
This is mandatory.
Number End The last number in the range to be used following the specified National Number Group.
This is mandatory.
Bulk Allocation A code assigned to groups of numbers, this is a named range of numbers. Completion is
Code optional, but can be used to add to existing named ranges.
Rule Based In order to specify a particular number pattern, rules can be used to determine what this
pattern will be, for example any of the following might be used:
Rule Example
LAST 4 DIGITS IDENTICAL 561111
LAST 3 DIGITS ZERO 561000
REPEAT 3 DIGIT SEQUENCE 567567
REPEAT 2 DIGIT SEQUENCE 565656
LAST 4 DIGITS SEQUENTIAL 561234
SYMMETRICAL 560056
LAST 3 DIGITS IDENTICAL 561222
LAST 2 DIGITS ZERO 561200
LAST 3 DIGITS SEQUENTIAL 569123
LAST 4 REPEAT 2 DIGIT 561212
When numbers are bulk loaded, these special numbers will be identified and the types will
be set accordingly.
If rules have not been set up, this field will remain blank and disabled.
Non-Rule Based Allows a choice of one of three options for number usage. The options are: Business,
Imported 5 or Residential. Choosing an option is mandatory.
Table 7-1: Bulk Load Boxes
To either delete or create a new range of numbers, complete the fields described.
There are a number of command buttons at the bottom of the window. These are
described in the following table:
5
Refers directly to telephone numbers that have been imported from other service providers

Button Description
Delete Deletes the entered range from the database.
Process Adds the entered range to the database.
Maintain Opens the Telephone Maintenance dialog.
Table 7-2: Bulk Load Buttons
If you enter a Number End figure that is less than the Number Start figure, a suitable
message will load when the Process button is clicked.
Click the OK button to close the message. Adjust the range and proceed as before.
Delete a Range of Numbers

Enter the National Number Group and the range required in the Number Start and
Number End fields. Click the Delete button to remove this range from the database. A
message will load to ask for confirmation of deletion of the selected range of numbers.
Click Yes to close the message and confirm deletion. Click No or Cancel to close the
message without deleting the range.
If you click Yes, a message will load to confirm that the range has been successfully
deleted. Click the OK button to close the message.
Figure 7-4: Deletion Successful
& This feature can also be used to delete a single number

by entering the same number in the Number Start and
Number End boxes.
Add a Range of Numbers

Enter the National Number Group and the range required in the Number Start and
Number End fields. If you wish to use an Allocation Code, select this from the
combo box provided. Specify either a rule or a non-rule based option and click the
Process button to add this range to the database. A message will load to indicate that
the details have been successfully loaded. Click OK to close the message.

Single Load
The Single Load tab is the second tab on the Telephone Number Management form
and is designed for the entry of individual numbers into the database.
Figure 7-5: Single Load Tab
The following table describes the boxes on this tab and their functions:
Box Description
National The group locale or dialing code. This is mandatory.
Number Group
Number To The number that is to be stored. This is mandatory.
Allocate
Type A combo box for choice of Business, Imported or Residential. This is mandatory.
Status A choice of values in a combo box to be assigned to the selected number. These values
are: ASSIGNED, AUTO ALLOCATE RESERVED, AVAILABLE, EXPORTED, HELD,
MALICIOUS, RESERVED and TEMPORARY RESERVED. The default value is null.
Selecting another value is optional.
Account Refers to a specific customer account number. Applicable for an existing account only. This
Number field is optional.

Box Description
Reservation Used in place of the Account Number field where the number is reserved but not yet
Code allocated. The same data is then entered here as would be entered in the Account Number
field. This field is optional.
Start Date This is the date on which the number is allocated if referring to an existing allocation. By
default this supplies today’s date. The format required for this field is indicated in a tooltip
when you hover the mouse pointer over it.
Allocation A code assigned to groups of numbers, this is a named range of numbers. Completion is
Code optional, but can be used to add to existing named ranges.
Comments A free text field for the addition of any comments if required.
Table 7-3: Single Load Boxes
Adding a Number
To add a single number you must enter the National Number Group and the
Number To Allocate. You must also choose a Type and a Status. In addition, you
can specify a customer account number, reservation code and start date, if you wish.
You can also add the number to an allocation range using the Bulk Allocation Code
combo box. A field is provided for comments if required.
When ready, click the Process button. The number will be stored and the following
message will appear:
Figure 7-6: Single Load Success
Click OK to close the message.
There is no facility to remove single numbers. However, you can use the Bulk
Load Delete facility to remove a single number. See page 49.
Query Number
The Query Number tab is a query screen designed for searching the database for a
number or group of numbers. The upper portion of the form is used for entering search
criteria, if required. This includes boxes for the following:

• National Number Group

• Number Start
• Number End
• Number Type
• Status
• Account Number
• Reservation Id
• Allocation Code
• Comments
You can use any or none of these before clicking the Query button at the bottom of
the form. The results are returned in tabular format as shown in the following
illustration:
Figure 7-7: Query Results Example
The resulting table contains columns indicating:

• NNG – National Number Group
• Number – the actual number
• Number Type – whether for business, residential or imported (from another
Telco)
• Number Status
• Account No.
• Start Date
• End Date
• Reservation Code

• Reservation Date
• Allocation Code
• Comments
The results are displayed in pages and the currently viewed range of rows and the
total number of rows appears at the bottom of the form. To the right of this, there are
two buttons that will allow you to move up or down through the pages as required, Pg
down and Pg Up.
Select Numbers
Rows can be selected from the query results table. Click on a single row to select a
single number or hold down the CTRL key as you select multiple rows, these can be
non-contiguous, or select the first in a group, hold down the SHIFT key and select the
last in the group to select a contiguous set of rows.
Modify Number Information

The information held on a selected number or numbers, if more than one row is
selected, can be modified as follows:
1. Select the row(s) to be modified.
2. Click the Modify button.
The following fields in the upper query section are enabled: Number Type,
Status, Account Number, Allocation Code and Comments.
3. Amend any of the fields as required. If more than one row was selected, all
selected rows will be affected in the same way.
If you change the status of a number from RESERVED to something else, the
Reservation Code and Date for that number will normally be retained so that if
the status is returned to RESERVED, the same information will appear. This is
dependent on a system parameter called IMS RESERVATION STATUS where
the default value is RETAINED. If this system parameter value is changed, the
reservation details will not be retained in the database. System parameters can
only be changed by your system administrator.
History
With a single row selected, it is possible to view the history of that number, where
recorded, by clicking the History button. Any transactions or changes that have taken
place concerning this number will then be listed in a separate window, similar to the
following example:

Figure 7-8: Telephone History
In addition, the Telephone History can include history of custom Attributes that may
exist and details of Geographic Number Portability (GNP), if applicable. These two are
displayed as simple tables on separate tabs.
To close this dialog, click the Cancel button.
Geographic Number Portability

This is used for recording numbers imported from one service provider to another. To
access this feature, a number must be selected that carries the status EXPORTED.
The button is enabled in the Query Number tab in this case and also when a number
is added in the Single Load tab with the status of EXPORTED.
When the button is clicked a specific GNP Details dialog will open for that number. As
each may have different details, this form will vary considerably.
Attributes
In order to accommodate a wider availability of information, custom code can now be
written to specify special attribute definitions for telephone numbers. You may have
had custom attributes assigned to the telephone numbers in your database.
If custom code has been written in this respect, the Attributes button will be enabled
when a single telephone number in the Query Number tab is selected. A separate
form will load where the attributes and their associated values will be listed in a read-
only tabular format.

As soon as a new number is created, any custom attributes will be assigned to it with
default values. These default values can only be changed using functions written in
the AXIOSS O2S® Designer client for that purpose.
Clear Selections
If you have selected one or more rows in the results grid, clicking the Clear button will
remove the selection(s).

Chapter 8 Using Java Help 56
Chapter 8
Using Java Help
Help for Java applications differs very little from other styles of help, but you may like
to familiarize yourself with the workings of these features if you have not used Java
Help before. Access the on-line help in Java ASI by clicking the Help button.
This help system is not context sensitive. You must use the tools provided to
locate the required topic.
Moving around in help can be achieved in a number of ways:
Hyperlinks
Hyperlinks are displayed as blue, underlined text. When you hover the mouse pointer
over this text, the mouse pointer will change to the Hyperlink Pointer, as shown below.
Figure 8-1: Hyperlink Mouse Pointer
When the mouse pointer is in this shape, click once with the left mouse button to
activate that link and the window will 'jump' to linked page. Normally the text in the
hyperlink will directly reflect the title of the page to which you will jump.
Hyperlinks can jump to other pages or show information as a separate popup window
on top of the page you are currently reading. In the case of a popup or a text popup,
once read, you can close it by pressing the ESC key or by clicking elsewhere within
the help window. Hyperlinks can also be activated from objects and can jump to an
alternative location within the same page.

Once a hyperlink has been used it will normally be displayed in a different text
color.
Table of Contents
The Table of Contents appears in the Navigation pane on the left of Help. It is the
first tab displayed on the left. When you hover your mouse pointer over the tab a
tooltip will appear to indicate that this is the Table of Contents.
Figure 8-2: Table of Contents Tab
The Table of Contents is much like a file manager and is displayed in a hierarchical
structure divided into two types of item:
• Folders
• Pages
The folders contain groups of related topics, like a folder in a file manager. Pages are
the topics themselves. They are normally open, but if closed, double click it to open it.
Any further books and/or topics it contains will then be displayed. You can close
folders in the same way.
Figure 8-3: Folder
To open a topic, click on the topic name or its icon.
Figure 8-4: Topic Icon
As you navigate, even when using hyperlinks within topics, the Table of Contents will
display the current selected topic.

Index
The Index is accessed from the navigation pane on the left. It is the second tab. When
you hover your mouse pointer over the tab a tooltip will appear to indicate that this is
the Index. Activate the Index by clicking on the Index tab.
Figure 8-5: Index Tab
You use the Index to search for help on topics with a particular theme. All topics that
deal with that theme are displayed in a list. Type the first letter or letters that you are
looking for in the box at the top. The list will automatically be displayed at that point
alphanumerically. Double-click the required topic to display it.
Keyword Searching
Switch to the Search tab in the navigation pane. This is the third tab that you can see.
When you hover your mouse pointer over the tab a tooltip will appear to indicate that
this is the Search tab.
Figure 8-6: Search Tab
Enter a word or words you are looking for in the box at the top. If you find the topic you
require in the list, double click its name to view that topic.

Toolbar
The following table describes the toolbar buttons in detail. When you hover the mouse
over the buttons a short tooltip appears to explain the function of the button.
Button Function
Will return to the topic last viewed. Use this button if you wish to return to a previous page. The
Previous button will remember the order of pages viewed in a session and will return through them at
each click.
Will go back to the topic viewed before clicking the Previous button. If you have not moved back, the
Next button will not work.
Opens the Print dialog. You can accept the default printer, or choose another if preferred.
Opens the Page Setup dialog. You can change any of the print settings as required, including paper
size, orientation and margins.
Table 8-1: Java Help Toolbar
Related Topics
At the bottom of many topics, you will find a button, usually displaying the text See
Also. When you click this, a list of related topics will appear. These work like
hyperlinks. When you click one, a popup list will appear. Click any one and you will
'jump' to that topic.
Changing the Help View

You can adjust the split of the window between the navigation pane on the left and the
topic on the right by moving your mouse pointer over the split and clicking and
dragging the double headed arrow to suit your requirements.
You can hide the navigation pane by clicking on the left pointing arrow on the split or
show it again by clicking the right pointing arrow in the same place on the vertical bar
to the left.

Appendix A: ASI Discrepancy Highlighting 60
Appendix A
ASI Discrepancy Highlighting
Following a network upload, ASI Objects may be flagged as being discrepant with
respect to the network. A discrepant Object is identified in the Java ASI Object Tree by
a small colored square against the Object’s icon; the color of the square represents
the type of discrepancy, and can be one of the following values:
Color Description
BLACK Object is “missing” (conceptually) in ASI (but present in the network).
RED One of the following conditions is true:
The Object’s Attributes are discrepant with respect to the network
There is a discrepancy with the Object’s peer-links
There is a discrepancy with one of the Object’s children
YELLOW The Object is present in ASI, but missing in the network.
WHITE A user generated status, representing that the object is excluded from further reconciliation or
upload. This might be used, for example, for taking a device offline for maintenance. It is applied or
removed using the right mouse options.
Appendix A Table 1: ASI Discrepancy Highlighting

Appendix B: XML Structure 61
Appendix B
XML Structure
This section describes the XML document structures that are generated by safe
functions and published to the ASI Upload Component via JMS.
Upload XML
<upload time="" type="{create|delete}" orphan_parent_id="">
<searches>
<object id="" max_objects="">
<name></name>
<class></class>
<attributes>
<attribute>
<name</name>
<value></value>
</attribute>
</attributes>
</object>
</searches>
<references>
<reference>
<object direct_update="Y" lookup_domain="" id="">
<name></name>
<class></class>
<attributes>

<attribute direct_update="Y">
<name></name>
<value></value>
</attribute>
</attributes>
<object>
...
</object>
</object>
</reference>
</references>
<device>
<object entry_object="Y">
<name></name>
<class></class>
<attributes/>
<links>
<link direct_update="Y" type="{L|P}" direction="{to|from}">
<object>
<old_name></old_name>
<name></name>
<class></class>
<attributes>
<attribute>
<name></name>
<value></value>
</attribute>
</attributes>
<object idref="">
...
</object>
</object>
</link>
</links>
<object ignore_children="Y">
...
<object delete_if_leaf="Y" display_geographically="N">
...
</object>

</object>
<search idref="" direct_child="Y">
<object>
...
<object>
</search>
<object>
...
<links DELETE_PHYSICAL_LINKS="Y">
<link direct_update="Y" type="{L|P}" direction="{to|from}">
<search idref="">
<object>
</object>
</search>
</link>
</links>
</object>
</object>
</device>
</upload>

Element Details
The following table provides the detail required for the elements:
Description
Description
Mandatory
Attributes
Element
Values
upload Defines the upload. time Y Time the upload occurred in
milliseconds from January 1 1970
00:00:00.
type create Type of upload being performed
delete defaults to create.
Create will create objects and links not
found and update attributes.
Delete will remove the object flagged
entry_object.
orphan_parent_id Id of the object in ASI to build devices
that do not already exist in ASI.
searches Container element for The object within this tag defines the
search definitions search. The attributes supplied along
with the name and class (if supplied)
are used as the search parameters.
references Container element for
references
reference Defines a reference.
device Defines the device.
object Represents an object direct_update Y Prevents changes to this object from
in the ASI object tree. being shown as a discrepancy.
If this object is the If the upload type is ‘create’ and the
child of a search object is not found it will be created but
element then the will not show as a ‘Missing in ASI’.
object is discovered If the upload type is ‘delete’ and the
via the search object is an entry_object or
definition and updated delete_if_leaf then the object will be
by this object.
deleted from ASI and not shown as
‘Missing in the Network’.
entry_object Y Entry object for the upload.
If the upload is a ‘create’ then any child
objects and links not supplied in the
XML will be marked as ‘Missing in
ASI’.
If the upload is a ‘delete’ then this
object and its children will be marked
as ‘Missing in the Network’.

Description
Description
Mandatory
Attributes
Element
Values
lookup_domain The ASI domain supplied is used to
lookup the appropriate name for the
object.
The name element must match a
‘value’ within the domain.
ignore_children Y Child objects are not set as ‘Missing in
the Network’.
ignore_links Y Links to/from this object are not set as
‘Missing in the Network’
delete_physical_links Y Physical links to/from this object are
deleted
id A unique identifier for an object that is
to be referenced further on in the XML
either directly or as a search.
idref This object is the same as the ASI
object previously contained in the XML
with the matching id.
delete_if_leaf Y The object is deleted if it has no child
objects.
display_ N The object will not be displayed
geographically geographically.
max_objects 1, 2, The number of objects that should be
etc. found if the object defines search
parameters. The default is 1, If more
objects are found or no objects are
found then an error occurs.
old_name Contains the old name
of the ASI object if the
object is to be
renamed.
name Contains name of the
ASI object.
If the object has a
lookup domain
attribute then the text
is used to lookup the
name from an ASI
domain.
class Contains the name of
the ASI class.
attributes Container element for

attributes.
attribute Defines an ASI direct_update Y The attribute value will be updated
attribute. rather than the upload value,
preventing any change from being
shown as a discrepancy.

Description
Description
Mandatory
Attributes
Element
Values
name Contains the name of
the ASI attribute.
value Contains the value of

the ASI attribute.
search Defines the search idref Y The object in the searches element
that should be used to with the matching id defines the
find the object. The parameters for this search.
search can be used
under device, object, direct_child Y The child object element is a direct
reference and link child of the search parent object
elements. If the element. If a search with this attribute
search is under an does not find an object then the object
object element then will be created.
the object is passed
into the search
parameters as an
ancestor.
links Container element for delete_physical_links Y Will delete physical links that are not
links. provided in the XML
(links are not
supported during a
‘delete’ upload)
link Defines the object tree direct_update Y Prevent links created from being
structure for the displayed as ‘Missing in ASI’.
remote object to link
the current object to. type Y L The type of link to create
(links are not P L - logical link
supported during a P - physical link
‘delete’ upload)
direction Y to The direction of the link between the
from local and the remote ASI objects.
Appendix B Table 1: XML Element Details

Index 67
Index
A
O
Access permissions ........................................................ 6
Available Attributes ....................................................... 22 Object Browser.............................................................. 13
removing............................................................................... 24 Object Description ......................................................... 25
Axiom Contact Information..............................................xi Object Details ................................................................ 16
Object Name ................................................................. 22
C Object path .................................................................... 14
Object Tree.................................................................... 14
Class Selection ............................................................. 22 Collapse................................................................................ 14
Close Icon ..................................................................... 12 Expand.................................................................................. 14
Collapse Object Tree .................................................... 14 Objects
Compressed objects ..................................................... 15 Methods ................................................................................ 30
Copy ................................................................. 20, 26, 42 Operators ...................................................................... 23
Copy CSV ..................................................................... 37
P
D
Parameter Values.......................................................... 35
Date settings ....................................................................x reset...................................................................................... 36
Definition ......................................................................... 1 Parent Object ................................................................ 21
Password Expiry.............................................................. 6
E Passwords..................................................................... 28
Expand Object Tree ...................................................... 14 Paste CSV..................................................................... 37
Export ............................................................... 20, 26, 42 Peer links
multiple ................................................................................. 20
G Permissions..................................................................... 6
Properties ...................................................................... 17
Geographical only....................................................... 15
Q
H
Queries.......................................................................... 39
Hide toolbar................................................................... 11 parameters............................................................................ 39
I R
Ignore Case .................................................................. 24 Remove
Interface ........................................................................ 10 Available Attributes ............................................................... 24
Internal abbreviations.......................................................x Restore Icon .................................................................. 12
Invalid logon.................................................................... 6 Run Module Utility ................................................... 34, 36
J S
Java Help ...................................................................... 56 SAFE Monitor ................................................................ 29
Search ........................................................................... 20
K Shortcut keys.................................................................. ix
Keyboard shortcuts .........................................................ix Show class .................................................................... 15
Show discrepancies .................................................... 15
L Show toolbar ................................................................. 11
Status bar ...................................................................... 14
Language settings............................................................x
Links ............................................................................. 18 T
Login procedure .............................................................. 3
Logout procedure............................................................ 8 Tab Order ....................................................................... ix
Telephone Management
M add single number ................................................................ 51
Operators.............................................................................. 46
Maximise Icon ............................................................... 12 Rules .................................................................................... 48
Methods ........................................................................ 30 Switches ............................................................................... 47
Minimise Icon ................................................................ 12 Tooltips.......................................................................... 12
Modules ........................................................................ 34 Topology........................................................................ 26
Parameters ........................................................................... 35
Re-run................................................................................... 37 U
Run ....................................................................................... 37
URL Attributes ............................................................... 18

Index 68
Z Zoom
Topology ............................................................................... 27

Axioss 6.1 Asi Java User Guide

Caricato da

Informazioni sul documento

Descrizione originale:

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Axioss 6.1 Asi Java User Guide

Caricato da

Copyright:

Formati disponibili

AXIOSS® Service Inventory

Software Release Number 6.1

Document Version Number 1.2

Axiom Part No. 61u5205

Axiom Systems Ltd

 The name of the publication and Axiom Part Number (shown on

 The page number, if applicable.

 A brief description of the content (for example, are you reviewing

 Your suggestion for correcting or improving the documentation.

Email to: documentation@axiomsystems.com

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

Locate an Object ................................................................................................. 27

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

Figure 4-26: Method Requiring Parameters........................................................................... 32

© Axiom Systems Ltd 2008

Appendix A Table 1: ASI Discrepancy Highlighting ............................................................... 60

Appendix B Table 1: XML Element Details ............................................................................ 66

© Axiom Systems Ltd 2008

Example: On the File menu, click Open.

Warnings, Notes and Information

© Axiom Systems Ltd 2008

Shortcut Description of Action

Table 1-1: Keyboard Functionality

© Axiom Systems Ltd 2008

Special Note Concerning Branding

© Axiom Systems Ltd 2008

Contacting Axiom Systems Limited

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

© Axiom Systems Ltd 2008

First time User

Figure 2-1: Logon Process

© Axiom Systems Ltd 2008

Figure 2-2: Loading Message

Once loaded, a login screen will appear, as shown below:

Figure 2-3: Login Screen

© Axiom Systems Ltd 2008

Figure 2-4: Invalid Username or Password

© Axiom Systems Ltd 2008

Figure 2-5: Change Password Dialog

Figure 2-6: Password Changed

© Axiom Systems Ltd 2008

Figure 2-7: Authorization Message

Figure 2-8: Exit Confirmation

© Axiom Systems Ltd 2008

Figure 2-9: Close Applet Warning

Figure 2-10: Timeout Message

Click OK to reconnect. The following will load:

Figure 2-11: Timeout Password Entry

© Axiom Systems Ltd 2008

Figure 3-1: Java ASI Interface

© Axiom Systems Ltd 2008

Figure 3-2: Hide Toolbar

Figure 3-3: Show Toolbar or Select an Option

© Axiom Systems Ltd 2008

Icon Name Function

Maximize Expands the window to fill the application browser window.

Table 3-1: Icons for Java Windows

Tooltips and Shortcuts

The name of the publication and Axiom Part Number (shown on

The page number, if applicable.

A brief description of the content (for example, are you reviewing

Your suggestion for correcting or improving the documentation.