Administration Options


About the Administration Options

The Admin tab includes a menu tree of objects used for global settings, integration with external systems, and JaxView administration tasks. These tasks include creating users, setting up client authentication options, connecting with external databases, enterprise service busses, message agents, and other options. When the root node of the Admin menu tree is selected, the right side panel displays a list of subpanel controls that provide a summary view of several configuration settings. Click on the down arrow icon at the left end of any of the subpanels to view a listing of configuration objects for that section.

The following sections describe the objects in the Admin object tree menu and how to work with the Admin objects.

Users

The Users node is where JaxView user account objects are added. Use the following steps to add or edit user accounts:

To add a new JaxView user:

  1. Click on the Admin tab in the JaxView Main view
  2. In the Admin object tree on the left side of the page, click on the Users node.
  3. Right click the mouse to display the node action menu and click Add User.
  4. Complete the required and optional properties for a new user account as described below.
  5. Click Save to add the user account. The user account is added as a User object to the Admin tree.

User Properties

The following describe the properties for JaxView users:

Name: (required)
Enter the display name for the user account. Normally, this would be the person's name or possible a role name.
Login: (required)
Login name for the user to access JaxView.
Password:(required)
Enter a password for the user. The password must be at least 6 characters.
Confirm Password:(required)
Renter the user password for the user. The password must match the password as entered above.
Email: (optional)
Enter an email address for this user. This is used for sending JaxView event alerts.
Telephone: (optional)
Enter a telephone number for this user
User Role: (required)
Select the JaxView user role for this user account. The role determines the access and control permissions for this user account.

Roles

Roles are associated with User account to define and control what actions users assigned to the Role may perform inside JaxView. Each user account is assigned to a role. Roles can also be associated with Web service definitions in the JaxView Services object tree. This allows system administrator the option to restrict user access to viewing or editing data or configuration settings for specific Web service operations. See the section JaxView Roles for more information on defining roles.

Clients

Clients node is used to create and store a simple access control list within JaxView. JaxView can use the Client list in a number of ways for SOA management and governance. This includes:

SOA Management Function

Client List Usage

Client authentication

When JaxView is deployed as a gateway or proxy server for Web services, JaxView can use the Client List as a simple access control list for authenticating all client requests for services. JaxView can comapre the client inforation in the request messages against the Client List to determine if the client should be allowed to access the services

Client usage monitoring

JaxView can measure/monitor usage of a Web service by a specific client application or user. For monitors that use a client list, JaxView looks at information in every request and if matches one of the JaxView Client profiles, the message traffic will be counted as usage by that client.

Service access control

Similar to the general Client authentication option described above, if JaxView is deployed as a gateway or proxy server, the JaxView Client Access Monitor can be assigned to a specific Web service operation. This allows JaxView to restrict access to the selected operation(s) to clients whose information matches a record in the Client List.



To add a new client profile:

  1. Click on the Admin tab in the JaxView Main view
  2. In the Admin object tree on the left side of the page, click on the Client node.
  3. Right click the mouse to display the node action menu and click Add Client. The Add Client page is displayed in the right side panel.
  4. Complete the required and optional properties for a new client profile as described below.
  5. Click Save to add the client profile. The client profile is added as a sub node to the Client object to the Admin tree.

Client Properties

The following describe the properties for client records in the Client List.

Client Name (required):
Name of the client
Description:
Short description of the client (optional)
Address:
The mailing address for this specific client (optional)
Email Address:
An email address for this client (optional).
Phone Number:
Phone Number for this client (optional)
Client User Name:
Enter the Client UserName or if using WS_SECURITY the value of standard UserNameToken tag. For more information on WS-SECURITY see the Oasis Web site.
Password:
Password for the above username to authenticate the client requests
Confirm Password:
Reenter the Password for the above username
LDAP Provider:
Enter the URL for the LDAP provider to authenticate service requests from this client through an LDAP server.
For Example:ldap://ldap.managedmethods.com:389
LDAP Security Principal:
The LDAP security principal for this client. For example: uid=testid,ou=test,o=ManagedMethods

 

Registries

JaxView can be integrated with a UDDI-compliant registry application in order to retrieve service and policy information and update monitoring and management settings. JaxView can also be configured to publish service and governance policy information to a registry. You can configure JaxView to communicate with one or more registries. You use the Registries page to configure integration with registries. See the section Integrating JaxView with Service Registries for more information on how to configure JaxView to work with external service registries.

WS-Policy

JaxView supports the proposed WS-Policy standard submitted to the World Wide Web consortium. JaxView can read policy information from a URL or policy definition file that is accessible through the file system. Alternately, policy statements can be added in WS-Policy compliant text markup into JaxView, thus making JaxView the repository for policy information.

To add a WS-Policy reference or definition to JaxView:

  1. Click on the Admin tab in the JaxView Main view
  2. In the Admin object tree on the left side of the page, click on the WS-Policy node.
  3. Right click the mouse to display the node action menu and click Add WS-Policy.
  4. Complete the required properties for the policy definition as described below. Policy objects may be one of the following:
  5. Optionally, select the class name of a custom file that should be used to enforce the policies associated with this JaxView policy object.
  6. Enter a regular expression or an XPath expression that will return a successful match on every message to which you want this policy definition to be applied.
  7. Click Save to add the WS-Policy object. JaxView attempts to validate the policy information. If the validation is successful, the WS-Policy object is added to the Admin tree.

To activate enforcement of the policy in JaxView:

  1. You must define one or more WS-Policy objects in the JaxView Admin tab.
  2. The applicable JaxView WS-Policy object must contain a Policy Expression that will return a valid match on the service messages for which the policy is to be applied.
  3. You must edit the policies section of the service to which the policy is to be applied. Use the Services tab to edit the applicable service object node.
  4. In the WS-Policies subsection for the service, both the Enforce WS-Policies checkbox and the checkbox to the right of one or more WS-Policy object names must be checked to enable policy enforcement.

WS-Policy Properties

JaxView Policy objects have the following properties:

Title:
A unique title for this object
Description:
Enter an optional text description this policy object.
Policy Location:
Enter the URL or file pathname of the location of the policy file. For example, for a URL based policy file, enter the URL of the form: http://policy_server_address/policy_url.xml To use a file on the local or network file system, enter the path name to the file. For example,c:\services_files\policies_folder\policy_file.xml
Policy:
Enter the XML representation of the WS-Policy object as defined by WS-Policy standard. Use this option if you do not include a reference to an external Policy Location above. JaxView will parse the expression and attempt to validate it using the information in the expression. This includes validation against any referenced schemas. The following is an example of a WS-Policy expression where binding to schemas is abstracted:

<wsp:Policy xmlns:wsp="..." xmlns:wsse="...">
   <wsp:ExactlyOne>
     <wsp:All wsp:Preference="100">
       <wsse:SecurityToken>
         <wsse:TokenType>wsse:Kerberosv5TGT</wsse:TokenType>
       </wsse:SecurityToken>
       <wsse:Integrity>
         <wsse:Algorithm Type="wsse:AlgSignature"
                  URI="http://www.w3.org/2000/09/xmlenc#aes" />
       </wsse:Integrity>
     </wsp:All>
     <wsp:All wsp:Preference="1">
       <wsse:SecurityToken>
         <wsse:TokenType>wsse:X509v3</wsse:TokenType>
       </wsse:SecurityToken>
       <wsse:Integrity>
         <wsse:Algorithm Type="wsse:AlgEncryption"
                  URI="http://www.w3.org/2001/04/xmlenc#3des-cbc" />
       </wsse:Integrity>
     </wsp:All>
   </wsp:ExactlyOne>
</wsp:Policy>

See the W3.org WS-Policy Web site for more information.

Policy Class
This optional field is used to specify a custom Java class file that will be called to enforce the policies. Use this option for custom or proprietary policy syntax or formats. Any custom policy enforcement class file must be copied to the <install_path>\JaxView\tomcat\webapps\Hubble\WEB-INF\classes\ws_policy directory
Policy Expression
Enter an REGEX: delimited regular expression or an XPATH: delimited XPath expression to be applied to incoming service requests. If an XPath expression is used then the expression must be prefixed with the string "XPATH:" For example: XPATH:Envelope/Body/sayHelloResponse/sayHelloReturn/text()

IMPORTANT: The expression you enter in this field must return a valid match for ALL messages to which you want to apply the WS-Policy specified in this JaxView object. Use the Regular Expression or XPath Expression tools to test the Policy Expression against sample service messages.

STS

JaxView can be configured to communicate with a Secure Token Service (STS) in order to authenticate Web service requests. You use the STS node in the Admin tab to add STS settings that tell JaxView how to make requests of the token service. More that one token service can be conifgured and used by JaxView. Secure Token Service settings that are created and named in the Admin tab then become available in a drop down list for building security policies for Web service objects. See the section Applying Policies to Services in JaxView for more information

To add a Secure Token Service object in JaxView:

  1. Click on the Admin tab in the JaxView Main view
  2. In the Admin object tree on the left side of the page, click on the STS node.
  3. Right click the mouse to display the node action menu and click Add STS.
  4. Complete the required properties to enable JaxView to connect to the Secure Token Service server.
  5. Click Add to add the STS object to JaxView.

STS Properties

The following are the properties on the STS object form:

Title
Enter a unique title for this object. The title will be used to identify the STS configuration object in the Secure Token Service Options section of the Security Policies for Web services objects.
Description
Enter an optional text description for this object.
WSDL Location
Enter the location of the WSDL file that describes the secure token service
STS Request SOAP Action
Enter the SOAP action to be used in for the request to the Secure Token Service. For example: http://schemas.xmlsoap.org/security/RequestSecurityToken
STS Response SOAP Action
Enter the SOAP action to be used in the response to the Secure Token Service in case that the service requires a response. For example: http://schemas.xmlsoap.org/security/RequestSecurityTokenResponse.

Options

The Options object in the Admin object tree is a container for configuring some of the integration settings and options for the JaxView application. The Options node itself contains configuration setting for integrating JaxView with a network analyzer. The Options node also has a child node labeled Mail which you use to integrate JaxView with an email server for use in sending email alerts. See the Mail Options section below for more information.

Clicking on the Options node in the Admin object tree displays the Options sub panel forms in the right side panel.

Note: The settings made in the Options node apply only to the local instance of JaxView. If you have deployed multiple JaxView servers in a cluster or distributed configuration and you want to manage the Network Analyzer and other optional settings from a shared configuration database, you should configure these settings under the shared Server Options section for this JaxView instance under the Master Settings node in the Admin tree.

Network Sniffer Options

These settings are used to configure JaxView as a Network appliance. This option requires that that JaxView have access to a network switch with a SPAN port enabled on it. See the section on configuring JaxView as a Network Appliance for more information.

Other Options

Disable Active Monitors & Scheduled Reports:
Check this box to disable active (scheduled) monitors and scheduled reports being run from this instance of JaxView.
If this instance of JaxView is being used as a load-balanced proxy or gateway, check this to maximize the performance of the JaxView server. You can install a separate JaxView data processing server outside the load balanced cluster to handle active monitors and reporting functions.
Log User Activity:
Check this box to turn on auditing of user activities. After this is turned on, JaxView will log all user activity to JaxView/Logs/User.log file
Auto Discover Clients
Check this box to have JaxView search request messages for new clients. If this option is checked, when JaxView finds a NEW user name in a message request and that user is not already in a JaxView client object, a new client object will be created in the Admin - > Client list tab for the user name.

Mail Options

The Options object in the Admin tree contains the Mail options node. You use this node to configure information on the SMTP server JaxView should use to send Email alerts and reports to users. Right click the Mail object node to display the Edit menu.

To configure JaxView to send email:

  1. Click on the Admin tab in the JaxView Main view
  2. In the Admin object tree on the left side of the page, click to expand the Options node

  3. Under the Options node, click on the Mail node.
  4. Right click the mouse to display the node action menu and click Edit. The Edit Mail Option page is displayed in the right side panel.
  5. Complete the required and optional properties for sending email from JaxView as described below.
  6. Click save to record the settings. JaxView will attempt to connect to the mail server and send a test message. The right side panel refreshes with the results of the test.

Mail Option Properties

The following describes the Mail option properties

SMTP Host
This is the host ip address or domain name. For example mail.managedmethods.com
SMTP Port
This is the SMTP port number for the server. The default port is 25.
SMTP User Name
User name to required to access the mail server
SMTP Password
Password to access the mail server
From Address
The “from” address to be used for all of the email messages generated by JaxView
Admin Address
The administrator address for JaxView to send specific system and application information.

 

Tools

JaxView includes a number of tools that are useful in working with Web services and debugging JaxView configurations. The following lists the tools and a description of their use. See the JaxView Tools section for more information on how to use these tools.

Tool Name

Description

XPath Validator

Use this tool to validate Xpath syntax in order to have JaxView extract custom data from Web service message elements.

Regex Validator

Use this tool to validate regular expression syntax used by JaxView to extract custom data from Web service messages.

LDAP Validator

Use this tool to validate an LDAP authentication query.

JMS Validator

Use this tool to check a JMS connection by sending a sample message to an ESB or a Message Broker.

HTTP Tool

Use this tool to test a service location by sending a sample HTTP request and content to a URL.



Database

The Database node in the Admin object tree provides options for integrating JaxView with external databases. One or more JaxView servers can be configured using data entered into a central database. JaxView can also be configured to store Web service message data in an external database. You use the Database Configuration page to enable these functions. See the Database Installation section for more information on how to configure JaxView to store data in an external database.

The Database node has the following right-click menu actions:

Node

Action Menu Item

Description

Database

Refresh Configuration

Click on this menu to refresh the current JaxView server configuration from database


Refresh All Configurations

Click on this menu item to refresh all JaxView servers that are using this database for configuration. This is useful if there is a need to have the configuration changes take immediate effect as JaxView does refresh its configuration on a schedule.



ESB/Message Broker

JaxView can connect ESB or Message Brokers to get messages being routed to and from Web services that JaxView is managing. This communication mechanism can be used instead of a stubs or JaxView proxy mode to allow JaxView to get copies of messages for management purposes. JaxView includes the following ESB and Message Broker types. See the section on Connecting to a Message Broker or ESB for more information on configuring JaxView to use an ESB or Message Broker.

Type

Description

Weblogic

For use with BEA Weblogic Message Broker

Sonic

For use with Sonic MQ or Sonic ESB

Websphere

For use with IBM WebSphere MQ or Message Broker

Swift

For use with Swift MQ

Iplanet

For use with Netscape Iplanet message broker

Other

For configuring a custom connection to other ESB's or Message Brokers not in this list.



License

The License node in the Admin object tree displays the list of licenses installed on this instance of JaxView server. JaxView licenses are file-based and installed by adding the license files to the directory where JaxView is installed. The License node has no action menu associated with it. License files must be added throughthe file system.

To install or upgrade licenses for JaxView

  1. Determine the number or Web services in your IT infrastructure that you want to monitor using JaxView.
  2. Request a license from Managed Methods, Inc.. You can request a license by emailing sales@managedmethods.com.

  3. A license file will be sent to you by email. Download or save the license file to portable media or directly to the JaxView server
  4. Copy the license file to the <jaxview_install_path>\JaxView\Config directory.
  5. After a a JaxView refresh cycle, the new license information should appear in the License node of the Admin object tree. The license is now active.

License Properties

The following is a description of the properties of the JaxView license as displayed in the License node of the Admin object tree.

Property

Description

Filename

This is used as a reference to the actual license file name. The directory path is not valid to your installation but the filename is the name of the license file. An example file name could be:

Filename=C:\Udev\License\Customer\VLBCorp_20_1_1137982036_90.lic

CPUs

This indicates the number of CPUs on which JaxView is licensed to run. For example:

CPUs=1

Number of Containers

This indicates the number of Service containers that may be added to the JaxView Services tree. For example:

Number of Containers=20

Expire

Indicates the date and time when the license will expire. An example Expire string is:

Expire=Thu Jan 04 02:23:13 MST 2007

Issued

Indicates the date and time when the license file was created or issued. An example Issued string is:

Issued=Fri Oct 06 03:23:13 MDT 2006

Company

This is an reference to the person or company to which the license was issued. For example:

Company=VLBCorp



Agent Stub

The Stub node in the Admin object tree is a container for JaxView agent stub configuration settings. The stub itself is installed on a remote server in the network environment. The agent stub properties provide JaxView with the information needed to connect to and receive messages from the agents. Clicking on the Stub node displays a list of agent stub connection information. Individual stub objects are added as children to the Stub node.

To add a new agent stub configuration:

  1. Install the JaxView agent stub package on the machine where the application server that you want to monitor is running. Configure the application server as applicable to send messages to the agent. The the section Installing JaxView Agent Stubs for information on agent stub installation and supported application platforms.
  2. Click on the Admin tab in the JaxView Main view
  3. In the Admin object tree on the left side of the page, click the Agent Stub node
  4. Right click the mouse to display the node action menu and click Add Agent Stub. The Add New Agent Stub page is displayed in the right side panel
  5. Complete the required for enabling communication from the agent stub to JaxView as described below
  6. Click save to record the settings. JaxView will attempt to connect to the agent stub and report the status of the connection.

Agent Stub Configuration Properties

Stub objects in the Admin object tree have the following configuration properties:

Title:
A unique title for this stub object within JaxView
Description:
This is an optional text description for this stub configuration
Stub URL:
This is the full URL of the stub as installed on the remote machine. In J2EE environments this is the URL to the StubServlet. An example stub URL is http://localhost:8080/axis/servlet/StubServlet.
Agent Stub Configuration
This sub panel displays the current status of communication between JaxView and the agent stub.

Master Settings

The Master Settings node on the Admin tree is a container for one or more lists of configuration settings. By default, only the local JaxView configuration data is included. Additional configuration data nodes will appear when the local JaxView is configured to connect to an external database for shared configuration control. With this optional configration, you can view and modify the master settings of remote JaxView servers from any other JaxView server.

Network Sniffer Options

These settings are used to configure JaxView as a Network appliance when two or more JaxView servers share a common conifguration database. This is an alternate to configuring a single JaxView as a network appliance using the settings under the Options node of the Admin tree.

Use of this option requires that that JaxView have access to a network switch with a SPAN port enabled on it. See the section on configuring JaxView as a Network Appliance for more information.

Other Options

Disable Active Monitors & Scheduled Reports:
Check this box to disable active (scheduled) monitors and scheduled reports being run from this instance of JaxView.
If this instance of JaxView is being used as a load-balanced proxy or gateway, check this to maximize the performance of the JaxView server. You can install a separate JaxView data processing server outside the load balanced cluster to handle active monitors and reporting functions.
Log User Activity:
Check this box to turn on auditing of user activities. After this is turned on, JaxView will log all user activity to JaxView/Logs/User.log file
Auto Discover Clients
Check this box to have JaxView search request messages for new clients. If this option is checked, when JaxView finds a NEW user name in a message request and that user is not already in a JaxView client object, a new client object will be created in the Admin - > Client list tab for the user name.

Master Settings

Master settings are global settings that change the behavior of JaxView in different ways. You can change the settings by editing the values displayed in the text area. The following describe are several settings that are useful:

Setting Name

Description

_logKeepDays

The number days to keep the message log files. The default is 30 days.

_numberOfKeptMsg

The maximum number of messages to be kept for viewing in the Message View Table. The default is 100.

_ numberOfActionsKept

Number of alert records kept in the Alert History table. The default is 20 alert records.

_metaRefreshTag

The refresh rate in seconds for all tables in JaxView user interface. The default is 30 seconds

_hubbleLogName

The name of the log file for JaxView. The default file name is hubble.log

_configRefreshFrequency

The interval for JaxView to reload all its configuration information from disk. The default is every 600 seconds

_restartFrequency

The interval at which JaxView will automatically re-start itself. The default is every 12 hours.

_numberOfViewMsg

The number of messages viewed in the Message View table. The default is 40.

_transactionViewNumber

Number of instances of a transaction to view in the transaction view page. The default is 20.

_reportErrorList

The number of Errors to list in reports. The default is 40.

_reportWarningList

The number of Warnings to list in reports. The default is 40.

_logReaderScheduler

The interval for JaxView to read the J2EE container serverlog for new entries

_userSessionTimeout

The interval after which a JaxView user's session will be timed out if there is no user activity. The default is 600 seconds.

_logUserActivity

A switch to enable logging of JaxView user activity. Set this to true to create the JaxView/Logs/user.log file to audit all user activities within JaxView.

Schedules

The Schedules node in the Admin object tree is a container for schedule definition objects. Schedule definitions are associated with monitor types to determine the schedule during which the monitor instances will be active. By default, all monitors are enabled to run 24 hours a day, 7 days a week. JaxView includes two other default schedule definitions that can be used to limit monitors to run only on weekdays or only during normal business hours.

Schedule definitions are added as child nodes to the Schedules node of the Admin object tree. Expand the Schedules node to view existing schedule definitions. Use the Schedules node right-click menu to add a new schedule. The following figure shows the Add/Edit Schedule form for a schedule definition.




To add a new schedule definition:

  1. Click on the Schedules node in the Admin tree
  2. Right click the mouse to display the action menu and select Add Schedule. The Add New Schedule form is displayed in the right side panel.
  3. Enter a display name for this schedule definition in the Schedule Name field of the Add New Schedule form. This name will be the display name in the Schedule selection list for JaxView monitor configurations.
  4. Complete the rest of the Add New Schedule form to define the desired schedule. Use the Enable/Disable drop down lists to the right of each day of the week to define if the monitors assigned to this schedule will be enabled or disabled for the time interval entered for that day. For example, selecting Disabled for Sunday and entering a Start time of 19:00 and an End time of 21:00 creates a schedule for which monitors will run on Sundays except between 7:00 pm and 9:00 pm in the evening.
  5. Click Save to add the schedule definition.

To change the run schedule for a JaxView monitor:

  1. Use the Services object tree or the Monitors object tree to select the monitor for which you want to change the schedule.

  2. Right click on the monitor node and select Edit from the action menu. The Edit monitor page is displayed.
  3. Click to expand the Monitor Settings sub panel.
  4. Use the drop down list for the Monitor Schedule item to select the named schedule you want to apply to the monitor.
  5. Click the Save button to update the configuration