Skip to main content link. Accesskey S
  • Company Logo
  • Crossware Mail Signature Wiki
  •  



Home > 1. Product Documentation > Esig Client Commands

Original noneditable edition

Esig Client Commands

ShowTable of Contents
The esig task has several built in commands for Local Signatures.

The commands can either be issued to a loaded esig task or as a single command.

Syntax & list of available commands



The commands are entered into the domino console as follows:

load esig client <command > <parameters >
In this case, the esig command will load, execute the command and then terminate.

tell esig client <command > <parameters >
In this case, the command will be issued to a currently loaded esig task.

Check single user



load esig client checkUser <username >
This command will check an individual user's signature for changes and update if a change is detected. No new users will be created.


Generate single user



load esig client generateuser <username >
This command will recreate the signature for the user. The username can be in any format as long as there is a match in $Users View. No new users will be created.


Check single group



load esig client checkgroup <User Configuration Name >

This command will use the Group listed in the "User Group" field in the User Configuration document and will check for changes in the signature in the User Log document and create a new signature if a change is detected. If the user does not have a User Log document then it will be created.

This command is designed to be used in a program document to maintain user signatures based on a server address book group.



Generate single group



load esig client generategroup <User Configuration Name >

This command will use the Group listed in the "User Group" field in the User Configuration document and will recreate the signature for all the members in the group. If the user does not have a User Log document then it will be created.



Check all users



load esig client checkall


This command will check all the existing users in the User Log View for changes and update if needed. No new users will be created.


Generate all users



load esig client generateall


This command will recreate the signature for all existing users in the User Log View. No new users will be created.



Check all groups



load esig client checkallgroups


This command will perform a "checkgroup" on all the User Configuration Document.

This command is designed to be used in a program document to maintain user signatures based on a server address book group.




Important Notes



  • The above commands will NOT override the current setting in the "Configuration" field in the User Log document. Therefore, once a user has been assigned a User Configuration it must be changed manually.
If the generategroup/checkgroup commands are executed, and the user is a member of one of these groups, then the User Configuration specified in the User Log document will be applied NOT the User Configuration specified as part of the command line.