Lotus C++ API Toolkit for Notes/Domino 8.0 for Windows English

Licensed Materials - Property of IBM C99N6EN C99N7EN C99N8EN (c) Copyright IBM Corporation 1998, 2007 All rights reserved. IBM, Lotus, Lotus Notes, Notes, and Domino are trademarks or registered trademarks of Lotus Development Corporation and/or IBM Corporation in the United States, or other countries, or both. PROGRAMS -------- AGENTS - Illustrates how to create agent notes. RAGENTS - Illustrates how to execute agents. ENVIRONMENTS ------------ Sample makefiles are provided for the following environments: Microsoft Visual C++ for Win32 IBM i5/OS IBM AIX Sun Solaris SPARC Edition Linux on Intel platforms FILES ----- mswin32.mak - Make file for 32-bit Windows using Microsoft Visual C++. sol_2x.mak - Make file for Sun Solaris SPARC Edition. aix.mak - Make file for IBM AIX. linux.mak - Make file for Linux on Intel platform. agents.cpp - Main program to create agent notes. ragents.cpp - Main program that executes the newly created agents. problems.nsf - Sample Notes database (in notedata directory). agents.ref - Reference sample output log file. HotAgent.java - Java Agent source code. HotAgent.class - Java Agent class file. readme.txt - This file. Specifies what is needed to use this example. mk_agents_i.clp - Make file (CL Program) for IBM i5/OS using ILE C++ with the source code being an IFS file. mk_agents_p.clp - Make file (CL Program) for IBM i5/OS using ILE C++ with the source code being in a source physical file. (Note: If you use ILE C++ compiler with the source code being in a source physical file, the file HotAgent.class is stored as IFS file: /qntcppsdk/notedata/HotAgent.class.) DESCRIPTION ----------- AGENTS This sample creates the following four agent notes in the sample database, problems.nsf, which is included with the toolkit. 1)"Send Reminder to Support Rep" This agent is a manual (menu command), shared, Actions agent that runs against the currently selected documents. When executed, it will send a mail message, with doclink, to the "Support Reps" of the selected documents in the view. 2)"Assign Support Rep" This agent is a disabled, shared, background LotusScript agent triggered and run against new and/or modified documents. When executed manually or as a background agent, it assigns default "Isabel Silton" to all open, problem documents that do not have an assigned Support Rep. When this agent is executed programmatically, by RAGENTS program, it uses Parameter Document to set a different name ("Sandy Block".) 3)"Decrease Priority" This agent is an enabled, shared, scheduled, formula based agent that runs against selected documents in the database dayly, at 1AM. When executed, it decreases the Priority value of all open problems created on the previous day by one level. 4)"Assign Hot Problems" This agent is a manual (menu command), shared Java agent that runs against all documents. When executed, it assigns "Fire Fighters" as the Support Rep to all problem documents that have an "Open" Status and "High" Priority. RAGENTS This sample executes the "Assign Support Rep" and "Decrease Priority" agents created by agents.exe and displays and logs the results. BEFORE RUNNING THIS SAMPLE --------------------------- This sample uses the problems.nsf sample database that is included in the notedata directory of the C++ API toolkit. Copy this file to the Notes data directory. Before running this sample, open the database from Notes and perform the following preparatory steps: 1) From the Main View create a new Problem document with an empty Support Rep field value, and set its Priority to "High". 2) Edit a number of existing Problem documents clearing the Support Rep field. RUNNING AGENTS and RAGENTS: --------------------------- 1) Run the AGENTS program, by typing 'agents' at the command prompt, followed by the name of the sample directory and an optional server name. If no server name is specified, the database problems.nsf in the local Notes data directory is used. For example, on PC platforms, if you installed the C++ API toolkit in c:\notescpp, you could run the program as follows: agents c:\notescpp\samples\agents If your Notes id is password protected, you will be required to type in the password. This program will create the four agent notes. Under i5/OS: Execute "RUNDOMCMD SERVER(<server>) CMD(CALL PGM(qntcppsdk/agents) PARM(<data directory>)) BATCH(*no)" 2) Open Domino Designer and open the Problem Tracking database (problems.nsf). Look at the Agents view. The four agents just created, "Decrease Priority," "Send Reminder to Support Rep," "Assign Support Rep," and "Assign Hot Problems" will be listed. Note: You will find also "Default Agent with LotusScript" which is included with the database and used solely as a repository of the LotusScript code. 3) Run the RAGENTS program by typing 'ragents' at the command prompt, followed by the optional server name. If no server name is specified, the database problems.nsf in the local Notes data directory is used. ragents [optional server name] This program will execute two of the four agents just created: "Assign Support Rep" and "Decrease Priority." Note: The "Decrease Priority" agent will generate a warning message, "Agent is performing full text operatons on database 'problems.nsf' which is not full text indexed. This is extremely inefficient." This will not affect execution of the agent. To remove the warning, create a full text index of problems.nsf prior to running ragents. Under i5/OS: Execute "RUNDOMCMD SERVER(<server>) CMD(CALL PGM(qntcppsdk/ragents)) BATCH(*no)" Note: For Domino/Notes 6, you may need to run the RAGENTS program -- With SBMJOB command as follows: 1) Add the environment variable PATH: "ADDENVVAR ENVVAR(PATH) VALUE('/QIBM/PRODDATA/LOTUS/NOTES:/QIBM/USERDATA/LOTUS/NOTES: /<server data directory>)" 2) Then run: "SBMJOB CMD(CALL PGM(qntcsdk/ragents)) USER(qnotes) CPYENVVAR(*YES) ALWMLTTHD(*YES)" or -- (for Domino 6.02 or later) "RUNDOMCMD SERVER(<server>) CMD(CALL PGM(qntcppsdk/ragents)) BATCH(*yes) ALWMLTTHD(*yes)" CHECKING THE RESULTS -------------------- 1) RAGENTS writes to the agents.log output log file. If no errors occur during execution, this file contains a trace of the execution results and run information for the two triggered agents. Any errors that occur during execution will be displayed to the console output. The file, agents.ref, which is included in the directory of the sample, contains a reference for the output log. Use this file to compare with and validate the trace results in agents.log. 2) Open the Problem Tracking database (problems.nsf) and from the Main View notice that the Problem document you had set up to not have an assigned Support Rep now has a Support Rep value of "Sandy Block." This validates the "Assign Support Rep" agent execution. 3) From the Main View, notice that the newly created problem previously assigned "High" Priority now have "Medium" Priority. This validates the "Decrease Priority" agent execution. 4) To validate the "Send Reminder to Support Rep" agent note: - Verify that it is available for selection from the Actions menu. - From the Main View modify the Support Rep value of one Problem document by assigning it your name.