API Documentation

Module

frontend/src/utils/sessionStorage/localSsotController/parameters

Methods

# inner checkIfParameterObjectCorrect(parameterObject, rpaFunctionalitiesObject) → {Boolean}

Checks if the parameter object is filled correctly
Parameters:
Name Type Description
parameterObject String Parameter object for which to check if it is filled correctly
rpaFunctionalitiesObject String Rpa functionalities object (rpa-task) needed to check for correctness

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 91

Indicates if parameter object is filled correctly
Boolean

# inner createParameterObject(localParameterStorage, robotId, activityId, application, task) → {Object}

Creates a parameter object in the parameter session storage
Parameters:
Name Type Description
localParameterStorage Array An Array containing the current parameter objects
robotId string Id of the selected robot
activityId string Id of the selected activity
application String Name of the rpa application the activity has selected
task String Name of the rpa task the activity has selected

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 20

Newly created parameter object
Object

# inner deleteUnusedParameterFromDB(parameters, usedElementIds, robotId)

If there is more than one unused parameter object, delete it in the database
Parameters:
Name Type Description
parameters Array List of all parameters saved in the session storage
usedElementIds Array ActivityIds that are still being used
robotId String Id of the robot

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 294

# inner getParameterObject(robotId, activityId) → {Object}

Retrieves the parameter object for the activity from the session storage and checks if the paramter object is correctly filled. If no paramter object for the activity exists but an attribute object then it will create a new parameter object and add it to the session storage. If no parameter object and no attributes object exists for the activity it will return undefined.
Parameters:
Name Type Description
robotId String Id of the robot/ssot for which the parameter object will be retrieved
activityId String Id of the activity for which the parameter object will be retrieved

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 129

Parameter object for the activity
Object

# inner getParameterObjectForActivity(activityId) → {Object}

Retrieves the parameter object for an activity from the session storage
Parameters:
Name Type Description
activityId String Id of the activity for which to get the parameter object for

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 76

Parameter object for the activity
Object

# inner getParameterStorage() → {Array}

Retrieves the parameter object session storage

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 68

Parameter session storage
Array

# inner parameterPropertyStatus(robotId, activityId, parameterName, property) → {String}

Retrieves the parameter session storage and returns the current value of the property that will be checked
Parameters:
Name Type Description
robotId string Id of the selected robot
activityId string Id of the selected activity
parameterName string Name of the parameter for which to get an update on the status of a property
property string Property of the parameters to get the current value of

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 245

Value of the property of the parameter or undefined if the activity has no parameter objects
String

# inner setOutputValueName(activityId, value)

Sets the new value as the name of the output variable in the session storage
Parameters:
Name Type Description
activityId String Id of the activity for which the value of the output variable will be changed
value String New value for the name of the output variable

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 269

# inner setPropertyForParameter(activityId, parameterName, property, value) → {Object}

Sets a property of a single parameter object in the session storage
Parameters:
Name Type Description
activityId String Id of the activity for which to change a parameter property for
parameterName String Name of the parameter of which a property will be changed
property String Name of the property that will be changed
value Object Value object returned by the dropdown selection

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 208

Updated parameter object
Object

# inner setSingleParameter(activityId, value, parameterName)

Sets a single parameter value in the session storage
Parameters:
Name Type Description
activityId String Id of the activity for which to change the parameter value for
value Object Value object returned by the dropdown selection cotaining the new parameter value
parameterName String Name of the parameter that will be changed

View Source frontend/src/utils/sessionStorage/localSsotController/parameters.js, line 170