SST Operations Bridge Administration Guide Part number: 577539-001 First edition: 07/2009
Legal notices Hewlett-Packard makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be held liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Contents Preface Before You Begin ..................................................................................................................................... 7 Who Should Read This Guide ................................................................................................................... 7 Goals of Documentation ........................................................................................................................... 7 Organization ..................................
6 Policies 6-1 6-2 Overview ................................................................................................................................... 45 Standard Policies......................................................................................................................... 46 6-2-1 Out-of-the-Box Standard Policies ........................................................................................... 46 6-2-2 Creating Standard Policies .......................................
12-1 12-2 12-3 13 14 15 Overview ................................................................................................................................. 109 Creating new Closure Codes ...................................................................................................... 109 Changing Closure Code Settings ................................................................................................. 110 Object State Codes 13-1 13-2 13-3 Overview ............................
19-6-2 19-6-3 20 Editing Data .................................................................................................................... 163 Deleting Columns ............................................................................................................. 163 Configuring Hours of Operation 20-1 20-2 20-3 20-4 20-5 20-6 20-7 20-8 Overview .................................................................................................................................
Preface SST Operations Bridge (SST/OB) is specially designed to provide an across-the-board solution for managing Problem, Change and Asset management in your Terminal environment. Before You Begin As the administrator who administers the SST/OB, you should be familiar with the Terminal environment, HP NonStop Servers, network protocols, client/server architecture and basic Microsoft Windows navigation.
Sr. No Chapter Name Description Chapter 14. Email Alerts This chapter provides information and instructions on how to send emails and configure email templates in SST/OB Client Application. Chapter 15. Thresholds and Threshold Alerts This chapter provides information and instructions on how to work with Thresholds and threshold Alert templates. Chapter 16. Commands This chapter provides information and instructions on how to configure commands and actions in SST/OB Client Application.
HP SST/OB Documentation Manual Description Media SST Operations Bridge Concepts Guide Provides information on the SST/OB product, the features/benefits the software offers along with its architecture and data-flow. PDF SST Operations Bridge Installation Guide Provides information on how to install the various components of SST/OB.
1 HP SST/OB: Overview This chapter lists the main features of SST/OB and points out the advantages this software offers. 1-1 What is HP SST/OB? The infrastructure supporting the Terminal environment can be both complex and extremely diverse. Management of such an environment requires a consistent, service oriented and Enterprise fluent approach.
1-2 Features & Benefits Real-Time Monitoring SST/OB uses the following methods for monitoring the Terminal environment: • Terminal data file based monitoring • Event based monitoring Together, they ensure round-the-clock real-time monitoring of your precious Terminal network. Dashboards Policies Policies are business rules that manifest the existing business practices of your Terminal environment. Creating a Policy in SST/OB defines the acceptable operational values for the Terminals.
SLA Monitoring SST/OB provides a mechanism of SLA monitoring by color codes in the views that are triggered using configurable timers. The information can be used for providing analysis of availability and service times along with tracking history, and Terminal performance. This enables you to increase your Terminal network efficiency, compare performance between various service providers and regions along with identifying the probable costly SLA breaches.
2 Getting Started This chapter provides information on how to get started with SST/OB Client. 2-1 Prerequisites The prerequisites for using SST/OB are as follows: The Backend Components Must be Running In order to get information from the backend Terminal environment, the SST/OB backend components installed on the Terminal environment must be up and running. Use the following command to verify the status of the backend components. For the BASE24 Terminal environment, switch over to the volume.
2-2 HP NonStop Server Tasks 2-2-1 Starting SST/OB on HP NonStop Server Use the following command to start SST/OB on the HP NonStop Server. $SYSTEM.SSTOB 85> RUN STRTAOB Use the following command to stop SST/OB on the HP NonStop Server. $SYSTEM.SSTOB 85> RUN STOPAOB 2-2-2 Checking the Status of SST/OB on HP NonStop Server Use the following command to check the status of the SST/OB components on the HP NonStop Server. $SYSTEM.SSTOB 90> RUN STATAOB Here is a sample output of the status utility.
2-3 SST/OB Application Server Tasks 2-3-1 SST/OB Services The SST/OB consists of the following services which are installed on the SST/OB Application Server. Services Description SST/OB Alerts Processor Logs the alerts generated by threshold processing to NT event log and/or to NonStop EMS logs. SST/OB Command and Control Responsible for centralized execution of commands. Elink TCP/IP based proprietary communication link with the switch.
The Service Manager enables you to perform the following functions: Table 2-2 Service Manager Functions Buttons Description Refresh the status of the selected SST/OB service(s). The command can also be accessed from the listed service(s) right-click menu. Start the selected SST/OB service(s). The command can also be accessed from the listed service(s) right-click menu. Stop the selected SST/OB service(s). The command can also be accessed from the listed service(s) right-click menu.
2-3-2 SST/OB Configuration Client The SST/OB Configuration Client is an interface, which enables you to edit configuration settings of the various SST/OB Application Server components. Use the Start->Programs->HP SST->SST OB->Server->Configuration Client option to access the SST/OB Configuration Client.
2-4 SST/OB Client Application 2-4-1 Starting the Application To start the SST/OB interface, click on the Start->Programs->HP SST->SST OB->Client->SST Operations Bridge option. This displays the Sign In dialog box. Figure 2-4 Sign In Dialog Box Associated with each logon is a profile, which determines the information a user can view and the actions that can be performed. The admin logon has special privileges, and can edit the profiles and passwords of other users.
2-4-2 Database Compatibility The SST/OB Client interface and the database have a versioning system. A particular interface is meant to be used with a particular version of the database structure. If there is any mismatch between interface and the database, an error would be displayed. 2-4-3 Database Connections and Services Status You can use the and the icons on the Status bar to view the status of the SST/OB components and the connection status with the database.
Database Connection Status Clicking on the icon displays the Connections and Components Status – Connections tab page. Figure 2-6 Connections and Components – Connections Tab Page You can view status of the following Database connections.
3 SST/OB Client Application 3-1 SST/OB Client Application Window The SST/OB Client interface has been designed from the user’s point of view for easy and smooth accessibility of various features. The SST/OB Client interface is tab-based. Each tab provides access to various functionalities and features. The main navigation area is the vertical area on the left side of the window. This area displays the Dashboards and the Terminal Tree views when the corresponding tabs are selected.
3-2 Menu Bar Figure 3-2 SST/OB Menu Bar The Menu bar gives access to the following menus: • Application Menu • Actions Menu • Tools Menu • Manage Menu • Help Menu 3-2-1 Application Menu Figure 3-3 SST/OB Application Menu This is the first menu on the Menu bar. The options available on the menu are: • Sign In The Sign In option allows you to login to the SST/OB application using a user name and password provided by the SST/OB administrator.
3-2-3 Tools Menu Figure 3-5 SST/OB Tools Menu The various options available in the Tools menu are: • Permissions You can use the Permissions option to grant and modify object/actions permissions to users and groups. Clicking on the option displays the Permissions dialog box. • Groups and Users The Groups and Users option enables you to create and delete SST/OB users and groups. You can reset passwords for users using this option. Clicking on the option displays the Groups and Users dialog box.
3-2-4 Manage Menu Figure 3-6 SST/OB Manage Menu • Terminal Sets The Terminal Sets option enables you to create, modify and delete Terminal sets. Clicking on the option displays the corresponding Terminal Sets dialog box. • Views The Views option enables you to create, modify and delete views. Clicking on the option displays the corresponding Views dialog box. • Commands The Commands option enables you to create, modify and delete command templates.
• Terminal Trees The Terminal Trees option allows you to configure a new terminal tree. Clicking on this option displays Terminal Trees dialog box. • Threshold Alert Templates The Thresholds Alert option allows you to create new threshold alerts or modify the already existing alerts. Clicking on this option displays the Alert Templates dialog box. • Schedules The Schedules option allows you to define the hours of operation for terminals. This option is used in availability calculations of terminals.
3-4 Toolbar Figure 3-9 SST/OB Toolbar – Dashboards Tab The Toolbar is displayed just below the Tabs bar in the SST/OB window. The buttons available on the toolbar depend upon the tab selected. Table 3-1 SST/OB Toolbar Buttons Description Available For Enables you to create a new dashboard. Clicking on the button displays the New Dashboard dialog box. Dashboards Tab Enables you to view and manage dashboards/policies, depending on tab selected.
3-5 Status Bar Figure 3-10 SST/OB Status Bar • Status of the Database connection • Status of the Application Server • Status of data being refreshed from the database • Tool tips • Miscellaneous messages • Local computer’s time and the Database Server time SST/OB Client Application The Status bar can be seen at the base of the SST/OB window.
4 Application Options You can configure the various SST/OB options using the Options dialog box. Use the Options command on the Tools menu to access the dialog box. The Options dialog box can be used to configure the following categories of parameters: • General options • Advanced options • Configuration options • Database options • Time options • Defaults options 4-1 General Options The general options can be configured using the General tab in the Options dialog box.
• Size of the log file Use the Maximum size of log file combo box in the Data Folder area to specify the maximum allowable log file size in KB. The default value is 10000 KB. • Default Export Folder Use the Change Folder Location button to change the location where the SST/OB Client application stores exported views. The default location is C:\Program Files\HP SST\SST Operations Bridge\Client\Data.
4-2 Advanced Options Figure 4-2 Options Dialog Box – Advanced Tab The Advanced tab page can be used to configure the following parameter: • Data Refresh Settings for Dashboards Specify how the data in the dashboards is to be refreshed using the check boxes in the Dashboard & Views area.
4-3 Configuration Options Figure 4-3 Options Dialog Box – Configuration Tab The Configuration tab page can be used to configure the following parameters: • Allowed Cost The Configuration tab page can be used to configure the View Cost for the SQL-based local View. SQL based Local Views to be created if the cost of populating the View is below or equal to the specified decimal value specified in the Allowed Cost field. The value can range from 0.1 to 999.9. The default value is 2.0.
4-4 Database Options Figure 4-4 Options Dialog Box – Database Tab The Database tab page can be used to configure the following data sources: • SST/OB data source • Transaction data source (If ATM Transaction Analyzer product has been configured with SST/OB) Clicking on the corresponding Manage button will display the Manage Data Sources dialog box. Figure 4-5 Options Dialog Box – Database Tab Select the Data Source name from the Select Data Source Name drop-down box.
4-5 Time Options Figure 4-6 Options Dialog Box – Time Tab The Time tab page can be used to configure the display time settings in the SST/OB Client application. Select the Default Time and the View Time using the corresponding drop-down boxes. The Default Time refers to fields in the database that have the time entered through the user interface. The View Time refers to all the fields that display the data coming from the host or node.
Terminal Browser or any Local/Policy View that uses the above fields will also be affected. NOTE: The time settings do not apply to any date/time columns in the Terminal Details transactions tab. NOTE: The time fields in the Transaction tab and the Terminal Profiles in the Manage Data tab are not impacted by any changes in these parameters. NOTE: In case a SQL view is created that displays these fields, it will display the times in UTC until conversion is done within the query itself.
4-6 Defaults Options Figure 4-7 Options Dialog Box – Defaults Tab The Defaults tab page can be used to configure the default settings for the Terminal Browser. The following parameter can be configured: • On Startup, select this Terminal Tree Use this drop-down box to select the Terminal tree option which is to be displayed by default in the Terminal Browser.
5 User Profiles and Permissions This chapter provides information on creating/maintaining SST/OB user profiles & groups and assigning permissions. 5-1 Overview The administrator User name in SST/OB is called admin. This user has no restrictions and can not be deleted. The admin login is used to create new groups/users and assign/modify permissions. Restricted Users is the default group available. NOTE: Only the admin user has the ability to create groups/users and assign/modify policies and tools.
The Groups and Users dialog box is displayed with the new group added. User Profiles and Permissions 4. Figure 5-3 Groups and Users Dialog Box with “Test Group” Added You can add users and assign permissions to groups/users. Click on the Close button to close the Groups and Users dialog box.
5-3 Creating a User Follow the steps below to create/add a user to an existing group. 1. Click on the Groups and Users option in the Tools menu. NOTE: The Groups and Users option is only available to the admin user. 2. The Groups and Users dialog box is displayed. Select the group in which the new user is to be created. Figure 5-4 Groups and Users Dialog Box 3. To create a new user, select the User option from the drop-down arrow and click on the New User button displayed. 4.
• User name: User account name. • Full Name: The full name of the User. By default, this field takes the value specified in the user name field. • Password: The password for the new user account. • Confirm Password: Reenter the password specified in the Password field. Click on the OK button to complete the process of creating a new user. NOTE: The User name cannot be changed once the user profile has been created. 5. The Groups and Users dialog box is displayed with the new user added.
5-5 Deleting a User/Group This topic provides information on how to delete a user or a group. Follow the steps below to delete a user or a group. 1. Click on the Groups and Users option in the Tools menu. NOTE: The Groups and User option is only available to the admin user. 2. The Groups and Users dialog box is displayed. Select the user group to be deleted and click on the Delete button. NOTE: You will not be able to delete groups in which users have been added.
You can use the Permissions option in the Tools menu to assign permissions for various features to Groups and Users. 5-7-1 Best Practices for Assigning Permissions • Avoid granting full access controls. • When possible, assign rights on a broad level rather than assigning individual access rights. Assign permissions to groups, rather than users. NOTE: The Permissions option is only available to the admin user. Each user/group can only view policies and tools assigned to them.
5-7-3 Assigning/Removing Permissions Follow the steps below to assign permissions. 1. Click on the Permissions option in the Tools menu. This displays the Permissions dialog box. Figure 5-9 Permissions Dialog Box 2. Select the group or user account for which the permissions are to be assigned in Group and user names list. NOTE: Permissions applied to a group will be applied automatically to all users belonging to it overriding any individual permission assignment to users within that group. 3.
You can assign permissions for Actions using the Permissions dialog box. Users will be able to perform actions that have been assigned to them. Figure 5-10 Permissions Dialog Box - Actions 1. All Items in the Actions category: Selecting this action will enable permissions for all the actions listed in the Actions list for the selected User/Group. 2.
16. View everyone’s Action History: Selecting this action will allow viewing everyone’s Action History permission for the selected User/Group. 17. View Faults Browser: Selecting this action will allow viewing Faults Browser. 18. View Faults on Terminals: Selecting this action will allow viewing faults on Terminals permission for the selected User/Group. 19. View General Terminal Information: Selecting this action will allow viewing general Terminal information permission for the selected User/Group.
6 Policies 6-1 Overview Policies are specialized conditions that can be used to monitor your Terminal environment. Creating a Policy in SST/OB defines the acceptable operational values for the Terminals. These are the conditions that SST/OB checks when a Terminal state is monitored. If the conditions defined in a policy evaluate to true, a violation is said to have occurred and appropriate actions are executed. The actions may include automated e-mail alerts.
6-2 Standard Policies 6-2-1 Out-of-the-Box Standard Policies SST/OB provides the following out-of the-box standard policies: The following policies are provided out of the box specifically for BASE24 switch application: • BASE24 Network Policy: This policy determines whether Terminals are out of service due to BASE24 failures network wide. • BASE24 State Closed Policy: This policy determines network wide Terminals that are CLOSED as per BASE24.
6-2-2 Creating Standard Policies Follow the steps below to create a Standard Policy. 1. Click on the Policies tab on the SST/OB Tabs bar to access Policies. The Policies area lists the Standard Policies that have been configured in the environment. 2. To create a new Standard Policy, click on the New Policy button on the Policies toolbar and select the Standard Policy option. Policies Figure 6-2 New Policy Menu 3. The Policy Wizard is displayed.
Specify the following information in the displayed wizard screen. • Enter the Policy Name. • Specify a description for the policy in the Description box. • Select the closure code to be associated with the policy using the Closure Code drop-down box. NOTE: You can use the Manage button to modify/create closure codes. For details, refer to the Closure Codes topic. • Specify the status of the policy as Active or Inactive using the corresponding radio buttons. Click on the Next button to continue. 4.
6. The Policy Wizard - Actions page is displayed. Use this page to select the actions that are to be taken when results are returned from the database. You can specify the following actions: • Create a View: Selecting the Create a View check box will define a corresponding Policy View. These Policy Views can be added to Dashboards for monitoring the Terminal environment. • Send an Email: Selecting the Send an Email check box will configure SST/OB Client to trigger an email alert.
6-2-3 Changing Standard Policies Follow the steps below to modify a Standard Policy. 1. Select the policy to modify from the Policies tab page and click on the Properties button on the Policies toolbar. You can also do a right-click action on the standard policy and select the Edit Policy option. This displays the Policy Wizard for the selected Policy. Figure 6-6 Standard Policy Wizard 2. Make required changes in the Policy Name, Description and Closure Code and the Execution status.
6-3 Fault Policies 6-3-1 Creating Fault Policies Use Custom Fault Policy for certain complicated conditions, which are not supported by Standard policy wizard. You can configure setting/resetting of a fault by specifying a SQL condition in a custom fault. The Custom fault policy will set/reset this custom fault that could be used in creation of standard policy conditions for further use. Follow the steps below to create a Fault Policy. 1.
5. The Policy Wizard - Filter Conditions page is displayed. Use this page to define the conditions to specify the kind of information that would be generated by the policy. Figure 6-10 Fault Policy Wizard Filter Conditions Page Specify the SQL conditions in SQL SELECT, SQL FROM and SQL WHERE fields, and verify the condition applied by using the Verify SQL button. NOTE: The query result must be a set of distinct ATMKEY values that passes the condition.
6. The Policy Wizard - Actions page is displayed. Use this page to select the fault which is to be set to Active when a Terminal passes the condition specified in the policy. Policies Figure 6-11 Policy Wizard – Actions Page NOTE: Terminals that fail the policy will automatically have the selected fault closed. 7. Click on the Finish button to complete the procedure to create a custom Fault Policy. The new policy is added in the policies list.
6-3-2 Deleting Fault Policies Follow the steps below to delete a fault policy. 1. Select the policy to be deleted from the Polices tab page and click on the Delete icon on the Policies toolbar. You can also do a right-click action on the fault policy and select the Delete option. 2. The Delete Policy confirmation box is displayed. Figure 6-13 Delete Policy Confirmation Box Click on the Yes button to delete the selected policy. This completes the procedure for deleting a Fault Policy.
6-4 Event Policies Event policies are another medium to introduce custom faults (apart from custom fault policies) into the SST/OB system. You first need to define a Custom Fault and then create the condition using an Event Policy to set or reset it. This fault can then be used to create a Standard Policy in the SST/OB Monitoring system.
3. Clicking on the New button displays the Event Policy Wizard. Figure 6-15 Event Policy Wizard Enter the Policy Name and Description in the corresponding text boxes. Specify the execution status of the policy as Active or Inactive using the corresponding radio buttons and click on the Next button. 4. The Event Policy Wizard - Conditions page is displayed. Use this page to create a Boolean expression by combining column names and values using one or more operators. a.
5. Click on the Next button. The Event Policy Wizard - Actions page is displayed. Use this page to specify the kind of action that is to be triggered when the policy condition is met. Configure the following information on the Actions page. • Update the fields: Use the Update the fields below area to select the fields that are to be updated when the policy conditions are met. To select fields and specify values, click on the New Condition icon.
6. Click on the Finish button. The Event Policies dialog box is displayed with the new event Policy.
6-4-2 Changing Event Policy Settings Follow the steps below to modify an Event Policy. 1. Click on the Event Policies option in the Manage menu. 2. The Event Policies dialog box is displayed. Select the Event Policy to be modified and click on the Properties button. Policies Figure 6-19 Event Policies Dialog Box with Properties Button 3. Clicking on the Properties button displays the Event Policy Wizard. Modify the Policy Name and Description, if required, and click on the Next button. 4.
6-4-4 Event Policy Categories Categories are used to group related Event Policies to speed up processing. For example, we can create a category related to all Device Handler EMS Events. This would mean that all policies in the Device Handler category will only process the Device Handler related events and will ignore the rest. The category is decided by using one or more pass values in the incoming event.
4. The New Event Policy Category dialog box is displayed. Policies Figure 6-23 New Event Policy Category Dialog Box Specify the following information in the dialog box. • Name • Description • Pass Values • Expression The Pass Values can be individual values separated by commas or ranges. For example: 100, 2000, 3000-3300, 4500, -1200. If the incoming event satisfied this condition it would qualify to be processed into this category only.
7 Global Parking and SLA Timers SST/OB provides you with the option to configure the Parking and SLA Timers for the Terminals in your environment. It also enables you to specify the display and formatting options. SLA Timers and Parking is provided to assist the operators to distinguish long standing problems using color coding. It also assists the managers to find out which operator/service personnel is taking how long to fix a problem.
• Color Formatting for Parking Timers When a Terminal is visible in a Policy View for a time longer than the specified duration, as defined in the Global Parking and SLA Timers page, the Terminals can be categorized into the following severity levels. • Warning • Minor • Major • Critical You can define the color schemes and formatting for various severity levels using the Color and Formatting tab page. Select the colors for the listed categories.
8 Views Views are the building blocks for creating Dashboards. A dashboard can contain one or more views. SST/OB Dashboards can contain the following types of views: • icon. Policy Views are associated with Standard Policy Views: Policy Views are depicted using the policies. These views cannot be created/deleted independently of a standard policy. • Local Views: Local Views are depicted using the view.
8-1 Policy Views 8-1-1 Overview Policy Views are specialized views that are used for customized management of the Terminal environment. Each Policy View has a Standard Policy associated with it. A Policy View is automatically created once a Standard Policy is created and specifying to create a corresponding view.
8-1-3 Creating a Policy View Policy View is automatically created when you create a Standard Policy and select the Create a View check box in the Standard Policy wizard. Figure 8-2 Unnamed Policy Dialog Box with Create a View Check Box For more information, refer to the Policies topic.
8-1-4 Changing Policy View Settings Follow the steps below to change settings for a Policy View. 1. Click on the Views options in the Manage menu. 2. The Views dialog box is displayed. Select the Policy View that needs to be modified and click on the Properties button. NOTE: The Policy Views are depicted with the icon. Figure 8-3 Views Dialog Box with Properties Button 3. The corresponding Policy View dialog box is displayed.
4. Click on the Columns tab to access the corresponding tab page. Figure 8-5 Cashout Problems (Policy View) – Columns Tab Page The Columns tab page can be used to select columns that would be displayed in the view. It is recommended that no more than 10 columns are selected per view. 5. Click on the Display & Formatting tab to access the corresponding tab page. You can use Default Display drop-down box to select the default view format for the view.
6. Click on the Parking and SLA Timers button to modify SLA and Parking Timers for the selected Policy View. This displays the corresponding dialog box. Figure 8-7 Parking and SLA Timers dialog Box The Parking and SLA Timers dialog box can be used to modify the SLA and Parking timers for the selected Policy View.
8-1-6 Taking Actions on Problems The Terminals displayed in a Policy View can have the following status: • Acknowledged • Unacknowledged • Closed 8-1-6-1 Acknowledging a Problem Acknowledging a current problem on a Terminal displayed in a Policy View will prevent new alert notifications from being generated until the problem is unacknowledged or the underlying problem is closed. Follow the steps listed below to acknowledge a problem. 1.
8-1-6-2 Unacknowledging a Problem Follow the steps listed below to remove the existing acknowledgment for a Terminal. 1. Right-click on a Terminal in a Dashboard view and select the Actions menu option. 2. In the displayed Actions menu, click on the Unacknowledge Problems option. NOTE: Only the Acknowledged Terminals can be Unacknowledged. 3. The Unacknowledge Problems dialog box is displayed. In the text box, specify the reason for unacknowledging the problem on the selected Terminal.
8-1-6-3 Closing a Problem Follow the steps listed below to remove the existing acknowledgment for a Terminal and close the problem. 1. Right-click on a Terminal in a Dashboard view and select the Actions menu option. 2. In the displayed Actions menu, click on the Closed Problems option. NOTE: Only the Acknowledged Terminals can be Closed. 3. The Close Problems dialog box is displayed. In the text box, specify the reason for closing the problem on the selected Terminal.
8-1-6-4 Terminal Summary SST/OB Dashboards provides you with an option for Terminal Summary to present the status of a Policy View in a nutshell. You can use the Display Summary , to toggle the display of Terminal Summary in each Policy View.
8-2 Local Views 8-2-1 Overview Local Views can be used to create informational or report type Views on Terminals or other entities. They may or may not be used for Monitoring. Unlike the Policy Views, you cannot specify actions or set Parking and SLA Timers for a Local View. You can create and manage Local Views using the Views option in the SST/OB Manage menu.
8-2-3 Creating Local Views Three types of Local Views can be created: • New View • New SQL-based View • New SQL-based View (in Custom Tab) NOTE: Permissions are needed for non-admin users to create Local Views. 8-2-3-1 Creating a New Local View Follow the steps listed below to create a new Local View. 1. Click on the Views option in the Manage menu. 2. The Views dialog box is displayed with a list of all the configured Local and Policy Views.
3. The New View dialog box is displayed. The General tab page is the default page. Enter the name for the Local View and description (optional) in the View Name and Description boxes, respectively. Figure 8-13 New View Dialog Box 4. Click on the Contents button in the General tab page to define the data that will be displayed in the Local View. 5. The View Contents Wizard Filter Conditions page is displayed.
Figure 8-14 Views Contents Wizard – Filter Conditions Page 6. Click on the Finish button to continue. 7. The New View dialog box is displayed again. To select the columns that will be displayed in the view, click on the Columns tab. This displays the corresponding tab page.
8. Select the Columns to display in the view. TIP: It is recommended that you choose less than ten columns in a view for easy manageability and monitoring. 9. Click on the Display tab to configure the default display format for the view. This displays the corresponding tab page. Use the Default Display box to specify the format in which the view is to be displayed by default. Figure 8-16 New View Dialog Box – Display Tab Page 10.
11. • Select the View is dependent on the results of one or more Standard Policies check box if the results to be displayed in the view are dependent on one or more Standard Policies. • Specify the execution status as Active or Inactive using the corresponding radio buttons. • Enter the Execution Frequency Interval in seconds in the corresponding box. Typically, this value would be about 4 to 5 times the duration it normally takes to execute the query for this view.
8-2-3-2 Creating New SQL-based Local View Follow the steps below to create a new SQL-based Local View. 1. Click on the Views option in the Manage menu. 2. The Views dialog box is displayed with a list of all the configured Local and Policy Views. To create an SQL-based Local View, click on the New View button and select the New SQL-based View option from the displayed menu. Figure 8-19 Views Dialog Box with New SQL based View Option Selected 3. The New SQL-based View dialog box is displayed.
4. Click on the SQL tab in the New SQL-based View dialog box to access the corresponding tab page. Create a query and click on the Verify SQL button to estimate the cost of populating the view. Figure 8-21 New SQL-based View Dialog Box - SQL Tab Page 5. The View Cost Estimation box is displayed showing the message that View estimation is completed or not within the specified cost in the Configuration options tab in the Options dialog box. Views Figure 8-22 View Cost Estimation Box 6.
7. Click on the Display tab in the New SQL-based View dialog box to configure the default display format for the View. This displays the corresponding tab page. Use the Default Display box to specify the format in which the View is to be displayed when first opened. The options available are: • Table (Default) • Column Chart • Pie Chart Figure 8-23 New SQL-based View - Display Tab Page 8. The Column Chart and Pie Chart display options can be edited using the Chart Properties button.
9. Click on the OK button in the Chart Properties box. This displays the New SQL-based View dialog box. 10. Click on the Options tab to configure the execution options for the view. This displays the corresponding tab page. Figure 8-25 New SQL-based View Dialog Box – Options Tab Page Select the View is dependent on the results of one or more Standard Policies check box if the results to be displayed in the view are dependent on one or more Standard Policies.
8-2-3-3 Creating New SQL-based Local View (in Custom Tab) The Custom Tab SQL View can only be displayed in the Terminal Details pane (in the tab called Custom Information). This view is not available for Dashboards. The following considerations are there while creating these views: • Only statements that begin with SELECT and EXEC can be put into the SQL tab of the view properties dialog for this view type.
3. The New SQL-based View dialog box is displayed. The General tab page is the default page displayed. Enter the name for the View and description (optional) in the View Name and Description boxes, respectively. Figure 8-27 New SQL-based View Dialog Box - General Tab page ’ 4. Click on the SQL tab in the New SQL-based View dialog box to access the corresponding tab page. The SQL query supports substitution parameters like %city%, %terminal id%, and %Fiid%.
5. Click on the Close button to close the View Cost Estimation box and return to the New SQL-based View dialog box. 6. Click on the Display tab in the New SQL-based View dialog box to configure the default display format for the View. This displays the corresponding tab page. Use the Default Display box to specify the format in which the View is to be displayed when first opened.
7. Click on the Options tab to configure the execution options for the view. This displays the corresponding tab page. Figure 8-30 New SQL-based View Dialog Box – Options Tab Page Specify the Start Time and Stop Time between which the view will be executes daily. To execute the view at all times in a day, specify 00:00 as the Start Time and 23:59 as the Stop Time. Time values are in 24 hour HH:MM format in the local time in the SSTOB Database Server.
8-2-4 Changing Local View Settings Follow the steps listed below to modify user-defined Local Views. NOTE: You can not modify a pre-configured Local View. 8-2-4-1 Modifying a Local View 1. Click on the Views option in the Manage menu. 2. The Views dialog box is displayed. Select the user-defined Local View to modify from the Available views list and click on the Properties button. Figure 8-31 Views Dialog Box – Properties Button 3.
4. The View Contents Wizard Filter Conditions page is displayed. Use this page to modify/add condition(s) that would be used to specify the kind of information that will be displayed in this view and click on the Finish button. 5. The View dialog box is displayed again. To modify the columns that will be displayed in the view, click on the Columns tab and select the required column check boxes. 6. A view can be displayed in different formats.
8-2-4-3 Modifying a SQL-based Local View (in Custom Tab) Follow the steps listed below to modify a SQL-based View (in Custom Tab): 1. Click on the Views option in the Manage menu. 2. The Views dialog box is displayed. Select the user-defined SQL-based View to modify from the Available views list and click on the Properties button. 3. The corresponding Edit SQL-based View dialog box is displayed with the General tab page. Figure 8-34 Edit SQL Dialog Box 4.
8-2-5 Deleting Local Views Follow the steps listed below to delete user-defined views. NOTE: You can not delete a pre-configured Local View. 1. Click on the Views option in the Manage menu. 2. The Views dialog box is displayed. Select the user-defined view to delete from the Available views list and click on the Delete button. Figure 8-35 Views Dialog Box – Delete Button 3. The Delete View(s) Confirmation box is displayed.
8-3 View Context Menu Options Figure 8-37 View Context Menu Actions: Use this option to perform the following actions on the selected terminal. • Acknowledge Problems • Unacknowledge Problems • Close Problems Commands: Use this option to select the commands to be run on the selected terminal. Copy Selection: Use this option to copy the selected row of data to the clipboard. Copy All: Use this option to copy all the data to the clipboard.
9 Dashboards 9-1 Overview SST/OB Dashboards provide you business intelligence across all areas of your Terminal environment. Dashboards offer instant snapshots of key performance indicators, enabling you to spend your time analyzing and acting on your key data rather than gathering it. Dashboard Views categorize each state as a different container and display the individual Terminals falling under that category. SST/OB comes with a range of pre-defined dashboards.
9-2 Pre-Defined Dashboards SST/OB provides the following pre-defined Dashboards: Table 9-1 Pre-Defined Dashboards S.
9-3 Dashboard View Functions The intuitive easy-to-use SST/OB Client Application enables you to perform a wide variety of functions. The following table lists the common tasks that can be performed in a Policy View. Table 9-2 Dashboard View Functions S. No Function 1 Tile Vertically Icon Description Click on this icon, available just below the Dashboards tab, to arrange all the views in the Dashboard as vertical tiles.
9-4 Creating new Dashboards Follow the steps below to create a new Dashboard. 1. Click on the button on the Dashboard toolbar. The New Dashboard dialog box is displayed. Figure 9-2 New Dashboard Dialog Box 2. Enter the name for the new Dashboard in the Dashboard Name box. 3. Select the views to be included in the dashboard using the Select the views this dashboard will display list and click on the OK button. TIP: You can create a new Local View using the New View button.
9-5 Changing Dashboard Settings Follow the steps below to modify Dashboard settings. 1. Select the Dashboard to be modified from the Dashboards list and click on the toolbar button. 2. This displays the corresponding Dashboard Properties dialog box. Change the name of the Dashboard using the Dashboard Name box, if required. 3. Modify the selection of views using the Select the views this dashboard will display list and click on the OK button.
10 Terminal Sets 10-1 Terminal Sets Overview SST/OB provides the ability to group the Terminals in your environment, providing easy manageability of your Terminal network. Terminal Sets are used to restrict the Terminals that can be displayed to a non-admin user. For example, you can assign different Terminal Sets to different operators based on geographical regions to make sure that there is no duplicity of efforts. Terminals Sets are also useful while specifying filter conditions for report generation.
4. Select the Field on the basis of which the Terminals are to be filtered, the Operator and the Value to define a condition. In case you need to specify multiple conditions, use the Bracket link at the beginning and end of the condition as appropriate. Brackets are used to make more complex queries using AND/OR condition, click on the icon again. In the example below, the Terminal set will include all the Terminals with Terminal Type as NCR in the city CITY1.
CAUTION: You cannot select more than 200 terminals individually. It is highly recommended that conditions are used to specify the terminal sets. 7. The New Terminal Set - Terminal Set Name wizard page is displayed. Specify the Name and Description in the corresponding text boxes and click on the Finish button to complete the procedure. Figure 10-4 New Terminal Set – Terminal Set Name Wizard Page The Terminal Sets dialog box is displayed with the new set added.
10-3 Changing Terminal Set Settings 1. Click on the Terminal Sets option in the Manage menu. 2. The Terminal Sets dialog box is displayed. Select the Terminal Set to modify from the Available Terminal Sets list and click on the Properties button. Figure 10-6 Terminal Sets Dialog Box with Properties Button 3. The Terminal Set - Specify Conditions wizard page is displayed. Make the required modification in the conditions in the page.
10-4 Deleting Terminal Sets Follow the steps listed below to delete a Terminal Set. 1. Click on the Terminal Sets option in the Manage menu. The Terminal Sets dialog box is displayed. 2. Select the Terminal Set(s) to be deleted from the Available Terminal Sets list and click on the Delete button. Figure 10-8 Terminal Sets Dialog Box with Delete Button 3. The Delete Terminal Set(s) confirmation box is displayed. Deleting a Terminal set will affect all views and users using the Terminal set.
11 Faults and Fault Categories 11-1 Overview SST/OB provides the functionality of creating custom faults and assigning them to Terminals. You can create customized faults and add them to fault categories using the Faults and Fault Categories option in the Manage menu. The faults can be set/reset on Terminals using Event Policies or Custom fault policies.
2. Use the Click to create a Custom Fault link to create a new custom fault. This displays the Custom Fault Details area. Figure 11-2 Custom Faults and Fault Categories Manager Dialog Box with Custom Fault Details Area 3. Enter the fault description in the Fault Description box. 4. Use the Fault applies to this Terminal Type drop-down box to select the Terminal types on which the fault will be applied. The options available are: • All Terminal Types • DIEBOLD 10xx • NCR 5.
11-2-2 Changing Faults Follow the steps below to modify a custom fault: 1. Click on the Faults and Fault Categories option in the Manage menu. This displays the Custom Faults and Fault Categories Manager dialog box. The Custom Faults tab page is displayed by default. 2. Select the fault to modify from the Custom Faults list and click on the Click to Make Changes link. This displays the details for the selected fault in the Custom Fault Details area.
11-3 Fault Categories Faults can be grouped into categories for easy manageability using Fault Categories. You can create fault categories using the Faults and Fault Categories option in the Manage menu. Fault categories can also be used in the SST/OB Web interface in the Search screen. Fault categories can be created to search for all Terminals that have a certain type of faults. For example, “Communication problems” category can be created and faults can be assigned to this category.
11-3-2 Modifying Fault Categories 1. Click on the Faults and Fault Categories option in the Manage menu. This displays the Custom Faults and Fault Categories Manager dialog box. Click on the Fault Categories tab to access the corresponding tab page. 2. Select the fault category to be modified from the Faults in the selected category area. The faults in the selected fault category are displayed in the Faults in the selected category area. 3.
11-3-3 Renaming a Fault Category Follow the steps below to rename a custom fault category: 1. Click on the Faults and Fault Categories option in the Manage menu. This displays the Custom Faults and Fault Categories Manager dialog box. Click on the Fault Categories tab to access the corresponding tab page. 2. Select the fault category to be renamed from the Faults in the selected category area and type the new name.
12 Closure Codes 12-1 Overview Closure Codes provide information related to the problem that a Terminal has. Using this feature, an operator working on a problem has quick access to information on how to fix the issue. Closure codes are directly related to Policies. Each Policy may or may not have a Closure Code defined for it. Once you select a Terminal in a Policy View, you can see the Closure Code information in the Details for Terminal area - Resolution tab page.
12-3 Changing Closure Code Settings Use the following steps to modify a closure code: 1. Click on the Closure Codes option in the Manage menu. This displays the Closure Codes dialog box. 2. Select the closure code that needs to be modified from the list and click on the Click to Make Changes link. This enables the Closure Code Details area. Figure 12-2 Closure Codes Dialog Box 3.
13 Object State Codes 13-1 Overview Object State Codes provide information related to the state of an object that is responsible for one or more Terminals like a device handler, a resource node, a router, etc. The default Object State codes available with SST/OB are as follows: • DOWN: The device or the process is down. • UP: The device or the process is up. 13-2 Creating new Object State Codes 1. Click on Object State Codes in the Manage menu. This displays the Object State Codes dialog box.
NOTE: Object state Codes cannot be deleted once created. 13-3 Changing Object State Code Settings Use the following steps to modify an object state code: 1. Click on the Object State Codes option in the Manage menu. This displays the Object State Codes dialog box. 2. Select the object state code that needs to be modified from the list and click on the Click to Make Changes link. This enables the Object State Code Details area. Figure 13-3 Object State Code Dialog Box 3.
14 Email Alerts 14-1 Overview The SST/OB provides the ability to send email alerts for problem situations, before they can impact your business. This functionality can be configured using email templates. The configured templates can be used to send emails when a policy is violated. This topic provides information on how to configure and manage email templates. NOTE: Only the admin user has the rights to create and manage email templates.
3. Clicking on the New button displays the Create Email Template dialog box. Figure 14-2 Create Email Template Dialog Box Enter the name for the template in the Template Name box. 4. Enter the From, To, CC and BCC email addresses in the respective fields. You can also select the values of these fields using the Columns button. Click on the respective check boxes to select the column name. Figure 14-3 Select Columns Dialog Box NOTE: To, CC and BCC fields should not contain “;” (semicolon) character.
5. Add the Subject and mail body in the corresponding boxes. You can use the Columns button to add substitution parameters. Thus, you can create the body of the mail template using normal text and special substitution parameters that will extract information about the Terminal once the email is ready to be sent. 6. Specify the time (in minutes) after which an email will be sent after the violation is reported, using the Wait for the specified duration before sending an email field.
14-2-2 Changing Email Templates Follow the steps below to change an email template. 1. Click on the Email Templates option in the Manage menu. 2. The Email Templates dialog box is displayed with the available templates. Select the template to be modified and click on the Properties button to view/modify an email template. Figure 14-5 Email Templates Dialog Box with Properties Button 3. The corresponding Email Template dialog box is displayed.
14-2-3 Deleting Email Templates Follow the instructions below to delete an Email template. 1. Click on the Email Templates option in the Manage menu. 2. The Email Templates dialog box is displayed with the available templates. Select the template to be deleted and click on the Delete button to delete the template. Figure 14-7 Email Templates Dialog Box with Delete Button 3. The Delete Email Template(s) confirmation box is displayed. Click on the Yes button to delete the selected email template.
14-3 Sending Emails You can configure SST/OB to send emails using the following methods: • Using Email Templates • Sending Manual Emails 14-3-1 Using Email Templates You can use the preconfigured email templates while creating policies. For details on how to configure policies to send emails, refer to the Policies topic. 14-3-2 Sending Manual Emails Follow the steps below to send emails manually using the SST/OB Client interface. 1. Click on the Send Email option in the Actions menu. 2.
15-1 Thresholds SST/OB provides the ability to create thresholds to define acceptable operational rules and threshold alert templates to create thresholds in a specific format. Thresholds are conditions that can be applied on SST/OB Views and if there is any violation, the configured actions will be performed. The following actions can be triggered in case of a violation.
2. To create a new threshold, click on the New button. This displays New Threshold dialog box. Figure 15-2 New Threshold Dialog Box 3. Enter the threshold Name in the corresponding field. 4. Specify a condition on which the threshold is based using the Threshold is based on drop-down field. The options available are: 5.
Clicking on the Specify Conditions button displays the Edit Conditions dialog box. You can create a Boolean expression by combining column names and values using one or more operators. Figure 15-3 Edit Conditions Dialog Box– Number of Records in a View threshold type a. Select the column from the Column drop-down box. The options available are: • Number of records: Displayed when you select Number of records in a view in Threshold is based on field.
8. You can configure one or all of the following actions in case of a threshold violation: • Run a Command: To specify a command to be run, select the Run a Command check box and click on the Select Command button. Clicking on the Select Command button displays the Command Templates dialog box. Select a command template from the list and click on the OK button. For details on how to create new command templates, refer to the Commands topic.
To specify an image, click on the Select Icon button. This displays the corresponding Select Icon dialog box. Thresholds and Threshold Alert • Figure 15-5 Select Icon Dialog Box • Choose an icon to be displayed and click on the OK button. This will modify the visual settings of the corresponding column. 9. Select the Include violation information check box in order to add information to the text message provided in the Run a Command, Send an Email and Write to a Log actions. 10.
15-3 Applying Thresholds to Views Once thresholds have been created, they can be applied to one or more views. Perform the following steps to apply a threshold on a view: 1. Select the Thresholds option from the Manage menu. This displays the Thresholds dialog box. The Thresholds tab page is displayed by default with a list of configured thresholds. 2. Click on the Threshold Activation tab to display the corresponding tab page. Figure 15-6 Threshold Activation Tab Page 3.
Perform the following steps to modify an existing Threshold: 1. Click on the Thresholds option in the Manage menu to access the Thresholds dialog box. 2. Select the threshold to be modified and click on the Edit icon displayed. . The Edit Threshold dialog box is Figure 15-7 Edit Threshold Dialog Box 3. Make the required changes in the dialog box and click on the OK button. 15-5 Deleting Thresholds Perform the following steps to delete an existing Threshold. 1.
15-6 Threshold Alert Templates The SST/OB provides the ability to log alerts for problem situations, before they can impact your business. This functionality can be configured using Threshold Alert Templates. The configured templates can be used to send alerts when a threshold is violated. 15-6-1 Creating Alert Templates Follow the steps below to create a new Alert template. 1. Click on the Threshold Alert Templates option in the Manage menu. This displays the Alert Templates dialog box.
2. Click on the New button create a new Alert template. This displays the Create Alert Template dialog box. Thresholds and Threshold Alert Figure 15-10 Create Alert Template 3. Enter a name for the alert in the Name field. 4. Specify description for the alert in the Description field. 5. Use the Log to check boxes to select where the alerts will be logged.
15-6-2 Modifying Alert Templates Perform the following steps to modify an existing alert template. 1. Click on the Threshold Alert Templates option in the Manage menu. This displays the Alert Templates dialog box. 2. Select the threshold to be modified and click on the Properties button. This displays the corresponding Alert Template dialog box. 3. Make the required changes and click on the OK button. 15-6-3 Deleting Alert Templates Perform the following steps to delete an existing Alert Template: 1.
16 Commands 16-1 Commands Overview The SST/OB monitors your system to identify problems, analyses the collected data to determine the cause of problems, and provides an option to perform corrective action or initiates defined recovery processes. SST/OB provides operator initiated commands for specific Terminal problems. The commands execute on the Application Server where the SST/OB Command Server is running and response routed back to the SSTOB client and web interface.
3. Clicking on the New button displays the Create Command Template dialog box. Enter the name for the command template in the Name box. Figure 16-2 Create Command Templates Dialog Box 4. Specify the program to be run along with the path in the Program box. NOTE: The specified program must exist on the SST/OB Application Server. Mention the path in the Program box so that undesired programs in the system’s Path environment variable do not run inadvertently. 5.
NOTE: The substitution parameters have their values replaced with information from the selected Terminal when a command is being executed from the context menu on a Policy View or in the Terminal Browser. 7. In the Create Command Template dialog box, enter a description in the Description box. 8. Click on the OK button to create the command template. The Command Templates dialog box is displayed with the new command added.
16-2-2 Changing Commands Follow the steps listed below to change a command template. 1. Click on the Commands option in the Manage menu. The Command Templates dialog box is displayed. 2. Select the command template to be modified from the Available Command Templates list and click on the Properties button. Figure 16-5 Command Templates Dialog Box with Properties Button 3. The selected Command Template dialog box is displayed. Make the required modification and click on the OK button to continue.
16-2-3 Deleting Commands Follow the steps listed below to delete a command template. 1. Click on the Commands option in the Manage menu. The Command Templates dialog box is displayed. 2. Select the command template to be deleted from the Available Command Templates list and click on the Delete button. Commands Figure 16-6 Command Templates Dialog Box with Delete Button 3. The Delete Command Template(s) confirmation box is displayed.
16-3 Running Commands SST/OB provides the ability to execute commands on Terminals. The commands that are available for a user depend on the permissions assigned on command templates created by the admin user. Follow the steps listed below to run a command. 1. Right-click on a Terminal on which the command is to be run and click on the Commands option in the displayed menu. The commands option can be accessed from the context menu on a Policy View, SQL Based Local View or in the Terminal Browser.
3. The Parameters box displays the parameters selected according to the command template. In case you need to make changes, click on the Columns button to select fields to be used as parameters. 4. The Cancel this command if no response is received within check box is used to specify the time, in seconds, after which the command will be terminated if no response is received. 5. Click on the Run button to trigger the command.
17 Terminal Trees 17-1 Overview The Terminal Tree feature in SST/OB allows you to manage Terminals proactively and conveniently. It displays the terminals in a hierarchical format for easier location of Terminals in the client interface. To access Terminal Tree, click on the Terminal Browser tab on the SST/OB Tabs bar.
17-2 Create New Terminal Tree List SST/OB also provides a feature of creating new Terminal Tree list according to your business specifications. You can filter the list of terminals accordingly. Follow the steps given below to create a new terminal tree list in the existing list of Terminal Tree. 1. Click on the Manage menu to access the Terminal Trees option. 2. Clicking on the option displays the Terminal Trees dialog box. Click on the New button to create a new Terminal tree list.
5. Click on the OK button to continue. This will add the new Terminal tree list to the existing list. Figure 17-4 Terminal Trees Dialog Box 6. The newly created Terminal tree will be displayed along with the existing terminal trees in the Terminal Browser. Figure 17-5 Terminal Browser with Newly created Terminal Tree NOTE: The custom-created Terminal Trees do not display any icon.
17-3 Modify Existing Terminal Tree Follow the steps given below to modify an existing terminal tree. 1. Click on the Manage menu to access the Terminal Trees option. 2. Select the Terminal Tree from the existing list and click on the Properties button. 3. The Terminal Tree Properties dialog box is displayed. Edit the settings of the Terminal tree and click on the OK button to save the modifications. This completes the procedure for modifying a Terminal Tree.
18 Action History 18-1 Overview The Action History tab on the SST/OB Tabs bar displays the actions taken, for example acknowledging a Terminal in a view, commands executed and emails sent, in the SST/OB monitoring environment. Figure 18-1 SST/OB Action History Tab Page The following information is displayed in the Action History tab page: • Type: The type of action, for example Operator Action. • Status: Current status of the action.
18-3 Action History Details You can view details for actions displayed in the Action History tab using the Details button on the toolbar. Clicking on the Details button displays the Action Details dialog box. Figure 18-2 Action Details Dialog Box Use the Previous History Item and the Next History Item button to view the previous and next Action History history items respectively. To copy the action history details, click on the Copy button.
18-4 Customizing Action History Follow the steps given below to customize the information displayed in the Action History tab page. 1. Click on the Customize button in the Action History tab page. Figure 18-3 SST/OB Action History Tab Page 2. The Filter builder dialog box is displayed. To add a new filter condition, click on the press the button to add a new condition button. Figure 18-4 SST/OB Filter Builder Dialog Box You can also add a new condition using the Filter button.
3. Clicking on press the button to add a new condition button will add a new condition in the following format. Where, • Filter Column Name: Name of the column on which the filter is applied. For example, Terminal ID. Click on the link and select the column name using the displayed drop-down list. • Operator: The type of operator. For example, like. Click on the link and select the operator using the displayed drop-down list.
5. Specify the values in the respective fields to create multiple conditions. Figure 18-7 SST/OB Filter builder With Multiple Conditions Click on the Apply button to apply the changes. Click on the Save As button to save the existing filter. NOTE: The AND, OR, NOT AND and NOT OR operators are applied on the root conditions. The result will be displayed in the Action History tab. Figure 18-8 SST/OB Action History Tab Page The condition applied in the filter will be visible at the bottom of the window.
19 Data Management 19-1 Overview With SST/OB, you can manage the following types of Terminal related information. • Custom Data • Terminal Profiles The Manage Data tab in the SST/OB Client Application enables you to manage the Custom Data and Terminal Profiles. To select the data to manage, use the Manage drop-down box on the toolbar. SST/OB also allows you to map data values to meaningful names and import/export data from the SST/OB environment.
19-3 Terminal Profiles Terminal Profiles displays the information about the Terminals gathered from the BASE24 environment. To access the Terminal Profile details, select the Manage Data tab and select the Terminal Profiles option from the Manage drop-down box. Figure 19-2 Manage Data – Terminal Profiles NOTE: You cannot add new columns or delete columns to/from Terminal Profiles.
19-4 Mapping Data Values to Meaningful Names The Data Mapping feature of SST/OB enables you to create name and value mappings for information displayed in various columns in Terminal Profiles and Custom Data. For example, you can map the Region ID “0001” to “North”. This will display the Region ID of “0001” as “North” in SST/OB Client Application. Follow the instructions below to specify name and value mappings. 1. Click on the Manage Data tab to access the corresponding tab page. 2.
19-5 Importing Data SST/OB provides the ability to import data from external sources like Microsoft Excel files or CSV files into the Custom Data. The Import utility can be run in user interactive mode or in batch mode if there is a requirement to constantly update the information on a scheduled basis. 19-5-1 Starting a New Import Follow the instructions below to import data to Custom Data fields. 1. Click on the Manage Data tab to access the corresponding tab page. 2.
5. The Data Source file path field is enabled. Enter the path of the data source file or use the Browse button to select the data source. Clicking on the Browse button displays the Open dialog box. Figure 19-6 Open Dialog Box 6. Select the data source file and click on the Open button to return to the Import Custom Data wizard.
8. The Choose the key column page is displayed. Select the column which would be used as a mapping field to update the destination table. The columns on the left are from the source file and columns on the right are in the destination table. The corresponding columns must have the same data type. Figure 19-8 Import a Data Source – Choose the key column Page Click on the Next button to continue. 9. The Import Custom Data wizard Customize the columns/data to be imported page is displayed.
10. Click on the Properties button on the Customize the columns/data to be imported page to modify the properties of the data to be imported. The Modify Column Properties window is displayed. Figure 19-10 Modify Column Properties Window Specify the column name in the SST/OB database and the display name that would be visible in SST/OB Client Application using the Destination Column Name and Display Name fields. Change the Data Type using the corresponding drop-down box.
Execute the Import Immediately a. Select the Execute the Import immediately radio button to start the import immediately and click on the Next button. b. Clicking on the Next button displays the Complete the Import wizard page. Figure 19-12 Import Custom Data – Complete the Import Page The new columns that were specified to be imported and the already existing columns that were overwritten are displayed. Review and verify the columns that would be created. To modify the selection, click on the Back button.
d. The Close box is displayed. Click on the Yes button to close the Import Custom Data wizard. Figure 19-14 Close Box e. Clicking on Yes button displays the Import Complete information box with the information that the data has been imported from the MS Office Excel. Click on the OK button to complete the process. Figure 19-15 Import Complete Information Box Save the Import Configuration a.
b. The Configuration file path box is enabled. Enter the file path or use the Browse button to select the path where the configuration file will be saved. This displays the Save dialog box. Specify the file name and click on the Save button to save the configuration as an XML file. Figure 19-17 Import Custom Data – Select final action Page c. The Select final action page is displayed with the Configuration file path. Click on the Next button to continue.
d. The Complete the Import page is displayed. Verify the choices made in the wizard and click on the Finish button to continue. Figure 19-19 Import Custom Data – Complete the Import Page e. Clicking on the Finish button starts the process of saving the import configuration. The Complete the Import page displays the summary and status. Click on the Close button to continue. Figure 19-20 Import Custom Data – Complete the Import Page f. The Close box is displayed.
19-5-2 Loading a Previously Saved Import Configuration You can use the following methods to load an automated import configuration XML file. • Using SST/OB Client GUI • Console Mode using the Command Prompt • Using Windows Scheduled Task Using SST/OB Client GUI Follow the instructions below to import data to Custom Data fields using the SST/OB Client GUI. 1. Click on the Manage Data tab to access the corresponding tab page. 2.
6. Select the configuration file and click on the Open button to return to the Import Custom Data wizard. Figure 19-22 Import a Data Source – Choose a Data Source Page with Configuration File Path Specified Click on the Next button on the Import Custom Data wizard Choose a Data Source page. 7. The Choose the key column page is displayed. Select the column which would be used as a mapping field to update the destination table.
11. The Select final action page is displayed. Figure 19-23 Import Custom Data – Select final action Page This page can be used for executing the import immediately or save the modifications made in the configuration file.
Console Mode using the Command Prompt SST/OB allows you to run the Import Utility using the ImportUtility.exe at command prompt. Command line options: ImportUtility /configFile: Where, /configFile: is the full path of the configuration file that contains import job information. The default is (ImportInfo.xml) To run the utility, switch over to the location where the ImportUtility.exe is copied.
Using Windows Scheduled Task Follow the instructions below to execute the Import Utility using Windows Schedule Task. 1. Open the Schedule Task window. Start -> Control Panel-> Scheduled Tasks 2. Right-click on the right pane and select the New – Scheduled Task option. This adds a New Task. Type a name for the new task and double click on it to configure. 3. The Task tab page is opened by default. Type the path of the ImportUtility.exe along with the parameters in the Run box.
5. Click on the Schedule tab to specify the scheduling time for the task. This displays the Schedule tab page. Figure 19-25 Scheduling Task – Schedule Tab 6. Click on the Apply button to save the configuration. 7. This displays the Set Account Information dialog box. Enter the password in the Password and Confirm Password fields and click on the OK button to continue.
19-6 Managing Data 19-6-1 Adding Columns SSTOB provides the facility to manually add data to the SSTOB database. This can be done via “New Column” functionality described below. Once a column is created the grid interface in the Manage data tab can be used to directly enter the data. Follow the instructions below to add a new column to add customized data in Custom Data. 1. Click on the Manage Data tab to access the corresponding tab page. 2.
19-6-2 Editing Data Follow the instructions below to edit data in Custom Data. 1. Click on the Manage Data tab to access the corresponding tab page. 2. Select the data type as Custom Data from the Manage drop-down box on the toolbar. 3. Click on the button on the Manage Data toolbar to activate the edit mode and select the cell that needs to be edited. 4. Make the appropriate changes and use the button or button to save the modifications.
20 Configuring Hours of Operation 20-1 Overview SST/OB configures “hours of operations” schedules to determine the dates and times, when a Terminal is expected to be in operation. You can create and manage schedules using the Schedules option in the SST/OB Manage menu. The following menu options are available to create Schedules: • New Schedules • New Weekly Schedule • New Exception Schedule 20-2 Creating a New Schedule Follow the steps given below to create a new schedule: 1.
3. The Schedule dialog box is displayed. Configuring Hours of Operation Figure 20-2 Schedule Dialog Box Enter the following details in the corresponding fields: a. Name: Enter a name for the schedule in the Name field. b. Schedule Type: Specify the type of schedule to be assigned. The options available are: c. • Available 24 hours: The terminals under this schedule type would be available 24 hours a day.
20-3 Creating a New Weekly Schedule Follow the steps given below to create a new weekly schedule: 1. Click on the Manage menu to access the Schedules option. 2. Clicking on the Schedules option displays the corresponding dialog box. Click on the New button and select the New Weekly Schedule option from the drop-down list. Figure 20-3 Schedules Dialog Box 3. Clicking on the New Weekly Schedule option displays a Weekly Schedule dialog box.
20-4 Creating a New Exception Schedule 1. Click on the Manage menu to access Schedules option. 2. Clicking on the Schedules option displays the corresponding dialog box. Click on the New button and select the New Exception Schedule option from the drop-down list. Figure 20-5 Schedules Dialog Box 3. Clicking on New Exception Schedule option displays an Exception Schedule dialog box.
Enter the following details in the Exception Schedule dialog box: a. Name: Enter the name for the exception schedule in the Name field. b. Type: Select the Type of exception schedule from the Type dropdown box. The options are 4. • Extended Hours in a Day: This exception type defines the extended hours during which a terminal is expected to be open for business, while it is normally closed for those hours. Specify the extended date and hours using Select Date, Start Hour and End Hour field.
20-7 Terminal Schedule Mapping 1. Click on the Terminal-Schedule Mapping option in the Manage menu. This displays the Terminal-Schedule Mapping dialog box. Figure 20-8 Terminal-Schedule Mapping Dialog Box 2. To assign a schedule to a Terminal, drag the corresponding schedule from the Schedules list and drop it onto a terminal in the Terminal-Schedule Mapping list. To remove a schedule from a terminal, drag it back to the Schedules list. You can also apply/remove the schedules using the arrow buttons.
20-8 Schedule Exception Mapping A schedule can have one or more exception schedules associated with it. Follow the steps given below to associate an exception schedule with a schedule: 1. Click on the Schedule-Exception Mapping option in the Manage menu. This displays the ScheduleException Mapping dialog box. Figure 20-9 Terminal-Schedule Mapping Dialog Box 2.
Appendix A SST/OB Grid Features This topic provides information on the common SST/OB Client Application Grid functions. This grid is the basic component of all the SST/OB Views, panels and Browsers. Selecting Columns to Display: Select/deselect the columns to display using the Select Visible Columns icon Appendix A Figure A-1 Dashboard View Header Context Menu Sort Ascending: Use this option to sort the values/data given in the list based on the data in the selected column, in ascending order.
Appendix B SST/OB Configuration Client Settings Components Categories SST/OB Alerts Processor Configuration Parameter Install Folder Log Folder The folder where the log files are created. If left blank, the default location is the location of the executable. Maximum Logfile Size (KB) The maximum allowed size of the log files in KB. The default value is 500. Trace Level The level of tracing. It can have the following values: • Error: For error and informational message logging only.
Components Categories Parameter ODBC Settings Login Timeout (secs) The timeout interval for logging in to the Database Server. The default value is 30. Query Timeout (secs) The timeout interval for a query to complete execution on the Database Server. The default value is 180.
Components Categories Parameter Problem in DBWriter Module if no data logged (if data is being received) to DB for duration (mins) ODBC Settings Login Timeout (secs) Query Timeout (secs) SST/OB Mail Agent Database Settings Windows Authentication Enabled SQL Server Instance Name SQL Port Username Password Operational Parameters Processing Enabled Inbound Mail Processing Enabled Idle Wait Interval (secs) Maximum Logfile Size (KB) Trace Level Log Folder POP3/IMAP Server SSL Enabled Settings IMAP Enab
Components Categories Parameter Max Catch Up Interval (secs) This parameter specifies the interval that the Event Logger uses to catch up in case there is a connection outage from the host. Purge Check Interval (hrs) This parameter specifies how frequently to run the purge process on the events storage. Purge Events Older Than (days) Specifies the retention interval of the events storage in days.
Components Categories Parameter ODBC Settings Login Timeout (secs) Query Timeout (secs) Appendix B 176
Appendix C SST/OB Import Utility Configuration Parameters Parameter Description UseTransaction Sets/Reset the transaction mode of the Import process. Default: “False” AbortOpeartionOnError Aborts the process in case any error occurred while importing the data. Default: “False” TruncateSourceStringandSaveOnE Truncates the value of string data type, if the length of the string exceeds the destination rrors column size.
Document Feedback Form We would appreciate your comments on the HP SST Operations Bridge Administration Guide. After you have read the Guide and used the software, please take a few moments to complete this form and return it to appropriate HP product support service. 1. The organization of the Guide makes it easy to locate topics quickly. Strongly Disagree 1 2. Strongly Agree 2 3 4 The appearance of the pages makes it easy to locate information quickly. Strongly Disagree 1 3.
9. The level of writing in this book is: Too Basic Just Right Too Technical (Please be specific.) Do you have any other suggestions for improvement? Document Feedback Form 10.
