User Guide HelpSystems Insite 1.6

Transcription

1 User Guide HelpSystems Insite 1.6

2 Copyright Copyright HelpSystems, LLC. HelpSystems Insite, 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, EASY VIEW, PowerTech, Network Security, AutoMate, and AutoMate BPA Server 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. Doc version: ii

3 CONTENTS Contents Introduction 5 Welcome to HelpSystems Insite 5 Notifications 7 Working with Notifications 7 Dashboards 9 Dashboards Overview 9 Dashboard Widgets 11 AutoMate BPA Server Ops Console Dashboard Widgets 11 PowerTech Network Security Dashboard Widgets 12 Robot SCHEDULE Dashboard Widgets 13 Robot NETWORK Dashboard Widgets 15 Creating a Dashboard 19 Adding Widgets to a Dashboard 19 Customizing a Dashboard 20 Deleting a Widget from a Dashboard 21 Deleting a Dashboard 21 Server Settings 23 Server Settings Overview 23 Getting Started 23 Product Connections 24 Authentication 25 Assigned Profiles 25 Administration Settings 26 Product Connections 26 Authentication 35 Logging 39 User Settings 39 iii iii

4 Contents Assigned Profiles 40 Profiles 42 Preferences 45 About HelpSystems Insite 47 Other Pages 48 Active Jobs 48 Job Log 48 Job Attributes 48 History Log (QHST) 49 Message Details 49 Spooled Files 49 Spooled File Properties 49 Spooled File View 49 Other Help 50 Index 51 iv

5 INTRODUCTION Welcome to HelpSystems Insite HelpSystems Insite 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 Insite on a Windows or Linux system, open the web interface in your favorite browser and point it at your AutoMate BPA server, or your IBM i system where you have the HelpSystems products installed. No updates are needed to the products you currently have running on those systems. With Insite, you can access the following products (provided they're installed on the AutoMate BPA server or the IBM i): AutoMate BPA Server Ops Console: Use this to monitor and control your AutoMate BPA Server resources, including workflows, tasks, processes, and agents. PowerTech Network Security: Use this to monitor and control access to networked systems that are set up in Network Security. Robot NETWORK: Use this to monitor the performance and statuses of your IBM i partitions, and respond to statuses (Reply, Escalate, Assign, etc.). Robot SCHEDULE: Use this to monitor and manage the jobs that are set up in Robot SCHEDULE. Click any of the links below to find out more about setting up Insite: Dashboards Server Settings Getting Started 5

6 Introduction / Welcome to HelpSystems Insite Admin Settings User Settings 6

7 NOTIFICATIONS Working with Notifications HelpSystems Insite 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 Menu button 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 Insite 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 Insite application, click Fix. The page opens where you can fix the issue. 7

8 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 Product Connections page where you could reconnect the system. 8

9 DASHBOARDS Dashboards Overview Each of the products that you can work with on HelpSystems Insite 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. 9

10 Dashboards / Dashboards Overview See also: Widget descriptions Creating a dashboard Adding widgets Customizing your dashboard Deleting widgets Deleting a dashboard 10

11 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. AutoMate BPA Server Ops Console Dashboard Widgets For more information on any of the following widgets, see the AutoMate BPA Server Ops Console User Guide. Activity - Active This widget displays information about currently active instances of workflows, tasks and processes. Activity - Agent Activity This widget displays information about task and process activities that occurred on a specific agent. Activity - Deviation This widget displays information about workflow, task, and process instances that ran slower or faster than the defined standard deviation limit. Activity - History This widget displays information about previous run instances of workflows, tasks and processes. Activity - Upcoming This widget displays information about workflow events that are scheduled to run in the future. Statistics - Completed Statistics This widget displays workflow, task, and process completion statistics presented in the form of an 11

12 Dashboards / Dashboard Widgets interactive line chart. Statistics - Queued Workflows This widget displays information about workflow instances that are currently queued based on defined load management limitations. Statistics - Run Statistics This widget displays workflow, task, and process run statistics presented in the form of an interactive line chart. Status - BPA Server Errors This widget displays any errors that occurred within the specified server or within a particular agent that resides in that server. Status - BPA Server Output This widget displays output messages regarding events that occurred within the specified server or within a particular agent that resides in that server. Status - BPA Statuses This widget displays important automation statistics, including global triggering status as well as total number of active instances, queued workflows, and connected agents. See also: Dashboards Adding widgets Deleting widgets PowerTech Network Security Dashboard Widgets For more information on any of the following widgets, see the PowerTech Network Security for Insite User Guide. 12

13 Dashboards / Dashboard Widgets Hourly Stats This widget shows a graph of recent network activity that has passed through Network Security's active servers within the past twenty-four hours. Transaction Counts This widget shows the number of transactions that have been allowed and rejected on each of Network Security's active servers within a specified time range. See also: Dashboards Adding widgets Deleting widgets Robot SCHEDULE Dashboard Widgets For more information on any of the following widgets, see the Robot SCHEDULE for Insite 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 13

14 Dashboards / Dashboard Widgets 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. 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 14

15 Dashboards / Dashboard Widgets 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. 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. See also: Dashboards Adding widgets Deleting widgets Robot NETWORK Dashboard Widgets For more information on any of the following widgets, see the Robot NETWORK for Insite 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. 15

16 Dashboards / Dashboard Widgets 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. 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. 16

17 Dashboards / Dashboard Widgets 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. 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. 17

18 To see this information for a single node, see the Node Product Summary widget. Dashboards / Dashboard Widgets 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 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 18

19 Dashboards / Creating a Dashboard 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. Click Dashboards under the HelpSystems Insite menu. Note: If the menu on the left is hidden, click the Menu button 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 Insite 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. Click Dashboards under the HelpSystems Insite menu. Note: If the menu on the left is hidden, click the Menu button in the upper left corner. 19

20 Dashboards / Customizing a Dashboard 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. From the Dashboards page, click the Settings button on any widget to edit its settings. See also: Dashboards Widget descriptions Creating a dashboard Customizing your 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. Click Dashboards under the HelpSystems Insite menu. Note: If the menu on the left is hidden, click the Menu button 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 20

21 Dashboards / Deleting a Widget from a Dashboard 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 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. Click Dashboards under the Robot menu. Note: If the menu on the left is hidden, click the Menu button 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. Click Dashboards under the Robot menu. Note: If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Select (check) one or more dashboards that you want to delete. 3. Click Delete. 21

22 Dashboards / Deleting a Dashboard 4. Click Delete again to confirm the deletion. 5. Click Save. 22

23 SERVER SETTINGS Server Settings Overview The Server Settings menu gives you access to the setup, general preferences, and administrative portion of HelpSystems Insite. 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 define connections to your product servers, specify how to authenticate users, and set the logging level for Insite. User Settings This page allows you to assign user profiles to your Insite connections and edit preference settings. About This page displays information about the Insite installation. Getting Started The Getting Started page shows you which tasks still need to be completed before you can use the modules available with HelpSystems Insite. It also shows you which of the modules are available, and the version and build that's installed on the Insite server for each of them. 23

24 Server Settings / Getting Started If this is the first time you're logging on to Insite, 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 Insite administrator needs to create the necessary connections to the IBM i and AutoMate BPA servers. The Insite administrator needs to define how to authenticate users. All users (including the administrator) need to create profiles for themselves and assign those profiles to the connected 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 Menu button in the upper left corner. Click the following links for instructions on completing the necessary tasks. Product Connections Authentication Assigned Profiles Product Connections Before any of your users can see data in the products you're using in HelpSystems Insite, you must create connections between the Insite and the IBM i or BPA servers that have the HelpSystems products installed on them. Note: Only the Insite administrator can access this link on the Getting Started page. To get to this page click Getting Started under Server Settings, then click Product Connections. If the menu on the left is hidden, click the Menu button in the upper left corner. On the Getting Started page, you'll see icons by Product Connections: A green icon means that all of the connections that were created between Insite and the IBM i or BPA servers 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. 24

25 Server Settings / Getting Started If you see a yellow or red icon, click Product Connections. Then, see Connect to your systems under Administration Settings for details on how to complete this task. Note: Your users will only be able to see data for the connections you create. See also: Getting Started Authentication Assigned Profiles Authentication Before any of your users can log on to HelpSystems Insite, you must specify how to authenticate the users. You can choose to authenticate your users against a lightweight directory access protocol (LDAP) server, one of your IBM i servers, or one of your AutoMate BPA servers. Note: Only the Insite administrator 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 Menu button 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 Insite should authenticate users who're attempting to log on. If you see a red icon, click Authentication. Then, see Authenticate users under Administration Settings for details on how to complete this task. Note: Until you set up user authentication, no one except for the Insite admin user will be able to log on. See also: Getting Started Product Connections Assigned Profiles Assigned Profiles All users must set up their profiles so they can access the systems that HelpSystems Insite is connected to. Note: You must assign one of your profiles to a defined product connection before you will see any 25

26 Server Settings / Administration Settings 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 Menu button in the upper left corner. On the Getting Started page, you'll see a green icon product connections has a profile assigned to it. A red icon profiles to a connection. by Assigned Profiles if at least one of the defined means you need to assign one of your 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 Product Connections Authentication Administration Settings The Administration Settings page allows you to configure your system connections, specify how to authenticate users, and set the logging level for HelpSystems Insite. To open this page, click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. Note: Only the Insite admin user can access this page. Click the following links for instructions on completing these tasks: Connect to your systems Authenticate users Configure Insite logging Product Connections Currently, HelpSystems Insite has modules available for the following products: 26

27 Server Settings / Administration Settings AutoMate BPA Server Ops Console PowerTech Network Security Robot NETWORK Robot SCHEDULE However, before you can begin using the above modules, you have to create connections between Insite and your IBM i and BPA servers that have those products installed on them. You do that from the Product Connections page. Note: Only the Insite administrator can access this page. To get to this page click Admin Setting under Server Settings, then click Product Connections. If the menu on the left is hidden, click the Menu button in the upper left corner. This page shows which connections have been made between Insite and your IBM i and BPA servers. For each connected system, you can see which products are installed on it. You can also connect and disconnect the IBM i and BPA servers via this page. See also: Adding connections Connecting and disconnecting servers Editing a connection Deleting connections Administration settings Sorting and Searching Your Product Connections View There are settings for the Product 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. 27

28 Server Settings / Administration Settings Adding a New Product Connection In order to use the HelpSystems Insite modules, you must connect Insite to one or more of your IBM i systems that have those products installed on them, or to one of more of your AutoMate BPA servers. Note: This is one of the tasks that must be done before anyone can use the Insite modules. For a list of the available modules, see Welcome to HelpSystems Insite. Follow these steps to define a connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Product Connections on the Administration Settings page. 3. Click Add. 4. Select a Connection Type. You can choose an IBM i or AutoMate BPA Server connection. 5. If you chose an IBM i connection: 28

29 Server Settings / Administration Settings a. Enter the IP Address (or network name) of the IBM i system you want to connect to. b. Enter an Alias for the IBM i system. This is what displays throughout Insite. c. 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 Insite 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 Insite can gather the information it needs. 6. If you chose an AutoMate BPA Server connection: a. Enter the IP Address (or network name) of the AutoMate BPA server you want to connect to. 29

30 Server Settings / Administration Settings b. Enter the Port number for the server. c. Enter an Alias for the BPA system. This is what displays throughout Insite. d. Enter a User Name for Guest Access and Password for Guest Access (and Confirm Password) for a user who would log on as a guest on the system you entered above. Note: You will not necessarily log on to the Insite as this user (unless you choose to). This is just the user that allows the connection to be made to the AutoMate BPA server. 7. Click Save. See also: Product connections Changing the view Connecting and disconnecting servers Editing a connection Deleting connections 30

31 Server Settings / Administration Settings Connecting to and Disconnecting from a Server On the Product Connections page, you can see at a glance which servers have active connections to HelpSystems Insite (they'll have a green check mark ). You can temporarily disconnect any system (without completely removing the connection) and then reconnect it again when needed. After disconnecting or reconnecting servers, you may need to refresh the page to see your changes. To disconnect one or more servers: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Product Connections on the Administration Settings page. 3. To disconnect one server: Click the Show Actions button at the end of the row for that server. Then, click Disconnect. To disconnect more than one server: Select (check) the servers. Then, click the Disconnect button. To reconnect one or more servers: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Product Connections on the Administration Settings page. 3. To connect one server: Click the Show Actions button at the end of the row for that server. Then, click Connect. To connect more than one server: Select (check) the servers. Then, click the Connect button. See also: Product connections Changing the view Adding connections Editing a connection Deleting connections 31

32 Server Settings / Administration Settings Editing an Existing Product Connection Follow these steps to edit the definition for an IBM i or AutoMate BPA server connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Product 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 HelpSystems products installed on that system along with their versions. 4. If you chose an IBM i connection: 32

33 Server Settings / Administration Settings a. Enter the IP Address (or network name) of a different IBM i system, if necessary. b. Enter a different Alias for the IBM i system. This is what displays throughout Insite. c. 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 HelpSystems Insite 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 Insite can gather the information it needs. 5. If you chose an AutoMate BPA Server connection: a. Enter the IP Address (or network name) of a different AutoMate BPA server, if necessary. b. Enter a different Port number for the server. c. Enter a different Alias for the BPA system. This is what displays throughout Insite. 33

34 Server Settings / Administration Settings d. Enter a User Name for Guest Access and Password for Guest Access (and Confirm Password) for a user who would log on as a guest on the system you entered above. Note: You will not necessarily log on to the Insite as this user (unless you choose to). This is just the user that allows the connection to be made to the AutoMate BPA server. 6. Click Save. See also: Product connections Changing the view Adding connections Connecting and disconnecting servers Deleting connections Deleting a Product Connection This severs the connection between HelpSystems Insite and the IBM i or AutoMate BPA server. 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 or BPA server instead of removing the connection entirely, see Connecting to and Disconnecting from a Server. To delete a connection: 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Product Connections on the Administration Settings page. 3. Select (check) one or more server connections to delete. 4. Click Delete. 5. Click Delete when asked to confirm the deletion. See also: Product connections Changing the view Adding connections Connecting and disconnecting servers Editing a connection 34

35 Server Settings / Administration Settings Authentication The Authentication page is only accessible to the HelpSystems Insite 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 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 Insite, you must specify how to authenticate users. You can choose to authenticate your users against an LDAP server, one of your IBM i servers, or one of your AutoMate BPA 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 or BPA server profile. Guest users can only access the Dashboard area and view only those dashboards designated as Guest. They cannot access any other part of Insite, 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 Menu button 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 BPA Server Activity, 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 LDAP, IBM i, or AutoMate BPA Server. 35

36 Server Settings / Administration Settings If you chose LDAP... To authenticate users against an LDAP server: a. Enter the name or address of the LDAP Host server. 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 36

37 Names, go to the Microsoft Developer Network website. Server Settings / Administration Settings e. Enter the Administrator Password (and Confirm Password) for the administrator you entered above. 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. 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 Insite to (see Product Connections). 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 server that's providing authentication. c. Enter the Port the server uses. If you chose AutoMate BPA Server To authenticate users against an AutoMate BPA server: a. Enter the name or Address of the AutoMate BPA server you want to use for authentication. Note: This does not have to be one of the AutoMate BPA systems that you're connecting 37

38 Server Settings / Administration Settings Insite to (see Product Connections). 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 server that's providing authentication. c. Enter the Port the server uses. 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 38

39 Server Settings / User Settings Dashboards Logging You can select the level of logging you want and download the log files. Note: Only the HelpSystems Insite administrator can access this page. 1. Click Admin Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Logging on the Administration Settings page. 3. Select the level of message logging you want used for the Insite 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 Product connections Authentication User Settings The User Settings page allows you to add your IBM i and AutoMate BPA server profiles to HelpSystems Insite and assign them to each of the connections that were created between Insite and your IBM i and 39

40 Server Settings / User Settings BPA servers. It also contains preferences that you can set for your user, including product-specific preferences. See also: Assigned profiles Profiles Preferences Assigned Profiles After you add the profiles, you assign them to the product connections that the administrator created. You will not be able to work with any of the products until you assign a profile to that connection. For each product 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 a product 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 product connection. It will find everything that contains what you're typing. 40

41 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 product connections. You can choose to Search All Fields, or to search by Address, Alias, or User Profile Alias. 4. Click the Close button to close the settings. Assigning Profiles to a Product Connection To assign profiles: 41

42 Server Settings / User Settings 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Assigned Profiles on the User Settings page. 3. Select (check) one or more product 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 product server. 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 product connection. It automatically creates a profile name for you that's used within HelpSystems Insite. To use this method, select New Profile from the Select a Profile list. Then, enter the User Name and Password for it. Add Profile is intended for users who will use the same profile for several product connections. You enter the profile name yourself. This makes it easier to find and re-use the profile. To use this method, click 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 or AutoMate BPA server that HelpSystems Insite 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 product 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: 42

43 Server Settings / User Settings 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. 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 43

44 Server Settings / User Settings Assigning a profile to a connection Adding a New Profile Add profiles for the IBM i and AutoMate BPA systems that you need to access. 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the Menu button 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 Insite interface. 5. Enter a valid profile User Name and Password (and Confirm Password) for the IBM i system or BPA server 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 server connections in order to see the data from those systems. See also: Profiles Editing a profile Deleting a profile Assigning a profile to a server connection Editing a Profile To edit a profile for any of the systems you need to access: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Profiles on the User Settings page. 3. Click the profile you want to edit. Notice that the product 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 HelpSystems Insite. 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 connections in order to see the data from those systems. 44

45 Server Settings / User Settings See also: Profiles Adding a profile Deleting a profile Assigning a profile to a 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 Menu button 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 a product connection uses, you won't be able to see the data from that system until you assign another profile to it. See also: Profiles Adding a profile Editing a profile Assigning a profile to a connection Preferences The Preferences page allows you to configure your sessions to function in a way that's best for you. These are general preferences, such as setting the default homepage or dashboard. Preference settings only apply to the profile you're currently logged in under. Note: Each of the modules in HelpSystems Insite also have preferences specific to that product. For more information about those, see the user guide for that product. Follow these steps to change your general preferences: 1. Click User Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 2. Click Preferences on the User Settings page. 45

46 Server Settings / User Settings 3. Under Homepage: Select the page you want to open when you log on to HelpSystems Insite. 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. 4. Under Products: You can control which products show up in the menu along the left. (Note: If the menu on the left is hidden, click the Menu button in the upper left corner.) Clear the check mark by any product you do not want to see in the left-hand menu. Only the checked products are displayed. 46

47 Server Settings / About HelpSystems Insite 5. Click Save. About HelpSystems Insite The About HelpSystems Insite page displays information about the system that Insite 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 Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner. 47