Pathway
1.About Pathway
Web ViewPoint Pathway Plug-in is a thin web-based product for the monitoring and management of Pathway applications from Web Viewpoint. This is a plug-in product to Web ViewPoint, and therefore requires that Web ViewPoint be installed and operational prior to attempting an install and activation of the plug-in.
Web ViewPoint Pathway’s key features are:
• Point and click smart management methods
• Object oriented operation management
• Automatic management of resources and alert conditions
• Automated & central operation
• Parallel startup & shutdown
These features translate to the following key benefits:
• Significantly reduces time to select and execute commands
• Improves operator productivity through use of smart commands
• Reduces operator training requirements
• Allows for automated monitoring and management of applications
• Sends out automatic notifications upon reaching customizable alert conditions
• Significantly reduces scheduled down-times through parallel startup & shutdown of multiple Pathway applications
Access to Pathways and objects are organized in a simple and dynamic tree structure. You would select a node to see a list of Pathways; select a Pathway to expose its objects and select an Object to issue a command. Web ViewPoint Pathway knows the steps required to take an Entity from one state to another.
Let’s assume you were to issue a RESTART command on multiple SERVER Classes. Web ViewPoint Pathway examines the current state of each SERVER Class on your selected list. It then issues the proper sequence of commands (e.g. FREEZE, STOP, STATUS, THAW, START, STATUS) to take each entity to the stopped state & back to a running state. This not only reduces the required time to complete the task but eliminates the need to have knowledge of sequence and syntax of the required commands, and also ensures that the final state is reached for each entity.
Web ViewPoint Pathway’s Auto-Manage feature is obsolete starting from H01AAO-L01AAP version onwards.
2.Pre-Installation Tasks
3.Installation Intructions
Web View Point Pathway can be installed using DSM/SCM tool or can be installed manually also.
- For DSM/SCM, use the IPSETUP.exe program to upload the files from the CD / PC to the NonStop server. Follow the screens on the Wizard and provide the necessary information as prompted. Once the IPSETUP program completes ensure that the files listed below have been transferred in the correct format and the file codes are correct.
- Following are the steps needed to install Web ViewPoint Pathway Manually:
- README.TXT – File containing product and basic installation information.
- SETPATH – Configuration and installation of Web ViewPoint on NonStop.
- PATHPAK – Web ViewPoint Pathway PAK file containing all required files.
- WPWY.tar – Tar file containing Pathway OSS files (For plugging into Web ViewPoint)
- WPPWY.tar – Tar file containing Pathway OSS files (For plugging into Web ViewPoint Plus)
Installation Steps:
Note: Web ViewPoint or Web ViewPoint Plus instance to which you want to integrate this plugin must be stopped before installing this product.
The installation requires you to have access to both Guardian and OSS side on your NonStop. Files need to be installed on both the sides.
Guardian Side:
- FTP the following files to your Web ViewPoint subvolume.
(Note: These files need to be transferred to the WVP $volume.subvolume to which you want to integrate this plugin)
The following files have to be transferred in ‘BINARY’ Mode
- SETPATH
- PATHPAK
- Run the setup file ‘SETPATH’ (read the following instructions first)
- It prompts user to specify the parameters you want to use for Web ViewPoint Pathway
- Refresh Process Name: This is the process name of the Refresh Program (WVPPREF). This process starts alongside Web ViewPoint Pathway and will be a part of STARTWVP/STARTPLS. It runs in the background to Relearn the Pathway environments once a day by default.
By default, $REF is set as the Refresh process name, to change the default parameter follow the below step:
- Input number 1 and enter, input desired Refresh Process name and enter.
- Install: Input number 2 and enter to install Pathway Plugin as shown below
OSS Side:
- Goto your Web ViewPoint/Web ViewPoint Plus installation subvolume
- Open the UGATCONF to see the OSS location
(example: PARAM WEBLOCATION /usr/tandem/wvp) - Now switch to the OSS side and goto the OSS location specified in UGATCONF
Example: cd /usr/tandem/wvp - Transfer the tar file (which was sent as a part of install package) to the wvp folder\
- Extract the contents of the tar file by running the below command:
tar -o -xvf wpwy.tar (For Web ViewPoint)
tar -o -xvf wppwy.tar (For Web ViewPoint Plus) - Go to the Guradian side and start Web ViewPoint and Web ViewPoint Plus.
- To access Web ViewPoint Pathway, open our browser, enter the IP address and Port on which Web ViewPoint is running (the plug-in functions can be accessed under the ‘Admin’ menu item) Example: http://121.231.102.221:8787/index.html
Uninstall Web ViewPoint Pathway Plugin:
Procedure: Web ViewPoint Pathway can be uninstalled by running RMVPATH from the installation sub volume.
It removes WVPPWY from Web ViewPoint by updating the STARTWVP/STARTPLS and STOPWVP/STOPPLS files.
The following steps need to be followed:
- Stop Web ViewPoint/ Web ViewPoint Plus, if already running
- Set your working volume to $system.zwvps (or to $volume.sub volume where you have installed Web ViewPoint)
- Issue ‘Obey STOPWVP’ or ‘OBEY STOPPLS’
- Run the Uninstallation program, UINSTALL
- Issue ‘RUN RMVPATH’
Figure showing the uninstall of Web ViewPoint Pathway.
3. Web ViewPoint can be started up after the plug-in is removed by running
OBEY STARTWVP/STARTPLS
4.Activating Web ViewPoint Pathway
When Web ViewPoint Pathway is first run through the Browser, it tries to activate itself by contacting the activation website over the internet. If you are a new user you will be prompted to enter your registration details. If you have an active Internet connection the activation will happen automatically, if not then the system will provide you with details and handle the registration and activation via email.
During activation, a license key is written to the license repository (i.e. ULICENSE) that is identified by the LICENSE-FILE Assign. Once complete, Web ViewPoint Pathway will fully function from Web Viewpoint. In the default configuration, the LICENSE-FILE Assign points to the $Vol.Subvol where Web Viewpoint is installed.
5.Admin-Pathway
Administration functions are used to initialize & maintain the central host databases used by Web ViewPoint Pathway. The following information is maintained per Pathway:
- Lists number of TERM, TCP, and SERVER entities that are running
- Maintenance of Group definitions
- Syncing, Starting, Stopping and deleting pathways
- Cold, Cool and Shutdown Obey file names
- Start & Shutdown of Pathways
Web ViewPoint Pathway administration functions are accessible at the Web View Point instance and under the Admin Section. A logon screen is displayed upon access to this port. Use your Guardian id/alias & password to logon to the NonStop Server you are connected to. Using a tree structure, Web ViewPoint Pathway displays the NonStop Server you are connected to.
By default, the right part of the window will be blank with an Add button on the top right corner. This ‘Add’ button acts as the learning function.
To manage a Pathway, Web ViewPoint Pathway needs to know/learn and store names of all its entities for all Objects (TERM, TCP, & SERVER). This process needs to be done once. In addition, Sync option is also provided if and when necessary to synchronize the database with the current state of operation (e.g. remove information for a Pathway that no longer exists).
To learn a Pathway…
Clicking on the Add button displays the list of all available pathways for that node. Select all the Pathways you want to manage. Web ViewPoint Pathway displays entry fields where you can enter the name of Obey files to Cold Start, Cool Start, or Shutdown each Pathway. There is one row of fields per selected Pathway. This information is optional but is needed if you want to use Web ViewPoint Pathway to start or shutdown a Pathway. Note: All file name entries should be fully qualified with volume and sub-volume names.
To maintain Pathway previously learned information…
From time to time you may want to update the information about the previously learned Pathways. Instances when such may be the case are:
- A given Pathway environment is no longer used.
- Obey files to start/shutdown have changed or need to be entered.
- Entities have been added or deleted from a Pathway outside of Web ViewPoint Pathway (e.g. Pathcom), and information needs to be synchronized. Note that Web ViewPoint Pathway automatically updates its database anytime you delete an entity or add a new one using its own commands.
Select Pathways from the list to perform one of the three functions (a button is provided for each):
- Edit – Enter or change Obey files names to start/shutdown the selected Pathway(s).
- Sync – This retrieves names of all Entities for the selected Pathways and updates the Web ViewPoint Pathway database. Click on the Sync button to initiate this process.
- Delete – Click on this button to remove all information for selected Pathways from the Web ViewPoint Pathway database.
All updated information is located centrally on the NonStop Server and becomes immediately available to all Web ViewPoint Pathway users.
Starting and Stopping of Pathways…
- Start – If no information is configured, it opens a dialog box prompting you to enter the file locations.
If information is already configured, it opens a dialog box, giving you the option to perform a Cold or Cool start. Select the appropriate option and click on the Yes button. Web ViewPoint Pathway issues an OBEY request on the host for the proper startup file previously defined for this Pathway using the Administration Function (described earlier in this document). The result of this process (obey file listing) is displayed in a new Window. This shows the beginning timestamp, the result/listing of the obey file, the end timestamp, and duration of the startup for that Pathway.
- Stop – If no information is configured, it opens a dialog box prompting you to enter the file locations.
If information is configured, clicking on Stop opens a dialog box which requests your confirmation to shutdown the Pathway.
Web ViewPoint Pathway issues a request on the host to OBEY the shutdown file previously defined for this Pathway using the Administration Function (described earlier in this document). The result of this process (obey file listing) is displayed in a new Window. A timestamp shows the beginning of shutdown operation, and another shows the time when it completes. Web ViewPoint Pathway also calculates and displays the time the shutdown operation takes.
Managing Groups
You may define one or more Groups of Entities for any Pathway Object and assign them an identifiable name. Entities may be part of one or more Groups. When issuing a command for an Object, you are given the option to apply the command to a group of entities, simply by selecting the Group’s name you had previously defined.
Group definitions are held centrally on the host. As such, when you add a new Group or make changes to a current definition, it immediately becomes available to all other Web ViewPoint Pathway users.
To manage group definitions for a Pathway, click on Groups button for that respective Pathway. Then select its desired Object folder (TERM, TCP, SERVER).
- To Add a Group,
When no groups are available or selected, only Add operation is displayed. Select the Add option and enter a group name (free format – 1 to 35 characters) in the entry box right below the Add option.
A list of all Entities for that Object and Pathway is displayed in a dropdown list. Select any one or more entities, as you click on each entity they get selected automatically. If you want to remove any entity from the list, simply click on the selected entity (it gets unchecked and removed). Click on the Submit button to add the new Group.
- To Edit a Group,
Select the Edit option. This displays a dropdown list which contains a list of all Group names currently defined for this Object and Pathway. Select a Group from this list. Its list of entities will be displayed in textbox for Entities.
Make any changes to this list, by checking and unchecking from the list of entities as necessary. Click on the Submit button to apply the changes to this Group.
- To Delete a Group,
Select the Delete option. This displays a list of all Group names currently defined for this Pathway in the dropdown list. Select any one or more Groups that you want to delete from the dropdown list.
Click on the Submit button to confirm & delete the selected Group(s).
6.Operation-Pathway
User functions include all day to day monitoring and management tasks for all supported Pathways. These include:
- Monitoring and affecting the state and configuration of various Pathways and their entities
Use your Guardian User ID/Alias & password to logon to the NonStop Server you are connected to. Web ViewPoint Pathway user functions are accessible from the “Pathway” tag name in the “Operation” menu.
Web ViewPoint Pathway uses a hierarchical tree structure to allow you to navigate through the all the learned pathways.
Clicking on Pathways shows the overall summary of all Pathways present in that node. Summary shows all the high-level stats of TERM, TCP & SERVER.
Please note that the list of Pathways displayed are those previously learned via the Administration functions (described earlier in this document) of Web ViewPoint Pathway. This also is the case any time references are made to “all Pathways” or “Pathways” in this section.
Clicking on the name of a Pathway (on the left panel) populates the right panel with detailed information of that Pathway i.e. Properties, TERM, TCP and SERVER related info.
The following sections describe the features and commands available in each section.
Available Operations and Commands
- Pathway level operations – These are commands available when you click on the name of a Pathway of a selected NonStop Server on the hierarchical navigation tree.
- Selecting Entities – This topic reviews the available entity selection options. These options and their selected methods are common to or similar for all Object commands.
- Quick Commands – Describes methods where you can quickly issue multiple commands to the same or subsets of previously selected entities.
- Objects & Commands – Lists and briefly reviews a list of commands for all Objects. Where applicable it describes the built-in intelligence of command management.
Pathway Level Operations
Following operations are available on the right panel after clicking on the Pathway name of a selected NonStop Server on the left panel:
- Properties – Displays current status & statistics of the selected Pathway. This is a complete set of current data that would otherwise need to be retrieved from a combination of “INFO PATHWAY”, “STATUS PATHWAY”, and “STATUS PATHMON” commands via Pathcom.
Error messages are returned if the selected Pathway is not currently running or whose MAXSPI (a parameter defined at cold start of a Pathway – default is one) value is reached. It also shows the graphical representation of currently used vs remaining (based on the MAX parameters set).
TCP – Selecting Entities
Clicking on the TERM tab displays all the list of commands that you can apply to the selected entities.
The right panel of the screen is further divided into two sections:
- Lists all the commands that you can to apply for selected entities
- Identify entities that you want to apply the commands to.
You can select any command from the left side and then make necessary selections to the Entity parameters on the right side.
Available options for selecting entities are as follows:
- All (object name) – Selected command applies to all entities. In this case a command with a “*” qualifier is sent to the Pathmon process, asking for execution of this command to all current entities for the given Object. Note that this includes even entities which may not have been previously learned.
- Select – Web ViewPoint Pathway displays an alphabetically ordered list of all learned entities for you to choose from. Select any one or more entities to apply the command to.
- Group – Web ViewPoint Pathway displays a list (via a drop-down list-box) of all previously defined Groups (see Managing Groups later in this document). You may select a Group and have Web ViewPoint Pathway execute the command against all entities which are part of this Group.
- Type – You are given the option to manually type in the name of a single Entity to apply the command to. No wildcards are supported. You may even enter the name of an Entity which has not been learned before.
- Only if: – This enables you to apply the selected command to entities based on their current state (e.g. Abort All TERMS which Suspended are). Note that the list of displayed state options to choose from varies and is dependent on the selected Object and command. Upon issuance of a command, Web ViewPoint Pathway examines the current state of each entity for the selected Pathway and Object. The selected command is issued, if the current state of an entity matches your selected option.
Click on the Submit button to issue the selected command, after one of the above options is chosen to identify the target entities. Results of the executed command are displayed in the right panel.
Quick Commands
Web ViewPoint Pathway displays the results of an executed command on an Object’s entities, on the browser Windows right panel.
You may click on the refresh icon on the toolbar to execute the same command again for the same entities.
To issue a new command on the same entities, click on the command iconon the toolbar. This shows a list of all available commands for the selected object. Simply select a command from the list.
There is also a check-box displayed to the left of each entity name in the displayed results. You may select any one or more entities by checking their checkbox. If you now click on either the refresh or command icon
, the new command only applies to the selected entities. Note that for some results (e.g. list of ASSIGNs for SERVER Classes) entity name may be repeated for multiple rows. You only need to select one row. Web ViewPoint Pathway treats multiple selections of the same entity as one.
Objects and Commands
Clicking on a Pathway name displays its Objects (TERM, TCP, SERVER). An Object is listed if it has a max value (e.g. MAXTCPS) greater than zero.
Click on an Object’s tab to see a list of available commands and entity selection area. Select a command, and Web ViewPoint Pathway displays a prompt set on the right panel where you can specify entities to apply the command to (see Selecting Entities earlier in this document). Following are the available commands for each Object:
Note:
– Pathcom equivalent commands are listed
– Where applicable, the option to carry out a command based on the current state of entities is listed (state option: list).
- TERM
- Abort
ABORT TERM
State options: SUSPENDED, RUNNING
- Alter
ALTER TERM
- Delete
DELETE TERM
- Info
INFO TERM
State options: [Not] RUNNING, STOPPED, SUSPENDED.
- Resume
RESUME TERM
State option: SUSPENDED.
- Restart
ABORT TERM and START TERM
State option: SUSPENDED.
- Start
START TERM
State option: STOPPED.
- Stats
STATS TERM
State option: RUNNING.
- Status
STATUS TERM
State options: [Not] RUNNING, STOPPED, SUSPENDED.
- Stop
STOP TERM
State option: RUNNING.
- Suspend
SUSPEND TERM
State option: RUNNING.
- Add
ADD TERM – This is the only command which is displayed as a button on the top right corner of the screen. Clicking on Add button open a new modal window with all required fields for user to input.
- TCP
- Alter
ALTER TCP
- Delete
Delete TCP
- Info
INFO TCP
State options: [Not] PENDING, RUNNING, STOPPED.
- Refresh
REFRESH TCP
State options: RUNNING.
- Start
START TCP
State options: STOPPED.
- Stats Terms
STATS TERM TCP
- Stats
START TCP
State options: RUNNING.
- Stats Server
STATS SERVER TCP
- Status
STATUS TCP
State options: [Not] PENDING, RUNNING, STOPPED.
- Stop
STOP TCP
State options: PENDING, RUNNING, not STOPPED.
- Switch
SWITCH TCP
State options: RUNNING.
- Add
ADD TCP – This is the only command which is displayed as a button on the top right corner of the screen. Clicking on Add button open a new modal window with all required fields for user to input.
- SERVER
- Alter
ALTER SERVER
Special considerations: There are five tabs:
- Base – alter one or more attributes
- CPU/Process – alter CPU and Process setting
- Assigns – Alter ASSIGN(s)
- Defines – Alter DEFINE(s)
- Params – Alter PARAM(s)
For Assigns, Defines, and Params, information is displayed in a grid/tab format. You can edit items for each of these categories by clicking on their name (blue ribbon).
Click on the Add button (right of the panel) and enter values to add the new entries to the grid. To remove items (use Set Like list box above the grid to retrieve and display current setting for a selected SERVER) off the grid. Delete button is present to the right of any row, click on Delete button to delete the newly added entry.
Once all changes are in place (you may alter many things at once, and edit multiple things on multiple tabs), click on Alter command.
Alter assumes that the selected SERVERs are in a STOPPED status and just issues the needed ALTER commands.
- Delete
Delete SERVER
- Freeze
FREEZE SERVER
- Info
INFO SERVER
Special considerations: There are five info options:
- Base values – returns main attributes (e.g. NUMSTATIC)
- Defines – returns SERVER DEFINE(s), if any
- Assigns – returns SERVER ASSIGN(s), if any
- Params – returns SERVER PARAM(s), if any
- CPU Load – returns SERVER CPU Distribution(s), if any
- Restart
STATUS SERVER,
[FREEZE SERVER], [STOP SERVER], [THAW SERVER]. START SERVER
- Start
START SERVER.
- Stats Linkmon
STATS LINKMON SERVER
- Stats TCP
STATS TCP SERVER
- Status
STATUS SERVER
State options: FROZEN, FREEZE PENDING, PENDING, THAWED.
- Status Process
STATUS DETAIL SERVER
- Stop
STOP SERVER
- Stop Process
STATUS DETAIL SERVER, Guardian STOP of each Process
- Thaw
THAW SERVER
- Add
ADD SERVER – This is the only command which is displayed as a button on the top right corner of the screen. Clicking on Add button open a new modal window with all required fields for user to input.
7.Configuring Web ViewPoint Pathway
Web ViewPoint Pathway provides a set of configuration options which are primarily used to provide flexibility in the location of database files. The following table provides the available ASSIGNs and PARAMs used by objects WVPPREF and UMPGATE:
ASSIGNs | WVP File | Description |
LICENSE-FILE, <license filename> | UGATCONF | This provides Web ViewPoint Pathway with the location of license file that contains the licensekey. By default, the installation program makes this assign point to the ULICENSE file present in the Web ViewPoint subvolume (the ULICENSE file present in the Web ViewPoint/Plus subvolume serves as a key-store and can store license keys of Web ViewPoint/Plus Shell as well as Web ViewPoint Pathway). This ASSIGN is mandatory and is automatically set during plug-in installation.
|
PATHWAYS-FILE, <fully qualified pathways filename> | UGATCONF | This provides the location of the file that stores information on Pathways. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.PATHWAYS
|
SERVERS-FILE,
<fully qualified servers filename> |
UGATCONF | This provides the location of the file that stores information on SERVERs. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.SERVERS
|
TERMS-FILE,
<fully qualified terms filename> |
UGATCONF | This provides the location of the file that stores information on TERMs. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.TERMS
|
TCPS-FILE,
<fully qualified tcps filename> |
UGATCONF | This provides the location of the file that stores information of TCPs. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.TCPS
|
GROUPS-FILE,
<fully qualified groups filename> |
UGATCONF | This provides the location of the file that stores Object (TERM, TCP or SERVER) group information. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.GROUPS
|
GROUPE-FILE,
<fully qualified entity group filename> |
UGATCONF | This provides the location of the file that stores entity group information. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.GROUPE
|
PWAWORK1-FILE, <temp filename> | UGATCONF | This provides the location of the file that is used to stage temporary information when executing commands.
|
CC-FILE,
<fully qualified setup filename> |
STRTWVP
UGATCONF |
This provides the location of the file that stores the Setup Information for Auto Manage. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.WVPPCC
|
CCE-FILE,
<fully qualified entity filename> |
STRTWVP
UGATCONF |
This provides the location of the file that stores the Entity Information for Auto Manage. This ASSIGN needs to have a fully qualified path to the pathway plug-in subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.WVPPCCE |
WVP-LOCATION,
<fully qualified UGATCONF filename> |
STRTWVP | This provides the location of the where Web ViewPoint is installed so that the WVPPREF file can be started up. This ASSIGN needs to have a fully qualified path to the Web ViewPoint subvolume. By default, this ASSIGN points to $SYSTEM.ZWVP.UGATCONF |
PARAMs | WVP File | Description |
PATHWAY-01 <program filename> | UGATCONF | This param specifies the location of Pathway Monitor Program. This is set by the installation program to $SYSTEM.SYSTEM.PATHMON but can be changed if necessary.
|
EXECUTION-LOG * | STARTWVP/STARTPLS
UGATCONF |
This is a mandatory param set by the installation program. It is a runtime requirement for WVPPUSER, WVPPADM and shall not be removed from UGATCONF file.
|
PATHWAY-REFRESH-INTERVAL <number-of-hours> | STARTWVP/STARTPLS | This is an optional param that specifies the interval at which the WVPPREF process will refresh the TERMs and SERVERs of Learned Pathways. Default value is 24 hours. Maximum value is 200 hours.
|