<< <%SKIN-STRTRANS-SYNCTOC%> >> Reports - Schedule a Message Report |
Overview
Deliver filtered message report(s) as a CSV or ZIP file, at a scheduled frequency.
Click button on 'Scheduled Message Report Summary' screen.
|
Description
New Message Report Order |
Summary
Name
|
Name the report.
|
Description
|
Type/paste any extra descriptive information which might be useful.
|
Search Options
Message Type
|
The type of message to run the report for. The options include: All, SMS, , RCS, WhatsApp or Email.
|
Message Status
|
The status of the messages to report on. Options include, 'ALL', 'Sent', 'Received' and 'Failed'.
|
Data Scope
|
Whether the report is querying the client application or the connection from AT&T GSMS towards the operator network.
|
Customer
|
The customer/sub-customer to run the report for. If you do not have any sub-customers, then this will reflect your root customer name.
|
User
|
The user who you wish to report activity for.
Note that if the root customer is selected, data for that customer and all sub-customers will be returned.
|
Address
|
The destination mobile that you wish to report activity for.
|
Cost Center Label
|
The cost Center that you wish to report activity for.
|
Order Name
|
The order name that you wish to report activity for.
|
Start Date/Time, End Date/Time
|
The time period of the activity you wish to report for.
These fields will be made inactive if you choose 'DAILY' or 'MONTHLY' as the 'Delivery Frequency' in 'Delivery Options' tab - see next section for more details.
|
Column Selection
Column Selection |
The "Column Selection" tab is available for users to choose individual columns that need to be visible in the viewed / exported reports. This gives the users flexibility to be able to view only specific use-case columns. Each time the Users would like to view reports a little different, they can use the "Column Selection" feature. |
Delivery Options
Delivery Frequency |
The report may be generated at regular intervals as defined in the 'Delivery Frequency' settings. 'Delivery Frequency' options include:
•IMMEDIATE
returns the range of data defined in 'Search Options' tab > 'Start/End Date/Time' fields as soon as
•ONCE
returns the range of data defined in 'Search Options' tab > 'Start/End Date/Time' fields once only, at the scheduled date/time.
•DAILY
uses the scheduled start date/time +1 day to calculate data range, and delivers report each day until the specified end date. Overrides any dates specified in 'Search Options'.
e.g. if I schedule a report to run on Feb 5 at 12pm with a delivery frequency of Daily then the report will collect all data from Feb 4 12pm to Feb 5 12pm.
•WEEKLY
uses the scheduled start date/time +1 week (starting from Sunday and ending on Saturday) to calculate data range, and delivers report each week until the specified end date. Overrides any dates specified in 'Search Options'.
e.g. if I schedule a report to run on May 19 - Friday with a delivery frequency of Weekly then the report will collect all data from Sunday - Feb 7 12 pm to Saturday - Feb 13 12pm.
•MONTHLY
uses the scheduled start date/time +1 month to calculate data range, and delivers report each month until the specified end date. Overrides any dates specified in 'Search Options'.
e.g. if I schedule a report to run on Feb 4 12pm with a delivery frequency of Monthly then the report will collect all data from Jan 4 12pm to Feb 4 12pm.
|
File Naming Convention
|
The file naming convention for the file can be set as 'STRING' with variables representing data parameters.
File naming variables include:
•YYYY - Year (4 character format)
•YY - Year (2 characters; no padding)
•MM – Month (2 characters; no padding)
•M – Month (actual month number; no padding)
•DD – Day (2 Characters zero padded)
•D – Day (actual day; no padding)
|
Start Date
|
The date upon which the report will be scheduled to run first.
The start date can be selected from a pop-up box, or alternatively, from dd/mm/yyyy.
|
Start Time
|
The time on the start date when the report will be scheduled to run first. The start time format is hh:mm.
|
End Date
|
The time at which the report will be scheduled to run last. The end date can be selected from a pop-up box or alternatively from dd/mm/yyyy.
|
End Time
|
The time on the end date at which the report will be scheduled to run first. The end time format is hh:mm.
|
Email Settings
The report will appear as an attachment to an email.
Email delivery preferences include:
Primary Email
|
Primary email address to receive the report as a '.csv' file attachment.
|
Secondary Email
|
Secondary email address to receive the report as a '.csv' file attachment.
|
Check your mail domain rules as you may not be able to receive emailed message report order results if the email is too large. |
FTP Delivery Preferences
FTP can be used to deliver the report towards a remote server for post-processing.
FTP delivery preferences include:
URL
|
The IP address of the FTP Server upon which to deposit the report.
|
Username
|
The username of the FTP/SFTP user on the remote server.
|
Password
|
The password of the FTP/SFTP user on the remote server.
|
HTTP/URL Delivery Preferences
The report can be sent over a HTTP interface towards a web server for handling if required.
HTTP delivery preferences include:
URL
|
The IP address of the HTTP Server upon which to deposit the report.
|
Username
|
The username of the HTTP user on the remote server.
|
Password
|
The password of the HTTP user on the remote server.
|
If the volume of message report results is large, the receiving HTTP server must be big enough to accommodate them. |
Report Format
AT&T GSMS Scheduled Message Reports are provided in the following format.
Report output will be a CSV file including a header line. |
|
Over time, additional fields may be added onto the report to provide further detail. If ingesting the report content into a automated system, please include the flexibility to add additional field mapping capability. |
Once all required fields are complete:
|
Store changes and exit
|
|
If 'Delivery Frequency' is 'IMMEDIATE', this button launches the order.
|
|
If 'Delivery Frequency' is 'ONCE', or a recurring value (e.g. 'DAILY'), this button activates the order so that it will be sent at that time (and/or frequency).
|
|
Undo any changes and exit.
|