Les actions en cas d'incident étendent les capacités de surveillance de Produits Broadsign Control. Elles permettent aux applications tierces d'ouvrir et de fermer des incidents sur Broadsign Control Player.
Quelques Broadsign Control Players nécessitent des capacités de surveillance étendues. Les actions d'incident permettent aux applications tierces d'ouvrir et de fermer des incidents dans le système Broadsign.
Utilisez l’une des actions d’incident suivantes :
- open_incident
- close_incident
- query_incidents
Appelez les actions open_incident, close_incident et query_incidents en utilisant l'une des options suivantes :
Serveur WebSocket :
-
JSON – Vous pouvez transmettre des paramètres depuis votre fichier HTML5 à l’aide de JSON.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
Port 2324 :
- remote_action – Une application fournie avec Broadsign Control Player qui utilise la ligne de commande.
- XML – Si vous souhaitez développer vos propres applications, vous pouvez communiquer directement avec Broadsign Control Player API en utilisant XML.
Note : Assurez-vous de sélectionner Enable Remote Control dans l’onglet Remote Control du profil de configuration. Voir L'onglet «Remote Control».
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
Note : L'action Déclencheurs est la seule exception à cette règle. Elle utilise le port 2325. Voir Action Triggers.
Vous pouvez appeler cette action sur Windows et Ubuntu Linux, et la trouver via les chemins suivants :
- Windows (64 bits) :
- Ubuntu Linux :
/opt/broadsign/suite/bsp/bin/
C:\Program Files\BroadSign\bsp\bin
Vous pouvez ajouter jusqu'à vingt-cinq types d'incidents définis par l'utilisateur à la liste prise en charge. Ces types d'incidents sont masqués par défaut dans Broadsign Control Administrator, mais apparaîtra lorsque vous cocherez Show External Incidents dans le rapport d'incident.
Les incidents externes peuvent servir à n’importe quelle fin et vous pouvez standardiser le texte utilisateur via un fichier de traduction.
Si vous souhaitez utiliser « Incident externe de type 1 » pour la surveillance Wi-Fi, créez un fichier de traduction pour remplacer « Incident externe de type 1 » par « Panne Wi-Fi ». Chacun des 25 types d'incidents peut apparaître avec des seuils d'incident définis par l'utilisateur.
Pour utiliser l'outil remote_action en ligne de commande, recherchez l'exécutable dans le répertoire bin d'installation de Broadsign Control Player.
Mesures en cas d'incident
- open_incident – Un seul incident de chaque type peut être ouvert à la fois et les doublons seront supprimés. Notez que -T (Type d'incident) et -P (Description du problème d'incident) sont requis lorsque l'action est open_incident.
- close_incident – Notez que -T (type d’incident) et -R (description de la résolution de l’incident) sont requis lorsque l’action est close_incident.
- query_incidents – Cette action renverra un document XML décrivant tous les incidents actuellement ouverts. De cette façon, un tiers peut décider quand et si ils doivent être fermés. Le document sera formaté comme suit :
Par exemple, pour ouvrir un type d’incident :
remote_action open_incident -T 10001 -P "This is an Incident"Pour résoudre ou clôturer l'incident :
remote_action close_incident -T 10001 -R "Incident Resolved"Un « incident externe de type 1 » correspondrait au code de type 10001, un « incident externe de type 2 » au code de type 10002, et ainsi de suite.
<?xml version="1.0"?>
<incidents>
<incident id='12345'
type='10005'
occurred_on_utc='2012-12-12T09:13:13'
problem_description='Wifi hotspot not functional.'
status='2'
target_resource_id='0'
resource_id='0'/>
<incident id='123456'
type='10007'
occurred_on_utc='2012-12-21T09:13:13'
problem_description='Panel door is open.'
status='2'
target_resource_id='0'
resource_id='0'/>
</incidents>Note : Broadsign ferme automatiquement tous les incidents signalés ouverts qui sont inactifs depuis quatorze jours. Si l’incident persiste après quatorze jours, vous devez le rouvrir comme un nouvel incident.
Votre application peut ouvrir ou fermer des incidents via, ou interroger des incidents à partir de, l'API du lecteur. Envoyer un message XML au port monitor_remote (2324).
Action en cas d'incident
- open_incident – Vous pouvez ouvrir un incident en utilisant une requête XML vers l’API du lecteur. Fournissez le type d'incident et sa description dans problem_description. Un seul incident de chaque type peut être ouvert à la fois et les doublons seront supprimés.
- close_incident – Fournissez le type d’incident et sa résolution dans resolution_description. Un « incident externe de type 1 » correspondrait au code de type 10001, un « incident externe de type 2 » au code de type 10002, et ainsi de suite.
- query_incidents – Cette action renverra un document XML décrivant tous les incidents actuellement ouverts. De cette façon, un tiers peut décider quand et si ils doivent être fermés.
Saisissez le XML comme suit :
<rc version="1" id="1" action="open_incident" type="10001" problem_description="This is an incident." />\r\n\r\nNote : Vous devez terminer la requête avec \r\n\r\n.
Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
Pour résoudre/clôturer l'incident :
<rc version="1" id="1" action="close_incident" type="10001" resolution_description="Incident resolved."/>\r\n\r\nPour interroger les incidents :
<rc version="1" id="1" action="query_incidents"/>\r\n\r\nLe document de retour apparaîtra comme suit :
<?xml version="1.0"?>
<incidents>
<incident id='12345'
type='10005'
occurred_on_utc='2012-12-12T09:13:13'
problem_description='Wifi hotspot not functional.'
status='2'
target_resource_id='0'
resource_id='0'/>
<incident id='123456'
type='10007'
occurred_on_utc='2012-12-21T09:13:13'
problem_description='Panel door is open.'
status='2'
target_resource_id='0'
resource_id='0'/>
</incidents>Action en cas d'incident - Paramètres XML
Note : Tout pare-feu présent sur Broadsign Control Player doit être configuré pour permettre à bsp.exe d'ouvrir des ports, ou pour configurer directement le port 2324 ou le port 2326 pour l'utiliser.
| Paramètre | Description |
|---|---|
| version | La version est toujours « 1 ». |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre : open_incident, close_incident ou query_incidents. |
| type | Un « incident externe de type 1 » correspondrait au code de type 10001, un « incident externe de type 2 » au code de type 10002, et ainsi de suite. Obligatoire lorsque l'action est open_incident ou close_incident. |
| problem_description | Une brève description du problème ou de l’incident. Obligatoire lorsque l'action est open_incident. |
| résolution_description | Une brève description de la résolution du problème. Obligatoire lorsque l'action est close_incident. |
Votre application interactive peut soumettre des données JSON au lecteur via le serveur WebSocket de monitor_remote (port 2326). Vous devrez activer le serveur WebSocket. Pour plus d'informations, voir L'onglet «Remote Control».
Mesures en cas d'incident
- open_incident – Vous pouvez ouvrir un incident en soumettant une chaîne JSON à l’API du lecteur. Fournissez le type d'incident et sa description dans problem_description. Un seul incident de chaque type peut être ouvert à la fois et les doublons seront supprimés.
- close_incident – Fournissez le type d’incident et sa résolution dans resolution_description. Un « incident externe de type 1 » correspondrait au code de type 10001, un « incident externe de type 2 » au code de type 10002, et ainsi de suite.
- query_incidents – Cette action renverra un document JSON décrivant tous les incidents actuellement ouverts. De cette façon, un tiers peut décider quand et si ils doivent être fermés.
Entrez le JSON comme suit :
{
"rc": {
"version": "1",
"id": "1",
"action": "open_incident",
"type": "10001",
"problem_description": "This is an incident."
}
}Note : Chaque commande envoyée nécessite un identifiant unique (id). L'application peut utiliser ici une valeur d'incrémentation simple.
Pour résoudre ou clôturer l'incident :
{
"rc": {
"version": "1",
"id": "1",
"action": "close_incident",
"type": "10001",
"resolution_description": "Incident resolved."
}
}Pour interroger les incidents :
{
"rc": {
"version": "1",
"id": "1",
"action": "query_incidents"
}
}Le document de retour apparaîtra comme suit :
{
"incidents": {
"incident": [
{
"id": "12345",
"type": "10005",
"occurred_on_utc": "2012-12-12T09:13:13",
"problem_description": "Wifi hotspot not functional.",
"status": "2",
"target_resource_id": "0",
"resource_id": "0"
},
{
"id": "123456",
"type": "10007",
"occurred_on_utc": "2012-12-21T09:13:13",
"problem_description": "Panel door is open.",
"status": "2",
"target_resource_id": "0",
"resource_id": "0"
}
]
}
}Action en cas d'incident - Paramètres JSON
Note : Si vous utilisez JSON via le serveur WebSocket, tout pare-feu présent sur Broadsign Control Player doit être configuré pour accéder directement au port 2326 pour utilisation.
| Paramètre | Description |
|---|---|
| version | La version est toujours « 1 ». |
| id | Contient l'identifiant de la requête. |
| action | Le type d'action à entreprendre : open_incident, close_incident ou query_incidents. |
| type | Un « incident externe de type 1 » correspondrait au code de type 10001, un « incident externe de type 2 » au code de type 10002, et ainsi de suite. Obligatoire lorsque l'action est open_incident ou close_incident. |
| problem_description | Une brève description du problème ou de l’incident. Obligatoire lorsque l'action est open_incident. |
| resolution_description | Une brève description de la résolution du problème. Obligatoire lorsque l'action est close_incident. |