Create and modify tasks
Creating a task is simple, just go to the tasks section in the left "hamburger" menu, and click on "+ create New Task", select the task category from Outgoing Webhook/HTTP Request and Script and start writing your task. A task can be modified directly from the tasks' panel in the Dashboard or you can go to the tasks page in the left menu, and click the edit button over the task row.
You can also create tasks from the dashboard by clicking on the "+" button:
Types of Task
Click on "advanced options" for further features.
|Name||name||string||name your task|
|Bots||host_id||string||select the host where the script will run|
|Script||script_id||string||select the script to be executed by the task|
|Tags||tags||strings array||tag your task so you can find quickly through the application.|
|Task Arguments||task_arguments||array||If the script played by the task is meant to receive parameters you can set them from here. Mind the order as it will be used by the script. Fixed, options, and input arguments are allowed. Input and options arguments will be asked to the user for execution. Fixed arguments will not be displayed to the user at execution time.|
|Copy Task||select an already created task as template|
|Run As||run_as||string||write down any extra command or argument needed to run the script. Windows users must declare here which interpreter to use. Linux users could prepend sudo|
|Description||description||text||describe your task. What does it do, what's the expected output after execution|
|ACL's||acls||array||select who can view your task (what can be done with the task depends on the user role)|
|Triggered by||triggers||array||If the task is part of a workflow, select what triggers the task. The task will be triggered by the resource you selected here.|
|Trigger on-hold time||grace_time||number||enter the time period TheEye should wait before running the task. No wait / Cancelation can be selected which means the task will run inmediately after triggered. (only applicable for triggered tasks). To cancel the task execution during the grace period, go to tasks panel, expand the task and delete the schedule created by the trigger.|
|Execution Timeout||timeout||number||This is the number of seconds the Bot will wait for the script to complete the execution. If the timeout is exceeded the Bot will try to terminate(kill) the script, sending SIGTERM/SIGKILL signal|
|Multitasking||multitasking||boolean||enable or disable parallel execution of the task. When this is enable assigned bot will be able to run multiple instances of the Job at same time. this is important to check when running DesktopBots|
|Environment (env)||env||string||Define extra environment variables that will be present during script execution|
Webhooks or HTTP Request
Check the Webhooks for more details.
Approval tasks handle approval requests in workflows. As breakpoints do, an approval task will pause the workflow execution until it is approved or rejected. Many approvers can be selected, only one approval is needed to continue workflow actions.
An input task is a special task commonly used to start workflows. When executed, the input parameters will be submitted directly to the next chained task in the workflow.
Check the Task Notifications for more details.
To received input values into tasks it is required to define the Task Arguments. It is important to define the arguments in the same order in which they will be used in the script.
|Type||UI Usage||Workflow Usage|
|Fixed||will not be visible to users into forms||this is a fixed value that will be always the same. cannot be rewrited or replaced|
|Text||a free text input||it is usefull to receive dynamic values from outputs to inputs|
|Options||create an options element||behave as Text Argument|
|Remote Options||create an options element using the response of a Remote API. It is posible to include the email of the user executing the task at the momento of the fetch. This will be achived including the keyword %THEEYE_USER_EMAIL% in the queystring of the url of remote api. Example url http://tracking-tool.domain.com/tickets?user=%THEEYE_USER_EMAIL%||behave as Text Argument|
|Date||create a Date Picker element||behave as Text Argument|
|File||create a File Selection element||when it is used with Script Tasks the uploaded file will be downloaded and the argument will contain the local path to the file.|
You can use the task scheduler to create and manage tasks that TheEye will carry out automatically at the times you specify. Task Scheduler can be created using natural language or cron expressions. The main difference between them is that cron expressions is executed always at the exact same date and time. On the other hand, natural language could produce some time shift on successive executions.
Schedules can be created from the Dasboard as shown here below
Your new schedule will be shown when the task row is expanded:
Export and Import Tasks
Inside TheEye community you will hear that other people had already solved or automated typical common problems using the platform. When this automation was performed by a task, you will be able to import the solution or on the other hand export and share the tasks you have created.
To export a task recipe, go to the task, click on the context menu, and then click on the "export recipe" icon as shown here:
Integration through API
Check the Integration through API documentation for more details.