Configure Your Lotus Domino Collector for Windows

A) ENABLE LOTUS ON-PREMISE COLLECTION

NOTE: Before enabling Lotus On-Premise collection, make sure that your archiving provider's support team has enabled the service for your archiving account.

    1. As the customer account administrator (AO), open the Admin page.
    2. Select the Account tab.
    3. Under OPTIONS, select "Enable Lotus On-Premise Collection".
    4. Click Update account at the bottom of the page.

B) CREATE THE COLLECTOR

    1. As the customer AO in the archive account, select the Collectors tab.
    2. Click the button Configure Lotus On-Prem Collector.

    3. Enter a "Customer Friendly Name" (free form).
    4. Do NOT select the checkbox for "Automatically Upgrade Agent Software".
    5. Select 'Target Operating System' = Windows 64-bit.
    6. Enter a location for the "Location of Journaled NSFs': C:\sa-agent\archive

NOTE: The "Location of Journaled NSFs" must be unique for each Lotus On-Prem Collector the customer may archive at any time. Each Domino server may need to run its own Collector depending on how Domino routing and journaling are configured. Customers with multiple Domino servers in their domain may need multiple Collectors; each location must be unique. This warning is primarily to address the use of Network Attached Storage devices.

    7. Click "Add Collector".



C) VERIFY CUSTOMER'S DOMINO JOURNAL SETTINGS

    1. Log into the Domino Administrator.  
    2. Select Configuration tab - Server - Configurations, select your Domino Server document.
    3. Select the Router/SMTP tab.
    4. On the Router/SMTP - Advanced - Journaling tab.
    5. Verify Journaling = Enabled.


D) VERIFY THE MAIL RULES

    1. Select the Router/SMTP tab.
    2. Select Restrictions and Controls.
    3. Select the Rules tab.
    4. Verify Mail Rules created will result in mail messages being journaled.

NOTE: The archiving service has no requirements for Mail Rule Conditions other than that the Rules result in mail messages being journaled. The archive service can only archive messages that that Domino server journals according to the Domino Mail Rules. If a subset of Domino mail is journaled, only that subset will appear in the customer's archive account.


E) VERIFY DOMINO VERSION

    1. As a System Administrator on the customer's Domino server, verify the customer is running on 64-bit Domino 8.5.3. In the Domino console.log, found in C:\Program Files\IBM\Lotus\Domino\data\IBM_TECHNICAL_SUPPORT, the startup of the Domino server records the following which indicates 64-bit: 

Lotus Domino (r) Server (64-bit), Release 8.5.3, September 15, 2011
Copyright (c) IBM Corporation 1987, 2011. All Rights Reserved.

F) DOWNLOAD AGENT INSTALLER ZIP FILE

    1. As a System Administrator on the customer's Domino server, launch a browser.
    2. Access the Customer's archiving account as the Customer Account Administrator.
    3. Select the Admin page.
    4. Select the Collectors tab.
    5. Click the Edit button for the Lotus OnPrem Collector to be used with this Domino server.
    6. In the section "DOWNLOAD THE LOTUS ON-PREM AGENT", click the 'Download' link.
    7. Review the Terms of Service.
    8. Click 'Accept Terms and Download'.




    9. Proceed through any expection or warning dialogs.
    10. Save the file (ex. installer-xxx...xx.zip) to a location on the customer's Domino server, ex. C:\agent.
    11. The downloaded archive file = 51MB.

G) EXTRACT FILES

    1. Extract all the contents of the downloaded zipped archive file while preserving the supplied directory structure. You may wish to change the Destination Directory of the extracted files to make it easier to access from a terminal window, ex, C:\agent. The extracted contents contain the following:
                archive-agent-1.0.0-SNAPSHOT (directory)
                bin (directory)
                current
                jre (directory)
                nSANSFCollector.dll
                SAArchive.ini


H) COPY nSANSFCollector.dll

Copy the file nSANSFCollecor.dll to the Domino installation directory, ex: C:\Program Files\IBM\Lotus\Domino


I) EDIT notes.ini

    1. Edit the notes.ini file, found in C:\Program Files\IBM\Lotus\Domino
    2. Search for the values: EXTMGR_ADDINS.
            a) If the value exists, add ",SANSFCollector" to the end of the line (Note the comma and no space).
            b) If the value does NOT exist, add the following line: EXTMGR_ADDINS=SANSFCollector
    3. Save the change to the notes.ini file.


J) COPY SAArchive.ini

    1. Copy the file SAArchive.ini to the C:\Program Files\IBM\Lotus\Domino\data
    2. SAArchive.ini contains the following lines:
                AgentDirectory=c:\sa-agent
                ArchiveDirectory=
c:\sa-agent\archive
                ArchiveUser=CN=Archive Agent/O=<YourArchiveProvider>
                TargetJournalLatencySeconds=3600

NOTE: The values for AgentDirectory and ArchiveDirectory were derived from the values specified for 'Location of Journaled NSFs' when the Agent was created in the archive account UI above. If you wish to use a different directory location, you must create and deploy a new Agent. Changes to these values in this file are not sufficient to utilize new directory locations.


K) REST
ART THE DOMINO SERVER

Stop and restart the Domino server to enable the Domino server to use the archive provider supplied file nSANSFCollector.dll.


L) VERIFY DOMINO CONSOLE LOG OUTPUT

View the Domino console output, found in: C:\Program Files\IBM\Lotus\Domino\data\IBM_TECHNICAL_SUPPORT\console.log, to verify the nSANSFCollector.dll has been loaded. Output should show entries similar to to the following:
                SAArchive: Loaded [1.0, 02/04/2013, 123] logging to c:\sa-agent/SAArchive.log

M) INSTALL AGENT

    1. It is recommended that the agent be installed from a location on the local server's hard drive rather than on a shared network drive. In a terminal window, change directory to the location if the extracted files, C:\agent.
    2. Change directory to archive-agent. This is the location where the agent is launched and where the agent.log file will be created.
    3. Open a terminal window for installing the agent as a Windows Service.
    4. Change directory to the location of the extracted files,
C:\agent.
    5. Change directory to
archive-agent.
    6. Launch the installation script:
                bin\service.bat install
                    Installing service...
                    done.

    7. The installation creates and writes the following to the log file,
            C:\agent\archive-agent\SAArchiverService.<datestamp>.log
                    Commons Daemon procrun log initialized
                    Commons Daemon procrun (1.0.15.0 32-bit) started
                    Installing service...
                    Service SAArchiverService name SAArchiverService
                    Setting service description <yourarchiveprovider> Collector Agent
                    Service 'SAArchiverService' installed
                    Commons Daemon procrun finished


N) START AGENT

    1. Open Administrative Tools - Services
    2. Verify SAArchiverService is listed.
    3. Select SAArchiverService, click Start.
    4. Verify SAArchiverService Status changes to Started.
    5. Starting the SAArchiverService creates the file, agent.log.
    6. Open the Task Manager to verify the java process is running.
    7. Select the java.exe *32 process
    8. Right-click, select Properties
    9. java.exe *32 Properties dialog should show Location:
            C:\agent\archive-agent\jre\bin, including the location of your running agent.
   

O) VERIFY AGENT STATUS

    1. Agent status can only be verified if the agent is running.
    2. Launch a terminal window.
    3. Change directory to the location where the agent was launched,
C:\agent\archive-agent
    4. Issue the following command to retrieve the agent status:
bin\agentctl status
    5. If the agent is running, the command should return output similar to the following:
                Last successful operation was (sleep 60) at 2013-04-09T11.31.32.
                Log level is normal.
                Version is 1.0.0-SNAPSHOT.
                Up for 0 hours 4 minutes 3 seconds

    6. Agent status can also be determined from the customer archive account, in the Edit screen of the Collector.

    7. Verify the file: C:\agent\archive-agent\agent.log is created.
    8. When the agent is started successfully,
C:\agent\archive-agent\agent.log will contain the following:
                starting server
                initializing [larabee.config larabee.op larabee.log larabee.upgrade larabee.server]
                done starting server


P) VERIFY MESSAGES ARE JOURNALED

    1. Send a message to a user on the Domino server.
    2. Verify a record of the message appears in the Domino console log.
    3. Verify a new journal file is created in C:\sa-agent\archive
    4. Verify a record of the message appears in the C:\sa-agent\SAArchive.log
                Info: Loaded [0.1-dev, 20121120-003231, 825111a]
                Warning: found no files matching: /sa-agent/archive/journal*.nsf
-- initially no journal is available to store the new message, one is created.
                Info: Journaled message to /sa-agent/archive/journal-20121228T011319Z.nsf -- journal file created, message stored. 


Q) UNINSTALL THE DOMINO ON-PREM COLLECTOR

    1. Launch a terminal window.
    2. Change directory to the location where the agent was launched, C:\agent\archive-agent
    3. Issue the following command to stop the agent: bin\service.bat uninstall

    4. Verify the agent is stopped by viewing output in: C:\agent\archive-agent\agent.log
                executing admin: [stop]
                stopping server
                done stopping server                

    5. Verify SAArchiverService is removed by viewing output in C:\agent\archive-agent\SAArchiverService.<datestamp>.log
                Commons Daemon procrun log initialized
                Commons Daemon procrun (1.0.15.0 32-bit) started
                Deleting service...
                Service 'SAArchiverService' deleted
                Delete service finished
                Commons Daemon procrun finished

    6. Verify SAArchiverService is removed from Services.
    7. Delete the agent directory C:\agent
    8. Stop the Domino server.
    9. Delete the file nSANSFCollector.dll from the directory C:\Program Files\IBM\Lotus\Domino
    10. Edit the file C:\Program Files\IBM\Lotus\Domino\notes.ini
    11. Remove the value ",SANSFCollector" from the EXTMGR_ADDINS setting
    12. Save the file.
    13. Delete the file SAArchive.ini from the directory C:\Program Files\IBM\Lotus\Domino\data