helpsystems insite user guidecloud.networkautomation.com/installs/insite/help... ·...

User Guide

HelpSystems Insite 1.6

HelpSystems Insite User Guideii

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, NetworkSecurity, AutoMate, and AutoMate BPA Server are trademarks or registered trademarks of HelpSystems, LLC in the United States andother countries.

IBM, AS/400, OS/400, System i, System i5, i5/OS, Power Systems, and iSeries are trademarks or registered trademarks ofInternational 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 Statesand/or other countries.

All other product and company names are trademarks of their respective holders. For third-party conditions and disclaimers, see theRelease Notes in the product directory.

Doc version: 201606290206

CONTENTS

Contents iii

Introduction 5Welcome to HelpSystems Insite 5

Notifications 7Working with Notifications 7

Dashboards 9DashboardsOverview 9DashboardWidgets 11AutoMate BPA Server OpsConsole DashboardWidgets 11PowerTech Network Security DashboardWidgets 12Robot SCHEDULE DashboardWidgets 13Robot NETWORK DashboardWidgets 15

Creating a Dashboard 19AddingWidgets to a Dashboard 19Customizing a Dashboard 20Deleting aWidget from aDashboard 21Deleting a Dashboard 21

Server Settings 23Server SettingsOverview 23Getting Started 23Product Connections 24Authentication 25Assigned Profiles 25

Administration Settings 26Product Connections 26Authentication 35Logging 39

User Settings 39

HelpSystems Insite User Guideiii

Assigned Profiles 40Profiles 42Preferences 45

About HelpSystems Insite 47

Other Pages 48Active Jobs 48Job Log 48Job Attributes 48History Log (QHST) 49Message Details 49Spooled Files 49Spooled File Properties 49Spooled File View 49

Other Help 50

Index 51

HelpSystems Insite User Guideiv

Contents

HelpSystems Insite User Guide5

INTRODUCTION

Welcome to HelpSystems Insite

HelpSystems Insite gives you a single web interface where you can go to work with your HelpSystemsproducts, all while using your browser on your desktop, or even on amobile device, such as a phone ortablet.

After you download and install Insite on aWindows® or Linux® system, open the web interface in yourfavorite browser and point it at your AutoMate BPA server, or your IBM i system where you have theHelpSystems products installed. No updates are needed to the products you currently have running onthose systems.

With Insite, you can access the following products (provided they're installed on the AutoMate BPAserver or the IBM i):

l AutoMate BPA Server Ops Console:Use this to monitor and control your AutoMate BPA Serverresources, including workflows, tasks, processes, and agents.

l PowerTech Network Security:Use this to monitor and control access to networked systems thatare set up in Network Security.

l Robot NETWORK:Use this to monitor the performance and statuses of your IBM i partitions, andrespond to statuses (Reply, Escalate, Assign, etc.).

l Robot SCHEDULE:Use this to monitor and manage the jobs that are set up in RobotSCHEDULE.

Click any of the links below to find out more about setting up Insite:

DashboardsServer SettingsGetting Started

Introduction / Welcome to HelpSystems Insite


Admin SettingsUser Settings


NOTIFICATIONS

Working with Notifications

HelpSystems Insite has an automatic notification system to alert you when an event happens thatprevents you from getting data from your connected systems. When such events occur, you'll see aNotifications 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 theymay require a fix that's outside of the Insiteapplication. 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.

Notifications / Working with Notifications


E X A M P L E

If you received a notification that one of your IBM i systemswas disconnected, you shouldclick Fix. Doing so would take you to the Product Connections page where you could reconnectthe system.


DASHBOARDS

Dashboards Overview

Each of the products that you can work with on HelpSystems Insite has a set of dashboards that displaydata from the systems that the server is connected to. You can create custom dashboards that show youthe data you need to see, all on one screen.

Notes:

l You can create more than one dashboard.

l Any combination of widgets can be used in the same dashboard. You can even use a mix ofwidgets from different products.

l Dashboards are specific to the profile you used to log on. However, you can share themwitheveryone or keep them private, as needed.

l Users logging on with the guest profile can view only those dashboardsmarked asGuest. Formore on the guest profile, see Authentication.

Dashboards / Dashboards Overview


See also:Widget descriptionsCreating a dashboardAdding widgetsCustomizing your dashboardDeleting widgetsDeleting a dashboard

Dashboards / Dashboard Widgets


Dashboard Widgets

Following are descriptions of each of the available dashboard widgets. For more information about awidget, such as customizing and using them, see the user guide for that product.Note: The defaultwidget names are listed below. What you see on your systemmay differ because you can change thewidget names.

AutoMate BPA Server Ops Console Dashboard Widgets

For more information on any of the following widgets, see the AutoMate BPA Server OpsConsole UserGuide.

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 fasterthan 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



interactive line chart.

Statistics - Queued Workflows

This widget displays information about workflow instances that are currently queued based on definedload management limitations.

Statistics - Run Statistics

This widget displays workflow, task, and process run statistics presented in the form of an interactive linechart.

Status - BPA Server Errors

This widget displays any errors that occurred within the specified server or within a particular agent thatresides in that server.

Status - BPA Server Output

This widget displays output messages regarding events that occurred within the specified server or withina particular agent that resides in that server.

Status - BPA Statuses

This widget displays important automation statistics, including global triggering status as well as totalnumber of active instances, queued workflows, and connected agents.

See also:DashboardsAdding widgetsDeleting widgets

PowerTech Network Security Dashboard Widgets

For more information on any of the following widgets, see the PowerTech Network Security for InsiteUser Guide.



Hourly Stats

This widget shows a graph of recent network activity that has passed through Network Security's activeservers within the past twenty-four hours.

Transaction Counts

This widget shows the number of transactions that have been allowed and rejected on each of NetworkSecurity's active servers within a specified time range.


Robot SCHEDULE Dashboard Widgets

For more information on any of the following widgets, see theRobot 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 eventsinclude 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 filesthat 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 eventsinclude 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 eventtype: 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 periodof 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 thenumber 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 oftime. 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 oftime.

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 tooearly, 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 RobotSCHEDULE web interface. It shows the number of jobs in each list. Then, it shows howmany of thosejobs were terminated yesterday, are forecasted today. completed normally yesterday, and didn't runyesterday.

Status - Group Jobs

This widget displays information about the members in the group jobs that have been set up in RobotSCHEDULE for the selected system. It shows the number of members in the group. Then, it shows thenumber of members in the group that are set to be omitted in the next run, are on hold, are set to runnext, 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 currentstate, 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 theRobot NETWORK for Insite User Guide.

ASP History

This widget displays the percentage of the total auxiliary storage pool (ASP) that's being used over aperiod 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 isbased on the number of I/O requests, the amount of data transferred, and the performancecharacteristics 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 oneplace. So, you'll see the percentage of time the disk unit is being used during a period of time (Busy) andhow 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 thatoccurred 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 oftime.

Job History

This widget displays the number of jobs in the system history for the selected systems over a period oftime.



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 anduser applications on a single, selected system.

To see this information for several systems at once, see theRobot Product Summarywidget.

Non-Database Faults History

This widget displays the number of non-database faults that occurred over a period of time. These arefaults 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 onewith 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 systemswhere RobotCONSOLE is installed.

Robot CONSOLE Resources History

If you have Robot CONSOLE installed on the systems you select, this widget displays the number ofresources 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 systemsover a period of time.

Robot Product Summary

This widget shows the status counts (Attention, Warning, and Informational) for the Robot products onthe selected systems, sorted by the highest status.



To see this information for a single node, see theNode Product Summarywidget.

Robot REPORTS Report Sets History

For systems that have Robot REPORTS installed, this widget displays the report history over a period oftime 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 volumesreported over a period of time.

Robot SCHEDULE Jobs History

For systems that have Robot SCHEDULE installed, this widget displays information about jobs over aperiod 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 CPUand databasecapability 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 canalso 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 theprocessor (CPU) that's being used and the percentage of the total auxiliary storage pool (ASP) that'sbeing used.

See also:Dashboards

Dashboards / Creating a Dashboard


Adding widgetsDeleting widgets

Creating a Dashboard

You can create asmany dashboards as you need to. Also, after you add a dashboard, you can changeits layout and settings at any time by customizing it.

1. ClickDashboards under the HelpSystems Insite menu.Note: If the menu on the left is hidden,click the Menu button in the upper left corner.

2. ClickAdd on the Dashboards page.

3. Type aName for the dashboard. Each namemust be unique among all users.

4. Click the Shared button to indicate whether or not you want to allow any HelpSystems Insite userto see this dashboard.On allows all users to see the dashboard.Off keeps it private to the useryou're logged on as.

5. Click theGuest button to indicate whether or not you want to allow users who log on with the Guestprofile to see this dashboard.On allows guest users to see the dashboard.Off prevents guestusers from seeing it.

Note: The only thing guest users can do is view dashboardsmarked asGuest. For more on theGuest profile, see Authentication.

6. Select the Layout you want to use.

7. ClickSave.

After you create the dashboard, you need to add widgets to it. See below.

Adding Widgets to a Dashboard

You can add asmany widgets as you need to your dashboard. For many of the widgets, you can evenaddmore than one of each kind. But, be aware that number of widgets on the page does affect theresponse time. Also, you can only add widgets to dashboards that you've created. Shared dashboardscreated by another user are view-only.


Dashboards / Customizing a Dashboard


2. Click the dashboard you want to work with.

3. ClickAdd 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 clickAdd.

Note: If you want to add more than one widget of a particular type, for example, if you want to addtwo Jobs widgets, repeat steps 3-5 for each one.

6. After you add widgets, you can customize them. From the Dashboards page, click the Settingsbutton on any widget to edit its settings.

See also:DashboardsWidget descriptionsCreating a dashboardCustomizing your dashboardDeleting widgetsDeleting a dashboard

Customizing a Dashboard

You can rename a dashboard, share it (or stop sharing), make it a Guest dashboard, and change thelayout. However, you can only customize dashboards that you've created. Shared dashboards createdby another user are view-only.

The easiest way to customize the look of the dashboard is to rearrange the widgets. Simply click and holdthe widget title bar and drag it where you want it. However, keep in mind that if you're going to view this ona mobile device, the widgets will display in order by column (first, second, third).



3. ClickCustomize on the page for the dashboard you selected.

4. Type a newName for the dashboard.

5. Click the Shared button to indicate whether or not you want to allow others to see this dashboard.

6. Click theGuest button to indicate whether or not you want to allow users who log on with the Guest

Dashboards / Deleting a Widget from a Dashboard


profile to see this dashboard. The only thing Guest users can do is view dashboardsmarked asGuest. For more on the Guest profile, see Authentication.

7. Select the Layout you want to use.

8. ClickSave.

See also:DashboardsWidget descriptionsCreating a dashboardAdding widgetsDeleting widgetsDeleting a dashboard

Deleting a Widget from a Dashboard

You can only delete widgets from dashboards that you've created. Shared dashboards created byanother user are view-only.

1. ClickDashboards under the Robot menu.Note: If the menu on the left is hidden, click the Menubutton in the upper left corner.


3. Click Settings on the widget you want to delete.

4. ClickDelete.

5. ClickDelete again to confirm the deletion.

Deleting a Dashboard

You can delete one or more dashboards at the same time. However, you can only delete dashboardsthat 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 Menubutton in the upper left corner.

2. Select (check) one or more dashboards that you want to delete.

3. ClickDelete.

Dashboards / Deleting a Dashboard


4. ClickDelete again to confirm the deletion.

5. ClickSave.


SERVER SETTINGS

Server Settings Overview

The Server Settingsmenu gives you access to the setup, general preferences, and administrativeportion of HelpSystems Insite. Click a link below to learn more about each section.

Getting StartedThis page lists the tasks that must be done in order to use any of the products, and shows you whichtasks still need to be completed.

Admin SettingsThis page allows you to define connections to your product servers, specify how to authenticate users,and set the logging level for Insite.

User SettingsThis page allows you to assign user profiles to your Insite connections and edit preference settings.

AboutThis 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 themodules available with HelpSystems Insite. It also shows you which of the modules are available, and theversion and build that's installed on the Insite server for each of them.

Server Settings / Getting Started


If this is the first time you're logging on to Insite, the Getting Started page opens automatically. That'sbecause you need to perform some tasks before you can use the available products. However, what youneed to do depends on what type of user you log in as:

l The Insite administrator needs to create the necessary connections to the IBM i and AutoMateBPA servers.

l The Insite administrator needs to define how to authenticate users.

l All users (including the administrator) need to create profiles for themselves and assign thoseprofiles to the connected systems.

If you later need to adjust any of the settings, clickGetting Started under Server Settings to return to thepage. 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 ConnectionsAuthenticationAssigned Profiles

Product Connections

Before any of your users can see data in the products you're using in HelpSystems Insite, you mustcreate connections between the Insite and the IBM i or BPA servers that have the HelpSystems productsinstalled on them.Note: Only the Insite administrator can access this link on the Getting Started page.

To get to this page clickGetting Started under Server Settings, then clickProduct Connections. If themenu 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:

l A green icon means that all of the connections that were created between Insite and the IBM i

or BPA servers are active.

l A yellow icon means that connections have been created, but at least one of them has been

disconnected.

l A red icon means you need to create the connections.

Server Settings / Getting Started


If you see a yellow or red icon, clickProduct Connections. Then, seeConnect to your systems underAdministration 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 StartedAuthenticationAssigned Profiles

Authentication

Before any of your users can log on to HelpSystems Insite, you must specify how to authenticate theusers. 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 Insiteadministrator can access this link on the Getting Started page.

To get to this page clickGetting Started under Server Settings, then clickAuthentication. If the menu onthe 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, clickAuthentication. Then, see Authenticate users under Administration Settingsfor 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 StartedProduct ConnectionsAssigned Profiles

Assigned Profiles

All users must set up their profiles so they can access the systems that HelpSystems Insite is connectedto.Note: You must assign one of your profiles to a defined product connection before you will see any

Server Settings / Administration Settings


data from that system.

To get to this page clickGetting Started under Server Settings, then clickAssigned Profiles. If the menuon 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 Assigned Profiles if at least one of the defined

product connections has a profile assigned to it. A red icon means you need to assign one of your

profiles to a connection.

If you see a red icon, clickAssigned Profiles. Then, see Assigned Profiles for details on how to completethis task.

See also:Getting StartedProduct ConnectionsAuthentication

Administration Settings

The Administration Settings page allows you to configure your system connections, specify how toauthenticate users, and set the logging level for HelpSystems Insite. To open this page, clickAdminSettings 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 systemsAuthenticate usersConfigure Insite logging

Product Connections

Currently, HelpSystems Insite hasmodules available for the following products:



l AutoMate BPA Server Ops Console

l PowerTech Network Security

l Robot NETWORK

l Robot SCHEDULE

However, before you can begin using the above modules, you have to create connections between Insiteand your IBM i and BPA servers that have those products installed on them. You do that from theProduct Connections page.Note: Only the Insite administrator can access this page.

To get to this page clickAdmin Setting under Server Settings, then clickProduct Connections. If themenu on the left is hidden, click the Menu button in the upper left corner.

This page shows which connections have beenmade 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 anddisconnect the IBM i and BPA servers via this page.

See also:Adding connectionsConnecting and disconnecting serversEditing a connectionDeleting connectionsAdministration 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 anddecide 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 sortorder to ascending or descending .

3. Select what you want to use when searching for connections. You can choose to Search AllFields, or to search byAddress, Alias, or User Name.

4. Click the Close button to close the 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 isystems 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 ofthe available modules, seeWelcome to HelpSystems Insite.

Follow these steps to define a connection:

1. ClickAdmin Settings under Server Settings. If the menu on the left is hidden, click the Menubutton in the upper left corner.

2. ClickProduct Connections on the Administration Settings page.

3. ClickAdd.

4. Select aConnection Type. You can choose an IBM i or AutoMate BPA Server connection.

5. If you chose an IBM i connection:



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 theUser Name and Password (andConfirm Password) for a user on the systemyou entered above.Note: You will not necessarily log on to the Insite as this user (unlessyou 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 QSECOFRor equivalent authority so thatInsite 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 connectto.



b. Enter the Port number for the server.

c. Enter an Alias for the BPA system. This is what displays throughout Insite.

d. Enter aUser Name for Guest Access and Password for Guest Access (andConfirmPassword) 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 isjust the user that allows the connection to be made to the AutoMate BPA server.

7. ClickSave.

See also:Product connectionsChanging the viewConnecting and disconnecting serversEditing a connectionDeleting connections



Connecting to and Disconnecting from a Server

On the Product Connections page, you can see at a glance which servers have active connections toHelpSystems Insite (they'll have a green checkmark ). You can temporarily disconnect any system

(without completely removing the connection) and then reconnect it again when needed. Afterdisconnecting or reconnecting servers, you may need to refresh the page to see your changes.

To disconnect one or more servers:



3. To disconnect one server:

Click the ShowActions button at the end of the row for that server. Then, clickDisconnect.

To disconnect more than one server:

Select (check) the servers. Then, click theDisconnect button.

To reconnect one or more servers:



3. To connect one server:

Click the ShowActions button at the end of the row for that server. Then, clickConnect.

To connect more than one server:

Select (check) the servers. Then, click theConnect button.

See also:Product connectionsChanging the viewAdding connectionsEditing a connectionDeleting connections



Editing an Existing Product Connection

Follow these steps to edit the definition for an IBM i or AutoMate BPA server connection:



3. Click the name of the system you need to edit. The page that opens shows the current definitionand a list of the HelpSystems products installed on that system along with their versions.

4. If you chose an IBM i connection:



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 theUser Name and Password (andConfirm Password) for a user on the systemyou 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 theIBM i. Therefore, the user you choose must have QSECOFRor equivalent authority so thatInsite 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.



d. Enter aUser Name for Guest Access and Password for Guest Access (andConfirmPassword) 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 isjust the user that allows the connection to be made to the AutoMate BPA server.

6. ClickSave.

See also:Product connectionsChanging the viewAdding connectionsConnecting and disconnecting serversDeleting connections

Deleting a Product Connection

This severs the connection between HelpSystems Insite and the IBM i or AutoMate BPA server. If youever need to reconnect, you'll need to add the connection again, and all users will need to reassign theirprofiles. If you want to temporarily disconnect from the IBM i or BPA server instead of removing theconnection entirely, seeConnecting to and Disconnecting from a Server.

To delete a connection:



3. Select (check) one or more server connections to delete.

4. ClickDelete.

5. ClickDeletewhen asked to confirm the deletion.

See also:Product connectionsChanging the viewAdding connectionsConnecting and disconnecting serversEditing a connection



Authentication

The Authentication page is only accessible to the HelpSystems Insite administrator. It allows you to setthe 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 timeoutlimit set here is greater than what a user sets for the auto-refresh intervals for dashboard widgets or intheir preferences (for items such Schedule Activity or the Status Center), it will prevent the user's sessionfrom 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 canchoose to authenticate your users against an LDAP server, one of your IBM i servers, or one of yourAutoMate BPA servers.

Enable a guest login

A guest profile allows you to give people access to the dashboards that are marked asGuest. The Guestprofile is for people who normally don't log onto the product and whomay not even have an IBM i or BPAserver profile. Guest users can only access the Dashboard area and view only those dashboardsdesignated as Guest. They cannot access any other part of Insite, see any other dashboards, or makeany changes.

The default Guest profile credentials are: User Name = guest, Password = guest. However, you canchange it, if necessary. All guests use the same guest profile.

To complete the above tasks:


2. ClickAuthentication on the Administration Settings page.

3. Enter the Session Timeout in minutes.Note: If the timeout limit set here is greater than what auser sets for the auto-refresh intervals for dashboard widgets or in their preferences (for itemssuch BPA Server Activity, Schedule Activity, or the Status Center), it will prevent the user'ssession 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.



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 yourLDAP server.

d. Enter the name of your LDAP Administrator. This administrator must be able to read theLDAP tree.Note: Distinguished Name format is acceptable. For more on Distinguished



Names, go to theMicrosoft Developer Network website.

e. Enter the Administrator Password (andConfirm Password) for the administrator youentered above.

f. Enter theDefault Context for the LDAP server. This is the location to search for users inDistinguished Name format.

g. Enter theUser ID Field Name for the LDAP server. This is the Attribute Name to search infor the username.

h. ClickValidate 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 (seeProduct Connections).

b. Enter an Alias for the server you entered above.Note: The alias you enter here is displayedon 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

https://msdn.microsoft.com/en-us



Insite to (see Product Connections).

b. Enter an Alias for the server you entered above.Note: The alias you enter here is displayedon 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 theGuest User Name. The default is 'Guest'.

c. Enter theGuest Password. Enter it again to confirm it. The default is 'guest'.

6. ClickSave.

See also:Admin Settings

Server Settings / User Settings


Dashboards

Logging

You can select the level of logging you want and download the log files.Note: Only the HelpSystemsInsite administrator can access this page.


2. Click Logging on the Administration Settings page.

3. Select the level of message logging you want used for the Insite applications. You can choosefrom 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. ClickSave.

To download the logs, clickDownloadwhile you're on this page. Then, Save orOpen the .zip file.

See also:Admin settingsProduct connectionsAuthentication

User Settings

The User Settings page allows you to add your IBM i and AutoMate BPA server profiles to HelpSystemsInsite and assign them to each of the connections that were created between Insite and your IBM i and



BPA servers. It also contains preferences that you can set for your user, including product-specificpreferences.

See also:Assigned profilesProfilesPreferences

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 eachproduct connection listed on the Assigned Profiles page, you can see which products are installed on it (ifany) 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 thatsystem.

Things to know and do:

l The total number of records is at the top of the page.

l Click the refresh button to refresh the display.

l Click the page number and select the page you want to view. Or, click the previous and nextarrows.

l Start typing in the Search field to search for a specific product connection. It will find everythingthat contains what you're typing.



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 whattypes 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 toascending or descending .

3. Select what you want to use when searching for product connections. You can choose to SearchAll Fields, or to search byAddress, Alias, or User Profile Alias.


Assigning Profiles to a Product Connection

To assign profiles:



1. ClickUser Settings under Server Settings. If the menu on the left is hidden, click the Menu button in the upper left corner.

2. ClickAssigned Profiles on the User Settings page.

3. Select (check) one or more product connections to assign a single profile to.

4. ClickChange Profile.Note: If you don't have any profiles created, you will go to the NewProfilepage instead.

5. Select the profile you want to assign to the connections. Or select "No Profile" if you don't want toassign a profile at this time.Note: You must assign a profile to be able to see data for that productserver.

6. If you need to add a new profile, there are two ways to do it, depending on how you will use theprofile:

l New Profile is intended for users who will use a different profile for each productconnection. It automatically creates a profile name for you that's used within HelpSystemsInsite. To use this method, selectNew Profile from the Select a Profile list. Then, enter theUser Name and Password for it.

l Add Profile is intended for users who will use the same profile for several productconnections. You enter the profile name yourself. This makes it easier to find and re-use theprofile. To use this method, clickActions and select Add Profile. See Adding a New Profilefor detailed instructions.

7. If you wish to edit the profile you selected in step 5, clickActions and select Edit Profile. SeeEditing a Profile for detailed instructions.

8. ClickSave.

Profiles

In order to see the data from an IBM i system or AutoMate BPA server that HelpSystems Insite isconnected to, you must add a profile for it and assign it to that system. The user in the profile is the userwho'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 bechanged (name, user name, or password), you can change it in one spot, rather than having to change itfor each system individually.

Things to know and do:



l The total number of records is at the top of the page.

l Click the refresh button to refresh the display.

l Click the page number and select the page you want to view. Or, click the previous and nextarrows.

l Start typing in the Search field to search for a specific profile. It will find everything that containswhat 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 ofdata 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 toascending or descending .

3. Select what you want to use when searching for profiles. You can choose to Search All Fields, orto search byNameor User Name.


See also:Adding a profileEditing a profileDeleting a profile



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.


2. ClickProfiles on the User Settings page.

3. ClickAdd.

4. Enter aName for the profile. This is the name that's displayed in the HelpSystems Insite interface.

5. Enter a valid profileUser Name and Password (andConfirm Password) for the IBM i system orBPA server that you need to access.Note: This is the user who's checked for security in eachproduct, and is also the one who's audited when actions are taken.

6. ClickSave.

After you add profiles, you must assign them to the server connections in order to see the data fromthose systems.

See also:ProfilesEditing a profileDeleting a profileAssigning a profile to a server connection

Editing a Profile

To edit a profile for any of the systems you need to access:


2. ClickProfiles 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 differentName for the profile. This is the name that's displayed in HelpSystems Insite.

5. Change theUser Name or Password, if needed. This must be a valid profile to access thatsystem.Note: This is the user who's checked for security in each product, and is also the onewho's audited when actions are taken.

6. ClickSave.

You must assign your profiles to connections in order to see the data from those systems.



See also:ProfilesAdding a profileDeleting a profileAssigning a profile to a connection

Deleting Profiles

To delete one or more profiles:


2. ClickProfiles on the User Settings page.3. Select (check) one or more profiles to delete.

4. ClickDelete.

5. ClickDelete to confirm.

If you delete the profile that a product connection uses, you won't be able to see the data from thatsystem until you assign another profile to it.

See also:ProfilesAdding a profileEditing a profileAssigning 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. Preferencesettings 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. Formore information about those, see the user guide for that product.

Follow these steps to change your general preferences:


2. ClickPreferences on the User Settings page.



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 theproducts are available for you to select). If you select "Default," the Server Settings page isdisplayed.

4. Under Products:

You can control which products show up in the menu along the left. (Note: If the menu on the left ishidden, click the Menu button in the upper left corner.) Clear the checkmark by any product

you do not want to see in the left-hand menu. Only the checked products are displayed.

Server Settings / About HelpSystems Insite


5. ClickSave.

About HelpSystems Insite

The About HelpSystems Insite page displays information about the system that Insite is installed on, andtherefore, can be used when troubleshooting issues. It also shows the HelpSystems contact information.

To get to this page, clickAbout under Server Settings. If the menu on the left is hidden, click the Menubutton in the upper left corner.


OTHER PAGES

There are pages that are common to many of the products in HelpSystems Insite. They're describedbelow.

Active Jobs

The Active Jobs page contains information about all of the jobs currently active on your IBM i server. Formore information on active jobs, refer to the user guide for your product.

Job Log

The Job Log page displays the systemmessages associated with the job you selected. For moreinformation 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 LibraryList information for a job. Use this information for troubleshooting when job problems occur. For moreinformation on job attributes, refer to the user guide for your product.

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 yourproduct.

Message Details

TheMessage Details page displays details for the selected job log message. You can access themessage details when you're viewing the Job Log page or the History Log (QHST) page. For moreinformation 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 onspooled 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 certainproperties. 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 ofcharacters. For more information on viewing a spooled file, refer to the user guide for your product.


OTHER HELP

For help with the product components of HelpSystems Insite, see the user guide for that product:

AutoMate BPA Server OpsConsole User Guide

PowerTech Network Security for Insite User Guide

Robot NETWORK for Insite User Guide

Robot SCHEDULE for Insite User Guide


INDEXA

About HelpSystems Insite 47Active jobs 48Adding

Dashboards 19Product connections 28Profiles 44Widgets to dashboards 19

Admin settings 26Alerts 7Assigned profiles

Getting started 25Sorting and filtering 41User settings 40

Assigning profiles 41Authenticating users 35Authentication 35

Getting started 25Guest login 35Session timeout 35

BBPA server connections 26

CConnecting to a server 31Connections 26

Customizing dashboards 20

DDashboards 9

Adding 19Adding widgets 19Customizing 20Deleting 21Deleting widgets 21Guest 19Overview 9Preference 46Shared 19Widget descriptions 11

Debug logging 39Deleting

Dashboards 21Product connections 34Profiles 45Widgets from dashboards 21

Details of amessage 49Disconnecting from a server 31

EEditing

Product connections 32Profiles 44Spooled file properties 49

FFiltering

Assigned profiles 41Profiles 43

GGetting started 23

Assigned profiles 25Authentication 25Product connections 24

Guest dashboards 19Guest login 35

HHelpSystems Insite 47History log (QHST) 49Homepage preference 46

IIBM i connections 26Info logging 39Insite 47

JJob attributes 48Job Log 48Jobs

Active 48

LLDAP server 36Log

Message details 49Logging 39Login, guest 35Logs

History 49QHST 49

MMessage details 49

NNotifications 7

PPreferences 45

Dashboards 46Homepage 46Products 46

Product connections 26Adding 28Assigning profiles 41Connecting 31Deleting 34Disconnecting 31Editing 32Getting started 24

Product versions 23


Index

Products preference 46Profiles

Adding 44Assigning to product connections 41Deleting 45Editing 44Sorting and filtering 43User Settings 42

PropertiesSpooled file 49

SSearching 27Server Settings

Getting Started 23Session timeout 35Shared dashboards 19Sorting 27

Assigned profiles 41Profiles 43

Spooled file properties 49Spooled file view 49Spooled files list 49

TTrace logging 39

UUser preferences 45User Settings 39

Assigned profiles 40Preferences 45

Profiles 42Users

Authenticating 35

VVersions 23View spooled file 49

WWelcome 5Widgets

Adding 19Deleting 21Descriptions 11


Index

helpsystems insite user guidecloud.networkautomation.com/installs/insite/help... ·...

Documents