Home
IBM® Domino 10.0.1 Documentation
Welcome to the IBM® Domino 10.0.1 Administrator Help.
Tuning
Use this information to improve IBM® Domino® server, Domino Web server, and messaging performance through the use of resource balancing and activity trends, Server.Load commands, advanced database properties, cluster statistics, and the Server Health Monitor.
The Server.Load tool
Server.Load is a capacity-planning tool that you use to run tests, also called "scripts" and "workloads," against a targeted Domino® server to measure server capacity and response metrics.
Server.Load commands
Server.Load scripts consist of statements in a simple command language, the Server.Load specification language.
ColorProfileAdd command
Adds a color profile to the mail database.

IBM® Domino 10.0.1 Documentation
Welcome to the IBM® Domino 10.0.1 Administrator Help.
- What's new in IBM® Domino® 10?
  Learn about all of the new features for administrators in IBM® Domino® 10.
- Overview
  Welcome to IBM® Domino® Administrator Help.
- Installing
  Use this documentation to install the IBM® Domino® server and subsequently deploy the IBM Notes® client.
- Planning
  Use this topic as an overview of planning task.
- Configuring
  Use this information to configure an IBM® Domino® network, users, servers (including Web servers), directory services, security, messaging, widgets and live text, and server clusters. Also use this information to set up IBM iNotes® on a server using Domino Off-Line Services (DOLS).
- Securing
  This section describes IBM® Domino® security features, including execution control lists, IDs, and SSL.
- Administering
  This documentation provides information about the administration tools for managing and monitoring IBM Domino® servers and databases.
- Tuning
  Use this information to improve IBM® Domino® server, Domino Web server, and messaging performance through the use of resource balancing and activity trends, Server.Load commands, advanced database properties, cluster statistics, and the Server Health Monitor.
  - Resource balancing and activity trends
    Domino® server resource utilization can be separated into two types, system activity and user activity. System activity, which includes the level of processor, disk, memory, and network consumption that Domino generates to keep the server running, is a fixed amount of activity, as long as systems are healthy and performing smoothly. Domino servers typically use a modest percentage of their resources to run. The remaining server capacity is used to support user activity, which varies with the usefulness of the data on the server.
  - The Server.Load tool
    Server.Load is a capacity-planning tool that you use to run tests, also called "scripts" and "workloads," against a targeted Domino® server to measure server capacity and response metrics.
    - Server.Load agents
      Server.Load includes a set of agents in the file NAMAGENT.NSF, which is initially installed in the data directory on the Domino® Administrator client. The first agent in this list -- Create NotesBench Mail Person Documents -- is used to set up Person documents for the workloads and set the HTTP password. The rest of the agents are used to repair and change the workload setup.
    - Server.Load metrics and messaging statistics
      As you run a test, you can view various script metrics and server statistic metrics and optionally store the test output in a separate file. Server statistic metrics are generated by the Domino® server. Script metrics correspond to Server.Load command names and display the performance of particular commands. For example, if you select the Add metric, the Metrics window displays the results of the Add command.
    - Setting up clients and servers for Server.Load
      To use Server.Load, install the Domino® server on the server under test (SUT) and install the Domino Administration client and the Server Load Utility on each client.
    - Built-in and custom Server.Load scripts
      Server.Load includes a set of built-in scripts. You can also create a custom script from scratch.
    - Running the built-in Server.Load workloads
      Server.Load contains numerous built-in workloads and initialization workloads.
    - Server.Load commands
      Server.Load scripts consist of statements in a simple command language, the Server.Load specification language.
      - @Else command
        Use with the @If command in a Server.Load script.
      - @EndIf command
        Use with the @If command in a Server.Load script.
      - @If command
        Used in a Server.Load script to execute [Commands] if [Value] is non-zero. @If is used to execute multiple commands or to use an @Else condition.
      - Add command
        Use in a Server.Load script to create new documents in a database according to the value of a.
      - BeginCrit command
        Use in a Server.Load script to mark the beginning of a script's critical region.
      - BeginLoop command
        Use in a Server.Load script to mark the start of the loop and the point to which the Rewind statement returns control. A script can have one loop.
      - BeginLoop2 command
        Use in a Server.Load script to mark the start of the loop and the point to which the Rewind2 statement returns control.
      - Break command
        Use in a Server.Load script to allow the user to set program control after an error.
      - Cal command
        Use in a Server.Load script to schedule an appointment or invitation.
      - ChangeTo command
        Use in a Server.Load script to set the current database for the test.
      - CheckForNewMail command
        Use in Server.Load to check for new mail on the specified mail database.
      - Close command
        Use in a Server.Load script to close the current view. The view is opened with the Open command.
      - Closecoll command
        Closes a view opened by the OpenColl command.
      - ColFindKey command
        Given a collection, searches for all notes within a set time range of one week prior to the current time, and three weeks after.
      - ColorProfileAdd command
        Adds a color profile to the mail database.
      - ColorProfileDelete
        Clears out (removes) the color profile items and notes.
      - Console command
        Use in a Server.Load script to allow you to issue remote server console commands, similar to the Domino® server console in the Domino Administrator console.
      - DBClose command
        Closes the open database.
      - DbDelete command
        Use in a Server.Load script to delete a database (locally or on a server). If the database is on a server, you must have delete database access.
      - DBGetModNoteInfo
        Requests a list of all notes modified or added since the last call.
      - Delete command
        Use in a Server.Load script to delete randomly selected notes from the current database.
      - DeleteFromColl
        Deletes a number of notes from a view. The view must have been previously opened with OpenColl.
      - Drop command
        Use in a Server.Load script to drop all network connections on the specified port.
      - EndCrit command
        Use in a Server.Load script to indicate a critical region that can be executed by only one simulated user (thread).
      - EntriesColl
        Retrieve a number of documents from the view to populate the internal list of Note IDs. The view must have been previously opened with OpenColl.
      - Entries command
        Used in a Server.Load script to simulate a user pressing PgUp and PgDn or pressing Up and Down arrows to traverse a view.
      - ErrorDelay command
        Used in a Server.Load script to set a time delay after a nonfatal error occurs.
      - FindByKey command
        Used in a Server.Load script to enable you to search index entries by key.
      - FindByName command
        Used in a Server.Load script to enable you to search index entries by name.
      - FindDesignNote command
        Finds a design note and saves the NotesID.
      - FolderFind command
        Find a folder's Note ID for use in the next command. Remains cached until a new folder is found.
      - GetAll command
        Used in a Server.Load script to fetch the ID table of all Note IDs from the database.
      - GetAllFolderChangesRqst command
        Requests any folder changes from the server. Nothing is done with the results.
      - GetCollation command
        Get collation for the most recently opened collection.
      - Help command
        Used in a Server.Load script to display help text.
      - ImailCheckForNewMail command
        Used in a Server.Load script to purge deleted IMAP messages and check for new messages.
      - ImailCloseMailbox command
        Used in a Server.Load script to close the currently selected IMAP mailbox.
      - ImailFetchEntry command
        Used in a Server.Load script to get (UID Fetch) body for specified entry.
      - ImailFetchOld command
        Used in a Server.Load script to get (UID Fetch) Body for specified entry.
      - ImailGetLastEntries command
        Used in a Server.Load script to get (Fetch) last page of entries (UID, flags, envelope) for use with ImailFetchEntry.
      - ImailGetNewMail command
        Used in a Server.Load script to check for new IMAP messages.
      - ImailHelp command
        Used in a Server.Load script to displays all available IMAP (IMail*) commands with Help text.
      - ImailListMailboxes command
        Used in a Server.Load script to list IMAP mailboxes.
      - ImailLogin command
        Used in a Server.Load script to log in to a server running IMAP.
      - ImailLogout command
        Used in a Server.Load script to log out of a server running IMAP.
      - ImailOpenMailbox command
        Used in a Server.Load script to open (select) an IMAP mailbox (the Inbox folder of the mail file).
      - ImailPostMessage command
        Used in a Server.Load script to add a message to the specified mailbox.
      - ImailSetSeen command
        Used in a Server.Load script to set current message as seen.
      - Index command
        Used in a Server.Load script to update the currently open collection.
      - LDAPLookup command
        Used in a Server.Load script to perform LDAP lookup for specified user name.
      - LocateCalNote
        Searches the calendar view for the last entry that was created.
      - Lookup command
        Used in a Server.Load script to search the Domino® Directory (NAMES.NSF) for names you specify.
      - MailRuleBlockSender command
        Add a mail rule that blocks a user from sending to the database.
      - MailRuleDeleteAll command
        Removes all the mail rules in the database.
      - MoveToFolderColl command
        Moves notes from a view to a folder.
      - NABRetrievePOP3Mail command
        Used in a Server.Load script to retrieve POP3 mail messages for a fixed user in the Domino® Directory (NAMES.NSF).
      - NABUpdate command
        Used in a Server.Load script to update a number of random documents of a particular type in the Domino® Directory (NAMES.NSF) database.
      - Navigate command
        Used in a Server.Load script to read number of documents as listed in index.
      - NavigateColl command
        Read a number of documents in the index. Reply to all recipients in a number of messages. Do this every NB_ReplyNthIteration iteration.
      - NewMail command
        Used in a Server.Load script to poll for new mail.
      - NewMailPoll command
        Poll for new mail, refresh the view if there is new mail.
      - NewReplicateDB command
        Used in a Server.Load script to create empty database target as replica of source.
      - NoteAdd command
        Used in a Server.Load script to add a document with the specified [Subject], [Body], [Attachment], [MsgCount], [NamedField], and [FolderID].
      - Open command
        Used in a Server.Load script to open a view collection.
      - OpenCalNote command
        Opens the last calendar note created.
      - OpenColl command
        Opens a view for use by Server.Load commands.
      - Pause command
        Used in a Server.Load script to wait for a specified number of milliseconds before performing the next command in the script.
      - Populate command
        Used in a Server.Load script to ensure that there are (NumMailNotesPerUser) documents in the current database.
      - ProfileClose command
        Closes an opened profile, that is, a profile opened with the ProfileOpen command.
      - ProfileOpen command
        Opens a given profile note.
      - ProfileSetField command
        Can add four types of fields to a profile note.
      - ProfileUpdate command
        Updates the currently opened profile note.
      - Quit command
        Used in a Server.Load script to terminate the open program.
      - Read command
        Used in a Server.Load script to open and close a specified number of documents.
      - Replicate command
        Used in a Server.Load script to replicate with server.
      - RetrievePOP3Mail command
        Used in a Server.Load script to retrieve POP3 mail messages for a user.
      - Rewind command
        Used in a Server.Load script to restart the script file, if one is given, up to a maximum of n iterations, if n is specified.
      - Rewind2 command
        Used in a Server.Load script to restart the loop, up to a maximum of n iterations, if n is specified.
      - RSVPFromColl command
        Finds invitations for response from the Inbox.
      - RSVPInvitation command
        Use in a Server.Load script to send a response (acceptance) to an invitation (if one exists).
      - SendMessage command and SendMessage profile command
        Use in a Server.Load script to create and send a mail message.
      - SendMessageFromColl command
        Used in a Server.Load script to create and send a mail message.
      - SendSMTPMessage command
        Used in a Server.Load script to create and send an SMTP mail message.
      - SessionsClose command
        Used in a Server.Load script to close all open sessions.
      - SessionsOpen command
        Used in a Server.Load script to create sessions on the specified server, monitor the time it takes to open num_sessions, and return that val
      - SetCollation command
        In the most recent collection, set an ordinal position.
      - SetContextStatus command
        Used in a Server.Load script to set the context iteration status.
      - SetCalProfile command
        Used in a Server.Load script to set the Owner and BusyName fields for the current database.
      - SetReplID command
        Sets the database replica ID based on the date and time provided or, if the date and time are not provided, it uses the current date and time to set the replica ID.
      - Stamp command
        Used in a Server.Load script to select 'a' random documents from the list of Note IDs returned from GetAll.
      - Stblchange command
        Adds a user randomly chosen from the list of users defined for the test. If the user is already in the buddy list, it will find another until it has one that is not in the buddy list.
      - Stblinit command
        Deletes all current buddies in the current user's buddy list and adds a range of users.
      - Stchat command
        Sends a chat message.
      - Stfiletransfer command
        Attempts to transfer a file to a random user.
      - Stlocationset command
        Sets Location settings.
      - Stlocationwatchbl command
        Adds everyone in the current user's buddy list to a watch list for their locations.
      - Stlogin command
        Use in a Server.Load script to log a user in to a IBM® Sametime® server.
      - Stlogout command
        Logs an IBM® Sametime® user out of the server, pauses, then logs back in.
      - Stpolicy command
        Queries the current user's policy.
      - Ststatus command
        Sets the status of the current user.
      - Stterm command
        Logs an IBM® Sametime® user out of the server and closes the connection.
      - Stuserinfo command
        Randomly selects a user in the current user's buddy list and requests the user's business card.
      - Unread command
        Used in a Server.Load script to set the database unread list for the current collection to contain (a) random documents.
      - Update command
        Used in a Server.Load script to update random documents in a database, based on the value of 'a'.
      - WebGet command
        Used in a Server.Load script to retrieve information from a specified URL.
    - Server.Load scripts
      You can use any of the sample Server.Load scripts as they are or you can use them as a basis for creating customized scripts.
    - How Server.Load determines the range of mail addresses it uses when sending messages
      Server.Load uses the logic described in this topic when determining the range of mailing address to be used.
  - Tuning Domain Indexer performance
    Each time the Domain Indexer task runs, it looks in the Domain Catalog for new databases that have the Include in multi database indexing property enabled. It then looks for documents and files in existing databases and file systems that are new or changed since the last time it ran, and adds them to the Domain Index.
  - Improving Domino® server performance
    Read the following topics for help on improving basic Domino® server performance and capacity, as well as the performance of these features: Agent Manager, databases and the Domino directory, the directory catalog, LDAP searches, mail, Web server, and UNIX™ server.
  - Improving Web server performance
    After you set up the Domino® Web server and make sure that it runs properly, check the server's performance and response time.
  - Improving mail performance
    Domino® includes features that improve efficiency in specific environments, but these features may not be switched on by default.
  - Setting advanced database properties
    Advanced database properties include performance optimization and compression features, as well as ways to manage usability features such as unread marks and soft deletions.
  - Understanding cluster statistics
    Three categories of Domino® cluster statistics help you analyze clusters
  - Improving the performance of the Server Health Monitor
    If the Domino® Administration client workstation performs at 100 percent CPU utilization for a long period of time, the Server Health Monitor discards server statistic data to keep up with the workload.
- Troubleshooting
  This section describes how to find and solve problems with IBM® Domino® server and Administrator client.
- Glossary

ColorProfileAdd command

Adds a color profile to the mail database.

In the Inbox on a Notes® client, a circle appears if a message is delivered to the owner of the mail database or if the recipient is one of two names in the To field.

Syntax

ColorProfileAdd