Rule: Interact-with-gpa-analyser
loading x elements...

Name: Interact-with-gpa-analyser

Version: 3

Discussion Thread

Creator: oobola@yahoo.com

Creates an option that allows for a user to input arguments for the program
InteractGpaAnalyser and execute it.

ID: 595

Created: Oct. 17, 2019, 9:50 a.m.

full definition:

The below is the JSON description of this object.

It is annotated with links to the documentation of each component.

You can hide fields with default values to make things clearer, and copy it to a clipboard to make creating similar Rules and Options easier.

Rule

{ "name" : "Interact-with-gpa-analyser", "description" : "Creates an option that allows for a user to input arguments for the program
InteractGpaAnalyser and execute it."
, "dependencies" : [

Dependency

{ "symbol" : "gpa_analyser_v1" }
], "threshold" : 1.0, "trigger" :

Trigger

{ "repeat" : "different_variables", "arguments" : [

Tag filter (for search)

{ "type" : "tag", "symbol" : "?user_input_uploaded_file", "arguments" : { "0" :

File filter

{ "type" : "file", "var" : "dataJsonFile", "name_matches" : "^.*\\.json$" }
} }
] }
, "actions" : [

Create an Option

{ "type" : "create_option", "var" : "interact-with-gpa-analyser", "name" : "interact-with-gpa-analyser", "description" : "prompts user for input parameters", "confidence" : 1000.0, "trigger" :

Trigger

{ }
, "display" :

Option Display

{ "must_always_be_shown" : true, "parameter_file_name" : "userParametersFile", "message_components" : [

Text message component

{ "type" : "text", "text" : "Input the values/parameters before running the analysis." }
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "action", "title" : "Action to be performed", "description" : "Math function to be performed on the data", "optional" : true, "value" :

String Parameter

{ "type" : "string", "default" : "mean" }
}
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "mean_type", "title" : "Type of measn to be calculated", "description" : "Type of mean to be calculated, ie. per_student or per_year", "optional" : true, "value" :

String Parameter

{ "type" : "string", "default" : "per_student" }
}
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "years", "title" : "Years covered", "description" : "Min & max years covered by the provided gpas. Needed if mean_type is per_year.", "optional" : true, "value" :

String Parameter

{ "type" : "string" }
}
], "buttons" : [

Option Display Submit Button

{ "text" : "perform analysis", "style" : "cta" }
] }
, "actions" : [

Execute a Program

{ "type" : "execute_program", "program" : "InteractGpaAnalyser", "arguments" : { "student_data_file" :

Variable

{ "type" : "variable", "var" : "dataJsonFile" }
, "user_parameters_file" :

Variable

{ "type" : "variable", "var" : "userParametersFile" }
} }
] }
], "existing_variables" : { "dataJsonFile" :

Variable

{ "type" : "file" }
, "interact-with-gpa-analyser" :

Variable

{ "type" : "option" }
} }

Rule

{ "name" : "Interact-with-gpa-analyser", "description" : "Creates an option that allows for a user to input arguments for the program
InteractGpaAnalyser and execute it."
, "dependencies" : [

Dependency

{ "symbol" : "gpa_analyser_v1", "weight" : 1.0, "comment_filter" : null }
], "threshold" : 1.0, "trigger" :

Trigger

{ "repeat" : "different_variables", "arguments" : [

Tag filter (for search)

{ "type" : "tag", "var" : null, "role" : "required", "search_type" : "last", "search_postfilter" : null, "targeted_by" : [], "equals" : null, "created_by" : null, "created_earlier_than" : null, "created_in_same_event_as" : null, "created_later_than" : null, "is_reserved" : null, "symbol" : "?user_input_uploaded_file", "comment" : null, "comment_contains" : null, "comment_matches" : null, "weight" : null, "min_weight" : null, "max_weight" : null, "nullified" : false, "requirement_is_provided" : null, "task_is_finished" : null, "arguments" : { "0" :

File filter

{ "type" : "file", "var" : "dataJsonFile", "role" : "required", "targeted_by" : [], "equals" : null, "created_by" : null, "created_earlier_than" : null, "created_in_same_event_as" : null, "created_later_than" : null, "is_reserved" : null, "name_matches" : "^.*\\.json$" }
} }
], "deactivate_if" : {} }
, "actions" : [

Create an Option

{ "type" : "create_option", "var" : "interact-with-gpa-analyser", "name" : "interact-with-gpa-analyser", "description" : "prompts user for input parameters", "confidence" : 1000.0, "trigger" :

Trigger

{ "repeat" : "never", "arguments" : [], "deactivate_if" : {} }
, "display" :

Option Display

{ "must_always_be_shown" : true, "parameter_file_name" : "userParametersFile", "message_components" : [

Text message component

{ "type" : "text", "text" : "Input the values/parameters before running the analysis." }
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "action", "title" : "Action to be performed", "description" : "Math function to be performed on the data", "optional" : true, "value" :

String Parameter

{ "type" : "string", "default" : "mean", "multiline" : false }
}
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "mean_type", "title" : "Type of measn to be calculated", "description" : "Type of mean to be calculated, ie. per_student or per_year", "optional" : true, "value" :

String Parameter

{ "type" : "string", "default" : "per_student", "multiline" : false }
}
,

Option Parameter Selector

{ "type" : "option_parameter_selector", "name" : "years", "title" : "Years covered", "description" : "Min & max years covered by the provided gpas. Needed if mean_type is per_year.", "optional" : true, "value" :

String Parameter

{ "type" : "string", "default" : null, "multiline" : false }
}
], "buttons" : [

Option Display Submit Button

{ "text" : "perform analysis", "style" : "cta", "replace_normal_actions" : false, "is_the_default_button" : false, "actions" : [] }
] }
, "actions" : [

Execute a Program

{ "type" : "execute_program", "var" : null, "program" : "InteractGpaAnalyser", "arguments" : { "student_data_file" :

Variable

{ "type" : "variable", "nullable" : false, "var" : "dataJsonFile" }
, "user_parameters_file" :

Variable

{ "type" : "variable", "nullable" : false, "var" : "userParametersFile" }
}, "argument_lists" : {} }
] }
], "existing_variables" : { "dataJsonFile" :

Variable

{ "type" : "file", "value" : null }
, "interact-with-gpa-analyser" :

Variable

{ "type" : "option", "value" : null }
} }

all versions of this Rule:

Version 3

Version 2 (deleted)

Version 1 (deleted)