Message Log

Detail Forms: Message Response, Message

The Message Log form displays all messages that have been created in the past. You cannot create new messages on the Message Log form.

To view the actual message, click the Message tab in the lower half of the form.

To view any responses created by the recipient of the message, click the Message Response tab in the lower half of the form.

Note: If a message has Delete Immediately enabled, it will not display on the Message Log form.

All messaging features are outlined in the Messaging feature topic.

See Also:

Message Log Field Descriptions

Reset a Message

Cancel a Message

Re-Process a Message Export

Cancel a Message Export

 

Message Log Field Descriptions

Sender Num

Identifies the sender of the message.

Receiver Num

Person number identifying the recipient of the message.

Message

The body of the message.

Subject, Header, Trailer

If the message was sent via email, these fields display the components of the email message. Subject is the subject line of the email, Header is the body of the email, and Trailer is the closing line of the email.

Message Trigger Name

If the message was generated by a message trigger, this field will display the message trigger name.

Message Name

If the message was generated by a messaging rule, this field displays the name of the Message Definition that was used to generate the message.

Dialog Name

Name of the Dialog to which this message belongs. The dialog is defined on the Dialog Message form.

Dialog Message Name

Name of the message in the specified Dialog Name to which the Message text belongs. The Dialog Message Name is defined on the Dialog Element form and it is added to the Dialog Name on the Dialog Message form.

Dialog Group Id

System defined ID number for messages that belong to a particular dialog. The Dialog Group Id will display a value if the message was generated by the MESSAGE_CREATION service based on a Message Definition of type DIALOG. This column will be blank if you import your messages.

Receiver Name

First and last name identifying the receiver of the message.

Message Type

Broadcast Message: Message was created and sent from the Broadcast Message form.

Business Event Message: Message was created by a message trigger

System Alert Message: Message was generated by the MESSAGE_CREATION service based on a Message Definition of type SYSTEM or EXCEPTION.

Dialog Message: Message was generated by the MESSAGE_CREATION service based on a Message Definition of type DIALOG.

Date Created

Date and time the message was created.

For broadcast messages, Date Created is the date and time the message was sent on the Broadcast Message form.

For trigger-based messages, Date Created is the date and time the trigger occurred that activated the message.

For system, exception, and dialog messages, Date Created is the date and time the MESSAGE_CREATION service ran and generated the message.

Created By

Identifies the person that created/modified this message.

Start Date, End Date

Dates when the message is active. If the message will display on a terminal, the person must log in to the terminal during this date range to view the message. For email messages, the MESSAGE_DELIVERY service must run within this date range to send the message.

For broadcast messages, the Start and End Date are defined on the Broadcast Message form.

For all other messages, the Start Date is the current date and the End Date is the number of days past the start date that are defined in the message’s DO_NOT_DELIVER_AFTER setting.

Delivered Date

Date and time the message was delivered.

For messages that appear on the terminal or the web application pop-up form, the Delivered Date is the date and time the message was read on the terminal or web.

For email messages, Delivered Date is the date and time the MESSAGE_DELIVERY service ran and delivered the email message.

Priority

A message's Priority is defined on the Broadcast Message form (for broadcast messages), the Trigger Settings tab of the Message Policy (for message triggers), or the Message Settings tab of the Message Policy (for system, exception, and dialog messages).

High priority messages will be sent to the receiver before any other messages. If several messages are high priority, the message with the oldest Start Date will be sent or displayed first.

Medium priority messages will be sent or displayed after High and before Low priority.

Low priority messages are sent or displayed after any messages that are set to High/Medium priority.

Message Status

Cancelled - The message was cancelled on the Message Log form.

Ready for Delivery via Email - Indicates the email message has not yet been sent by the MESSAGE_DELIVERY service.

Unread – The terminal or web message has not yet been read by the recipient.

Read on Terminal – The message was read by the recipient on the terminal.

Read on Web – The message was read by the recipient in the web application.

Error – An error has prevented the message from being read.

Sent/Delivered via email: The MESSAGE_DELIVERY service delivered the message to the person’s email address.

Not Displayed – The message has not been displayed to the user. For example, a dialog message may include multiple messages that display based on the user’s response to the previous message in the dialog. If the user’s response prevents the additional messages from displaying, the status of these additional messages will be Not Displayed.

Message Medium

Terminal/Web: The message was displayed on the terminal or the web application.

Email: The message was sent via email.

External Document Num

System defined ID number for messages that originated from an import file.

Sender Name

Name of the ERP system that sent the message.

Process Status

Export status of the message.

Ready (R): The message is ready to be exported.

Complete (C): The message has been exported.

Cancelled Before (X): The export was cancelled before the message was exported.

Processing (P): The export is in process.

Processing Date

Date when the message was exported.

Update Date, Updated By

These fields display when the record was created or updated, and the person who created or updated the record.

 

The fields below are not visible by default on the Message Log form. You can select these fields in a custom Form Profile if you want to make them visible on the form.

Acknowledgement

Indicates whether the message requires the recipient to acknowledge the message in the terminal or web. This box will be checked if Acknowledgement is checked on the Trigger tab or ACKNOWLEDGEMENT_REQUIRED is set to True in the Message Settings tab of your Message Policy.

Agree Disagree

Indicates whether the message recipient will have to agree or disagree with the message when it appears on the client terminal or in a pop-up form when you log into the web application. This box will be checked if AGREEMENT_DISAGREEMENT is set to True on the Trigger tab or the Message Settings tab of your Message Policy.

Consolidate Message

Indicates whether CONSOLIDATE_EMAIL_MESSAGES is set to True on the Trigger Settings tab or the Message Settings tab of the Message Policy.

If this box is checked, the MESSAGE_DELIVERY service will group all the email messages generated by the same Message Name or Message Trigger and send them to the recipient in a single email.

Delete Immediately

Indicates whether the message had Delete Immediately checked on the Trigger tab or set to True on the Message Settings tab of the Message Policy.

If this box is checked, the message will be deleted after the user has read it (the system will permanently remove it from the database).

If this box is not checked, you must run the PURGE service to remove the message.

Dispose On Read

Indicates whether a message on the terminal will continue to appear after the user reads or acknowledges it. This box will be checked if Dispose on Read was checked on the Trigger tab or set to True on the Message Settings tab of your Message Policy.

The Dispose on Read setting does not affect messages that appear in the message pop-up form in the Shop Floor Time Web application. Once a message is viewed or acknowledged in the Shop Floor Time Web, the message will no longer appear in the message pop-up the next time you log in.

If this box is checked, the message will not appear again after the user reads, acknowledges, or agrees/disagrees with it on the terminal. If Dispose on Read is not checked, the message may appear again in the client terminal, depending on the user's response. If you click Done, the message will appear the next time you log in (the message's status remains Unread). If you click OK, Acknowledge, Agree, or Disagree, the message will not appear the next time you log in.

Do Not Purge

Indicates whether the message had Do Not Purge enabled on the Broadcast Message form, Trigger Settings tab, or Message Settings tab of the Message Policy.

If this box is checked, the PURGE service will not be able to delete the message.

 

Reset a Message

Use the Reset button on the Message Log form to change a message’s status to Unread or Ready for Delivery via Email.

Any message with a status of Read, Delivered, Error, or Cancelled can be reset. If the message will be displayed on a terminal or the web, the status will change to Unread. If the message will be emailed, the status will change to Ready for Delivery via Email.

Note: If you select a message that is part of a dialog message and you click Reset, the other messages in the dialog will also be reset.

 

Cancel a Message

Use the Cancel button on the Message Log form to cancel any messages that are Unread or Ready for Delivery via Email. The message’s status will change to Cancelled.

If a message is cancelled, the message will not be displayed to the user on the terminal/web and the MESSAGE_DELIVERY service will not send the message.

If you decide to send the message after you have cancelled it, you can use the Reset button to change the message’s status back to Unread/Ready for Delivery via Email.

Note: If you select a message that is part of a dialog message and you click Cancel, the other messages in the dialog will also be cancelled.

 

Re-Process a Message Export

Use the Re-Process button on the Message Log form to change the Process Status of a message so that it can be exported again.

If a message has a Process Status of Complete (C) or Cancelled (X) and you click Re-Process, the status will change to Ready (R). When you run your message export again, the record will be exported.

Note that Re-Process does not perform the actual export.

 

Cancel a Message Export

Use the Cancel Export button on the Message Log form to change the Process Status of a message from Ready (R) to Cancelled (X) so that the message will not be exported.

If a message has a Process Status of Ready (R) and you click Cancel Export, the status will change to Cancelled (X). When you run your message export again, the record will not be exported.

 

Message Tab

The Message tab on the Message Log form displays the text of a selected message. This form is a view-only form. Use the scroll bar next to the Message Text field to read the entire message.