Running Scheduled Agent Scans from the Lotus Notes Client


 Product:
 Agent Monitor for Lotus Notes / Domino > Scheduled Agent Scan > Version All

 Platform(s):
 All

 Edition(s):
 All

 Doc Number:
 1000086
Published 02-Aug-2011

 Problem

How do I setup and run a scheduled scan of agents from my Lotus Notes client?

 Solution

The Agent Monitor can be configured to scan agents on a scheduled basis from the Lotus Notes client as well as the Domino server. This support note provides information on the settings and configurations to enable the agent scans to run on the Notes client. The basic steps are:
  1. Enabled scheduled local agents in the Lotus Notes client.
  2. Ensure the database(s) containing the agents to be run locally are located in the data directory of the Notes client, or a sub-directory thereof.
  3. Ensure scanning profiles exist for each Domino server to be scanned for agents.
  4. Ensure a local scanning profile exists for the Notes ID which will be used to perform the scan from the Notes client.
  5. The name of the server to run Agent Scan on has been set to the same name as the Notes ID being used on the Notes client.

Each of these is described in more detail below.

Step 1 - Enable Scheduled Local Agents
To run scheduled agents from your Lotus Notes client you must first enable the feature to run local scheduled agents. To do this follow these steps:

Lotus Notes 7.x or earlier
1. Select the 'File' option from the Lotus Notes menu then select 'Preferences' and then 'User Preferences'.
2. Make sure the 'Enable scheduled local agents' option has been selected (see image below)



3. Restart the Lotus Notes client.

Lotus Notes 8.x or later
1. Select the 'File' option from the Lotus Notes menu then select 'Preferences'.
2. Select the 'Basic Notes Client Configuration' option on the left-hand side of the Preferences box.
3. Make sure the 'Enable scheduled local agents' option has been selected (see image below)



4. Restart the Lotus Notes client.

Step 2 - Ensure the database is located in the Lotus Notes Client data directory
The database(s) containing the scheduled agents you want to run on the Notes client must be located in the data directory, or a sub-directory thereof, on the Lotus Notes client. If the database is located only on the Domino server you will need to replicate it to the Notes client.

Step 3 - Setup server scanning profiles to run on a scheduled basis
After enabling the option to run scheduled agents on the Lotus Notes client and ensuring the database is located on the Lotus Notes client you then need to update or create scanning profile documents for each Domino server to be scanned.
  1. Open the Agent Monitor application.
  2. Select the 'Scanning Profiles'option which appears under the Administration heading on the left-hand navigation pane of the application.
  3. Locate and edit the appropriate scanning profile document for the server.
  4. If a profile does not exist for the Domino server click the 'New Scanning Profile' button at the top of the scanning profiles view.
  5. The 'Profile name' field in the scanning profile must exactly match the name of the server to be scanned. For example if the certified Domino server name is 'DomServer01/ACME' then this is what should be put into the Profile name field.
  6. The profile type should be set to 'Server Profile'
  7. Go to the 'Scheduled Agent Scans' section of the form.
  8. Set the 'Perform regular scans of agents on this server' option to 'Yes'.
  9. Make any other required changes to the scanning profile document.
  10. Save and close the scanning profile.

Repeat the above steps for each scanning profile corresponding to each Domino server to be scanned.

Step 4 - Create local scanning profile document
A local scanning profile must exist for the Lotus Notes ID that the scans will be performed under when running from the Lotus Notes client.
  1. Select the 'Scanning Profiles'option which appears under the Administration heading on the left-hand navigation pane of the application.
  2. Locate and edit the appropriate scanning profile document under local profiles whose profile name matches that of the Notes ID which will be used to run the scan.
  3. If a profile does not exist for the Notes ID you are going to use for running the agent scan click the 'New Scanning Profile' button at the top of the scanning profiles view.
  4. The 'Profile name' field in the scanning profile must exactly match the name of the Notes ID. For example if the certified Lotus Notes name is 'Notes Administrator/ACME' then this is what should be put into the Profile name field.
  5. The profile type should be set to 'Local Profile'
  6. Go to the 'Scheduled Agent Scans' section of the form.
  7. Set the 'Perform regular scans of agents on this server' option to 'Yes'.
  8. Click the dropdown arrow to the right of the 'Also scan agents on these servers' and select or enter the name of each Domino server you would like to scan from the Notes client. Note: ensure in the previous step you setup a scanning profile document for each server to be scanned.
  9. Make any other required changes to the scanning profile document.
  10. Save and close the scanning profile.
Step 5 - Enable Scheduled Agent Scans
The final step to running scheduled agent scans from the Notes client is to enable the Agent Scans agent. To do this follow these steps:
  1. Open the Agent Monitor application.
  2. Select the 'Configuration Settings' option from the left-hand navigation pane of the application. If you do not see this option please click this link for assistance ... Database 'AGECOM Support Notes', View '1. Search', Document 'Administration options not available'.
  3. When the Configuration Settings form has opened click on the 'Scheduled Agent Scans' tab.
  4. The 'Run agent on' option should be set to 'Specified server'.
  5. The 'Server to run on' option MUST be set to the same value as the certified name in the Notes ID file being used on the Lotus Notes client. For example if the certified Lotus Notes name in the Notes ID file being used on the Notes client is 'Notes Administrator/ACME' then this is the same value that should be added for the server to run the agent on.
  6. You may optionally click the 'Edit Agent Settings' link which appears near the upper-right corner of the Scheduled Agent Scans section. This enables you to customize when the agent should run.
  7. Set the 'Scan agents on remote servers' options to 'Yes'.
  8. Click the 'Enable Scan Agents agent' button.

The following diagram shows the name of the Lotus Notes ID currently being used (by selecting File -> Security -> User Security from the Lotus Notes menu) and the name of the server to run scheduled agent scans on in the Configuration Settings of the Agent Monitor application. The two names should match.



Summary
This completes the information for setting up the scanning of database agents on a scheduled basis from your Lotus Notes client. If the agent does not run as expected refer to the local log database (log.nsf) or the error logs view in the Agent Monitor application for information as to why it's not running. You can also enable the debugging feature to assist with troubleshooting ... Database 'AGECOM Support Notes', View '1. Search', Document 'Enabling Debugging in the Agent Monitor application'.



© 2011 AGE Computer Consultancy. All rights reserved.
Material may not be reproduced or distributed in any form without permission.