Message Viewer

Purpose:

View, modify, and post Messages.

Usage:

The Message Viewer is a centralized location for storing Messages. Messages are packages of data instructions used for integrating with Data-Basics add-on software. This includes, but is not limited to: TechAnywhere, TimeAnywhere, SubAnywhere, PointOfSaleAnywhere, DBAnalytics, Fleetmatics Integration, FMMS Vendor Integration. Its primary use is for managing TechAnywhere and TimeAnywhere Messages by a responsible individual specifically trained for this task by a Data-Basics Support Rep. Untrained individuals should NOT make ANY changes to Messages.

Important Fields:

Message ID:
Unique value automatically generated by the application. Each application may have its own naming convention for IDs for different reasons.

Process ID: Error Profile ID:
Reserved for future use.

Message Status:
A status given to the Message to determine what stage of the posting process the Message is in. Each application may have its own status convention. Here are just two examples.

TechAnywhere example:

PostPending = New Message not yet posted by the TechAnywhere Event Manager.

PostedByUser = Message currently in process of being posted.

Posted = Message successfully posted.

Failed = Message attempted to post, data contents prevented successful post. Needs addressed to fix.

Fleetmatics example:

ToSend = Queued up data to be processed by the Fleetmatics Integration Software.

Response = Received successful response back from Fleetmatics. SAMPro to post response.

Available = Message successfully posted and now available to be reused another time.

Source Table DB Name:
If the Message contents (‘Text’) is greater than 5,000 characters, the Message will be too large to fit and must be moved over to a different database table that provides more space. The Large Object (lrgeobjct) table is used for this purpose. This is commonly used for TechAnywhere Messages, but is available to be used for any Message Type if needed.

Source Table RN:
If the Large Object table is required to store the Message contents, the RN is referenced here.

Date: Time:
Date and time of when the Message was created.

Submitted By:
User or application responsible for creating the Message.

Message Type:
Software application to indicate the source of the Message. It also determines which SAMPro function will be responsible for posting the Message.

Action:
Different applications have their own set of Actions. Actions indicate the type/content to determine how the SAMPro function will post the Message.

Message Text:
Contents of the Message. Should not be used for editing as Export/Import buttons are better for managing. If contents are larger than 5,000 characters, this field will say the contents are too large to fit and indicates the information is stored in the Large Object table instead. To view/modify the contents, you must first export the Message.

Export Message (button):
Exports the contents of the Message into a TXT file for viewing/editing. The file will export to a subfolder in the SAMPro root directory in the format of ‘^SAMProRoot^\^MessageType^\^MessageID^.txt’ (Ex. S:\SAMPro\TechAnywhere\1234567890.txt). In the event of a Message post failure, exporting the Message to TXT file is the easiest way for fixing.

Import Message (button):
Use this button after exporting and editing a Message to address a failure. This will import the Message to attempt another post. The status will be changed back to ‘PostPending’ to post another time.

Post Message (button):
For manually posting a single Message. Typically Message posting is handled by the appropriate Event Manager Service, but this gives you the opportunity to post a one off Message. This only works for Message Types of TechAnywhere, TimeAnywhere, and SubAnywhere.

Export All Failed (button):
Similar to the Export Message button, this button will export all Messages with a Status of Failed and of the same Message Type.

Import All Failed (button):
Similar to the Import Message button, this button will import all Messages with a Status of Failed and of the same Message Type.

Note on Export/Import/Post Buttons:
Typically only used for TechAnywhere and TimeAnywhere Type Messages for fixing failures..