Action Parameters

An action parameter is tells Forio Broadcast to take a particular action. All action parameters use the key "FD_action" with a value indicating the action to take. Some actions require a second parameter "FD_runid" or "FD_loginid" which provide Broadcast with information necessary to take the action. All action parameters can be used in a simulation either in the form of URL parameters or form fields. Actions are not case sensitive.

For example, a model can be advanced in time with the URL

http://forio.com/simulation/carfactory?FD_action=step

All stored runs for a given user "john" can be deleted with the following URL. (Only John or the facilitator for John's subscription can do this).

http://forio.com/simulation/carfactory?FD_action=delete_runs&FD_loginid=john

The form fields corresponding to the above URLs would be the following:

and:

Action Parameters

Click on the heading below to learn more about each group of action parameters.

Controlling the Simulation Time

These actions control the simulation time. Possible values for the FD_action parameter are listed below.

FD_action	Description
go_back	Rewind the simulation one period (more precisely, $Run.StepsPerInterval steps).
step	Advance the simulation one period (more precisely, $Run.StepsPerInterval steps)
step_x	Advance the simulation x steps (x should be a number, e.g. "step_2"; will advance exactly that many steps)
step_toend	Advance the simulation to the end
reset	Reset the simulation to the beginning
reset_vars	Reset the simulation variables and start at the beginning, but keep the decisions the same as the were
reset_and_step	Same as reset_vars followed by step
reset_and_step_toend	Same as reset_vars followed by step_toend
reset_and_step_x	Same as reset_vars followed by step_x (where x is a number)
rewind	Rewind the simulation back to the beginning. (unlike reset, this keeps all the initial decisions and the run_id the same as they were)

Posting the Simulation Score

These actions control the simulation time. Possible values for the FD_action parameter are listed below.

FD_action	Description
post_score	Post the current simulation score for this run

Controlling the User Session

These actions affect the current user session.

FD_action	Description
logout	Logs the current user out
start_trial	If the simulation allows it, start a time-limited simulation trial
reload	Clears and reloads all settings in the current session. (Used by the manager application after the model or security settings are changed).

Managing User Runs

These actions are used by a user or the facilitator to review and delete past runs. Some of these actions require an additional FD_runid or an FD_loginid parameter. If an FD_runid parameter is required a 10 character run id must be given (e.g. that given by $Run.RunId). If an FD_loginid parameter is required, the user's login id must be given.

FD_action	Additional parameter?	Description
resume	FD_runid	Resume a previous run
backup		Create a backup copy of the current run
clone	FD_runid	Resume a copy of a previous run
clone_init	FD_runid	Resume a copy of a previous run, starting at the initial time period
clone_default	FD_runid	Resume a copy of a previous run, treating it similar to a default run (similar to clone but takes any decisions at or before InitialSteps and applies them to step 0)
clone_toend	FD_runid	Resume a previous run, then step to the end of the simulation
delete_runs	FD_runid, FD_loginid, or FD_subscriptionid	Delete runs with a given run id, or all runs for a given user or given user group.
set_public_access	FD_runid (optional)	Allow any user in the user's group to clone a run. Sets the property $Run.PublicAccess to true. Applies to the run specified by FD_runid or the current run if not given.
set_private_access	FD_runid (optional)	Only allow the current user or the group facilitator to clone this run. Sets the property $Run.PublicAccess to false. Applies to the run specified by FD_runid or the current run if not given.
set_listed	FD_runid (optional)	Sets the property $Run.Listed to true. Applies to the run specified by FD_runid or the current run if not given.
set_unlisted	FD_runid (optional)	Sets the property $Run.Listed to false. Applies to the run specified by FD_runid or the current run if not given.

Setting the Default Scenario

These actions are used by the facilitator to affect the current default scenario.

FD_action	Additional parameter?	Description
set_default	FD_runid (optional)	Sets the default scenario. Applies to the run specified by FD_runid or the current run if not given. When a user starts a new run, the decisions from this run are applied to the new run. (does not apply to facilitators). Special case: if the default run is at the start, then when the default run is applied all starting decisions will be applied to step 0 (even if InitialSteps is greater than 1).
set_default_init	FD_runid (optional)	Sets the default scenario based on the initial step of the current run. Applies to the run specified by FD_runid or the current run if not given. When a user starts a new run, the decisions from the initial step of this run are applied to the new run. (does not apply to facilitators). Like set_default all starting decisions will be applied to step 0 (even if InitialSteps is greater than 1).
clear_default		Clears the default scenario.

Controlling User Accounts

These actions are used to access user account information

FD_action	Additional parameter?	Description
send_password	FD_loginid or FD_email	Finds all users in the sim matching the given username or email and send them an email with their password and account information.