###############################
Start Worker
###############################

.. _startworker:


Start worker in Worfklows allows users to add multiple inputs to the worker based on requirement.
These inputs can be used or assign to any worker in the Workflow based on the input type.

.. thumbnail:: /_images/Images/startworker1.png
   :title:

   Start Worker

|

Start worker when opened shows a Modal to add inputs from the right panel.
We can drag and drop the inputs to the left side of the start worker to add inputs and save them.


.. thumbnail:: /_images/Images/startworker2.png
   :title:

   Start Worker

|

************************************
Inputs in Start worker
************************************

The Inputs in the start worker are available on the right side of the worker modal.
We have different types of inputs such as Text,Curve,Dataset etc...
These inputs can be added to the start worker with the values accoringly and can be saved to the start worker.
The saved inputs can be further used in any worker's input in the Workflow.

.. list-table:: List of Input types in Start worker. Each link can be used to access inputs in that Start worker
   :widths: 40 20 40
   :header-rows: 1
   
   * - Name of the Input Type
     - Type
     - Description
   * - :ref:`\Text_Input<Worker_start_text>`
     - Text
     - Text input defines a single line text input field
   * - :ref:`\Number_Input<Worker_start_number>`
     - Number
     - Number input defines a field for entering a number.
   * - :ref:`\File_Input<Worker_start_file>`
     - File
     - A file input's value attribute contains a string that represents the path to the selected file(s)  
   * - :ref:`\Curve_Input<Worker_start_curve>`
     - Curve
     - Curve is a 2D data representing a series of X-values and its associated Y-values. It can be visualized in a tabular format or in a curve plot
   * - :ref:`\list_Input<Worker_start_list>`
     - List
     - list Attribute is used to identify a list of pre-defined options for an element to suggest the user. 
   * - :ref:`\Set_Input<Worker_start_set>`
     - Set
     - Set input is used to set the inputs.
   * - :ref:`\Keyvalue_Input<Worker_start_keyvalue>`
     - Keyvalue
     - KeyValue Fields provide a convenient way to add non-structured information to your content
   * - :ref:`\Dropdown_Input<Worker_start_dropdown>`
     - Dropdown
     - The dropdown input allows users to select a value from a list of options. Unlike native select elements, the dropdown input allows you to customize both its appearance and behavior
   * - :ref:`\Dataset_Input<Worker_start_dataset>`
     - Dataset
     - A worker input that is a structured input containing rows and columns of data 
   * - :ref:`\TextArea_Input<Worker_start_textarea>`
     - TextArea
     - The <textarea> element is often used in a form, to collect user inputs like comments or reviews.
   * - :ref:`\Date_Input<Worker_start_date>`
     - Date
     - Elements of type="date" create input fields that let the user enter a date.
   * - :ref:`\Datatime_Input<Worker_start_datetime>`
     - Datetime
     - Datetime input defines a date and time picker
   * - :ref:`\Set-non-unique_Input<Worker_start_setnonunique>`
     - Set non-unique
     - Adds Set non-unique input
   * - :ref:`\Remote_lookup_Input<Worker_start_remotelookup>`
     - Remotelookup
     - The Remote lookup field is a useful way to get data from external systems into your form. With the ability to specify URLs, request types, headers, and data extraction methods
   * - :ref:`\Image_Input<Worker_start_image>`
     - Image
     - Image input can be added locally
   * - :ref:`\Video_Input<Worker_start_video>`
     - Video
     - Image input can be added locally
   * - :ref:`\Peacock_Input<Worker_start_peacock>`
     - Peacock
     - Peacock is a graphical front end for the MOOSE input file syntax. Peacock allows the user to build or modify an input file, execute the application
   * - :ref:`\Boolean_Input<Worker_start_boolean>`
     - Boolean
     - The Boolean input field enables users to input a “true” or “false” value in an entry
   * - :ref:`\Password_Input<Worker_start_password>`
     - Password
     - The input type="password" defines a password field (characters are masked)
   * - :ref:`\Formtable_Input<Worker_start_formtable>`
     - Formtable
     - Formtable input is collection of user data in a form
   * - :ref:`\Hyperlink_Input<Worker_start_hyperlink>`
     - Hyperlink
     - Hyperlink input is for entering the URL
   * - :ref:`\Heading_Input<Worker_start_heading>`
     - Heading
     - Heading is text input with characters
   * - :ref:`\HorizontalSeperator_Input<Worker_start_horizontalsepe>`
     - Horizontal seperator
     - Horizontal seperator input seperates the records
   * - :ref:`\VerticalSeperator_Input<Worker_start_verticalsepe>`
     - Vertical seperator
     - Vertical Seperator input seperates the records
   * - :ref:`\Location_Input<>`
     - Loaction
     - Loaction input define the types of Place data to return when requesting Place Details
   * - :ref:`\Range_Input<Worker_start_range>`
     - Range
     - Range input defines a control for entering a number whose exact value is not important 
   * - :ref:`\Colorpicker_Input<Worker_start_colorpicker>`
     - Color picker
     - Color Picker is a color selection input field that allows you to choose your color formed
   * - :ref:`\Datapoint_Input<Worker_start_datapoint>`
     - datapoint
     - Datapoint input specifies a short hint that describes the expected value of an input field 
   * - :ref:`\Remotefile_Input<Worker_start_remotefile>`
     - Remotefile
     - A file is a resource that is controlled and referenced by file handle variables
   * - :ref:`\Workerinput_Input<Worker_start_workerinput>`
     - WorkerInput
     - WorkerInput input allows user to select the inputs from workers
   * - :ref:`\DefineTable_Input<Worker_start_definetable>`
     - DefineTable
     - Definetable input allows user to add values and curves to the input
   * - :ref:`\DefineTable3D_Input<Worker_start_definetable3d>`
     - DefineTable3D
     - Definetable 3D input allows user to add values and curves to the input
   * - :ref:`\Condition_Input<Worker_start_condidtion>`
     - Condition
     - Condition input can be used in a form for handling a group of form fields
   * - :ref:`\Unit_system_Input<Worker_start_unitsystem>`
     - Unit system
     - Unit system input defines the selection of the unit system
   * - :ref:`\Convert_to_Unit_system_Input<Worker_start_convertunitsystem>`
     - Convert to Unit system
     - Convert to Unit system input defines the selection of units to be converted
   
   
 



***********************************
File Rules based extractions
***********************************


In Workflows, we have new option called File rules.
This options allows user to save the rules of the files and also helps in mapping inputs available in the start worker from different files.
The mappings and Rules are now saved to the start worker.
The mappings can be edited or can be changed by adding another source file which meets the rules from the previous file.


Import a file and define rules for file names
=====================================================

The below video shows how to Define rules based on sheets and extract inputs and map them. 

.. video:: _static/movies/defunerulesbasedonsheets.mp4
   :width: 100% 
   
|
|

Example to map curve input and edit the curve
==================================================

The below video shows how to Define rules based on sheets and extract inputs and map them. 

.. video:: _static/movies/exampltomapcurve.mp4
   :width: 100% 
   
|
|


Import a new file with values for the mappings
=====================================================

The video below shows how to updated the values of the mapping inputs

.. video:: _static/movies/importanewfilewithvalues.mp4
   :width: 100% 
   
|
|


Export and Import the Rules
===================================

We can export the existing Rules and Import them on to the new workflow.

The below video shows how to Export and Import the Rules to the Workflow.

.. video:: _static/movies/exportimportnewworkflow.mp4
   :width: 100% 
   
|
|


Rules can also be added based on the cell
=============================================

The below video shows how to Define rules based on Cell

.. video:: _static/movies/definetablerulesbasedcell.mp4
   :width: 100% 
   
|
|

Autoplay option
==========================

Updating mapped input from rule files option is available in Autoplay mode in Workflows, where we can update the inputs using rule files.​


.. thumbnail:: /_images/Images/updatingmappedinputrules.png
   :title:

    Rule files option is available in Autoplay mode

.. centered:: :sup:`Rule files option is available in Autoplay mode`

|
|

Inputs
=========================

Inputs mapped using rule files now show a message just below their value container indicating file name and file rule in Start worker.

.. thumbnail:: /_images/Images/inputsmappedvaluedisplay.png
   :title:

    Message just below their value container 

.. centered:: :sup:`Message just below their value container`


|
|


Mapped cells 
=======================

In start worker, when File Rule based mapped input is opened in Data Parser, the data-parser sheet will now automatically highlight the previous selection.​


.. thumbnail:: /_images/Images/filemappedcellsfilerules.png
   :title:

   File mapped cells

.. centered:: :sup:`File mapped cells`

|
|



*********************
Actions Examples
*********************

Observers/Actions work in pairs to observe inputs and trigger necessary actions on other Inputs.
Observers are the conditions that are available to trigger the Actions.
Actions are events that will occur on an INPUT based on the Observer State.
In Workflow, we have 10 types of Observers and 8 types of Actions that can be used as shown below.

.. thumbnail:: /_images/Images/typesofactions.png
   :title:

    Types of Actions and Observers

.. centered:: :sup:`Types of Actions and Observers`

|
|

Below are few Examples for Actions/Observers.

.. thumbnail:: /_images/Images/examples.png
   :title:

    Examples

.. centered:: :sup:`Examples`

|
|

Example - 1 :ref:`Use Observer on a TEXT-INPUT with the condition EQUAL to trigger an event that Hides another TEXT-INPUT. In this video, you will see how to create an Action and Trigger the Event using the observer as mentioned in this Example. <example1>` 

Example - 2 :ref:`Use Observer on a TEXT-INPUT with the condition EQUAL to trigger an event that Hides another TEXT-INPUT. <example2>`

Example - 3 :ref:`Use Observer on a NUMBER-INPUT with the condition GREATER THAN to trigger an event that Show the DATASET-INPUT. <example3>`

Example - 4 :ref:`Use Observer on a FILE-INPUT with the condition INPUT FILE CHANGE to trigger an event that Resets the value of CURVE-INPUT. <example4>`

Example - 5 :ref:`Use Observer on a NUMBER-INPUT with the condition LESSER THAN to trigger an event that will Run worker to get value for REMOTELOOKUP-INPUT. <example5>`

|



.. _example1:

Example 1 – 

.. video:: _static/movies/actionex1.mp4
   :width: 100% 

   
|

.. _example2:

Example 2 - 

.. video:: _static/movies/actionex2.mp4
   :width: 100% 

   
|

.. _example3:

Example 3 - 

.. video:: _static/movies/actionex3.mp4
   :width: 100% 

   
|

.. _example4:

Example 4 - 

.. video:: _static/movies/actionex4.mp4
   :width: 100% 

   
|

.. _example5:

Example 5 - 

.. video:: _static/movies/actionex5.mp4
   :width: 100% 

   
|
|

****************************
Actions and options
****************************


.. _actionsinputs:

********************************************
Actions
********************************************

UI for 'Actions' is updated with a Table having options to create/view/search and test the Actions. ​

.. video:: _static/movies/updatedactionsui.mp4
   :width: 100% 

   
|
|

'Add Action' button when clicked will open a window where the new action is created and added to the top row of the table in Workflows.

.. video:: _static/movies/addactionsbuttonclicked.mp4
   :width: 100% 

   
|
|

UI for Actions now supports filters where table can be filtered based on input, type of condition or searched by a string.

.. video:: _static/movies/filtersinaactionsnew.mp4
   :width: 100% 

   
|
|


Actions feature now supports a new tree view which is by default grouped by action groups and if no groups are available, all actions fall under 1 node.

.. video:: _static/movies/actionfeaturestreeview.mp4
   :width: 100% 

   
|
|

Actions table Input names ( both For input and Dependent Input ) will now show a popover showing the actual referenced input and its value.

.. thumbnail:: /_images/Images/actioninputtablenames.png
   :title:

    Names
	
.. centered:: :sup:`Names`

|


Actions can now be exported from the Export button in the header to a JSON file and can be imported as is using the Import button in Workflows.

.. video:: _static/movies/actionscanbexeportedjson.mp4
   :width: 100% 

   
|
|

Actions in a row will have an option called 'logs' which will open will open all logs associated with that action in a table.

.. thumbnail:: /_images/Images/actiontablelogs.png
   :title:

    Logs
	
.. centered:: :sup:`Logs`

|



Old version below
=======================


In several complex workflows, inputs are dependent on each other and this dependence require us to allow the ability to define the dependence. As an example, when a Text input is changed, value of certain inputs should change to a specific value.Such interactions and dependence are now possible with the new feature named “Input Actions”.

.. video:: _static/movies/actionsinput.mp4
   :width: 100% 

   
|

Actions option for inputs in start worker now supports rearranging the order of different actions in the modal under Workflows.

.. video:: _static/movies/actionsrearranging.mp4
   :width: 100% 

   
|

.. _conditionaction:

The Conditions option in the actions feature now supports usage of 'Expressions' for the dependent action inputs in Workflows.

.. video:: _static/movies/theconditionoption.mp4
   :width: 100% 

   
|

Actions operator has new value called 'Not Equals to' for Text/List/Select input workers in Workflows.

.. video:: _static/movies/notequalsto.mp4
   :width: 100% 

   
|

.. _multiselectactions:

Multiselect option is now available to select multiple dependent inputs for the Actions created in the Start worker.

.. video:: _static/movies/multiselectaction.mp4
   :width: 100% 

   
|

When multiple inputs are selected and added to actions using context menu , then the inputs selected are automatically available in the dependent input list under actions.

.. video:: _static/movies/contextmultiple.mp4
   :width: 100% 

   
|

Typeahead search is now available for Actions when input conditions are selected as 'Equals' in Start worker.

.. thumbnail:: /_images/Images/typeheadsearch.png
   :title:

    Typeahead search
	
.. centered:: :sup:`Typeahead search`

|

Actions can be now cloned in Start worker under Workflows

.. thumbnail:: /_images/Images/actionsclone.png
   :title:

    Clone Actions
	
.. centered:: :sup:`Clone Actions`

|

Actions options in Workflows can now be Expanded/Collapsed which helps us view full action information and view multiple inputs.

.. thumbnail:: /_images/Images/expandedcollapse.png
   :title:

    Expanded/collapsed
	
.. centered:: :sup:`Expanded/collapsed`

|

Actions in Workflows now supports Grouping. The Actions can be removed from a group or moved between the groups.

.. video:: _static/movies/groupssubactions.mp4
   :width: 100% 

   
|

Actions in Workflows now supports invoking of a worker and showing its output in the selected controlled input under start worker. The workers can be invoked while creating the Actions. The video here shows an example of invoking the worker for the Remote lookup input.

.. video:: _static/movies/controlledinput.mp4
   :width: 100% 

   
|

Play button in Actions turns to a stop button and once we click on the stop button Action will not be performed on the input and the input is reset to previous value.

.. video:: _static/movies/playstopbutton.mp4
   :width: 100% 

   
|

Purple border is available on the left side of the input when Actions are added to the inputs in start worker.

.. thumbnail:: /_images/Images/purpleborder.png
   :title:

    border is available
	
.. centered:: :sup:`border is available`

|

Controlled inputs can be identified with the presence a yellow-colored bordering line on the left, within Actions. This is visible while hovering over the main inputs or the action inputs.​

.. thumbnail:: /_images/Images/controlledinputsyellow.png
   :title:

    Controlled Inputs 
	
.. centered:: :sup:`Controlled Inputs`

|

Formatters
==============

New file type formatters are now added to Action inputs and Action worker outputs in Workflows

.. thumbnail:: /_images/Images/formatters.png
   :title:

    File type formatters
	
.. centered:: :sup:`File type formatters`

|

In Start worker Actions, Worker output will now toggle the option ColumnToUse depending on what type of output is chosen. 

.. video:: _static/movies/actionscolumntouse.mp4
   :width: 100% 

   
|

The Actions in the start worker can be Expanded/Collapsed and these are saved to the action settings in Workflows

.. thumbnail:: /_images/Images/actionsstartworkerexpand.png
   :title:

    Expanded/Collapsed
	
.. centered:: :sup:`Expanded/Collapsed`

|

Play and Stop buttons are now unified in Actions under Start worker.

.. thumbnail:: /_images/Images/playandstop.png
   :title:

    Play and Stop buttons unified
	
.. centered:: :sup:`Play and Stop buttons unified`

|

Repeated inputs can be added to workers and saved when invoked in Actions under Start worker.

.. video:: _static/movies/repeatedinputsactions.mp4
   :width: 100% 

   
|

Set multiple
=====================

Start worker list input's multiple flag can be enabled using the Actions in Workflows.

.. video:: _static/movies/setmultipleinputsactions.mp4
   :width: 100% 

   
|

Views Actions
=====================

Actions in the start worker has a new view called Table view which will show a tree view of the action groups on the left and a table of the corresponding actions which will have edit and remove options in each of the rows. ​​

.. video:: _static/movies/workeractionstableview.mp4
   :width: 100% 

   
|

Each input in Start worker has its own Actions button which will open the actions viewer and scroll to the corresponding row​.

.. video:: _static/movies/actionbuttonfrinput.mp4
   :width: 100% 

   
|

Action labels in start worker can be edited. The edit icon is shown beside the label along with clone​

.. video:: _static/movies/actionlabelsedited.mp4
   :width: 100% 

   
|

Actions will be re-run when we change the values in the inputs and provide updated results in Workflows.​

.. video:: _static/movies/actionsreruninputs.mp4
   :width: 100% 

   
|
|