HelpSystems Web Server User Guide
Copyright Copyright HelpSystems, LLC. Robot is a division of HelpSystems. HelpSystems Web Server, OPAL, OPerator Assistance Language, Robot ALERT, Robot AUTOTUNE, Robot CLIENT, Robot CONSOLE, Robot CORRAL, Robot CPA, Robot LPAR, Robot MONITOR, Robot REPLAY, Robot REPORTS, Robot SAVE, Robot SCHEDULE, Robot SCHEDULE Enterprise, Robot SPACE, Robot TRANSFORM, Robot TRAPPER, Robot UPS, and EASY VIEW are trademarks or registered trademarks of HelpSystems, LLC in the United States and other countries. IBM, AS/400, OS/400, System i, System i5, i5/os, Power Systems, and iseries are trademarks or registered trademarks of International Business Machines Corporation in the United States and/or other countries. Windows is a registered trademark of Microsoft Corporation in the United States and/or other countries. UNIX is a registered trademark of The Open Group. Linux is a registered trademark of Linus Torvalds. Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. All other product and company names are trademarks of their respective holders. For third-party conditions and disclaimers, see the Release Notes in the product directory. ii
CONTENTS Contents Introduction 5 Welcome to the HelpSystems Web Server 5 Notifications 6 Working with Notifications 6 Dashboards 8 Dashboards Overview 8 Dashboard Widgets 10 Robot SCHEDULE Dashboard Widgets 10 Robot NETWORK Dashboard Widgets 12 Creating a Dashboard 15 Adding Widgets to a Dashboard 16 Customizing a Dashboard 17 Deleting a Widget from a Dashboard 18 Deleting a Dashboard 18 Server Settings 19 Server Settings Overview 19 Getting Started 19 IBM i Connections 20 Authentication 21 Assigned Profiles 22 Administration Settings 22 IBM i Connections 23 Authentication 28 Logging 32 User Settings 33 Assigned Profiles 34 Profiles 36 iii iii
Contents Preferences 39 About HelpSystems Web Server 42 Other Pages 43 Active Jobs 43 Job Log 43 Job Attributes 43 History Log (QHST) 44 Message Details 44 Spooled Files 44 Spooled File Properties 44 Spooled File View 44 Other Help 45 Index 46 iv
INTRODUCTION Welcome to the HelpSystems Web Server The HelpSystems Web Server gives you a single web interface where you can go to work with your HelpSystems products, all while using your browser on your desktop, or even on a mobile device, such as a phone or tablet. After you download and install the HelpSystems Web Server on a Windows or Linux system, open the web interface in your favorite browser and point it at your IBM i system where you have the HelpSystems products installed. No updates are needed to the products you currently have running on your IBM i. With the HelpSystems Web Server, you can access the following products (provided they're installed on the IBM i): Robot SCHEDULE: Use this to monitor and manage the jobs that are set up in Robot SCHEDULE. Robot NETWORK: Use this to monitor the performance and statuses of your IBM i partitions, and respond to statuses (Reply, Escalate, Assign, etc.). Click any of the links below to find out more about setting up the HelpSystems Web Server: Dashboards Server Settings Getting Started Admin Settings User Settings 5
NOTIFICATIONS Working with Notifications The HelpSystems Web Server has an automatic notification system to alert you when an event happens that prevents you from getting data from your connected systems. When such events occur, you'll see a Notifications alert in red above the menus. Note: If the menu on the left is hidden, click the arrow in the upper left corner. If you get an alert: 1. Click the Notifications alert to open the Notifications page. 2. Some events may not need attention, or they may require a fix that's outside of the HelpSystems Web Server application. If you no longer want to see the notification, click Ignore. 3. If the event is something that must be dealt with and it can be fixed within the application, click Fix. The page opens where you can fix the issue. 6
Notifications / Working with Notifications E X A M P L E If you received a notification that one of your IBM i systems was disconnected, you should click Fix. Doing so would take you to the IBM i Connections page where you could reconnect the system. 7
DASHBOARDS Dashboards Overview Each of the products that you can work with on the HelpSystems Web Server has a set of dashboards that display data from the systems that the server is connected to. You can create custom dashboards that show you the data you need to see, all on one screen. Notes: You can create more than one dashboard. Any combination of widgets can be used in the same dashboard. You can even use a mix of widgets from different products. Dashboards are specific to the profile you used to log on. However, you can share them with everyone or keep them private, as needed. Users logging on with the guest profile can view only those dashboards marked as Guest. For more on the guest profile, see Authentication. 8
Dashboards / Dashboards Overview See also: Widget descriptions Creating a dashboard Adding widgets Customizing your dashboard Deleting widgets Deleting a dashboard 9
Dashboards / Dashboard Widgets Dashboard Widgets Following are descriptions of each of the available dashboard widgets. For more information about a widget, such as customizing and using them, see the user guide for that product. Note: The default widget names are listed below. What you see on your system may differ because you can change the widget names. Robot SCHEDULE Dashboard Widgets For more information on any of the following widgets, see the Robot SCHEDULE Web Interface User Guide. Event Monitor - Directory Events This widget displays the number of directory events that occurred over a period of time. Directory events include directories that are added, changed, removed, or that meet (or fail to meet) a threshold. Event Monitor - File Events This widget displays the number of file events that occurred over a period of time. File events include files that are added, changed, removed, or that meet (or fail to meet) a threshold. Event Monitor - Member Events This widget displays the number of member events that occurred over a period of time. Member events include members that are added, changed, removed, or that meet (or fail to meet) a threshold. History - Event Monitors This widget lists the event monitors by day for a period of time. It also indicates the type of event that occurred: directory event (added, removed, changed, or threshold), file event (added, removed, changed, or threshold), or member event (added, removed, changed, or threshold). History - Job Monitors This widget lists the job monitor events by day for a period of time. It also indicates the monitor event type: overrun, underrun, or late start. 10
Dashboards / Dashboard Widgets History - Jobs This widget lists the jobs that were completed on the selected system over a period of time. History - Terminated Jobs This widget lists the jobs that were terminated on the selected system over a period of time. Statistics - Completed Jobs This widget displays the number of jobs that were completed by day on the selected system over a period of time. It shows the number of jobs that completed normally, were terminated, or ended in error. Statistics - Job Metrics This widget displays various job metrics by day on the selected system over a period of time. It shows the number of jobs that were started, submitted, or ended. Statistics - Job Monitors This widget displays the number of job monitor events by day on the selected system over a period of time. It shows the number of monitor events that were a late start, overrun, or underrun. Statistics - Normal Jobs This widget displays the number of jobs that completed normally on the selected system over a period of time. Status - Business Window This widget allows you to specify a business window during which jobs (from a query object or a critical jobs list) need to run. It then lists any variances from that business window. It shows the jobs that ran too early, ended too late, or didn't run at all during the window. Status - Critical Jobs This widget displays information about the jobs in the critical job lists that have been set up in the Robot SCHEDULE web interface. It shows the number of jobs in each list. Then, it shows how many of those jobs were terminated yesterday, are forecasted today. completed normally yesterday, and didn't run yesterday. 11
Dashboards / Dashboard Widgets Status - Group Jobs This widget displays information about the members in the group jobs that have been set up in Robot SCHEDULE for the selected system. It shows the number of members in the group. Then, it shows the number of members in the group that are set to be omitted in the next run, are on hold, are set to run next, completed normally yesterday, were terminated yesterday, and are forecasted today. Status - Scheduler This widget displays the status of the job schedule for the selected system. It shows the system's current state, and the last and next wake up time. For jobs, it shows the number of forecasted, running, delayed, waiting, completed, and failed jobs. Robot NETWORK Dashboard Widgets For more information on any of the following widgets, see the Robot NETWORK Web Interface User Guide. ASP History This widget displays the percentage of the total auxiliary storage pool (ASP) that's being used over a period of time. CPU History This widget displays the percentage of the processor that's being used over a period of time. Database Faults History This widget displays the number of database faults that occurred over a period of time. Disk Busy History This widget displays the percentage of time the disk unit is being used during a period of time. This is based on the number of I/O requests, the amount of data transferred, and the performance characteristics of the type of disk unit. Disk Used History This widget displays the percentage of the disk unit that was allocated during a period of time. 12
Dashboards / Dashboard Widgets Disks This widget displays the information from both the Disk Busy and Disk Used dashboard widgets in one place. So, you'll see the percentage of time the disk unit is being used during a period of time (Busy) and how fully allocated the disk was during that time (Used). Faults This widget displays both the number of database faults and the number of non-database faults that occurred over a period of time. Interactive Response Time This widget displays the average interactive response time for the selected systems. Interactive Response Time History This widget displays the average interactive response time for the selected systems over a period of time. Job History This widget displays the number of jobs in the system history for the selected systems over a period of time. Jobs This widget displays a simple count of the number of jobs currently on each of the selected systems. Node Product Summary This widget shows the status counts (Attention, Warning, and Informational) for the Robot products and user applications on a single, selected system. To see this information for several systems at once, see the Robot Product Summary widget. Non-Database Faults History This widget displays the number of non-database faults that occurred over a period of time. These are faults against pages other than those designated as database pages. 13
Dashboards / Dashboard Widgets Performance Summary This widget displays a number of performance metrics. The selected systems are sorted from the one with the highest level of status issues to the lowest. Robot CONSOLE Messages History This widget displays the number of messages generated over a period of time on systems where Robot CONSOLE is installed. Robot CONSOLE Resources History If you have Robot CONSOLE installed on the systems you select, this widget displays the number of resources of different types reporting to Robot CONSOLE over a period of time. Robot NETWORK Statuses History This widget displays the number of statuses collected by Robot NETWORK for the selected systems over a period of time. Robot Product Summary This widget shows the status counts (Attention, Warning, and Informational) for the Robot products on the selected systems, sorted by the highest status. To see this information for a single node, see the Node Product Summary widget. Robot REPORTS Report Sets History For systems that have Robot REPORTS installed, this widget displays the report history over a period of time and whether any reports are ready to be bundled or deleted. Robot SAVE Media History For systems that have Robot SAVE installed, this widget displays information about media volumes reported over a period of time. Robot SCHEDULE Jobs History For systems that have Robot SCHEDULE installed, this widget displays information about jobs over a 14
Dashboards / Creating a Dashboard period of time. Statuses This widget displays the Robot NETWORK statuses for the selected systems. System Information This widget displays current information about the selected system such as the number of active users, the number of addresses used, the number of jobs and batch jobs, the percentage of CPU and database capability used, and so on. By default, the information is refreshed every five minutes. System Summary This widget displays the number of statuses of each severity for the selected systems. Note: You can also see this information on the Robot NETWORK home page. System Usage For the selected systems, this widget displays current information on both the percentage of the processor (CPU) that's being used and the percentage of the total auxiliary storage pool (ASP) that's being used. See also: Dashboards Adding widgets Deleting widgets Creating a Dashboard You can create as many dashboards as you need to. Also, after you add a dashboard, you can change its layout and settings at any time by customizing it. 1. ClickDashboards under the Robot menu. Note:If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Add on the Dashboards page. 3. Type a Name for the dashboard. Each name must be unique among all users. 4. Click the Shared button to indicate whether or not you want to allow any HelpSystems Web Server 15
Dashboards / Adding Widgets to a Dashboard user to see this dashboard. On allows all users to see the dashboard. Off keeps it private to the user you're logged on as. 5. Click the Guest button to indicate whether or not you want to allow users who log on with the Guest profile to see this dashboard. On allows guest users to see the dashboard. Off prevents guest users from seeing it. Note: The only thing guest users can do is view dashboards marked as Guest. For more on the Guest profile, see Authentication. 6. Select the Layout you want to use. 7. Click Save. After you create the dashboard, you need to add widgets to it. See below. Adding Widgets to a Dashboard You can add as many widgets as you need to your dashboard. For many of the widgets, you can even add more than one of each kind. But, be aware that number of widgets on the page does affect the response time. Also, you can only add widgets to dashboards that you've created. Shared dashboards created by another user are view-only. 1. ClickDashboards under the Robot menu. Note:If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click the dashboard you want to work with. 3. Click Add on the page for the dashboard you selected. 4. Click a product (you may see one or more products listed). 5. Select (check) the widgets you want and click Add. Note: If you want to add more than one widget of a particular type, for example, if you want to add two Jobs widgets, repeat steps 3-5 for each one. 6. After you add widgets, you can customize them. Click the Settings button on any widget to edit its settings. See also: Dashboards Widget descriptions Creating a dashboard Customizing your dashboard 16
Dashboards / Customizing a Dashboard Deleting widgets Deleting a dashboard Customizing a Dashboard You can rename a dashboard, share it (or stop sharing), make it a Guest dashboard, and change the layout. However, you can only customize dashboards that you've created. Shared dashboards created by another user are view-only. The easiest way to customize the look of the dashboard is to rearrange the widgets. Simply click and hold the widget title bar and drag it where you want it. However, keep in mind that if you're going to view this on a mobile device, the widgets will display in order by column (first, second, third). 1. ClickDashboards under the Robot menu. Note:If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click the dashboard you want to work with. 3. Click Customize on the page for the dashboard you selected. 4. Type a new Name for the dashboard. 5. Click the Shared button to indicate whether or not you want to allow others to see this dashboard. 6. Click the Guest button to indicate whether or not you want to allow users who log on with the Guest profile to see this dashboard. The only thing Guest users can do is view dashboards marked as Guest. For more on the Guest profile, see Authentication. 7. Select the Layout you want to use. 8. Click Save. See also: Dashboards Widget descriptions Creating a dashboard Adding widgets Deleting widgets Deleting a dashboard 17
Deleting a Widget from a Dashboard Dashboards / Deleting a Widget from a Dashboard You can only delete widgets from dashboards that you've created. Shared dashboards created by another user are view-only. 1. ClickDashboards under the Robot menu. Note:If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click the dashboard you want to work with. 3. Click Settings on the widget you want to delete. 4. Click Delete. 5. Click Delete again to confirm the deletion. Deleting a Dashboard You can delete one or more dashboards at the same time. However, you can only delete dashboards that you've created. Shared dashboards created by another user are view-only. 1. ClickDashboards under the Robot menu. Note:If the menu on the left is hidden, click the arrow in the upper left corner. 2. Select (check) one or more dashboards that you want to delete. 3. Click Delete. 4. Click Delete again to confirm the deletion. 5. Click Save. 18
SERVER SETTINGS Server Settings Overview The Server Settings menu gives you access to the setup, preferences, and administrative portion of the HelpSystems Web Server. Click a link below to learn more about each section. Getting Started This page lists the tasks that must be done in order to use any of the products, and shows you which tasks still need to be completed. Admin Settings This page allows you to configure your IBM i connections, specify how to authenticate users, and set the logging level for the HelpSystems Web Server. User Settings This page allows you to assign IBM i profiles to your HelpSystems Web Server connections and edit preference settings. About This page displays information about the HelpSystems Web Server installation. Getting Started The Getting Started page shows you which tasks still need to be completed before you can use the modules available with the HelpSystems Web Server. It also shows you which of the modules are available, and the version and build being used for each of them. 19
Server Settings / Getting Started If this is the first time you're logging on to the HelpSystems Web Server, the Getting Started page opens automatically. That's because you need to perform some tasks before you can use the available products. However, what you need to do depends on what type of user you log in as: The HelpSystems Web Server administrator needs to define the IBM i connections and user authentication. All users (including the administrator) need to create profiles for themselves and assign those profiles to the connected IBM i systems. If you later need to adjust any of the settings, click Getting Started under Server Settings to return to the page. If the menu on the left is hidden, click the arrow in the upper left corner. Click the following links for instructions on completing the necessary tasks. IBM i Connections Authentication Assigned Profiles IBM i Connections Before any of your users can see data in the products you're using with the HelpSystems Web Server, you must create connections between the web server and the IBM i systems that have the HelpSystems products installed on them. Note: Only the HelpSystems Web Server administrator user can access this link on the Getting Started page. To get to this page click Getting Started under Server Settings, then click IBM i Connections. If the menu on the left is hidden, click the arrow in the upper left corner. On the Getting Started page, you'll see icons by IBM i Connections: A green icon means that all of the connections that were created between HelpSystems Web Server and the IBM i systems are active. A yellow icon means that connections have been created, but at least one of them has been disconnected. A red icon means you need to create the connections. 20
Server Settings / Getting Started If you see a yellow or red icon, click IBM i Connections. Then, see IBM i Connections for details on how to complete this task. Note: Your users will only be able to see data for the IBM i connections you create. See also: Getting Started Authentication Assigned Profiles Authentication Before any of your users can log on to HelpSystems Web Server, you must specify how to authenticate the users. You can choose to authenticate your users against a lightweight directory access protocol (LDAP) server or against one of your IBM i servers. Note: Only the HelpSystems Web Server administrator user can access this link on the Getting Started page. To get to this page click Getting Started under Server Settings, then click Authentication. If the menu on the left is hidden, click the arrow in the upper left corner. On the Getting Started page, you'll see a green icon by Authentication if it's been set up. A red icon means you need to define how HelpSystems Web Server should authenticate users who are attempting to log on. If you see a red icon, click Authentication. Then, see Authentication for details on how to complete this task. Note: Until you set up user authentication, no one except for the HelpSystems Web Server admin user will be able to log on. See also: Getting Started IBM i Connections Assigned Profiles 21
Server Settings / Administration Settings Assigned Profiles All users must set up their profiles so they can access the IBM i systems that HelpSystems Web Server is connected to. Note: You must assign one of your profiles to an IBM i connection before you will see any data from that system. To get to this page click Getting Started under Server Settings, then click Assigned Profiles. If the menu on the left is hidden, click the arrow in the upper left corner. On the Getting Started page, you'll see a green icon connections has a profile assigned to it. A red icon connection. by Assigned Profiles if at least one of the IBM i means you need to assign one of your profiles to a If you see a red icon, click Assigned Profiles. Then, see Assigned Profiles for details on how to complete this task. See also: Getting Started IBM i Connections Authentication Administration Settings The Administration Settings page allows you to configure your IBM i connections, specify how to authenticate users, and set the logging level for HelpSystems Web Server. To open this page, click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. Note: Only the HelpSystems Web Server admin user can access this page. Click the following links for instructions on completing these tasks: Connect to your IBM i systems Authenticate users Configure HelpSystems Web Server logging 22
Server Settings / Administration Settings IBM i Connections Currently, the HelpSystems Web Server has modules available for the following products: Robot SCHEDULE Robot NETWORK However, before you can begin using the above modules, you have to create connections between the HelpSystems Web Server and your IBM i systems that have those products installed on them. You do that from the IBM i Connections page. Note: Only the HelpSystems Web Server administrator can access this page. To get to this page click Admin Setting under Server Settings, then click IBM i Connections. If the menu on the left is hidden, click the arrow in the upper left corner. This page shows which connections have been made between the HelpSystems Web Server and your IBM i systems. For each connected system, you can see which products are installed on it. You can also connect and disconnect the IBM i systems from this page. See also: Adding IBM i connections Connecting and disconnecting from IBM i servers Editing an IBM i connection Deleting IBM i connections Administration settings Sorting and Searching Your IBM i Connections View There are settings for the IBM i Connections page that allow you to choose how to sort the list and decide what data will be searched. 1. Click the Settings button. 2. Select how to sort the list of connections (Sort By). Click your selection again to change the sort order to ascending or descending. 3. Select what you want to use when searching for connections. You can choose to Search All Fields, or to search by Address, Alias, or User Name. 4. Click the Close button to close the settings. 23
Server Settings / Administration Settings Adding a New IBM i Connection In order to use the HelpSystems Web Server modules, you must connect the server to one or more of your IBM i servers that have those products installed on them. Note: This is one of the tasks that must be done before anyone can use the HelpSystems Web Server modules. For a list of the available modules, see Welcome to the HelpSystems Web Server. Follow these steps to define a connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click IBM i Connections on the Administration Settings page. 3. Click Add. 4. Enter the Address (or name) of the IBM i system you want to connect to. 24
Server Settings / Administration Settings 5. Enter an Alias for the IBM i system. This is what displays for the system throughout the HelpSystems Web Server interface. 6. Enter the User Name and Password (and Confirm Password) for a user on the system you entered above. Note: You will not necessarily log on to the HelpSystems Web Server as this user (unless you choose to). This is just the user that allows the connection to be made to the IBM i. Therefore, the user you choose must have QSECOFR or equivalent authority so the HelpSystems Web Server can gather the information it needs. 7. Click Save. See also: IBM i Connections Changing your IBM i connections view Connecting and disconnecting from IBM i servers Editing an IBM i connection Deleting IBM i connections Connecting to and Disconnecting from an IBM i System On the IBM i Connections page, you can see at a glance which servers have active connections to the HelpSystems Web Server (they'll have a green check mark ). You can temporarily disconnect any system (without completely removing the connection) and then reconnect it when needed. After disconnecting or reconnecting servers, you may need to refresh the page to see your changes. To disconnect one or more IBM i systems: 25
Server Settings / Administration Settings 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click IBM i Connections on the Administration Settings page. 3. To disconnect one system: Click the Show Actions button at the end of the row for that system. Then, click Disconnect. To disconnect more than one system: Select (check) the systems. Then, click the Disconnect button. To reconnect one or more IBM i systems: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click IBM i Connections on the Administration Settings page. 3. To connect one system: Click the Show Actions button at the end of the row for that system. Then, click Connect. To connect more than one system: Select (check) the systems. Then, click the Connect button. See also: IBM i Connections Changing your IBM i connections view Adding IBM i connections Editing an IBM i connection Deleting IBM i connections Editing a Defined IBM i Connection Follow these steps to edit the definition for an IBM i connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click IBM i Connections on the Administration Settings page. 3. Click the name of the system you need to edit. The page that opens shows the current definition and a list of the Robot products installed on the system along with their versions, 26
Server Settings / Administration Settings 4. Enter a different Address (or name) of the IBM i system, if necessary. 5. Enter a different Alias for the IBM i system, if necessary. This is what displays for the system throughout the interface. 6. Enter the User Name and Password (and Confirm Password) for a user on the system you entered above. Note: You won't necessarily log on to the HelpSystems Web Server as this user (unless you choose to). This is just the user that allows the connection to be made to the IBM i. Therefore, the user you choose must have QSECOFR or equivalent authority so that the HelpSystems Web Server can gather the information it needs. 7. Click Save. See also: IBM i Connections Changing your IBM i connections view Adding IBM i connections 27
Server Settings / Administration Settings Connecting and disconnecting from IBM i servers Deleting IBM i connections Deleting an IBM i Connection This completely removes the connection between the HelpSystems Web Server and the IBM i system. If you ever need to reconnect, you'll need to add the connection again and all users will need to reassign their profiles. If you want to temporarily disconnect from the IBM i instead of removing the connection entirely, see Connecting to and Disconnecting from an IBM i System. To delete an IBM i connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click IBM i Connections on the Administration Settings page. 3. Select (check) one or more system connections to delete. 4. Click Delete. 5. Click Delete when asked to confirm the deletion. See also: IBM i Connections Changing your IBM i connections view Adding IBM i connections Connecting and disconnecting from IBM i servers Editing an IBM i connection Authentication The Authentication page is only accessible to the HelpSystems Web Server administrator. It allows you to set the session timeout, define the authentication method, and enable guest logins. You can do the following: Set the session timeout limit. You can set the number of minutes a session can remain inactive before timing out. Note: If the timeout limit set here is greater than what a user sets for the auto-refresh intervals for dashboard widgets or in their preferences (for items such Schedule Activity or the Status Center), it will prevent the user's session 28
Server Settings / Administration Settings from timing out if they're on one of those pages. Select the authentication method you want to use and set it up. Before any of your users can log on to the HelpSystems Web Server, you must specify how to authenticate users. You can choose to authenticate your users against an LDAP server or against one of your IBM i servers. Enable a guest login. A guest profile allows you to give people access to the dashboards that are marked as Guest. The Guest profile is for people who normally don't log onto the product and who may not even have an IBM i profile. Guest users can only access the Dashboard area and view only those dashboards designated as Guest. They cannot access any other part of the web interface, see any other dashboards, or make any changes. The default Guest profile credentials are: User Name = guest, Password = guest. However, you can change it, if necessary. All guests use the same guest profile. To complete the above tasks: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Authentication on the Administration Settings page. 3. Enter the Session Timeout in minutes. Note: If the timeout limit set here is greater than what a user sets for the auto-refresh intervals for dashboard widgets or in their preferences (for items such Schedule Activity or the Status Center), it will prevent the user's session from timing out if they're on one of those pages. 4. Click in the authentication method field and select either IBM i or LDAP. If you chose IBM i... To authenticate users against an IBM i server: a. Enter the name or Address of the IBM i server you want to use for authentication. Note: This does not have to be one of the IBM i systems that you're connecting the HelpSystems Web Server to (see IBM i Connections). 29
Server Settings / Administration Settings b. Enter an Alias for the server you entered above. Note: The alias you enter here is displayed on the Log In page as the IBM i that's providing authentication. c. Enter the Port the server uses. If you chose LDAP... To authenticate users against an LDAP server: 30
a. Enter the name or address of the LDAP Host server. Server Settings / Administration Settings b. Enter the LDAP Port used by the LDAP server. c. Click Yes or No to indicate whether or not a secure sockets layer (SSL) is used with your LDAP server. d. Enter the name of your LDAP Administrator. This administrator must be able to read the LDAP tree. Note: Distinguished Name format is acceptable. For more on Distinguished Names, go to the Microsoft Developer Network website. e. Enter the Administrator Password (and Confirm Password) for the administrator you entered above. 31
Server Settings / Administration Settings f. Enter the Default Context for the LDAP server. This is the location to search for users in Distinguished Name format. g. Enter the User ID Field Name for the LDAP server. This is the Attribute Name to search in for the username. h. Click Validate LDAP Connection to test the information you entered above. 5. To enable guest logins and define the guest profile: a. Click On to Allow Guest Login. Click Off to disable it. b. Enter the Guest User Name. The default is 'guest'. c. Enter the Guest Password. Enter it again to confirm it. The default is 'guest'. 6. Click Save. See also: Admin Settings Dashboards Logging You can select the level of logging you want and download the log files. Note: Only the HelpSystems Web Server administrator can access this page. 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Logging on the Administration Settings page. 32
Server Settings / User Settings 3. Select the level of message logging you want used for the HelpSystems Web Server applications. You can choose from three levels. "Info" has the least amount of detail; "Trace" has the most. Note: Selecting "Trace" will have an impact on your server performance. 4. Click Save. To download the logs, click Download while you're on this page. Then, Save or Open the.zip file. See also: Admin settings IBM i connections Authentication User Settings The User Settings page allows you to add your IBM i profiles to the HelpSystems Web Server and assign them to each of the connections that were created between the web server and your IBM i servers. It also contains preferences that you can set for your user, including product-specific preferences. See also: Assigned profiles Profiles Preferences 33
Server Settings / User Settings Assigned Profiles After you add the profiles, you assign them to the IBM i connections that the administrator created. You will not be able to work with any of the products until you assign a profile to that IBM i connection. For each IBM i connection listed on the Assigned Profiles page, you can see which products are installed on it (if any) and which profile is assigned to it (if any). This is specific to the user you are logged on as. The profile you assign to an IBM i connection determines your authorization to the products on that system. Things to know and do: The total number of records is at the top of the page. Click the refresh button to refresh the display. Click the page number and select the page you want to view. Or, click the previous and next arrows. Start typing in the Search field to search for a specific IBM i connection. It will find everything that contains what you're typing. 34
Server Settings / User Settings Sorting and Filtering the Assigned Profiles View There are settings for the Assigned Profiles page that allow you to choose how to sort the list, and what types of data will be searched when you do a search. : 1. Click the settings button. 2. Select how you want the list sorted (Sort By). Click your selection again to change the sort order to ascending or descending. 3. Select what you want to use when searching for IBM i connections. You can choose to Search All Fields, or to search by Address, Alias, or User Name. 4. Click the Close button to close the settings. Assigning Profiles to an IBM i Connection To assign profiles: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Assigned Profiles on the User Settings page. 3. Select (check) one or more IBM i connections to assign a single profile to. 4. Click Change Profile. Note: If you don't have any profiles created, you will go to the New Profile page instead. 5. Select the profile you want to assign to the connections. Or select "No Profile" if you don't want to assign a profile at this time. Note: You must assign a profile to be able to see data for that IBM i. 6. If you need to add a new profile, there are two ways to do it, depending on how you will use the profile: New Profile is intended for users who will use a different profile for each IBM i connection. It automatically creates a profile name for you that is used in the HelpSystems Web Server web interface. To use this method, select New Profile. Then, enter the User Name and Password for it. Add Profile is intended for users who will use the same profile on several IBM i connections. You enter the profile name yourself. This makes it easier to find and re-use the profile. To 35
Server Settings / User Settings Actions and select Add Profile. See Adding a New Profile for detailed instructions. 7. If you wish to edit the profile you selected in step 5, click Actions and select Edit Profile. See Editing a Profile for detailed instructions. 8. Click Save. Profiles In order to see the data from an IBM i system that the HelpSystems Web Server is connected to, you must add a profile for it and assign it to that system. The user in the profile is the user who's checked for security in each product, and is also the one who's audited when actions are taken. The Profiles page lists the profiles that you've added. This is specific to the user you are logged in as. Note: You can also add new profiles as you're assigning profiles to connections. Sharing a profile amongst several IBM i connections saves time because if the profile needs to be changed (name, user name, or password), you can change it in one spot, rather than having to change it for each system individually. Things to know and do: The total number of records is at the top of the page. Click the refresh button to refresh the display. Click the page number and select the page you want to view. Or, click the previous and next arrows. Start typing in the Search field to search for a specific profile. It will find everything that contains what you're typing. 36
Server Settings / User Settings Sorting and Filtering the Profiles View There are settings for the Profiles page that allow you to choose how to sort the list, and what types of data will be searched when you do a search. : 1. Click the settings button. 2. Select how you want the list sorted (Sort By). Click your selection again to change the sort order to ascending or descending. 3. Select what you want to use when searching for profiles. You can choose to Search All Fields, or to search by Nameor User Name. 4. Click the Close button to close the settings. See also: Adding a profile Editing a profile Deleting a profile Assigning a profile to an IBM i connection Adding a New Profile Add profiles for the IBM i systems that you need to access. 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Profiles on the User Settings page. 3. Click Add. 4. Enter a Name for the profile. This is the name that's displayed in the HelpSystems Web Server web interface. 5. Enter a valid profile User Name and Password (and Confirm Password) for the IBM i system that you need to access. Note: This is the user who's checked for security in each product, and is also the one who's audited when actions are taken. 6. Click Save. After you add profiles, you must assign them to the IBM i connections in order to see the data from those systems. See also: Profiles 37
Server Settings / User Settings Editing a profile Deleting a profile Assigning a profile to an IBM i connection Editing a Profile To edit a profile for any of the IBM i systems you need to access: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Profiles on the User Settings page. 3. Click the profile you want to edit. Notice that the IBM i connections that use this profile are listed at the bottom of the page. 4. Enter a different Name for the profile. This is the name that's displayed in the HelpSystems Web Server web interface. 5. Change the User Name or Password, if needed. This must be a valid profile to access that system. Note: This is the user who's checked for security in each product, and is also the one who's audited when actions are taken. 6. Click Save. You must assign your profiles to the IBM i connections in order to see the data from those systems. See also: Profiles Adding a profile Deleting a profile Assigning a profile to an IBM i connection Deleting Profiles To delete one or more profiles: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Profiles on the User Settings page. 3. Select (check) one or more profiles to delete. 4. Click Delete. 5. Click Delete to confirm. If you delete the profile that an IBM i connection uses, you won't be able to see the data from that system until you assign another profile to it. 38
Server Settings / User Settings See also: Profiles Adding a profile Editing a profile Assigning a profile to an IBM i connection Preferences The Preferences page allows you to configure your sessions to function in a way that's best for you. There are general preferences, such as setting the default homepage or dashboard. There are also product-specific preferences. Preference settings only apply to the profile you're currently logged in under. For more information on the product features covered by the preferences (such as the Job Activity Summary and the Status Center), see the user guide help for that product. Follow these steps to change your preferences: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the arrow in the upper left corner. 2. Click Preferences on the User Settings page. 3. General under Homepage: Select the page you want to open when you log on to the HelpSystems Web Server web interface. If you select "Dashboards," click Look Up to select the dashboard you want to see (the dashboards from all the products are available for you to select). If you select "Default," the Server Settings page is displayed. 39
Server Settings / User Settings 4. Robot SCHEDULE under Robot SCHEDULE: Enter the IBM i system you want to work with by default. To select from a list, click Look Up. Note: As you're working, you can easily change to another system by clicking the system name under Robot SCHEDULE in the menu and selecting a different system. If the menu on the left is hidden, click the arrow in the upper left corner. 5. Robot SCHEDULE under Job Activity Summary: a. Enter the Run Duration Deviation percentage you want used. This is the percentage that the job's run time can deviate from the average run time for that job. The Job Activity 40
Server Settings / User Settings Summary will show the number of jobs with run time durations outside of that deviation. E X A M P L E You set the deviation at 25% and have a job with an average run duration of 10 minutes. The job actually runs for 13 minutes. It will show up on the Job Activity Summary because that 13 minute run deviated from the average run by 30%, and that exceeds the limit of 25% that you set. b. Enter the number of minutes to use for the Forecast Deviation. The Job Activity Summary will show the number of jobs that started outside of that deviation of the forecast. E X A M P L E You set the Forecast Deviation at 10 minutes. The Job Activity Summary will show the number of jobs that did not start within 10 minutes of their forecasted start time (10 minutes before or after the forecasted time). 6. Robot SCHEDULE under Schedule Activity: a. Click the Auto-Refresh button to enable it (On) or disable it (Off). b. Enter the Interval (in Minutes) for the auto-refresh. c. Select an option for Show Jobs on All Tables with Job Type. This allows you to see all jobs, or to see only iseries jobs or only agent jobs. d. Select an option for Show Completed/Failed Jobs from to indicate a time frame for which jobs to display. e. For the remaining four options (Show Completed/Failed User Jobs, Show Running/Waiting User Jobs, Show Submitted/Checked-Off Forecast Jobs, and Show Forecasted Jobs Scheduled with the EVERY Option), click the button to enable it (On) or disable it (Off). 7. Robot NETWORK under My Network Preferences: Select either Entire Network or Preferred Systems. This specifies which systems and data you'll see on the My Network page. For more information on Preferred Systems and My Network, see the Robot NETWORK Web Interface User Guide. 8. Robot NETWORK under Status Center Preferences: a. Click the Auto-Refresh button to enable it (Yes) or disable it (No). b. Click the Group Statuses button to enable it (Yes) or disable it (No). If you enable group statuses. identical statuses (text, node, and product) will be grouped together in the Status 41
Server Settings / About HelpSystems Web Server Center for easier handling. c. Enter how often (in seconds) you want Robot NETWORK to check for new statuses. Note: If you've enabled auto-refresh above, this is how often the Status Center page will refresh. If you've disabled auto-refresh, you'll get a message telling you how many new statuses arrived since the last time you refreshed the page. Also, if the Status Center is displayed and you step away from your screen, your session will be prevented from timing out if the time you enter here is less than what the Robot NETWORK web interface administrator sets for the Session Timeout. d. Select the Status Time Zone you want used for the timestamp on the statuses. You can choose either the time zone on the browser you're using to view the statuses, or the time zone of the server where they originated. e. Select the Default Sort you want used for the status list. Click your selection again to change the sort order to ascending or descending. f. Select the Default Filter you want used for the status list. Regardless of what you select here, you can always change it on the Status Center page. 9. Click Save. About HelpSystems Web Server The About HelpSystems Web Server page displays information about the system the web server is installed on, and therefore, can be used when troubleshooting issues. It also shows the HelpSystems contact information. To get to this page, click About under the Server Settings menu. If the menu on the left is hidden, click the arrow in the upper left corner. 42
OTHER PAGES There are pages that are common to many of the products that use the HelpSystems Web Server web interface. Active Jobs The Active Jobs page contains information about all of the jobs currently active on your IBM i server. For more information on active jobs, refer to the user guide for your product. Job Log The Job Log page displays the system messages associated with the job you selected. For more information on job logs, refer to the user guide for your product. Job Attributes The Job Attributes page displays detailed Status Attribute, Definition Attribute, Run Attribute, and Library List information for a job. Use this information for troubleshooting when job problems occur. For more information on job attributes, refer to the user guide for your product. 43
Other Pages / History Log (QHST) History Log (QHST) The History Log page displays the contents of the job log associated with the job message history queue (QHST) for the selected job. For more information on the history log, refer to the user guide for your product. Message Details The Message Details page displays details for the selected job log message. You can access the message details when you're viewing the Job Log page or the History Log (QHST) page. For more information on message details, refer to the user guide for your product. Spooled Files The Spooled Files page displays a list of the spooled files on the current system. For more information on spooled files, refer to the user guide for your product. Spooled File Properties This page displays the properties for the selected spooled file and allows you to change certain properties. For more information on spooled file properties, refer to the user guide for your product. Spooled File View This page displays the text from the selected spooled file. You can view it, or search it for a string of characters. For more information on viewing a spooled file, refer to the user guide for your product. 44
OTHER HELP For help with the product components of the HelpSystems Web Server, see the user guide for that product: Robot SCHEDULE Web Interface User Guide Robot NETWORK Web Interface User Guide 45
INDEX A About HelpSystems Web Server 42 Active jobs 43 Adding Dashboards 15 IBM i connections 24 Profiles 37 Widgets to dashboards 16 Admin settings 22 Alerts 6 Assigned profiles Getting started 22 Sorting and filtering 35 User settings 34 Assigning profiles 35 Authenticating users 28 Authentication 28 Getting started 21 Guest login 29 Session timeout 28 D Dashboards 8 Adding 15 Adding widgets 16 Customizing 17 Deleting 18 Deleting widgets 18 Guest 16 Overview 8 Preference 39 Shared 15 Widget descriptions 10 Debug logging 32 Deleting Dashboards 18 IBM i connections 28 Profiles 38 Widgets from dashboards 18 Details of a message 44 Disconnecting from an IBM i 25 C Connecting to an IBM i 25 Connections 23 Customizing dashboards 17 E Editing IBM i connections 26 Profiles 38 Spooled file properties 44 46
Index F Filtering Assigned profiles 35 Profiles 37 Forecast deviation 41 G Getting started 19 Assigned profiles 22 Authentication 21 IBM i connections 20 Guest dashboards 16 Guest login 29 H HelpSystems Web Server 42 History log (QHST) 44 Homepage preference 39 I IBM i connections 23 Adding 24 Assigning profiles 35 Connecting 25 Deleting 28 Disconnecting 25 Editing 26 Getting started 20 Info logging 32 J Job Activity Summary preferences 40 Job attributes 43 Job Log 43 Jobs Active 43 L LDAP server 30 Log Message details 44 Logging 32 Login, guest 29 Logs History 44 QHST 44 M Message details 44 My Network preferences 41 N Notifications 6 P Preferences 39 Dashboards 39 Homepage 39 47
Index Robot NETWORK 41 Robot SCHEDULE 40 Product versions 19 Profiles 36 Adding 37 Assigning to IBM i connections 35 Deleting 38 Editing 38 Sorting and filtering 37 Properties Spooled file 44 R Robot NETWORK preferences 41 Robot SCHEDULE preferences 40 Run duration deviation 40 S Schedule Activity preferences 41 Searching 23 Server Settings Getting Started 19 Session timeout 28 Shared dashboards 15 Sorting 23 Assigned profiles 35 Profiles 37 Spooled file properties 44 Spooled file view 44 Spooled files list 44 Status Center preferences 41 T Trace logging 32 U User preferences 39 User settings Assigned profiles 34 User Settings 33 Users Authenticating 28 V Versions 19 View spooled file 44 W Welcome 5 Widgets Adding 16 Deleting 18 Descriptions 10 48