slims.step module¶

class slims.step.Step(name: str, action: Callable, asynchronous: bool = False, hidden: bool = False, input: list = [], output: list = [], **kwargs)¶

Bases: object

The step class defines the step properties of a SLimsGate flow.

execute(flow_run: slims.flowrun.FlowRun) → Any¶

takes id of the flow run and it executes the flow. :param flow_run: flow to run :type flow_run: object

Returns:	if synchronous returns the value of action

to_dict(route_id: str) → dict¶

Construct and return a dict with all (except action) class attribute and the route id passed by argument. :param route_id: id of the route :type route_id: string

Returns:	(dic) of the attributes (except action) and route id

exception slims.step.StepExecutionException¶: Bases: Exception

slims.step.boolean_input(name: str, label: str, **kwargs) → dict¶

Allows to have a yes or no choice input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.date_input(name: str, label: str, **kwargs) → dict¶

Allows to have a date input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.date_time_input(name: str, label: str, **kwargs) → dict¶

Allows to have a date and time input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.file_input(name: str, label: str, **kwargs) → dict¶

Allows to have a file input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.file_output() → dict¶

Allows to have a file output for SLimsGate.

Returns: file output to download in client side

slims.step.float_input(name: str, label: str, **kwargs) → dict¶

Allows to have float input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.integer_input(name: str, label: str, **kwargs) → dict¶

Allows to have integer input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.multiple_choice_with_field_list_input(name: str, label: str, fieldelements: list, fieldtype: list = None, **kwargs) → dict¶

Allows to have a multiple choice out of a list input for SLimsGate.

Parameters:

name (String) – the name of the input
label (String) – the label of the input
fieldelements (list) – the list of elements in which the choice needs to be made, usually strings
fieldtype (list) – the type of the field elements its default value is None
-- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.multiple_choice_with_value_map_input(name: str, label: str, table: str = None, filtered: Any = None, reference: str = None, fixed_choice_custom_field: str = None, **kwargs) → dict¶

Allows to have a multiple choice out of a list input for SLimsGate.

Parameters:

name (String) – the name of the input
label (String) – the label of the input
table (String) – the table name of the possible choices to display its default value is None
filtered (Criteria object) – the filter applied on the list of displayed choice its default value is None
reference (String) – the name of the valueMap of the output of the previous step_dicts its default value is None
fixed_choice_custom_field (String) – the name of a custom field its default value is None
-- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.password_input(name: str, label: str, **kwargs) → dict¶

Allows to have a password input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.rich_text_input(name: str, label: str, **kwargs) → dict¶

Allows to have rich text input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.single_choice_with_field_list_input(name: str, label: str, fieldelements: list, fieldtype: list = None, **kwargs) → dict¶

Allows to have a single choice out of a list input for SLimsGate.

Parameters:

name (String) – the name of the input
label (String) – the label of the input
fieldelements (list) – the list of elements in which the choice needs to be made, usually strings
fieldtype (list) – the type of the field elements its default value is None
-- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.single_choice_with_value_map_input(name: str, label: str, table: str = None, filtered: Any = None, reference: str = None, fixed_choice_custom_field: str = None, **kwargs) → dict¶

Allows to have a single choice out of a list input for SLimsGate.

Parameters:

name (String) – the name of the input
label (String) – the label of the input
table (String) – the table name of the possible choices to display its default value is None
filtered (Criteria object) – the filter applied on the list of displayed choice its default value is None
reference (String) – the name of the valueMap of the output of the previous step_dicts its default value is None
fixed_choice_custom_field (String) – the name of a custom field its default value is None
-- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.table_input(name: str, label: str, subparameters: list, **kwargs) → dict¶

Allows to have a table input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input subparameters (list) – the list of parameters that need to be in the table -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.text_input(name: str, label: str, **kwargs) → dict¶

Allows to have short text input for SLimsGate by return a dictionary.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.time_input(name: str, label: str, **kwargs) → dict¶

Allows to have a time input for SLimsGate.

Parameters:	name (String) – the name of the input label (String) – the label of the input -- every additional and optional parameter (**kwargs) – it needs to be of the form defaultValue=”it is a default value”

Returns: (dict) a dictionary containing all these elements

slims.step.value_map_output(name: str, datatype: str) → dict¶

Allows to have a value map output for SLimsGate.

Parameters:	name (String) – the name of the output datatype (String) – the label of the output

Returns: (dict) a dictionary containing all these elements