Messaging Service Configuration

The Messaging Service Configuration screen allows you to edit the internal message settings of the system including which messages are logged to the database and which messages are sent via email. A list of all internal messages that are available is provided in the Internal Message Types section below.

Bookmarks to the headings on this page:

  1. Internal Message Types

To access the Messaging Service Configuration screen, click on the System Configuration System config icon icon in the top right hand corner of the screen – a drop down list will appear under this icon. From this list, select Messaging Service Configuration – the screen will appear.

The fields that are available are outlined below.

  • Log To File White List: the Log To File White List is shown in the figure below.

    The Log To File White List field
     The Log to File White List

    This field allows you to specify the internal messages that will be written to the system log file. The default value is * meaning that all internal messages will be logged. If you only want to log certain messages remove the * and add them to this field.
  • Log to File Black List: the Log To File Black List is shown in the figure below.

    The Log To File Black List field
     The Log to File Black List

    This field allows you to specify the internal messages that will not be written to the system log file. By default, the internal messages that will not be logged include asset.attributes, asset.workflow.invitation, asset.workflow.announce, asset.workflow.invitation.* and asset.workflow.announce.*. For further information on what these internal messages are, see the Internal Message Types section below.
  • Log To Database White List: the Log To Database White List is shown in the figure below.

    The Log To Database White List field
     The Log to Database White List

    This field allows you to specify the internal messages that will be written to the database and shown on the Logs screen of an asset. The default value is * meaning that all internal messages will be logged to the database. If you only want to log certain messages, remove the * and add them to this field.
  • Log To Database Black List: the Log To Database Black List is shown in the figure below.

    The Log To Database Black List field
     The Log to Database Black List

    This field allows you to specify the internal messages that will not be written to the database and are not shown on the Logs screen of an asset. By default, the internal messages that will not be logged include asset.attributes.fulllog, asset.workflow.invitation, asset.workflow.announce, asset.workflow.invitation.*, asset.workflow.announce.* and install.*. For further information on what these internal messages are, see the Internal Message Types section below.  
  • Log To Email White List: the Log To Email White List is shown in the figure below.

    The Log To Email White List field
    The Log to Email White List

    This field allows you to specify the internal messages that will be emailed to users. By default, the internal messages that will be emailed include asset.locking.forced, config.*, hipo.*, inbox.*, asset.status.notify, asset.workflow.invitation, asset.workflow.announce, asset.workflow.invitation.*, asset.workflow.announce.*, asset.workflow.stale and cron.deadlock. For further information on what these internal messages are, see the Internal Message Types section below.
  • Log To Email Black List: the Log To Email Black List is shown in the figure below.

    The Log To Email Black List field
    The Log to Email Black List

    This field allows you to specify the internal message that will not be emailed to users. This field is blank by default.

Internal Message Types

Below is a table outlining the internal messages that are available for the system. It includes the code for the message and the information that is logged to either the system log file, the database or sent in the email. The information uses keyword replacements and will substitute the keyword with information from the asset that caused the internal message.

Message Code Information that is logged
Asset Created asset New %type_code% “%asset_name%”created.
Asset Status Changed asset.status The status of "%asset_name%" was successfully changed from "%old_status%" to "%new_status%"
Asset Data Changed asset.dates The %date_type% date of "%asset_name%" was successfully changed from "%old_date%" to "%new_date%"
Asset Attribute Changed asset.attributes The value of attribute "%attr_name%" for asset "%asset_name%" has been changed
Asset Attribute Changed asset.attributes.scalar The value of attribute "%attr_name%" for asset "%asset_name%" has been changed from "%old_value%" to "%new_value%"
Asset Attribute Changed asset.attributes.fulllog The value of attribute "%attr_name%" for asset "%asset_name%" has been changed
Asset Attribute Changed asset.attributes.fulllog.scalar The value of attribute "%attr_name%" for asset "%asset_name%" has been changed from "%old_value%" to "%new_value%"
Asset Lock Forcibly Acquired asset.locking.forced User "%user_name%" has forcibly acquired the %lock_type% lock on %type_code% "%asset_name%", formerly held by user "%old_user_name%"
Asset Link Created asset.linking.create "%minor_name%" was successfully linked to "%major_name%"
Asset Link Type Updated asset.linking.type The type of link #%linkid% (between"%major_name%" and "%minor_name%") was successfully changed from %old_link_type% to %new_link_type%
Asset Link Value Updated asset.linking.value The value on link #%linkid% (between"%major_name%" and "%minor_name%") was successfully changed from %old_link_value% to %new_link_value%
Asset Link Sort Order Updated asset.linking.order The sort order of link #%linkid% (between "%major_name%" and "%minor_name%") was successfully changed from %old_sort_order% to %new_sort_order%
Asset Link Deleted asset.linking.delete "%minor_name%" was successfully unlinked from "%major_name%"
Asset Permission Set asset.permissions.grant %perm_name% permission has been granted on asset "%asset_name%" for "%user_name%"
Asset Permission Set asset.permissions.deny %perm_name% permission has been denied on asset "%asset_name%" for "%user_name%"
Asset Permission Deleted asset.permissions.delete %perm_name% permission has been deleted on asset "%asset_name%" for "%user_name%"
HIPO Herder hipo.force_kill FORCE KILL %hipo_code_name%
User Account Locked system.security.locked User "%user_name%" has had their account locked after %num_attempts% unsuccessful login attempts
User Logged In system.security.login User "%user_name%" logged in
User Logged Out system.security.logout.manual User "%user_name%" logged themselves out
User Login Failed system.security.login.failed User "%login_name%" failed to login (%failure_reason%)
User Automatically Logged Out system.security.logout.idle User "%user_name%" was logged out since they were inactive for %timeout% seconds
User Automatically Logged Out system.security.logout.staleauth User "%user_name%" was logged out since they hadn't authenticated for %timeout% seconds
Security Alert system.security.alert Possible attempt to steal session detected!
Install install.package.success %package_name% Package Installed Successfully
Install install.package.fail %package_name% Package Install FAILED
Install install.package.deferred %package_name% Package Deferred for Dependency Resolution
Install install.package.uninstall Uninstalled %package_name% Package
Install install.asset_type.uninstall UNINSTALLED the following asset types as they are no longer recognised by any package: %type_code_list%
Install install.system_assets.success %package_name% Package System Asset Creation Succeeded : %num_assets% Assets Created
Install install.system_assets.fail %package_name% Package System Asset Creation FAILED
Install install.authentication %auth_type_name% Authentication Type Created : %assetid%
Install install.prefs Global Preferences Done
Install install.event_listeners Event Listeners Done
Potential CRON Manager Dead Lock Issue cron.deadlock The cron manager for the system "%system_name%" has attempted to run %num_attempts% times, but has not been able to for one of two reasons: 1) An existing cron manager is currently running an extremely long running job. 2) Something has caused the cron manager to exit uncleanly and the lock wasn't able to be removed. Check the cron error log (in %error_log_path%) for any information. (System RootUrls : %root_urls%)
Forced Failure of %cron_type_code% cron.forced_fail The job "%cron_job_name%"(#%assetid%) has failed to run %num_attempts% times. It will be removed from the cron manager and will NOT be run again.
Termination of Cron Manager cron.term The cron manager for the system"%system_name%" fatally triggered an error, terminating the cron manager's run. Check the cron error log (in "%error_log_path%") for any information. (System Root Urls : %root_urls%)
%cron_type_code% Success cron.job.success %cron_job_name% Scheduled :%cron_job_when% Completed Successfully %exec_msg% Error Messages : %errors%
%cron_type_code% Failure cron.job.fail %cron_job_name% Scheduled :%cron_job_when% Failed %exec_msg% Error Messages : %errors%
%cron_type_code% Success cron.job.success.incomplete %cron_job_name% Scheduled :%cron_job_when% Successful, but there is more work to do %exec_msg% Error Messages : %errors%
%cron_type_code% ERROR cron.job.error %cron_job_name% Scheduled :%cron_job_when% ##### RETURNED AN INVALID RESULT FROM _exec() # Returned Value : %result% #(Translated : %result_bits%)#####%exec_msg% Error Messages : %errors%
Termination of %cron_type_code% cron.job.term The job "%asset_name%"(#%assetid%) fatally triggered an error and terminated the cron script. It has been removed from the cron manager. Error Messages : %errors%
Trigger Execution Success trigger.success SUCCESS Trigger "%trigger_name%"(#%triggerid%), Event: "%event%" broadcast by Asset:"%asset_name%" (#%assetid%)
Trigger Execution Failure trigger.invalid INVALID (Trigger components could not be loaded) Trigger "%trigger_name%" (#%triggerid%), Event: "%event%" broadcast by Asset: "%asset_name%" (#%assetid%)
Asset Made Live  asset.status.notify %type_code% "%asset_name%"has gone live from "%status%". You can view the asset
Workflow Approval Required asset.workflow.invitation %type_code% "%asset_name%"is currently in workflow. You are now required to approve or reject the changes made to "%asset_name%" so the workflow process can continue. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Workflow Approval Required asset.workflow.invitation.progress %type_code% "%asset_name%"is currently in workflow and has progressed from step %old_step% to step %new_step%. You are now required to approve or reject the changes made to "%asset_name%" so the workflow process can continue. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Asset Safe Edit Cancelled asset.workflow.log.safeedit.cancel User "%user_name%" has cancelled the safe edit of %type_code% "%asset_name%". "%asset_name%" has reverted to the previously saved version and the status of "%asset_name%" is now %status%
Asset Review Cancelled asset.workflow.log.review.cancel User "%user_name%" has started a safe edit of %type_code% "%asset_name%" during a review. The review has been cancelled and the status of "%asset_name%" is now %status%. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Asset Review Cancelled asset.workflow.review.cancel User "%user_name%" has started a safe edit of %type_code% "%asset_name%" during a review. The review has been cancelled and the status of "%asset_name%" is now %status%. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Review Complete asset.workflow.log.review.complete The review process for %type_code% "%asset_name%" has been completed. "%asset_name%" is now live. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Workflow Started asset.workflow.log.started User "%user_name%" has requested %type_code% "%asset_name%" to go live from %status%. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Asset Changes Approved asset.workflow.log.approve User "%user_name%" has approved the changes to %type_code% "%asset_name%". A full report for the Workflow of "%asset_name%" can be found on the
Asset Changes Approved asset.workflow.announce.approve User "%user_name%" has approved the changes to %type_code% "%asset_name%". A full report for the Workflow of "%asset_name%" can be found on the
Asset Up For Review asset.workflow.review User "%user_name%" has placed %type_code% "%asset_name%" up for review. You are now required to approve or reject the changes made to "%asset_name%" so the workflow process can continue. preview this asset.]]>
Asset Up For Review asset.workflow.log.review User "%user_name%" has placed %type_code% "%asset_name%" up for review. preview this asset.]]>
Asset Changes Rejected asset.workflow.log.reject User "%user_name%" has rejected the changes made to %type_code% "%asset_name%". The status of "%asset_name%" has reverted to %status%. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>}
Asset Changes Rejected asset.workflow.announce.reject User "%user_name%" has rejected the changes made to %type_code% "%asset_name%". The workflow process has been cancelled. A full report for the Workflow of"%asset_name%" can be found on the preview this asset.]]>}
Workflow Completed asset.workflow.complete The workflow process for %type_code%"%asset_name%" has been completed. "%asset_name%" is now approved and can be made live by an administrator. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Workflow Completed asset.workflow.log.complete The workflow process for %type_code% "%asset_name%" has been completed. "%asset_name%" is now approved and can be made live by an administrator. A full report for the Workflow of "%asset_name%" can be found on the preview this asset.]]>
Workflow User Log asset.workflow.userlog %message%
Stale Workflow Step asset.workflow.stale Asset "%asset_name%"[#%assetid%] has been in step "%step%" of workflow schema"%schema%" since %started_time%, and has exceeded the %expiry_time% time frame within which this step is meant to be completed. You may want to consider intervening to progress this workflow by visiting the asset's
System Config Updated config.system_config %setting% changed from %old_value% to %new_value%
External Tools Config Updated config.external_tools_config %setting% changed from %old_value% to %new_value%
Squiz Server Config Updated config.squiz_server_config %setting% changed from %old_value% to %new_value%
Messaging Service Config Updated config.messaging_service_config %setting% changed from %old_value% to %new_value%
HIPO Config Updated config.hipo_config %setting% changed from %old_value% to %new_value%
Password Rules Config Updated config.password_rules_config %setting% changed from %old_value% to %new_value%
Proxy Authentication Config Updated config.proxy_authentication_config %setting% changed from %old_value% to %new_value%
Global Preferences Updated prefs.system %type_code% preference variable %setting% changed from %old_value% to %new_value%
%subject% inbox.message %body%
%subject% inbox.sent %body%

PreviousNext