Lists - New List

<< <%SKIN-STRTRANS-SYNCTOC%> >>

Lists - New List

Overview

 

Create a AT&T GSMS list.

 

Click the 'Address Book' tab at the top of the interface to open the Address Book drop-down menu.

 

Click on the button.

 

Choose 'Add a new shared list' or 'Add a new personal list'.

 

'Shared' lists can be accessed by any users belonging to the parent customer, while 'personal' lists belong to the current user.

 

 

There are up to 3 visible tabs (click to jump to section):

 

List Information - Mandatory list name and optional description/report presentation fields

 

Content - Add list content.

 

List Delivery Schedule - Choose various scheduling options for keeping your list up to date.

 

 

 

Description

 

New List

 

 

List Information

 

 

Name

 

The name of the order/broadcast. This is for internal use only and is not visible to message recipients.

 

Description

 

Type/paste any other information that will help identify the order.

 

New Photo

Personalize your group by adding a unique photo to the profile.

 

Note: Image size can be a maximum of 10Kb.

 

List Owner

 

Indicates whether the list is 'Personal' or 'Shared'. 'Shared' lists can be accessed by any users belonging to the parent customer, while 'personal' lists belong to the current user.

 

List Presentation

 

Allows you to provide multiple fields in a list to be presented in message reports, a more meaningful data set than a mobile number. This field can utilize either plain text, or valid fields as listed below:

 

The 'List Presentation' field utilizes braces '{' '}' around a number e.g. {2} to represent field {2} of the list.

 

•e.g. {3} {4} - {5} [{6}] - {2}

 

Would represent the following output:

 

LIST_FIELD_3<SPACE>LIST_FIELD_4<SPACE><DASH><SPACE>LIST_FIELD_5<SPACE><OPEN_SQUARE_BRACKET>

LIST_FIELD_6<CLOSE_SQUARE_BRACKET><SPACE><DASH><SPACE> LIST_FIELD_2

 

•e.g. Static Content

 

MAIL-ORDER-CAMPAIGN

 

The data within the messages summary would display 'MAIL-ORDER-CAMPAIGN' as the RECIPIENT (Outbound) or ORIGINATOR (Reply), together with the MSISDN in the message reports when exported.

 

 

 

The list presentation has a limitation of 1kb of data.

 

 

 

Content

This section will display different fields depending on the 'Method' selection. There are several methods for creating list data:

 

•Retrieve a List over FTP (Automatic) - Provide URL, username/password information to upload a csv file from an (external) FTP server.

 

•Text - Type data in 'Content' field.

 

•Upload - Supply a comma separated variable (.csv), Excel (.xlsx) or text (.txt) file using the 'Import List' field.

 

Retrieve a List over FTP (AUTOMATIC)

 

Data can be scheduled to be automatically uploaded from an external FTP site (automatic lists). These uploads can be scheduled to occur at specific times or on a recurring basis.

 

Please note that you must provide and maintain your own FTP server to receive or provide files.

 

Upload list type's Retention Policy can be scheduled by users and determines how long the lists are retained within the system. The available choices are 'NONE', 'DELETE AFTER USAGE', '7 DAYS', '14 DAYS', '30 DAYS' or '90 DAYS'. The default Retention Policy value is '30 Days'. Users can modify the retention policy per List, as per their specific needs.

 

When AUTOMATIC list is processed by SMS Broadcast order, email is sent to the notification list configured under SMS Company Preference page. The email contains information of total recipients, total sent and total discarded.

 

As a user creating a list, you can add a launch date time stamp for the message to be sent using the column header 'launchTimestamp'. This can be used when the list method is TEXT or UPLOAD or AUTOMATIC or AUTOMATIC_API and File/Content Starts with HEADER LINE.

 

<destination,firstName,launchTimestamp>

 

 

For Example ; 447545430377,Mike,2020-06-11T07:00:00.00+01:00.

 

The format for the Timestamp element is <YYYY-MMDDThh:mm:ss.sTZD>.

 

The List can also have a recurring delivery schedule mentioned within the List's Columns. When creating a list the header line can optionally contain a 'recurrence' field e.g. destination,firstname,recurrence.

For list items you can optionally set the recurrence to daily, weekly, monthly or yearly (case insensitive) 447545439377,Mike,yearly.

 

 

Note: If the list item has 'launchTimestamp' set, the recurrence interval should be relative to the 'launchTimestamp'.

 

For Example; launchTimestamp = 20th June 2020 and recurrence = Yearly then the recurrence will be 20th June 2021.

 

If the list item doesn't have 'launchTimestamp' set, the message will be sent immediately and the recurrence will be relative to the date/time the message was sent.

 

Users can add short URLs to their Broadcast Orders by adding the URL to their list item under the column name 'ShortURL'.

Create a list with a header field 'ShortURL' and add a list item under the field ShortURL :

 

Format: destination,firstName,ShortURL

 

For Example ; 447545430377,Mike,www.sopranodesign.com

 

 

 

Users can enter a valid source address as a column entry in the format displayed in the below Example.

 

 

 Automatic Content

 

 

 

 

Method

 

Select 'AUTOMATIC' from the drop-down menu.

 

Retrieval Frequency

 

Select the interval at which the list data will be retrieved from the external FTP site:

 

•DAILY

 

•FORTNIGHTLY

 

•HOURLY

 

•IMMEDIATELY

 

•MONTHLY

 

•ONCE

 

•WEEKDAY

 

•WEEKEND

 

•WEEKLY

 

•EVERY 5 MINUTES

 

URL

 

Type/paste location URL for the external site where the file will be retrieved from. Alternatively, files can be delivered toward an internal server by AT&T.

 

Broadcast messages can be automatically triggered whenever lists are retrieved/delivered by setting 'TRIGGER' as the 'Delivery Frequency' when sending a new SMS Broadcast.

 

 

If an auto-list fails due to an invalid or corrupted file type, an error notification will be sent to a specified email address containing the following text:

 

'The automatic list '$Automaticlistname' attempted to retrieve the file '$Filename' at $date $time. This file does not appear to be in a plain text 'Comma Separated Value' (CSV) format and it has been rejected on this basis.

 

Automatic lists only support plain text 'Comma Separated Value' (CSV) format. Please check that the file mentioned above has been correctly saved in this format before making it available for future collections.'

 

 

If data within one or more rows is considered to be invalid, an email notification will also be sent to the user. To determine whether a single row in a list is invalid, we look at the the following rules:

 

•If the first field has alpha characters and numbers, we will remove non-numeric numbers and attempt to treat as a mobile number before determining if there is an error. Example: if first CSV field is '12912345678ABC', we will trim the 'ABC' and treat this as a mobile number '12912345678'.

 

•If the first field contains a TAB we will treat this row as being invalid.

 

•Check to see if the overall length of the string for the number is <= 15 characters.

 

•Remove whitespace, -, (, ), \, + from the mobile number.

 

•Expect that the mobile number is all digits, and contains at least one digit.

 

•If the row is just commas (no data) we will not send an error, and the row will be treated as an empty line

 

•If the first CSV field is less than 9 characters (after trimming carriage returns), we will treat this as an invalid line

 

•If the file is detected to be a PDF, JPG, GIF, Open Office document or MS Office Document then the file would be considered invalid.

 

•If there is no valid mobile number in the first value of the list.

 

 

Username

 

The FTP username credentials.

 

Start Date

 

The date when file retrieval should commence. Click icon to select a date.

 

Source File Encoding

 

Select from the drop-down menu (leave as default unless you wish to display foreign characters):

 

•Big5

 

•Big5-HKSCS

 

•GB18030

 

•GB2312

 

•GBK

 

•ISO-8859-1

 

•ISO-8859-11 Thai

 

•ISO-8859-2

 

•ISO-8859-3

 

•ISO-8859-4

 

•ISO-8859-5 Cyrillic

 

•ISO-8859-6 Arabic

 

•ISO-8859-7 Greek

 

•ISO-8859-8 Hebrew

 

•ISO-8859-9

 

•US-ASCII

 

•UTF-16

 

•UTF-8

 

Protocol

 

Select from the drop-down menu:

 

•FTP

 

•SFTP

 

File Name

 

The name of the file to retrieve. You can type {date} within the file name and it will be replaced by today's date - e.g. {yyyyMMdd} for daily or {yyyyMMddHH} for 'Hourly'.

 

Password

 

The FTP password credentials.

 

Start Time

 

The time when file retrieval should commence.

 

Rename Once Collected

 

Click check box to indicate that you would like the file to be renamed and appended with the '.COLLECTED' extension after retrieval.

 

Note: If this feature is selected and the FTP user does not have sufficient write access to the FTP server path, the list retrieval will fail.

 

Ignore Duplicated Files

Click check-box to compare the time-stamp of the new file to the last uploaded file with identical names.

Suppress Email Notifications

Check this box if you do not want to receive email notifications when no remote file available and/or retrieval fails.

Notification List

Contains the list of people who would receive notifications once the SFTP file processing has completed.

File Starts With

Choose "Header Line" to indicate if the first row of the sheet is a header (for example, Column name) or choose none if not applicable.

Destination Column

Indicates which column contains the recipient's destination details.

Once a list has been saved, the 'Method' and 'Retrieval Frequency' fields cannot be changed. The list must be cloned to allow this action.

 

 

If the file does not exist on the server the Automatic FTP process will retry the retrieval every 5 minutes for up to an hour. If the file is still not available no list will be created for the period and an email will be sent to whomever last modified the List order notifying them of the event.

 

Email Content will be something like:

 

The system has tried to retrieve the file [Name=FILE_NAME] from FTP [FTP_URL] for automatic list [ID=LIST_ID, Name=LIST_NAME every 5 minutes for a period up to X minutes but failed. Please check auto list configuration.

 

 

 

If more than one FTP file is located, both files will be retrieved, and each will generate a list.

 

If the file transfer fails, the incomplete file will be discarded and no list will be generated.

 

The above is also dependent on your 'Retrieval Frequency' selection:

 

•IMMEDIATE - No retry

•5 MINUTES - No retry. The system will continue to poll for files at the next interval.

 

 

 

If the file retrieval is successful:

 

•The file content will be stored into persistent storage (list created) then it will inspect the content for processing.

 

•During inspection of content, if any line was found not to contain a valid mobile number, this line will be skipped. All skipped lines will be collected and an email will be triggered to the order owner listing the entries in the file that were skipped and not included in the broadcast.

 

Retrieve a List over FTP (AUTOMATIC_API)

 

Data can be scheduled to be automatically uploaded from an external FTP site (automatic_api lists). These uploads can be scheduled to occur at specific times or on a recurring basis.

 

Please note that you must provide and maintain your own FTP server to receive or provide files.

 

Upload list type's Retention Policy can be scheduled by users and determines how long the lists are retained within the system. The available choices are 'NONE', 'DELETE AFTER USAGE', '7 DAYS', '14 DAYS', '30 DAYS' or '90 DAYS'. The default Retention Policy value is '30 Days'. Users can modify the retention policy per List, as per their specific needs.

 

 

Automatic_API Content

 

 

 

 

Method

 

Select 'AUTOMATIC_API' from the drop-down menu.

 

Retrieval Frequency

 

Select the interval at which the list data will be retrieved from the external FTP site:

 

•DAILY

 

•FORTNIGHTLY

 

•HOURLY

 

•IMMEDIATELY

 

•MONTHLY

 

•ONCE

 

•WEEKDAY

 

•WEEKEND

 

•WEEKLY

 

•EVERY 5 MINUTES

 

URL

 

Type/paste location URL for the external site where the file will be retrieved from. Alternatively, files can be delivered toward an internal server by AT&T.

 

Broadcast messages can be automatically triggered whenever lists are retrieved/delivered by setting 'TRIGGER' as the 'Delivery Frequency' when sending a new SMS Broadcast.

 

 

 

If an auto-list fails due to an invalid or corrupted file type, an error notification will be sent to a specified email address containing the following text:

 

'The automatic list '$Automaticlistname' attempted to retrieve the file '$Filename' at $date $time. This file does not appear to be in a plain text 'Comma Separated Value' (CSV) format and it has been rejected on this basis.

 

Automatic lists only support plain text 'Comma Separated Value' (CSV) format. Please check that the file mentioned above has been correctly saved in this format before making it available for future collections.'

 

 

If data within one or more rows is considered to be invalid, an email notification will also be sent to the user. To determine whether a single row in a list is invalid, we look at the the following rules:

 

•If the first field has alpha characters and numbers, we will remove non-numeric numbers and attempt to treat as a mobile number before determining if there is an error. Example: if first CSV field is '12912345678ABC', we will trim the 'ABC' and treat this as a mobile number '12912345678'.

 

•If the first field contains a TAB we will treat this row as being invalid.

 

•Check to see if the overall length of the string for the number is <= 15 characters.

 

•Remove whitespace, -, (, ), \, + from the mobile number.

 

•Expect that the mobile number is all digits, and contains at least one digit.

 

•If the row is just commas (no data) we will not send an error, and the row will be treated as an empty line

 

•If the first CSV field is less than 9 characters (after trimming carriage returns), we will treat this as an invalid line

 

•If the file is detected to be a PDF, JPG, GIF, Open Office document or MS Office Document then the file would be considered invalid.

 

•If there is no valid mobile number in the first value of the list.

 

 

Username

 

The FTP username credentials.

 

Start Date

 

The date when file retrieval should commence. Click icon to select a date.

 

Source File Encoding

 

Select from the drop-down menu (leave as default unless you wish to display foreign characters):

 

•Big5

 

•Big5-HKSCS

 

•GB18030

 

•GB2312

 

•GBK

 

•ISO-8859-1

 

•ISO-8859-11 Thai

 

•ISO-8859-2

 

•ISO-8859-3

 

•ISO-8859-4

 

•ISO-8859-5 Cyrillic

 

•ISO-8859-6 Arabic

 

•ISO-8859-7 Greek

 

•ISO-8859-8 Hebrew

 

•ISO-8859-9

 

•US-ASCII

 

•UTF-16

 

•UTF-8

 

Protocol

 

Select from the drop-down menu:

 

•FTP

 

•SFTP

 

FTP File Name

 

The name of the file to retrieve. You can type {date} within the file name and it will be replaced by today's date - e.g. {yyyyMMdd} for daily or {yyyyMMddHH} for 'Hourly'.

 

Password

 

The FTP password credentials.

 

Start Time

 

The time when file retrieval should commence.

 

Rename Once Collected

 

Click check box to indicate that you would like the file to be renamed and appended with the '.COLLECTED' extension after retrieval.

 

Note: If this feature is selected and the FTP user does not have sufficient write access to the FTP server path, the list retrieval will fail.

 

Ignore Duplicated Files

Click check-box to compare the time-stamp of the new file to the last uploaded file with identical names.

Suppress Email Notifications

Check this box if you do not want to receive email notifications when no remote file available and/or retrieval fails.

Notification List

Contains the list of people who would receive notifications once the SFTP file processing has completed.

With Pipe Delimiter

Check this box if the pipe "|" is used as a delimiter within the file. Else, by default 'comma' is used as the delimiter.

File Starts With

Choose "Header Line" to indicate if the first row of the sheet is a header (for example, Column name) or choose none if not applicable.

Header Line

Indicate what the header line is in the file being uploaded, if the option 'File Starts With' is chosen as 'None'.

With Footer Line

Indicate if the file ends with a Footer line.

Ignore Duplicated Records

Check this box to discard duplicate records within the file.

Once a list has been saved, the 'Method' and 'Retrieval Frequency' fields cannot be changed. The list must be cloned to allow this action.

 

 

If the file does not exist on the server the Automatic FTP process will retry the retrieval every 5 minutes for up to an hour. If the file is still not available no list will be created for the period and an email will be sent to whomever last modified the List order notifying them of the event.

 

Email Content will be something like:

 

The system has tried to retrieve the file [Name=FILE_NAME] from FTP [FTP_URL] for automatic list [ID=LIST_ID, Name=LIST_NAME every 5 minutes for a period up to X minutes but failed. Please check auto list configuration.

 

 

 

If more than one FTP file is located, both files will be retrieved, and each will generate a list.

 

If the file transfer fails, the incomplete file will be discarded and no list will be generated.

 

The above is also dependent on your 'Retrieval Frequency' selection:

 

•IMMEDIATE - No retry

•5 MINUTES - No retry. The system will continue to poll for files at the next interval.

 

 

 

If the file retrieval is successful:

 

•The file content will be stored into persistent storage (list created) then it will inspect the content for processing.

 

•During inspection of content, if any line was found not to contain a valid mobile number, this line will be skipped. All skipped lines will be collected and an email will be triggered to the order owner listing the entries in the file that were skipped and not included in the broadcast.

 

Text Content

 

List data can be typed/pasted directly into the 'Text Content' field (Note: maximum number of lines accepted is 100,000).

 

 Text Content

 

 

Method

Select 'TEXT' from the drop-down menu.

 

Content

Type or paste data according to the accepted format (one record per line, comma-separated):

 

•e.g. Mobile - 12912345678,John,Smith,...(use international format for mobile number).

 

•e.g. Email - john@smith.com,John,Smith,..

•

Delimiter

Choose a field separator to be used between list items. Supported characters are Comma (,), Pipe (|) and semi-colon (;)

 

File / Content Starts With

 

Choose "Header Line" to indicate if the first row of the sheet is a header (for example, Column name) or choose none if not applicable.

 

Destination Column

Manually enter the column that contains the recipient destination information. Provide numeric values. For Example : If the recipient mobile number is in column 3, enter the value as 3 in this field.

 

Upload

 

List can be created by supplying a comma separated variable (.csv) file using the 'Upload' option.

 

Upload list type's Retention Policy can be scheduled by users and determines how long the lists are retained within the system. The available choices are 'NONE', 'DELETE AFTER USAGE', '7 DAYS', '14 DAYS', '30 DAYS' or '90 DAYS'. The default Retention Policy value is '30 Days'. Users can modify the retention policy per List, as per their specific needs.

 

 

 

 

 Upload Content


 

Method

Select 'UPLOAD' from the drop-down menu.

 

Import List

Click on 'Choose File' to select the file on the User's local Desktop. The file should be in csv format and maximum size supported is 20MB. In the csv file, the first column should be the recipient, i.e. Mobile number in national or international format for Mobile campaigns and email address for email campaigns.

 

•e.g. Mobile - 12912345678,John,Smith,...(use national or international format for mobile number).

 

•e.g. Email - john@smith.com,John,Smith,...

 

Source File Encoding

Select from the drop-down menu (leave as default unless you wish to display foreign characters):

 

•US-ASCII

•UTF-8

•UTF-16

•ISO-8859-1

•ISO-8859-2

•ISO-8859-3

•ISO-8859-4

•ISO-8859-5 Cyrillic

•ISO-8859-6 Arabic

•ISO-8859-7 Greek

•ISO-8859-8 Hebrew

•ISO-8859-9

•ISO-8859-11

•Big5

•Big5-HKSCS

•GB18030

•GB2312

•GBK

 

File Starts With

Choose "Header Line" to indicate if the first row of the sheet is a header (for example, Column name) or choose none if not applicable.

Destination Column

Indicates which column contains the recipient's destination details.

 

Upload Multiple lists via List Names

 

 

Step 1 : Click on the '+' button to open up the upload options.

 

Step 2 : Choose the option "Add List Names'

 

Step 3 : Enter the specific list by their names in the text box.

 

Step 4 : Click on 'Add' to complete the action.

     

   

List Delivery Schedule

 

Delivery Frequency

 

Select as required:

 

•DAILY

 

•MONTHLY

 

•NONE (note: Selecting 'NONE' will cause all other fields, except 'Deliver Empty Group' and 'Delete Delivered Contacts', to be 'greyed-out').

 

•WEEKLY

 

•HOURLY

 

•Every 15 mins

Delivery Method

 

Select as required:

 

•EMAIL

 

•FTP

 

•HTTP

 

•SFTP

 

Start Date

 

Commencement date for list delivery - format DD/MM/YYYY. Click the icon to select a date.

 

End Date

 

Termination date for list delivery - format DD/MM/YYYY. Click the icon to select a date.

 

Start Time

 

Commencement time for list delivery in '24-hour' time (e.g. '15:00' = Three o'clock in the afternoon).

 

End Time

 

Termination time for list delivery in '24-hour' time (e.g. '16:00' = Four o'clock in the afternoon).

 

Update Option

 

Click radio button as required:

 

•New Content - When a list is updated via scheduled delivery, only new content will be uploaded to the list.

 

•Complete Content - When a list is updated via scheduled delivery, the full content will be replaced.

 

Naming Convention

 

Naming convention allows the user to define the naming format of the file that they would like to create as part of the list delivery. The naming convention can be made up of alphanumeric characters, with the following character strings defining date variables:

 

•yyyyMMddHHmm, e.g. 200909011015

 

•yyyyMMdd, e.g. 20090901

 

•yyyyMdHHmm, e.g. 20099110

 

•yyyyMd, e.g. 200991

 

•yyMMddHHmm e.g. 0909011015

 

•yyMMdd, e.g. 090901

 

•yyMdHHmm, e.g. 09911015, for 1st September, 2009 at 10:15am

 

•yyMd, e.g. 0991, for 1st September, 2009 at 10:15am

 

e.g. 'mycrmlist-yyyyMMdd' would equate to 'mycrmlist-20090901.csv'

 

Deliver Empty File

 

If box is checked, CSV file will still be delivered even if it contains no data.

 

Delete Delivered List Items

 

Remove delivered list items.

 

 

 

Settings

Note: This section will not appear if user has selected 'NONE' in the 'Delivery Frequency' drop-down menu in 'Delivery Schedule' section.

 

Email Settings                                                                                                                        

 

 

Email Destination/URL

 

The delivery destination email address (if Delivery Method is 'EMAIL') or URL (if 'Delivery Method' is 'FTP', 'HTTP' or 'SFTP').

 

Password

 

User's login password.

 

Username

 

User's login username (same as registered email address).

 

 

 

After the required changes have been made:

 

 

Store changes and exit

 

 

Undo any changes and exit.