Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
configuration:sdk-job [2022/04/11 11:19] schmittconfiguration:sdk-job [2022/07/21 07:37] (current) – [Regex] dodenhoeft
Line 1: Line 1:
 ====== SDK Job Management ====== ====== SDK Job Management ======
-==== Allgemein ==== +==== General ==== 
-Das SDK Jobmanagement setzt sich aus einem Skript, einem Trigger und einem Job zusammen.\\  Das Skript erfüllt eine bestimmte Funktion wie z.Bdas Senden einer SMS, das mounten eines USB Sticks oder abhören einer seriellen Schnittstelle.+The SDK Job Management consists of a script, a trigger and a job.\\ The script performs a specific function such as sending an SMS, mounting a USB stick or listening to a serial interface. 
 + 
 +The trigger triggers the scriptThe trigger can be based on an event or on a time. Events can be based on all sorts of features of the router. \\ Example: incoming call, successful/failed SMS, interfaces are powered up/off, VPN functions are enabled/disabled and many more. A script can also be triggered manually via the CLI. 
 + 
 +When the job is created, a trigger can be assigned to a script.
  
-Der Trigger löst das Skript aus. Der Trigger kann auf einem Event basieren oder auf einer Zeit. Events können auf allen möglichen Funktionen des Routers basieren.  
-\\ Beispiel: eingehender Anruf, erfolgreiche/fehlgeschlagene SMS, schnittstellen werden hochgefahren/abgeschalten, VPN funktionen werden aktiviert/deaktiviert und viele mehr. Ein Skript kann auch manuell über die CLI getriggert werden. 
  
-Beim erstellen des Jobs kann einem Script ein Trigger zugewiesen werden. 
 ==== Script ====  ==== Script ==== 
-Dazu muss auf der Weboberfläche zu Services -> Job Management -> Scripts -> Add navigiert werden.+To do this, navigate to Services -> Job Management -> Scripts -> Add on the web interface.
 {{ :configuration:jobmanegement_scripts.png?nolink |}} {{ :configuration:jobmanegement_scripts.png?nolink |}}
-Hier kann ein Name(regex), eine Beschreibung und die Argumente des Scriptes übergeben werdenDes weiteren wird das Skript hier erstellt indem es geschrieben(edit), hochgeladen(uploadoder aus dem Speicher(select) ausgewählt wird.+Here a name(regex), a description and the arguments of the script can be passedFurthermore, the script is created here by writing(edit), uploading(uploadingor selecting it from memory(select).
 {{ :configuration:jobmanagement_scripts_edit.png?nolink |}} {{ :configuration:jobmanagement_scripts_edit.png?nolink |}}
  
-Für das Skript wird [[https://wiki.netmodule.com/sdk/reference|die Sprache Arena und  das API Manual]] verwendet.+For the script we're using, [[https://wiki.netmodule.com/sdk/reference|the Arena language and the API Manual]].
  
 ==== Trigger ====  ==== Trigger ==== 
 ==Events:== ==Events:==
-Es wird immer dann getriggert, wenn das Event eintritt+It is triggered whenever the event occurs.
  
 {{ :configuration:jobmanagement_trigger.png?nolink |}} {{ :configuration:jobmanagement_trigger.png?nolink |}}
  
-Hier wurde als Trigger sdk-startup gewähltDas bedeutet, dass das Skript bei jedem sdk start getriggert wird also auch beim hochfahrenWird system-startup gewähltwird nur bei start des Routers getriggertWählt man als Trigger cliphp, kann man den Trigger manuell über einen Browser ausgelöst werdenDer Befehl lautet: nmevent -e "cliphp" -m "TRIG". "cliphp" ist das Event und "TRIG" ist der Name des Triggers+Here sdk-startup was chosen as the triggerThis means that the script is triggered every time sdk starts, including when booting upIf system-startup is selectedonly the system-startup of the router is triggeredIf you select cliphp as the triggeryou can trigger the trigger manually via a browserThe command is: nmevent -e "cliphp" -m "TRIG". "cliphp" is the event and "TRIG" is the name of the trigger
-==Uhrzeit:== +==Date&time:== 
-Benutzt man die einen zeitbasierten Triggerwird folgendes Menü angeigt.+If you use a time-based triggerthe following menu is displayed.
 {{ :configuration:jobmanagement_trigger_time.png?nolink |}} {{ :configuration:jobmanagement_trigger_time.png?nolink |}}
  
-Hier kann dem Trigger wieder ein Name(regex) gegeben werdenIm Feld condition kann eingestellt werden, in welchem Zeitintervall getriggert werden sollIm Feld timespec, wird diese Zeit dann spezifiziert. +Here the trigger can be given a name (regex) againIn the condition fieldyou can set the time interval in which triggering is to be doneIn the timespec fieldthis time is then specified. In the image above, periodically selected as the time triggerThe trigger is now triggered every 1.5 hours.
-In dem Bild oben wurde periodisch als Zeittrigger gewählt +
-Der Trigger wird nun alle 1.5 Stunden ausgelöst.+
 ==== Job ====  ==== Job ==== 
-Es werden die Argumente für das Skript übergeben.+The arguments for the script are passed.
 {{ :configuration:jobmanagement_job.png?nolink |}} {{ :configuration:jobmanagement_job.png?nolink |}}
-Hier wird das ausgewählte Skript mit dem ausgewählten Trigger zugeordnet.+Here, the selected script is mapped with the selected trigger.
  
 ====Administration==== ====Administration====
-Unter SDK -> Administration -> Status kann eingesehen werden ob die SDK Umgebung aktiv istgerade ein Job läuft und ob ein Job beendet wurde.+Under SDK -> Administration -> status you can see whether the SDK environment is activea job is currently running and whether a job has been terminated.
 {{ :configuration:sdk_administration1.png?nolink |}} {{ :configuration:sdk_administration1.png?nolink |}}
-Über die Exitcodes wird der Status über das gelingen eines Jobs zurückgegebenExitcode heißt keine Fehler.+The exit codes are used to return the status of the success of a jobExit code means no errors.
 ====Regex==== ====Regex====
-Die erlaubten Symbole für Name,Argumente und sonstiges finden sie unter [[documentation:config-parameters|Configuration Parameters]]+The allowed symbols for namearguments and other can be found under[[documentation:config-parameters|Configuration Parameters]]