Bureaucrats, editor
1,487
edits
Changes
Jump to navigation
Jump to search
|-! style="* Whereas Mediaroom STBs exist, maximum size of this text-align:left;" | Show Badge| It is a checkbox which indicates if the application will have to show a badge or not 153 characters (if available configurable in the deviceMiB as instance parameter gvp.notifications: MEDIAROOM: MR_MAX_MSG_LEN).|
|-
! style="text-align:left;border-left:5px solid red;" | Scheduled Date
| The day and hour that the notification has to be sent.
|
* Mandatory
|-
! style="text-align:left;border-left:5px solid yellow;" | Sent Date
| Operator that created this item.
| ReadOnly
! |}<br /> === Catalog Item ===----<br />[[File:CatalogItemBlock.png|center|800px]] With this block, the operator will be able to select one product (Movie, Subscription or LiveChannel) to be associated and attached with the notification. This will allow the operator to advertise the product to the users. <big>'''Add existing Catalog Item'''</big>* Click the [[File:AddExisting.png|middle|70px]] button and a dialog will open to select and existing Catalog Item.* Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page and the Catalog Item be associated.<br /><br /> <big>'''Remove Notification Interests'''</big>* Use the [[File:DeleteRed3.png|middle|30px]] button to remove the association of Catalog Item from the Notification.* Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page. <br /> === Sending details ===----<br />[[File:SendingDetailsBlock.png|center|800px]]<br /> {| class="wikitable" style="text-alignmargin:0px;width:left100%;border-left"! style="width:5px solid yellow15%;" | Number DevicesField! style="width:45%;" | Number of devices that the notification was sent to successfully.Description! style="width:40%;" | Read OnlyRestrictions
! style="text-align:left;border-left:5px solid yellow;" | Error Detail
| Detailed error summary. The Notification agent will update this field with a detailed summary of the sending process.
It is important to remark that the Google GCM and Apple APN services have slightly different behavior when returning the result of the notification sending process. While Android will report if the notification has properly delivered to the end device or not, the Apple APN service doesn't do it, it just confirms if the notification has been created properly or not, but doesn't provide feedback about if the device received the notification or not.<br />
The reasons for a notification to fail are:
*'''Expired device''': it means that the token that was registered by the application for that devices has expired, so the notification was not sent to them. This error happens usually because the user has deinstalled the application and the device has not renewed the notification token.
*'''Invalid devices''': it means that the token that was registered by the application for that devices has been marked as invalid, so the notification was not sent to them. This error happens usually because the service has detected that this device is not receiving notifications anymore so the device is marked as invalid and will be removed automatically by the feedback service.
*'''Renewed devices''': the token of these devices has been renewed, but the notification has been delivered properly to this devices.
*'''Unknown errors''': the external notification service has reported error in the sending process but without providing details for the error. If this error occurs very often, the configurations and logs should be reviewed in order to search for the root cause of this problem.
| Read Only
The At main notifications block, operator can upload select a .csv file with the list of users to which notification is to be sent.Notification will be sent to all devices belonging to users included in the list and being of device type selected at devices block. <br />This block, allows upñoading new CSV files if needed.
<big>'''Add existing Catalog Item'''</big>
* Click the [[File:AddExisting.png|middle|70px]] button and a dialog will open to select and existing Catalog Item.
* Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page and the Catalog Item be associated.<br />
<big>'''Remove Notification Interests'''</big>
* Use the [[File:DeleteRed3.png|middle|30px]] button to remove the association of Catalog Item from the Notification.
* Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page.
Notifications Page Manual 3.0 (view source)
Revision as of 13:52, 15 March 2019
, 13:52, 15 March 2019no edit summary
__TOC__
<br />
The notifications page allows Affected Services Agent is responsible for analyzing SCOM xml files with errors reported by all GVP components and sending e-mail with alerts about the errors or to configure notifications for clients do a post on an URL.All the users from certain instance inserted on Instance Notification will receive these e-mails when some error happens and deviceswhen the error is resolved.<br /><br />Here you have a list of complementary manuals that will help you during the operation of Notifications:* '''[[How to create a notification]]''': Step by step guide on how to create a notification in in Betools.* '''[[How to enable/disable/delete/cancel a notification]]''': A guide that allows to understand which actions are possible over already created notifications.* '''[[How to manage GROUPS]]''': only for Open Platform notifications.* '''[[How end users manage their notifications]]'''
== Blocks ==
Schedule date must be in the future
Notification size validation: the size of the notification will be checked against the configured GVP Parameters (APN_PAYLOAD_LIMIT and GCM_PAYLOAD_LIMIT). If the notification is being sent to each device group (iOS, Android) and it exceeds the payload limit defined, it will show an error when creating the notification.
<br />
| The name for the notification.
|
* '''Mandatory'''
|-
! style="text-align:left;border-left:5px solid red;" | Source
| The mib source associated with the notification.
|
* '''Mandatory'''
|-
! style="text-align:left;border-left:5px solid red;" | Instance
| Instance associated with the notification.
|
* '''Mandatory'''|-|}<br /> === Notification details ===----<br /> [[File:NotificationsDetails.png|1000px|center|thumb|Notifications Details information]] <br />{| class="wikitable" style="margin:0px;width:100%;"! style="width:15%;" | Field! style="width:45%;" | Description! style="width:40%;" | Restrictions|-! style="text-align:left;" | Enabled| It's a checkbox that enable/disable the notification. | * GVP will not process (and send) the notification if its status is not enabled.* Under certain conditions, this checkbox allows cancelling Open Platform notification already sent (See [[How_to_enable/disable/delete/cancel_a_notification|how to enable/disable/delete/cancel a notification]]).
|-
! style="text-align:left;" | Message
| Is the message that will be displayed to the end user in the notification.
|
|-
! style="text-align:left;" | Image
|-
! style="text-align:left;" | CSV file
| To upload to the notification choose a .csv containing the list of UNIQUE IDs of the users that the notification will be sent to.| |-! style="text-align:left;" | Custom style/css| custom style to be applied in the notification when displaying to the end user (currently not used by devices).| |-! style="text-align:left;" | Enabled| It's a checkbox that enable/disable the notification.
|
|-
| Can be used when creating a notification for an specific event notification (for example a match). In order to use it, just associate the Live channel that will have the event in the notification and then set the event start date to the date where the event will take place. This will allow devices to identify exactly the event that is being highlighted.
|
|-
! style="text-align:left;" | Free URL
|
|-
! style="text-align:left;border-left:5px solid yellow;" | OwnerShow Badge| Name of It is a checkbox which indicates if the creatorapplication will have to show a badge or not (if available in the device).| Read Only
|-
! style="text-align:left;border-left:5px solid yellow;" | Number UsersCustom style/css| Number of users that Custom style to be applied in the notification was sent when displaying tothe end user (''currently not used by devices'').| Read Only
|-
|-
! style="text-align:left;border-left:5px solid yellowred;" | Number ErrorsScheduled Date| Number of errorsThe day and hour that the notification has to be sent.| Read Only* '''Mandatory'''
|-
! style="text-align:left;border-left:5px solid yellowred;" | Notification StatusEnd Date| Provides feedback about The day and hour the notification will be disabled in Open Platform. End date will be ignored by notification agent when sending process statusnotifications to Android, IOS and Mediaroom. Possible status are:|*'''PendingMandatory''': is the status before the schedule date is reached. In this status, the notification can still be modified.*'''Schedule error''': this status is an error status, meaning that the Only for Open Platform notification could not be processed correctly. Please verify the Error Details to know more about the reason that caused this error.type*'''Processing''': is the status while the Notification Agent is processing the cannot be saved with empty end date if any device type linked to notification, after the scheduled data has been reached.*'''Sent''': means that the notification was sent without any errors in the sending processtype = OpenPlatform.*'''Error''': means that the notification could not Notification cannot be send to one or more user devices. Please refer to the Error Details to know more about the different error reasons.| Read Onlysaved if end date is lower than scheduled date
|-
|}
<br />
=== Upload CSV File ===
----
<br />
[[File:UploadCSVFileBlock.png|center|800px]]
'''Add new CSV File'''
* Then click Click the [[File:UploadIcon.png|middle|30px]] button and a dialog will be open so you will be able to select the CSV File to be uploaded.*Once finished, save changes by using the [[File:SaveNameButton.png|middle|40px]] in the movie page and the CSV File will be associated.<br />
<br />
<br />
[[File:DeviceTypesBlock.png|center|800px]]
<br />The operator will can also have to select the device types that the notification is addressed to: Android Phone, Android Tablet, iPhone and , iPad, Open Platform STB, Mediaroom STB... This will allow the operator to restrict the notification to only a set of device types. The notification mechanism will vary depending on the device type.<br /><u>'''Pre-requeriments'''</u>:<br />1. Device types must be linked to notification type during [[OpenPlatform1.2:_Notifications_for_TV_Open_Platform#Setup_.26_Configuration|Setup and Configuration]].<br /><u>'''What happens if operator DOES NOT select any device type'''</u>:<br />:- If operator DOES NOT select any device type and at next step operator selects a TOP filter (list, subscription, STB model or region):::- MIB will raise a simple ''alert'' telling the Operator that the notification will only be sent to devices with Open Platform notification type.::- Notification will be sent ONLY to device types with notification type Open Platform.[[File:DeviceTypesAlarm.png|400px|center]]<br />:- If operator DOES NOT select any device type and operator DOES NOT select any TOP filter (list, subscription, STB model or region):::- Notification will be sent to all device types fulfilling filters conditions (see next step) regardless notification type.
<br />
<big>'''Add existing Device Type'''</big>
* Click the on [[File:AddExisting.png|middle|70px]] button and a dialog will open to select and existing Device Type.* Mark as many device types as desired in pop up window * Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page and the Device Type will be associated.<br />
<br />
<big>'''Remove Notification InterestsDevice Type'''</big>
* Use the [[File:DeleteRed3.png|middle|30px]] button to remove the association of Device Type from the Notification.
* Once finished, save changes by using the [[File:Save3.png|middle|30px]] in the Notification page.
<br />
=== Open Platform filters ===
----
<br />
[[File:OpenPlatformFilters.png|center|800px]]
<br />
{| class="wikitable" style="margin:0px;width:100%;"
! style="width:15%;" | Field
! style="width:45%;" | Description
! style="width:40%;" | Restrictions
|-
! style="text-align:left;" | Subscription
| To choose a subscription from GVP_SUBSCRIPTIONS table. Notification will be sent to all devices belonging to users that have the subscription.
|
* Compatible ONLY with Open Platform notification type
* This filter cannot be combined with any other filter (Group, STB Model, Geographic Area, CSV or Interest).
|-
! style="text-align:left;" | Geographic Area
| To choose a Geographic Area from GVP_REGIONS table. Notification will be sent to all devices belonging to users in that Geographic Area.
|
* Compatible ONLY with Open Platform notification type
* This filter cannot be combined with any other filter (Group, Subscription, STB Model, CSV or Interest).
|-
! style="text-align:left;" | Group
| To choose a group from GVP_GROUPS table. Notification will be sent to all devices belonging to users that have been added to a Group previously (See [[How to manage GROUPS]].).
|
* Compatible ONLY with Open Platform notification type
* This filter cannot be combined with any other filter (Subscription, STB Model, Geographic Area, CSV or Interest).
|-
! style="text-align:left;" | STB Model
| To choose a STB model. Notification will be sent to all devices that have provided STB model information and match filter.
|
* Compatible ONLY with Open Platform notification type
* This filter cannot be combined with any other filter (Group, Subscription, Geographic Area, CSV or Interest).
|-
|}
<br />
=== Notification Interests ===
<br />
=== Catalog Item Delivery status ===
----
<br />
[[File:CatalogItemBlockDeliveryStatus.png|800px|center|800px]] With this block, the operator will be able to select one product (Movie, Subscription or LiveChannel) to be associated and attached with the notification. This will allow the operator to advertise the product to the users.
<br />
{| class="wikitable" style="margin:0px;width:100%;"
! style="width:15%;" | Field
! style="width:45%;" | Description
! style="width:40%;" | Restrictions
|-
! style="text-align:left;border-left:5px solid yellow;" | Notification Status
| Provides feedback about the notification sending process status.
Possible status are:
*'''Pending''': is the status before the schedule date is reached. In this status, the notification can still be modified.
*'''Schedule error''': this status is an error status, meaning that the notification could not be processed correctly. Please verify the Error Details to know more about the reason that caused this error.
*'''Processing''': is the status while the Notification Agent is processing the notification, after the scheduled data has been reached.
*'''Sent''': means that the notification was sent without any errors in the sending process.
*'''Error''': means that the notification could not be send to one or more user devices. Please refer to the Error Details to know more about the different error reasons.
| Read Only
|-
! style="text-align:left;border-left:5px solid yellow;" | Sent Date
| Operator that created this item.
| ReadOnly
|-
! style="text-align:left;border-left:5px solid yellow;" | Number Errors
| Number of errors.
| Read Only
|-
! style="text-align:left;border-left:5px solid yellow;" | Error Details
| Detailed error summary. The Notification agent will update this field with a detailed summary of the sending process.
It is important to remark that the Google GCM and Apple APN services have slightly different behavior when returning the result of the notification sending process. While Android will report if the notification has properly delivered to the end device or not, the Apple APN service doesn't do it, it just confirms if the notification has been created properly or not, but doesn't provide feedback about if the device received the notification or not.<br />
The reasons for a notification to fail are:
*'''Expired device''': it means that the token that was registered by the application for that devices has expired, so the notification was not sent to them. This error happens usually because the user has deinstalled the application and the device has not renewed the notification token.
*'''Invalid devices''': it means that the token that was registered by the application for that devices has been marked as invalid, so the notification was not sent to them. This error happens usually because the service has detected that this device is not receiving notifications anymore so the device is marked as invalid and will be removed automatically by the feedback service.
*'''Renewed devices''': the token of these devices has been renewed, but the notification has been delivered properly to this devices.
*'''Unknown errors''': the external notification service has reported error in the sending process but without providing details for the error. If this error occurs very often, the configurations and logs should be reviewed in order to search for the root cause of this problem.
| Read Only
|-
! style="text-align:left;border-left:5px solid yellow;" | Number Users
| Number of users that the notification was sent to.
| Read Only
|-
! style="text-align:left;border-left:5px solid yellow;" | Number Devices
| Number of devices that the notification was sent to successfully.
| Read Only
|-
|}
<br />
| style="text-align:center" | [[File:Cross.png|16px|center]]
| style="text-align:center" | [[File:Cross.png|16px|center]]
| style="text-align:center" | [[File:TickCross.png|16px|center]]| style="text-align:center" | [[File:TickCross.png|16px|center]]
| style="text-align:center" | [[File:Tick.png|16px|center]]
|}
Notification creation is enabled.
# Use the [[File:New3.png|middle|30px]] button to create an empty entry.
# Fill all the required information.following [[How_to_create_a_notification|'''how to create a notification (step by step guide)''']]
# Once finished, save changes by using the [[File:Save3.png|middle|30px]] button.
<br />
=== [[File:BulkEdit3.png|middle|40px]] Bulk Edit ===
Bulk Edit is disabled fot for this page.
<br />
=== [[File:Delete3.png|middle|40px]] Delete ===
Notification can be deleted by the operator using the [[File:Delete3.png|middle|30px]] button. A confirmation popup will be shown before excluding it.<br />When operator tries to delete a notification with status "Sent" or "Error" and Device Types includes at least one device with notification type Open Platform and end date is bigger than now: operator receives a warning asking him to disable first the notification.
<br />
