Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
English

This articel describes how the ticket creation from the machine into x4 Asset Performance Platform (x4app) works. 

For creating tickets by the machine it is necessary to send the information for the ticket (e.g. Name, Description, error code, ...) from the machine to x4remote. There is no feedback channel from x4app to the machine, so the machine can only create a ticket and not delete or solve a ticket and it even don't get informend if the ticket is really created.This is a fire-and-forget function.

The decision when a ticket inside x4app is necessary must be done by the machine logic. It is not usefull to create a ticket for every error, because this will be overload the user of the ticket system. Keep in mind that the user target group of x4portal is more highlevel than for a visualization system.

Prerequisites:

  • x4app company setup incl. Ticket module

  • x4remote company

    • Router x500

    • Cloud logging license

    • “x4remote connection” to this company connected with an asset. See x4remote Connections

x4remote variable settings

The x4 Asset Performance Platform is listening to the devices which are streaming data. Here it will listen to the following variables: (You can find a CSV-file down at the attachments. This file can be directly imported to the x4remote variables. CSV-File)

x4remote variable name

datatype

mandatory

Ticket field

Description

x4portal_ticket_title

string

x

Title

This text will be used as title.

x4portal_ticket_description

string

Description

This text will be used as Description

x4portal_ticket_alarmcode

int/string

Alarm Code

The alarm code from an i550 as integer will be transformed to the Keypad code and displayed here. This works for i550 only! Otherwise this field will not displayed.

x4portal_ticket_priority

int/string

Priority

This value contains the  value for the ticket priority.
1=critical, 2=major, 3=minor. Default is criticaly.
If the INT data type is used, the numbers 1,2,3 are to be transferred.
If the STRING data type is used, 'critical', 'major' or 'minor' is to be set as the text.

x4portal_ticket_componentPath

string

x

(Device)

This variable value is used for identifying the device where this ticket shall be referenced to. The value or ID for every device needs to be clarified in prior. Every ID needs to be unique.

x4portal_ticket_create

boolean

x

--

With a False→ True edge a ticket will be created with the available variable content above. Due to the different reading cycles of the variable this variable should be stay true in the controller for at least 3s.

In x4remote variables with the naming above needs to configured. The address and identifier of the variable in the controller doesn't matter for the ticket creation. The name of the variable is importand and it is what the service is listening to.

Where is the content of the variables used?

The content of the variables will taken over from the system with an edge on the boolean variable “x4portal_ticket_create”. The following pictures shows where the values of the variables are used.

What is the variable “x4portal_ticket_componentPath” for?

The x4portal_ticket_componentPath variable is something like the asset address for the ticket. Every asset has this information. You can find it in the asset details in the settings area as the "x4portal-componentPath" attribute. When a new asset is created, this attribute is automatically created and populated with the asset ID. If a machine is to create a new machine ticket on this asset, the content of the "x4portal-componentPath" must match the variable "x4portal-ticket-componentPath".

German

Dieser Artikel beschreibt, wie die Ticket-Erstellung von der Maschine in die x4 Asset Performance Platform (x4app) funktioniert.

Für die Erstellung von Tickets durch die Maschine ist es notwendig, die Informationen für das Ticket (z.B. Name, Beschreibung, Fehlercode, ...) von der Maschine an x4remote zu senden. Da es nicht möglich ist Daten von der Asset Performance Plattform zur Maschine zu schicken, kann die Maschine nur ein Ticket erstellen, nicht aber ein Ticket löschen oder lösen und wird auch nicht darüber informiert, ob das Ticket wirklich erstellt wurde.

Die Entscheidung, wann ein Ticket in der Asset Performance Plattform erstellt werden sollte, muss von der Maschinenlogik getroffen werden. Es ist nicht sinnvoll, für jeden Maschinenfehler ein Ticket zu erstellen, da dies die Service-Abteilung, als Nutzer des Ticketsystems überlasten könnte. Bedenken Sie, dass die Zielgruppe der Asset Performance Plattform eine andere ist als die eines Visualisierungssystems.

Vorraussetzungen:

  • eine x4remote Company mit:

    • mind. einem x500 Router

    • eine Cloud logging Lizenz (mind. 1000 Datenpunkten/h)

  • eine “x4remote connection”, die mit der x4remote Company verbunden ist, sowie ein Asset mit einer Verknüpfung. Siehe dazu x4remote Connections .

Nötige x4remote Variablen

Um Tickets in der Asset Performance Plattform einzustellen sind die Daten für ein Ticket in der Form von Variablen mittels x4remote zu übergeben. Das heißt ein Controller muss folgende Informationen als Variablen bereitstellen und an x4remote übergeben: (Bei den Anhängen ist eine CSV-Datei zu finden, welche in die x4remote Variablen importiert werden kann. CSV-Datei)

x4remote Variablenname

Datentyp

Pflicht

Ticketfeld

Beschreibung

x4portal_ticket_title

string

x

Titel

Der Variableninhalt wird als Title eingetragen.

x4portal_ticket_description

string

Beschreibung

Der Variableninhalt wird als Beschreibung eingetragen.

x4portal_ticket_alarmcode

int/string

Alarm Code

Der Variableninhalt wird als Alarmcode eingetragen.

x4portal_ticket_priority

int/string

Priorität

Der Variableninhalt bestimmt die Priorität des Tickets.
1=Kritisch, 2=Hauptfehler, 3=Nebenfehler. Alles andere wird als ‘Kritisch’ gesetzt.
Wird der Datentyp INT verwendet, so sind die Zahlen 1,2,3 zu übertragen.
Wird der Datentyp STRING verwendet, so ist als Text ‘critical’, ‘major’ oder ‘minor’ zusetzen.

x4portal_ticket_componentPath

string

x

Assetadresse

Der Variableninhalt wird zur Bestimmung des Assets genutzt. Er kann als Adresse verstanden werden.

x4portal_ticket_create

boolean

x

--

Bei einer False → True Flanke diese Variablen wird ein Ticket mit den dann in den obigen Variablen eingetragenen Inhalten erstellt. Auf Grund der unterschiedlichen Abtastraten der Variablen durch den x500 sollte dieses Signal mind. 3s anstehen.

In x4remote müssen Variablen mit der oben genannten Benennung konfiguriert werden. Adresse und Bezeichner der Variablen in der Steuerung spielen für die Ticketerstellung keine Rolle. Der Name der Variablen in x4remote ist wichtig.

Wo werden die übergebenen Variablen genutzt?

Der Inhalt der Variablen wird mit einer Flanke der boolesche Variable „x4portal_ticket_create“ vom System übernommen. Die folgenden Bilder zeigen, wo die Werte der Variablen verwendet werden.

Wofür ist die Varaible “x4portal_ticket_componentPath” da?

Die Variable „x4portal_ticket_componentPath“ ist so etwas wie die Asset-Adresse für das Ticket. Jedes Asset hat diese Informationen. Sie finden es in den Asset-Details im Einstellungsbereich als Attribut „x4portal-componentPath“. Wenn ein neues Asset erstellt wird, wird dieses Attribut automatisch erstellt und mit der Asset-ID gefüllt. Wenn eine Maschine ein neues Maschinenticket an diesem Asset erstellen soll, muss der Inhalt des „x4portal-componentPath“ mit der Variable „x4portal-ticket-componentPath“ übereinstimmen. Ist die Steuerung in der Lage für die Maschinenkomponenten weltweit eindeutige ID’s zu erzeugen, dann können diese als x4portal_ticket_componentPath genutzt werden und in dem Asset, in dem Attribute x4portal-componentPath hinterlegt werden.

Anhänge

...