SMS Broadcast System Version 3.0 Last Revised October 16th, 2005 Copyright 2005 by Etisalat. All rights Reserved 1
Inde 1. SCOPE 4 2. PREREQUI SI TES 4 3. I NTENDED USERS 4 4. SECURI TY 4 5. I NTRODUCTI ON 5 5.1 Site Map 5 5.2 New Features 6 1. Enhanced Security 6 2. Audit Service 6 3. Arabization 6 5.3 Application I nterface 7 5.3.1 Administrator I nterface 7 5.3.2 Operator I nterface 7 6. WEB USER I NTERFACE 8 6.1 Login 8 6.1.1 Blocked Account 9 6.1.2 SMS Broadcast Link From the Login Page 10 6.1.3 Contact Us Page 11 6.2 Administrator Web I nterface 12 6.2.1 Main Page 14 6.2.1.1 Personal I nfo 16 6.2.1.2 Change Password 17 6.2.1.3 Audit View 18 6.2.1.3.1 Audit View Form 20 6.2.1.3.2 Activity Log 21 6.2.2 Message 22 6.2.2.1 Create Predefined Message(s) 24 6.2.2.2 Delete Eisting Message(s) 25 6.2.2.3 Edit a Message 26 2
6.2.2.4 Send Customized Message(s) 27 6.2.2.5 Send Predefined Message(s) 28 6.2.2.6 Advanced Message Scheduler 29 6.2.2.7 View Reports 31 6.2.2.8 View Campaign Details 32 6.2.3 Target 33 6.2.3.1 Add A New Target 34 6.2.3.2 Add Bulk Targets 35 6.2.3.3 Search For A Target 36 6.2.3.4 Delete Targets 37 6.2.3.5 Edit A Target 38 6.2.3.6 Add To Selection List 39 6.2.3.7 Manage Selection List 40 6.2.4 Operator 42 6.2.4.1 Create A New Operator 43 6.2.4.2 Attach An Operator To Current Account 44 6.2.4.3 Delete Operator 45 6.2.4.4 Send Operator Password 46 6.2.5 Group 47 6.2.5.1 Create A New Group 48 6.2.5.2 Delete An Eisting Group Or A Number Of Groups 49 6.2.5.3 Rename A Group 50 6.3 SMS Broadcast Help 51 3
1. SCOPE The scope of this document is to give a complete description of the features and functionalities of the web-based SMS Broadcast System. 2. PREREQUI SI TES In order to use the web-based SMS Broadcast System you need to have A valid SMS Broadcast account set-up with Etisalat A web browser with an internet account 3. I NTENDED USERS There are currently two roles for the customers intending to use the application; 1. Administrator role 2. Operator role 4. SECURI TY Only authorized registered administrator or operator(s) can logon to the application by entering their mobile number and a password. The Administrator created by Etisalat or the Operators created by the administrator, will receive an SMS on their mobiles with the generated password. To prevent operators from managing the account details, some functionality will not be available unless the user is an administrator. 4
5. I NTRODUCTI ON The SMS Broadcast System provides the user with a proficient way of using the Short Messaging Service (SMS) through a web-based application. The system is designed to fulfill the user s needs in a user-friendly interface and reduce the number of clicks. 5.1 Site Map 5
5.2 New Features 1. Enhanced Security SMS Broadcast became more secure than ever after employing a 128 bit encryption for sensitive data. Communication with the site is secured using ecomany Digital Certificates. Furthermore, passwords are hashed and stored using very secure algorithms. 2. Audit Service The Audit View section allows the administrators to monitor the actions made by all operators on their account. The actions could be searched for using a number of fields to specify search criteria. Depending on the search criteria, the administrator might appear in the search result which will be detailing the actions made by the users. 3. Arabization SMS Broadcast became Multilingual by adding the Arabic interface: o All Menus and Fied content are Arabized o User input through the web may be in Arabic o Uploading of Arabic Files is supported o Fleibility to Switch between Arabic and English Interfaces 6
5.3 Application I nterface The system consists of two main interfaces: the administrator interface and the operator interface. 5.3.1 Administrator I nterface Switch between accounts, change password. Create new messages; Send, Edit, Delete and list all messages. Schedule the process of sending messages. Add new targets (name and mobile number); add a bulk of targets, Edit, Delete, and list all targets. Create new operator; Edit, Delete, attach operator, send passwords to operators, list all operators. Create new Group; Edit, Delete, and list all groups. Create a temporary group (Selection List) of targets from different groups. Send predefined or customized messages to the Selection List or groups. Get reports for all campaigns. View audit information about the actions performed by the admin and/or his operators. 5.3.2 Operator I nterface Create a temporary group (Selection List) of targets from different groups. Send predefined or customized messages to the Selection List or groups. Schedule the process of sending messages. View Targets, and search for a target name or number. View operators. View groups. View reports. View messages. 7
6. WEB USER I NTERFACE 6.1 Login The first page is the login page, where authorized users will be able to access the system and view their profiles. If the mobile number/password fields are a valid combination, then the user will access the system unless Etisalat is blocking the account. On the other hand, a message will appear indicating an invalid entry. Steps 1. Click on the Login link. 2. Enter the Mobile Number. 8
3. Enter the password. 4. Click on Login. 5. If the user cannot be authenticated or did not enter all the required fields, an error message will be displayed on the same page. 6. On the first login the user is requested to fill in his personal information which includes a secret question and an answer to it that will be used later as a security check to retrieve a forgotten password. 6.1.1 Blocked Account In case of a blocked account a list of other operators accounts will be displayed for the operator to login to another active account. If the account is blocked but the user had successfully logged in, the user will be forwarded to an error page indicating that the account is blocked and prompting to choose another account if he has multiple accounts in the their profile. All other functionalities and different views in the web interface will depend on the user s role for that working account. He could have either the Administrator interface or the Operator interface. 9
6.1.2 SMS Broadcast Link From the Login Page You can use this page to a get a general idea about the site. The pages describe the main four functions with a brief description on each. 10
6.1.3 Contact Us Page This page provides the contact details needed for support. For any inquiries or information about SMS Broadcast service, the contact number is displayed. 11
6.2 Administrator Web I nterface A fully functional web interface in which, the administrator can utilize the four major operations. Message Create predefined and customized messages. Send predefined or customized messages to different groups or to the Selection List. Schedule the time of sending messages. Edit the content of the messages. Delete a predefined message or a number of messages. View and refresh the list of messages. View and control all the campaigns through the reports. View the content of the Selection List. Target Add a new target number or a new target number with a name to the groups. Add bulk of targets. Edit the target number and/or name. Delete one or more targets. Add targets to the Selection List. View content of the Selection List. Remove targets or Empty the Selection List. View and refresh the list of targets. Search for targets using target name, number or group id. 12
Operator Add new operator. Attach eisting operator to account. Send password to the operator. Delete operators. View and refresh the list of operators. Group Add a new group and edit it. Delete a group or a number of groups. View and refresh the list of groups. 13
6.2.1 Main Page The main page provides a place where the administrator profile can be viewed. The SMS Broadcast system etends the capabilities of a simple browser to a more advanced one where the user will be able to navigate the site easily. In order to provide you with a statistical summary of the system, the main page provides you with the following information: Account Name Current Working Account Default Account Profile Name Administrator Number of Targets Ma Number of Targets per Account Number of Operators Number of Predefined Messages Ma Number of Predefined Messages 14
Furthermore you can change your password and get a new password that will be sent to your mobile. Also, passwords can be sent to other operators. Through this page, you will able to switch between accounts as well as the ability to set your current account to make it a default one. If the working account is not the same as the default account you can set your current working account as your default account. To view and edit your personal information click on the Personal I nfo link. Four main operations are available to the user: Message, Target, Operator and Group. The following pages provide a full description of these four main operations. Tips The Login Time and the Login I d will be provided in the summary page. (Home, Help and Sign out) links are provided at the top right corner of the screen. 15
6.2.1.1 Personal I nfo 1. Click on the Personal I nfo link. 2. Modify any desired values but do not leave any required field blank. 3. Click on Submit, to save the new details. 4. Click on Cancel, to cancel the operation and go back. 16
6.2.1.2 Change Password 1. Click on the Change password link. 2. Enter your old password. 3. Enter your new password. 4. Confirm your new password by reentering it. 5. Click on Change, to save the new password. 6. Click on Cancel, to cancel the operation and go back. 17
6.2.1.3 Audit View The system can record, store and view a set of important actions whenever these actions occur. This is needed to be able to go back in the history of events and determine when certain events occur, the persons involved in these events, the associated results, to be able to trace certain errors and/or make decisions based on what happened. The following is a description of the search criteria. Field Contet Action Action Date Description This list is used to specify the type of contet. There are 5 contets to select from: Campaign, Message, Operator, Target and group. This list is dynamically generated depending on the type of contet selected in the previous list. For eample, if the selected contet was Target, the values in the Action list would be Create, Edit, Delete and Bulk Create. The list contains three values and they are: After, Equal & Before. The default value is After. The tet field is used to show the selected date. However, the user may not be able to add or edit tet in the tet field manually. To do so, the user must click on the button to generate a calendar. From the calendar, the user would select a date and the selected 18
date will be printed into the tet field. Contet ID Contet ID specifies a certain contet record/s. For eample, if there are 8 Campaigns launched by the account operators, each campaign will have an ID. So the Administrator may search for Contet ID: 4 to find the operator that launched that particular Campaign. However, the administrator should know the contet ID in advance. UserID-MSISDN Appearing in the form as a tet Field. This field is used to search for the user id of the operators of the account. The user id is equivalent to the MSISDN without 050 or +97150. This feature shows results for a certain operator of current the account. Sort by This option is used to organize the results. It contains two fields: the first one is the criteria of sorting (e: Action, date etc); while the other is to decide on ascending or descending order. 19
6.2.1.3.1 Audit View Form 1. Select the desired criteria by first ticking the check bo then enter the data a. List: select a single value from the list. b. Tet field (date): click on the button and select a date from the calendar. c. Tet Field (other): enter data manually. 2. Click on the Submit button to view search result. 20
6.2.1.3.2 Activity Log The result shows details of actions made in a table. The table has the following fields: o User ID o Contet o Contet ID o Contet Name o Action o Time Stamp o Description 21
6.2.2 Message This page deals with all the operations related to the account Messages. Depending on the task, you can use this page to control your Messages and add any modification to it. You can create predefined or customized messages and send them to a multiple number of groups or to the targets in your Selection List. In addition, you can view reports about all the campaigns and control them if they are not completed. A status message is displayed indicating the number of targets in the selection list. You can perform the following tasks: 1. Create Predefined Messages. 2. Delete Eisting message(s). 3. Edit a Message. 4. Send Customized Message(s). 5. Send Predefined Message(s). 22
6. Advanced Message Scheduler. 7. View Reports. 8. View Campaign Details. Tips: If you eceeded the maimum number of messages, the Create Message link will not be available. Therefore, you must delete some unwanted messages. The status of your Selection List is displayed below the Refresh List button. If your Selection List is not empty, you can press on the hyperlink to view the targets in your Selection List. 23
6.2.2.1 Create Predefined Message(s) 1. Click on the Create Message link. 2. Enter the name. 3. Enter the message. 4. Select the Id. 5. Click on Create, to create the message with the name you specified. 6. Click on Cancel, to cancel the operation and go back to the message page. Tip: An Error Message will appear whenever a message is created without specifying the id Error in creating a new Predefined Message. Make sure you enter correct values for all fields. 24
6.2.2.2 Delete Eisting Message(s) 1. Select the message you want to delete. 2. Click on the Delete button. 3. A list of the selected messages will appear to confirm deletion. 4. Click on Delete, to delete the message. 5. Click on Cancel, to cancel the operation and go back to the message page. 25
6.2.2.3 Edit a Message 1. Select the message you want to edit or modify. 2. Click on the Edit link. 3. Modify the name of the message, if required. 4. Modify the message, if required. 5. Click on Edit, to manage the message. 6. Click on Cancel, to cancel the operation and go back to the message page. 26
6.2.2.4 Send Customized Message(s) 1. Click on the Customize Message link. 2. Enter the message you want to send. 3. Select the group(s) or the Selection List. 4. Click on Send, to send the message. 5. Click on Cancel, to cancel the operation and go back to the message page. 6. Click on Reset to clear the message. 7. Click on Schedule to schedule the time for sending the message. 27
6.2.2.5 Send Predefined Message(s) 1. Select the Message you want. 2. Click on Send. 3. Select the Group(s) from the list bo available or the Selection List. 4. Click on the Send, to send the message. 5. Click on Send, to confirm sending the message. 6. Click on Cancel, to cancel the operation and go back to the message page. 7. Click on Reset to clear the group selection. 8. Click on Schedule to schedule the time for sending the message. 28
6.2.2.6 Advanced Message Scheduler 1. Click on the Schedule link. 2. Click on the Start Date & Time checkbo if you want to specify the starting date and time for sending messages. 3. Select Day, Month, Year, Hour and Minute from the drop-down lists. 4. Click on the End Date & Time checkbo if you want to specify the ending date and time for sending messages. 5. Select Day, Month, Year, Hour and Minute from the drop-down lists. 6. Click on the Daily Sending Time checkbo if you want to specify the daily time for sending messages. 7. Select Hour and Minute from the drop-down lists. 8. Click on Send to send the message according to the scheduled time. 9. Click on Reset to clear any selection. 10. Click on Close Schedule to close the scheduling window. 11. Click on Cancel to cancel the operation and go back to the message page. 29
Tips: You can send a single message to multiple groups at the same time. To schedule the time for sending messages, you can specify the Start Date & Time and/or End Date & Time and/or Daily Sending Time. If you clicked on Start Date & Time and/or End Date & Time and/or Daily Sending Time checkbo(es), you have to fill all fields for the selected checkbo otherwise an error message will appear saying Please enter all missing parameters. 30
6.2.2.7 View Reports 1. Click on the Reports link. 2. Click on the icon of the specific message to change its status. 3. Click on to get the Campaign Details. 4. Click on the Refresh List link to refresh the list of campaigns. Tips: The Total Number of Campaigns will appear above the list. The Status of any campaign can be one of the following: I nitial, Ready, Running, Stopping, Stopped, Blocked and Completed. When you start sending messages, the status of the campaign will be initial, and then it will shift to ready, running and completed respectively unless you stopped the campaign, deleted it or blocked it with the specific block period (the period which is not included in the daily sending time). You can delete any campaign if its status is either initial, stopped, blocked or completed. You can stop any campaign if its status is either ready or running. You can resume any campaign if its status is stopped. 31
6.2.2.8 View Campaign Details 1. Click on icon to get the Campaign Details. 2. Click on the Refresh List link to refresh the details. 3. Click on Close to close the window and go back to the report. Tip: The Total number of undelivered messages will appear at the bottom of the page. 32
6.2.3 Target This page deals with all the operations related to the targets. The target page will start with a search engine which will power the user with the capabilities to view a list of target names and numbers. The search engine will help the user to find his target according to the Target number, Target name or Group ID. There are a number of tasks that can be achieved using this feature. The user can view, search, edit and delete targets. The following tasks can be performed: 1. Add A New Target. 2. Add Bulk Targets. 3. Search For A Target. 4. Delete Target(s). 33
5. Edit A Target. 6. Add To Selection List. 7. Manage Selection List. 6.2.3.1 Add A New Target 1. Click on the Add Target link. 2. Enter the target number and target name (optional). 3. Select the group(s). 4. Click on Add, to add the target. 5. Click on Cancel, to cancel the operation and go back to the Target page. Tips: Multi-group selection is enabled to allow you to add the target to a multiple number of groups. Simply press control and select the groups. The target number should not eceed 7 digits. An Error Message will appear if the required fields are not filled. Please enter all required fields. 34
6.2.3.2 Add Bulk Targets 1. Click on the Add Bulk Targets link. 2. Click on Browse and select the file. 3. Select the group(s). 4. Click on Add, to add the bulk target numbers in the selected file. 5. Click on Cancel, to cancel the operation and go back to the Target page. Tips: Multi-group selection is enabled to allow you to add the bulk targets to a multiple number of groups. Simply press control and select the groups. The target number should not eceed 7 digits. An Error Message will appear if the file is not a tet file: Sorry, either this file is empty or it s not 'tet/ plain'type. An Error Message will appear if nothing is entered in the file field: Please enter the file path. An Error Message will appear if the group(s) is not selected: Please choose a group to insert the data into. 35
6.2.3.3 Search For A Target 1. Click on the Target link. 2. Select the category of search you want (Target Number, Target Name or Group ID). 3. Select the condition you want (Contains, Equals, Starts With, Ends With). 4. Enter the key word. 5. Click on the Search link. 6. A list of the matching targets will be listed. 36
6.2.3.4 Delete Targets 1. Select the group(s) or target(s) you want to delete. 2. Click on the Delete link. 3. A list of the selected targets will appear to confirm deletion, with the message: Are you sure you want to delete the above Target (s)? 4. Click on Delete, to delete the Target. 5. Click on Cancel, to cancel the operation and go back to the Target page. 37
6.2.3.5 Edit A Target 1. Select the Target you want to edit. 2. Click on the Edit link. 3. Enter the new target number or name, as required. 4. Click on Submit, to edit the target. 5. Click on Cancel, to cancel the operation and go back to the target page. 38
6.2.3.6 Add To Selection List 1. Search for the targets you want to add. 2. Select the targets you want to add to your Selection List. 3. Click on the Add to Selection List link. The target will be added immediately and the status message near the Search link will be updated and clickable. 39
6.2.3.7 Manage Selection List You can view the contents of the Selection List by clicking on its link. The Selection List link is near the Search link in the Target section and below the upper Refresh List link in the Message section. There are two links in the Selection List Page: Remove: 1) Select the targets in the Selection List. 2) Click on Remove to remove the selected targets from the Selection List. Empty: Click on Empty to remove all the targets from the Selection List. 40
Tips: o The Selection List is valid for one session only. Once you log out, the Selection List will be emptied. o There are 3 navigation links to the left: Add More Targets: Forwards you to the target search page where you can add more targets. Send Message: Forwards you to the message section where you can send a predefined message either to group(s) or your current Selection List. Send Customized Message: Forwards you to the Customize Message section where you can send your message either to group(s) or your current Selection List. 41
6.2.4 Operator This page deals with all the operations related to the Operator. The Administrator can use this page to make modifications and control the operators. Furthermore, you can view the list of all the eisting operators. The tasks that can be performed are: 1. List all the available operators. 2. Create a new operator. 3. Delete an eiting operator or a number of operators. 4. Attach an operator. 5. Send a password to an operator. Tip: You can delete all the operators by clicking on the top checkbo and then the Delete link. 42
6.2.4.1 Create A New Operator 1. Click on the Create Operator link. 2. Enter the mobile number. 3. Select an ID. 4. Click on Create, to create the operator. 5. Click on Cancel, to cancel the operation and go back to the operator page. 6. Password will be sent directly to the operator via SMS. Tip: An Error Message will appear if the fields are not entered: Please enter all required fields. 43
6.2.4.2 Attach An Operator To Current Account 1. Click on the Attach Operator link. 2. Enter the mobile number. 3. Click on Add, to attach the operator. 4. A new window will appear. 5. Select an id. 6. Click Add to continue. 7. Click on Cancel, to cancel the operation and go back to the operator page. 44
6.2.4.3 Delete Operator 1. Select the operators you want to delete. 2. Click on the Delete link. 3. A list of the selected operators will appear to confirm deletion with the following message: Are you sure you want to delete the Operator(s)? 4. Click on Delete, to delete the operator(s). 5. Click on Cancel, to cancel the operation and go back to the operator page. Tips: You can delete all the operators by clicking on the top checkbo and then the Delete link. If one of the selected operators is an administrator, the user will not be allowed to delete it. An error message will appear: Sorry, but you cannot delete an administrator! 45
6.2.4.4 Send Operator Password 1. Select the operator. 2. Click on the Send Password link. 3. Click on Send, to send the password. The new password will be sent to the operator s mobile via SMS. 4. Click on Cancel, to cancel the operation and go back. 46
6.2.5 Group This page deals with all the operations related to the Groups. The Administrator can use this page to control and modify any of the groups. This page enables you to view a list of all the eisting groups along with all the target numbers included in each group. The tasks that can be performed are: 1. List all the available groups. 2. Create a new group. 3. Delete an eiting group or a number of groups. 4. Rename a group. Tip: Clicking on the name of the group will show you a list of all the targets which are included in that group. 47
6.2.5.1 Create A New Group 1. Click on the Create Group link. 2. Enter the name of the group you want to create. 3. Select the id. 4. Click on Create, to create the group with the name you specified. 5. Click on Cancel, to cancel the operation and go back to the group page. Tip: An Error Message will appear if the fields are not entered. Please enter all required fields. 48
6.2.5.2 Delete An Eisting Group Or A Number Of Groups 1. Select the group(s) you want to delete. 2. Click on the Delete link. 3. A list of the selected group(s) will appear to confirm deletion, with the following message: Are you sure you want to delete the Group(s)? 4. Click on Delete, to delete the group. 5. Click on Cancel, to cancel the operation and go back to the group page. Tip: You can delete all the groups by clicking on the top checkbo and then the Delete link. 49
6.2.5.3 Rename A Group 1. Select the group you want to edit. 2. Click on the Rename link. 3. Enter the name of the group to rename it. 4. Click on Submit, to manage the group. 5. Click on Cancel, to cancel the operation and go back to the group page. 50
6.3 SMS Broadcast Help There are two kinds of users for the SMS Broadcast service: Administrators and Operators. Each user has a separate manual. These manuals can be either viewed online or downloaded as pdf files. 51