Journal file format for administration actions

A journal file for administration activity records IBM SmartCloud® Notes® administrator actions.

File name

The name of the compressed file that you download is <date>LIVE_ADMIN.txt.gz, where <date> is the date that the journal was written, in YYYY-MM-DD format. For example: 2015-03-23.LIVE_ADMIN.txt.gz.

Syntax

Each record in the journal file conforms to the following syntax:

date user email (id=subscriberId, customerId=customerId) performed ACTION 
with outcome OUTCOME [reason=REASON][(EXTRA)]
Notes:
  1. To fit the width of this page, the record syntax is shown on several lines. In the journal file, each record is a single line.
  2. Content between [ and ] is only present if applicable to the recorded event.

Parameters

date

The date and time that the event occurred at UTC. For example: 2015-06-30T13:23:47+0000

email

The email address of the person who performed the action.

subscriberId

The unique identifier of the person who acted.

customerId

The unique number that identifies your company in the service.

ACTION
A text value described in one of the following tables that indicates the action. Each table corresponds to a set of pages in the SmartCloud Notes Administration interface.
Table 1. Actions on the Account Settings pages
Action Text value in journal file
Set directory synchronization server in a hybrid environment. (Account Settings > Directory Sync Server) SET_DIRSYNC_SERVERS
Set passthru server in a hybrid environment. (Account Settings > Passthru Server ) SET_PASSTHRU_CONFIG
Set mail routing server in a hybrid environment. (Account Settings > Mail Routing Server) SET_MAIL_ROUTING_CONFIG
Set a base name for mail servers in a hybrid environment. (Account Settings > Mail Server Base Name ) SET_VIRTUAL_SERVER_BASE_NAME
Set the instant messaging community. (Account Settings > Instant Messaging) SET_STCOMMUNITY_PREFERENCE_OPTIONS
Set default time zone. (Account Settings > Default Time Zone) SET_DEFAULT_TIMEZONE
IBM customer service representative sets inbound Internet domain for your company (Account Settings > Inbound Internet Mail Routing) SET_INBOUND_INTERNET_DOMAINS
IBM customer service representative verifies domain ownership. (Account Settings > Internet Domain Verification > Force Ownership) OVERRIDE_INTERNET_DOMAIN_VALIDATION
Complete the final step of Internet domain verification. (Account Settings > Internet Domain Verification > Begin Verification) SET_INTERNET_DOMAIN
Enable administrator notifications. (Account Settings > Email Notifications) SET_MAIL_NOTIFY_OPTIONS
Set email and calendar options. (Account Settings > Email & Calendar Options) SET_CUSTOMER_MAIL_OPTIONS
Set mail limits. (Account Settings > Email Management, Limit Message Size, External Forwarding) SET_CUSTOMER_MAIL_LIMITS
Set the display of Notes links in the web client. (Account Settings > Email Management > Link Style) SET_CUSTOMER_LINK_STYLE
Set the length of time mail remains in the Trash folder and user ability to empty the Trash. (Account Settings > Email Management > Configure Mail Retention in the Trash Folder) SET_SOFT_DELETE_OPTIONS
Delete older email. (Account Settings > Email Management > Delete Older Email) SET_MAIL_MANAGEMENT
Validate an on-premises SMTP host that is used for routing to external domains. If validated, set the host. (Account Settings > Email Management > Manage Routing to External Internet Domains > SMTP server) VALIDATE_SMTP_HOST; SET_SMTP_HOST
Enable IMAP access. (Account Settings > IMAP Email Access) SET_IMAP_OPTIONS
Set Notes password expiration or synchronization options. (Account Settings > Password Management) SET_PASSWORD_OPTIONS
Set name finder options. (Account Settings > Name Finder) SET_GALACTIC_ADDRESS_PICKER_OPTIONS
Set journaling options. (Account Settings > Journaling Options) SET_JOURNALING_OPTIONS
Table 2. Actions on the Users and Groups pages
Action Text value in journal file
Apply mail template. (Users > Apply Mail Template) SET_MAIL_TEMPLATE
Apply an extension forms file. (Users > Apply Extension Forms File) SET_USER_FORMS_EXTENSIONS
Change access to one mail file. (Users > Available actions for this users > Manage mail file access) POST_ACL_REQUEST_USER
Change access to multiple mail files through a batch request. (Users > Batch request > Access control) POST_ACL_REQUEST
Delete the SmartCloud Notes user data that is associated with a deleted user account or a deleted subscription. (Users > Deleted Users) DELETE_USER_DATA
Reset the password on a user's IBM® Notes ID. (Users > Reset IBM Notes Password) RESET_USER_PASSWORD
Manage IBM Traveler devices. (Users > Manage IBM Notes Traveler Devices) SET_TRAVELER_DEVICES
Table 3. Actions on the Mail Templates and Extensions Forms File pages
Action Text value in journal file
Set default mail template. (Mail Templates > Custom Mail Templates, Standard Mail Templates > Set as default) SET_DEFAULT_MAIL_TEMPLATE
Delete custom mail template. (Mail Templates > Custom Mail Templates > Delete Selected) CUSTOM_MAIL_TEMPLATES_DELETE
Set a default extension forms file. (Extension Forms Files > Set as Default) UPDATE_CUSTOMER_FORM
Apply an extension forms file.(Extension Forms Files > Apply to Users) SET_USER_FORMS_EXTENSIONS
Delete an extension forms file. (Extension Forms Files > Delete) SET_USER_FORMS_EXTENSIONS and UPDATE_CUSTOMER_FORM
Table 4. Actions on the Provisioning pages
Action Text value in journal file
Provision users with new mail files in a hybrid environment.(User Provisioning) PROVISION_HYBRID_USERS
Create a control document for mail file transfer. (Done by transfer manager.) MIGRATE_CREATE_NEW_CONTROL_DOC
Provision users with transferred mail files. (User Provisioning with Mail File Transfer) MIGRATE_PROVISIONED_USERS
Import users with transferred mail files. (Done by transfer manager.) MIGRATE_IMPORT_USERS
Cancel provisioning of users with transferred mail files. MIGRATE_CANCEL_PROVISIONING_USERS
Restart provisioning of users with transferred mail files. MIGRATE_RESTART_USERS
Cancel a control document that is used for mail file transfer. (Done by transfer manager.) MIGRATE_CANCEL_CONTROL_DOC
Set FTP password for mail file transfers. (Done by transfer manager.) SET_MIGRATE_FTP_PASSWORD
OUTCOME

The result of the action. Can be SUCCESS or FAILURE.

REASON

If the outcome of an event is FAILURE, the reason is given, for example, authentication failure or account expired.

EXTRA

Contains additional information that is relevant in the context of some actions.

Examples

Note: To fit the width of this page, the example records are shown on more than one line. In the journal file, each record is a single line.
  1. The administrator branney@renovations.com enables the Allow users to empty the Trash folder option in the Email Management page:
    2015-02-01T19:08:45+0000 user branney@renovations.com (id=60364110,
customerId=20784294) performed SET_SOFT_DELETE_OPTIONS with outcome SUCCESS
(allowEmptyTrash="true")
  2. The administrator jchetelat@renovations.com disables password synchronization and also sets a Notes password expiration interval of 120 days in the Password Management page:
    2015-02-01T19:21:46+0000 user jchetelat@renovations.com (id=20166395,
customerId=20784294) performed SET_PASSWORD_OPTIONS with outcome SUCCESS 
(pwSync="false", expiration="120", isEnabled="true")
  3. Administrator branney@renovations enables the Do not allow automatic forwarding to external addresses option and also configures an incoming message size limit of 500KB in the Email Management page.
    2015-02-01T19:08:45+0000 user branney@renovations.com (id=id=60364110,
customerId=20784294) performed SET_CUSTOMER_MAIL_LIMITS with outcome SUCCESS
(restrictExternalForward="1", maxMsgSizeKb="500")