DPA User Interface Guide

DPA User Interface GuideAbstract This guide documents the general menus and server parameters associated with Dynamic Provisioning Architecture (DPA) for the OpenCall Profile Manager. Product Version Release E10.00/PM 2.1.0 Supported Releases N/A Part Number/Classification 150316-009 Hewlett-Packard Company Published June 2009 Release ID E10.00/PM 2.1.0 Document History Part Number 150316-009 150316-008 150316-007C 150316-007B 150316-007 150316-006B 150316-006 150316-005 150316-004 Product Version E10.00/PM 2.1,0 E00.00/PM 2.0 D60.30 D60.10 D60.00 D50.20 D50.00 D40.00 D30.00 Published June 2009 November 2008 June 2008 February 2008 July 2007 January 2007 October 2006 March 2006 April 2005 Ordering Information For information on ordering manuals, contact your sales representative. Document Disclaimer Information contained in a manual is subject to change without notice. Please check with your authorized representative to make sure you have the most recent information. Export Statement Export of the information contained in this manual may require authorization from the U.S. Department of Commerce. Examples Examples and sample programs are for illustration only and may not be suited for your particular purpose. The inclusion of examples and sample programs in the documentation does not warrant, guarantee, or make any representations regarding the use of the results of the use of any examples or sample programs in any documentation. You should verify the applicability of any example or sample program before placing the software into productive use. U.S. Government Customers FOR U.S. GOVERNMENT CUSTOMERS REGARDING THIS DOCUMENTATION AND THE ASSOCIATED SOFTWARE: These notices shall be marked on any reproduction of this data, in whole or in part. NOTICE: Notwithstanding any other lease or license that may pertain to, or accompany the delivery of, this computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in Section 52.227-19 of the FARS Computer Software—Restricted Rights clause. RESTRICTED RIGHTS NOTICE: Use, duplication, or disclosure by the Government is subject to the restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227-7013. RESTRICTED RIGHTS LEGEND: Use, duplication or disclosure by the Government is subject to restrictions as set forth in paragraph (b)(3)(B) of the rights in Technical Data and Computer Software clause in DAR 7-104.9(a). This computer software is submitted with “restricted rights.” Use, duplication or disclosure is subject to the restrictions as set forth in NASA FAR SUP 18-52 227-79 (April 1985) “Commercial Computer Software—Restricted Rights (April 1985).” If the contract contains the Clause at 18-52 227-74 “Rights in Data General” then the “Alternate III” clause applies. U.S. Government Users Restricted Rights — Use, duplication or disclosure restricted by GSA ADP Schedule Contract. Unpublished — All rights reserved under the Copyright Laws of the United States. Copyright 2009 Hewlett-Packard Company. All rights reserved. 12.0 Location Title Page 9. E10. 13. 10.00/PM 2. including appropriate modifications to the front and back matter. 13.New and Changed Information You will find the following major changes in this guide.1. Amended CGI command list to notate commands which are only applicable to ANSI HLR Systems. 12. 11. 14 Description Modified Release information. 11. 9. In addition. 11. 13. Feature N/A N/A DPA User Interface Guide – 150316-009 Hewlett-Packard Company 3 . numerous small editorial changes have been made throughout. Contents New and Changed Information 3 Abbreviations 1 Section Descriptions 2 Provisioning Guides 2 User Access 2 References 2 System Security 3 Logging On/Off 3 Passwords 3 Window Functions 4 Action Menus 4 Online Help 4 Online Window Help 4 Online Field Help 5 Window Navigation 6 Moving the Cursor 6 General Tab 6 GCI 8 Method 8 Commands 8 Entity Type 14 Target Name 14 Target Value 14 Property Name 15 Property Value 15 DPA User Interface Guide – 150316-009 Hewlett-Packard Company 1 . Standard Error data stream Standard Input data stream Standard Output data stream Transmission Control Protocol / Internet Protocol Unicode Transformation Format eXtensible Markup Language DPA User Interface Guide – 150316-009 Hewlett-Packard Company 1 .Abbreviations ADR AFC ALM API ASCII BIN CLI CMD CPU CSV Cygwin ERAD HLR HSS INS NDM NSK PM SCARF SMP STDERR STDIN STDOUT TCP / IP UTF XML Agnostic Data Replication Application Foundation Class library Application Lifecycle Management Application Programming Interface American Standard Code for Information Interchange BINary (executable program) file folder Command Line Interface Command Central Processing Unit Comma-Separated Values A linux like environment for Windows Error Reporting and Distribution Home Location Register Home Subscriber Server Intelligent Network Server (of OpenCall) Network Data Management Non-Stop Kernel Profile Manager Statistics Collection And Retrieval Facility Symmetric multiprocessing. server values are not documented in the case of text entry fields or contiguous number ranges where the valid value matches the server value. Section 4 documents the GCI and Programmatic Interface Examples. However. These fields are documented with the text. HLR) provisioning guides provide window displays. References Users should be familiar with the information contained in and have ready access to the following documentation: • • • • DPA Security Administration Guide DPA Subsystem Guide DPA Server Customization Profile Manager External Protocol Interface Guide DPA User Interface Guide – 150316-009 Hewlett-Packard Company 2 . User Access DPA user access is discussed in the DPA Security Administration Guide. (GCI/PI Only) following the field name. entity types. and target names (used for programmatic interface and DPA GCI provisioning) for each file. refer to the Documentation Guide for your OpenCall application. and property names. The provisioning guides also describe fields the are only used for GCI or Programmatic Interface (PI) provisioning. For a complete list of Provisioning Guides. Where appropriate.1 Introduction Section Descriptions This manual is organized into the following sections: Section 1 provides an Introduction to the DPA User Interface Manual. field descriptions. Provisioning Guides OpenCall application (e. Section 3 documents the DPA Window Functions and Navigation.g. Section 2 describes the DPA System Access. These fields are not viewable on the GUI windows but are documented to provide the property name and target name (record access key). server values (used for programmatic interface and DPA GCI provisioning) for the fields are also documented. These options include GUI provisioning windows. Logging On/Off Each user is required to enter a valid User Name and Password before being allowed to access any application provisioning resources. Each user allowed access to the DPA GUI application provisioning windows must prevent access by unauthorized personnel by logging off of the Web browser when a provisioning session is completed. System Security For descriptions of the DPA options for provisioning and maintaining DPA Security Administration database files. an unauthorized user has full access based upon the logon completed by the authorized user. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 3 . see the DPA Security Administration Guide. Passwords Passwords must be set up for each user.2 System Access This section describes where to find information on the various DPA access functions. When an open session is left on the computer desktop. The logging on and off procedures for the DPA provisioning systems are found in the DPA Subsystem Guide. the password does not appear—only an asterisk (*) is displayed for each entered character. For security reasons during entry. For instructions on setting up a password. and Generic Command Interface (GCI) and Programmatic Interface methods. see the DPA Subsystem Guide. Window Functions Window functions are described in the DPA GUI Basics section of the DPA Subsystem Guide. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 4 . Action Menus Each application specific provisioning guide provides a table displaying the actions appropriate for the provisioning window. These functions are available via the Actions menu and on the Toolbar buttons. Displays help for the current window.3 Window Functions and Navigation This section describes where to find information on the basic window functions. The menu items and their functions are as follows: Menu Item Contents Screen Function Displays a browser window with the first page of the provisioning guide. Online Help Online Window Help Provides access to help files specific to this application. and select “What's This?”.3. Click the page number or section name to be taken to that page. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 5 . Displays the first page of the guide Displays the previous page of the guide Displays the next page of the guide Displays the last page of the guide Displays the last page viewed (back) Displays the last page viewed (forward) Each page of the provisioning guide appears as a separate browser page. as shown below. click bookmark to display the chapter and section name. click the right mouse button. place the cursor on the appropriate field. Click page index to display the page numbers in the navigation panel. Use the tools at the top of the navigation (left) panel to navigate through the entire guide. Window Functions and Navigation Online Field Help Online Field Help To access online help. The system opens a browser window that displays a page from the provisioning guide describing the item in question. separated by an etched line. This bar contains the following three fields: DPA User Interface Guide – 150316-009 Hewlett-Packard Company 6 . Window Functions and Navigation Window Navigation Window Navigation Moving the Cursor The arrow keys. The Last Action bar is displayed at the bottom of the box/ screen. or mouse pointer may be used to move the cursor within a window or menu. tab key. The General tab contains the Last Action bar shown below. The cursor can be found in the field that is shaded (text boxes) or outlined (tabs.3. check boxes). Arrows ← → ↑ ↓ Tab moves the cursor to the left within the field when inside a textbox or moves the cursor backward from tab label to tab label. option buttons. moves the cursor to the right within a textbox or moves the cursor forward from label tab to label tab moves the cursor up within a drop-down menu moves the cursor down within a drop-down menu moves the cursor to the next field Shift Tab moves the cursor to the previous field Space Bar selects or deselects when in a check-box General Tab Each provisioning window contains a General tab. by (Read only) Displays the User ID of the user who performed the last operation on the file. Property Name: Valid Values: Default: Example: FM-HDR-USERID Printable ASCII characters N/A SUPER DPA User Interface Guide – 150316-009 Hewlett-Packard Company 7 . Window Functions and Navigation General Tab Last Action (Read only) Displays the last operation performed on the AC System Parameters file.3. Property Name: Valid Values: Default: Example: FM-HDR-USER-DT yyyy/mm/dd-hh:mm:ss N/A 2001/05/12-10:34:29 Last Action . Property Name: FM-HDR-OPERATION Valid Values: Display Value/Description Add .Last operation performed was an Update Default: Example: N/A Update Server Value A U Last Action .on (Read only) Displays the calendar date and time the last operation was performed on the file.Last operation performed was an Add Update . > Method Provisioning methods are: Valid Value(s): processSingle processMultiple Commands Valid commands for GCI and Programmatic Interface provisioning are: AddCommand Adds a record to the database. <Property Name> <Property Value> or processSingle AddCommand GSUB <Target Name> <Target Value>.) The attributes required for GCI and programmatic provisioning are Commands. Targets. <Property Name> <Property Value> DPA User Interface Guide – 150316-009 Hewlett-Packard Company 8 .4 GCI GCI Provisioning and Examples This section documents all GCI commands used with Profile Manager and provides examples. processSingle AddCommand GSUB <Target Name> <Target Value>. The processSingle and the processMultiple methods. must be used to provision using the GCI. Example: Adding an ANSI subscriber record with all fields set to the default values. Entities. <[Property Name] <Property Value>. For more complete information about GCI see the DPA Subsystem Guide. and Properties. GCI syntax is included here as a reference. along with their required parameters. <method> [Command] <Entity Type> <Target Name> <Target Value>. (See References in this manual for a list of DPA provisioning guides. Target Names. and Property Names are found in each of the specific provisioning guides.. .. The Generic Command Interface (GCI) is a way of executing service method calls to provision an application from a command line rather than through a GUI screen. processSingle AddCommand sub <Target Name> <Target Value> processSingle AddCommand sub MIN 1001001001 Example: Adding a GSM subscriber record using the GLOBAL Default record. GSUBD-KEY GLOBAL. Actual Entity Types. processSingle DeleteCommand sub <Target Name> <Target Value> processSingle DeleteCommand sub MIN 1001001001 DeleteOrphanCommand (ANSI HLR only) Delete any existing and orphaned primary and secondary records associated with the specified MIN. SUB-TYPE 1 DeleteCommand Deletes a record from the database. Example: Deleting a subscriber record. GCI Provisioning and Examples Commands processSingle AddCommand GSUB IMSI 310205030500001.4. <[Property Name] <Property Value> processSingle GenerateAKEYCommand sub MIN 1001001001. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 9 . GSUBD-KEY GLOBAL. Example: processSingle GenerateAKEYCommand sub <Target Name> <Target Value>. <Property Name> <Property Value> processSingle AddCommand GSUB IMSI 310205030500001. Example: processSingle DeleteOrphanCommand sub <Target Name> <Target Value> processSingle DeleteOrphanCommand sub MIN 1001001001 GenerateAKEYCommand (ANSI HLR only) Generate a new A-Key using the DES Key ID to encrypt and decrypt the A-Key. DESKEY-ID-HOLDER 1 GetDefaultsCommand Retrieves defaults. This command should be used only when the ORPHANED-RECORDREPAIR environment parameter is set to “M” (Manual mode) and either the SUBS or SUBN record is missing. GSUBD-KEY <Default Record Name>. GSUBD-KEY DEFAULTS01. SUBTYPE 1 Example: Adding a GSM subscriber record using a Default record other than GLOBAL. processSingle AddCommand GSUB <Target Name> <Target Value>. SUB-TYPE 1 or processSingle AddCommand GSUB IMSI 310205030500001. The GetDefaultsCommand can not be used with the HLR and the SPCD Entity Types. SUB-TYPE InactivateCommand (ANSI HLR only) De-registers a subscriber using the TEAR-DOWN-CALL property. Example: processSingle InactivateCommand sub <Target Name> <Target Value>. <Property Name> processSingle GetDefaultsCommand GSUBD KEY. AUTHENABLE Example: Retrieve all of the true default values on the subsdefault Entity Type: processSingle GetDefaultsCommand subsdefault KEY The GetDefaultsCommand can be used with the GSUBD Entity Type to read the values for all attributes or specified attributes in the GLOBAL Default record. processSingle GetDefaultsCommand GSUBD KEY or processSingle GetDefaultsCommand GSUBD KEY GLOBAL Example: Read the values for specified attributes in the GLOBAL Default record. Example: Retrieve all default values on the sub Entity Type: processSingle GetDefaultsCommand sub SUBSDEFAULT Example: Retrieve the default value for a specific field on the sub Entity Type: processSingle GetDefaultsCommand sub SUBSDEFAULT. When the command is used with the SUBSDEFAULT Entity Type. a default value of “0” applies.) Example: Read the values for all attributes in the GLOBAL Default record. GCI Provisioning and Examples Commands When the GetDefaultsCommand is used with the sub Entity Type. SUB-TYPE or processSingle GetDefaultsCommand GSUBD KEY GLOBAL.4. When the TEARDOWN-CALL property is not included. the true default values for the attributes in the Subscriber Default record are returned. <Property Name> <Property Value> processSingle InactivateCommand sub MIN 1001001001. processSingle GetDefaultsCommand GSUBD KEY. <Property Name> or processSingle GetDefaultsCommand GSUBD KEY GLOBAL. TEAR-DOWN-CALL 1 DPA User Interface Guide – 150316-009 Hewlett-Packard Company 10 . the default values in the Subscriber Default record are returned. (The ReadCommand must be used to read the values for all attributes or specified attributes in a Subscriber Default record other than GLOBAL. AKEY-HOLDER1 1111111111111111. processSingle ProvisionAKEYType1Command sub MIN 1001001001.. SSD-SSD-A 0. SSD-SSDA 0. AKEYHOLDER1 1111111111111111. SSD-AB-STATUS-HOLDER 0 ProvisionAltAKEYType1Command (ANSI HLR only) Provisions an alternate A-Key. Example: processSingle ProvisionAKEYType1Command sub <Target Name> <Target Value>. GCI Provisioning and Examples Commands MWIResetCommand (ANSI HLR only) Resets the Message Waiting Indicator. Variations of the ReadCommand include: ReadCommand ReadFirst ReadLast ReadNext ReadPrev Example: processSingle ReadCommand sub <Target Name> <Target Value>. SSD-AB-STATUS-HOLDER 0 Read Commands Read records in the database. <Property Name> DPA User Interface Guide – 150316-009 Hewlett-Packard Company 11 . <[Property Name] <Property Value>. SSD-SSD-B 0. processSingle ProvisionAltAKEYType1Command sub MIN 1001001001. <[Property Name] <Property Value>.4.. DESKEY-ID-HOLDER 7777... The output is developed according to the CommandResult or CommandResultSet defined for the read... Example: processSingle MWIResetCommand sub <Target Name> <Target Value>. SSD-SSD-B 0. <Property Name> <Property Value> processSingle MWIResetCommand sub MIN 1001001001. CHKDIGITS-HOLDER 111111. DESKEY-ID-HOLDER 7777. MWICNT 0 ProvisionAKEYType1Command (ANSI HLR only) Provisions a primary A-Key. Example: processSingle ProvisionAltAKEYType1Command sub <Target Name> <Target Value>. <[Property Name] <Property Value>. <[Property Name] <Property Value>. CHKDIGITS-HOLDER 111111. PRINT-REPORT Y processSingle RegCanCommand sub MIN 1001001001. AUTHENABLE processSingle ReadFirst NEDF PARTKEY 1/ processSingle ReadLast NEDF PARTKEY 1/ processSingle ReadNext sub MIN 1001001001 processSingle ReadPrev sub MIN 1001001001 The ReadCommand can be used with the GSUBD Entity Type to read the values for all attributes or specified attributes in any Subscriber Default record. PRINT-REPORT Y RepairOrphanCommand (ANSI HLR only) Create the SUBN record and.) Example: Read the values for all attributes in any Subscriber Default record. and the SUBN record is missing. If you do not include the “PRINT-REPORT Y” parameter. SUB-TYPE RegCanCommand (ANSI HLR only) Initiates the Automatic Registration Cancellation process for a specific subscriber. the primary AMDN record for the specified MIN. (The GetDefaultsCommand can be used with the GSUBD Entity Type to read only the GLOBAL Default record. processSingle ReadCommand GSUBD KEY <GLOBAL|Default Record Name>. This command should be used only when the ORPHANEDRECORD-REPAIR environment parameter is set to “M” (Manual mode). SUB-TYPE or processSingle ReadCommand GSUBD KEY DEFAULT01. if it does not already exist. <Property Name> processSingle ReadCommand GSUBD KEY GLOBAL.4. GCI Provisioning and Examples Commands processSingle ReadCommand sub MIN 1001001001. no report is sent to the spooler. the SUBS record exists. Example: processSingle RegCanCommand sub <Target Name> <Target Value>. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 12 . processSingle ReadCommand GSUBD KEY <GLOBAL|Default Record Name> Example: Read the values for specified attributes in any Subscriber Default record. 4. Example: processSingle UpdateCommand sub <Target Name> <Target Value>. processSingle UpdateCommand sub MIN 1001001001. <Property Name> <Property Value> This example shows updating the Authentication Enabled field to No. Example: processSingle SSDUpdateNextCommand sub <Target Name> <Target Value> processSingle SSDUpdateNextCommand sub MIN 1001001001 UniqueChallengeCommand (ANSI HLR only) Initiates a unique challenge. A record must be read before it is updated. Example: processSingle UniqueChallengeCommand sub <Target Name> <Target Value> processSingle UniqueChallengeCommand sub MIN 1001001001 UpdateCommand Updates the database for the specified record in the view. GCI Provisioning and Examples Commands Example: processSingle RepairOrphanCommand sub <Target Name> <Target Value> processSingle RepairOrphanCommand sub MIN 1001001001 SSDUpdateCommand (ANSI HLR only) Initiates an SSD update. Example: processSingle SSDUpdateCommand sub <Target Name> <Target Value> processSingle SSDUpdateCommand sub MIN 1001001001 SSDUpdateNextCommand (ANSI HLR only) Initiates an SSD update on next system access. AUTHENABLE N DPA User Interface Guide – 150316-009 Hewlett-Packard Company 13 . processMultiple URDInitiation NEDF <Target Name>. Example: Initiate Unreliable Roamer Data recovery for a specific MSCID. URD-TIMESTAMP 2003/ 08/15-05:15:31 Example: Initiate Unreliable Roamer Data recovery for all NEDF records with a record type of “1” (MSCID). URD-TIMESTAMP <date><time> processMultiple URDInitiation NEDF URDRECS. all records in the specified file are retrieved. Target Value The target value identifies a specific key for a database record. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 14 . <Property Name> <Property Value> URDInitiation (ANSI HLR only) Initiates Unreliable Roamer Data recovery for a specific MSCID or all MSCIDs.4. URDTIMESTAMP <date>-<time> processSingle URDInitiation NEDF NEDF-KEY 1/10316/215. Some of the files are configured to allow the use of “ALL” as the target name in a processMultiple command. processSingle URDInitiation NEDF <Target Name> <Target Value>. execute the UpdateCommand on the subsdefault Entity Type: processSingle UpdateCommand subsdefault KEY DEFAULT. URD-TIMESTAMP 2003/08/1505:15:31 Entity Type Entity Type is the name identifying a DPA database file. To locate the Entity Type. To find targets. When the user enters a processMultiple command with a target of “ALL”. Target Name Key used to access records in database files are defined as a target name value-pair. refer to the Introduction section of each application specific Provisioning Guide. To do this. GCI Provisioning and Examples Entity Type The UpdateCommand is also used to update default values in the Subscriber Default record. look in the Introduction section of each application specific Provisioning Guide. A specific time may be set or the default is the current Greenwich Mean Time. “ALL” does not require a target value. As a general rule. property names correspond to fields in the application record. DPA User Interface Guide – 150316-009 Hewlett-Packard Company 15 . GCI Provisioning and Examples Property Name Property Name Name portion of the property name-value pair.4. Property Value The valid values for the properties are defined with the property names in the application specific Provisioning Guides. however. look first in the Property Name Index of each application specific Provisioning Guide which is an alphabetical list of all properties. To find definitions of these Property Names. this is not always the case. It points you to the correct place in the provisioning guide where the properties are defined. A A Action Menus 4 AddCommand 8 P Passwords 3 Property Name 15 Property Value 15 ProvisionAKEYType1Command 11 ProvisionAltAKEYType1Command 11 C Commands 8 D DeleteCommand 9 DeleteOrphanCommand 9 R Read Commands 11 ReadFirst 11 ReadLast 11 ReadNext 11 ReadPrev 11 RegCanCommand 12 RepairOrphanCommand 12 E Entity Type 14 G General Tab 6 GenerateAKEYCommand 9 GetDefaultsCommand 9 S SSDUpdateCommand 13 SSDUpdateNextCommand 13 System Security 3 I InactivateCommand 10 T Target Name 14 Target Value 14 L Last Action 7 Last Action .by 7 Last Action .bar 6 Last Action .on 7 Logging On/Off 3 U UniqueChallengeCommand 13 UpdateCommand 13 URDInitiation 14 M Moving the Cursor 6 MWIResetCommand 11 W Window Functions 4 Window Navigation 6 O Online Field Help 5 Online Window Help 4 DPA User Interface Guide – 150316-009 Hewlett-Packard Company 1 .