Document Settings

Document settings are used to adjust the size of the simulation, provide background and surrounding background color options, add interface variables, create default range selections, set conditions for pages to load, set scenarios for the scenario selector component, set refresh rate, and confirm saved runs for compared runs tables.

Access the document settings by clicking on a blank space on your canvas (not on a component). The document settings property options will appear as a categorized stack of ten horizontal tabs in the component panel. The document settings are described below.

Document Settings: Size and Styles

Click the ‘Size and Style’ tab in the component panel to access the properties used to adjust the simulation size and color, and to select grid display and to allow the sim to maintain scale for the user.

Simulation Width – Enter a number in the ‘Simulation Width’ text entry box to adjust the simulation width.
Simulation – Enter a number in the ‘Simulation Height’ text entry box to adjust the simulation height.
Total Height – Displays the simulation height plus the height of the bottom bar if there is one.
Background Color – Click the ‘Background Color’ box to select a background color for the sim.
Surrounding Background Color – Click the ‘Surrounding Background Color’ box to select a color for the area around the sim.
Show Grid - Place a check mark in the ‘Show Grid’ checkbox to display a grid area, typically used to align objects on the canvas.
Allow Scaling – Place a check mark in the ‘Allow Scaling’ checkbox to enable the sim to shrink when a user adjusts their browser window.

Document Settings: Size and Styles Tab

Document Settings: Interface Variables

Click the ‘Interface Variables’ tab in the component panel to create interface variables. Note that interface variables are used to store and display text entered by users After opening the ‘Interface Variables’ tab, scroll down to view the text entry boxes for creating interface variables.

Name - Enter a name for your variable in the ‘Name’ text entry box.
Default Value – Enter a value for the variable in the ‘Default Value’ text entry box. This is the value of the variable before it has been set.
Scope – Click the ‘Scope’ drop-down menu arrow to select where the variable will be saved. Variables are typically set to ‘Run’.
Add – Click the ‘Add’ button to add the interface variable name, value, and scope to the ‘Interface Variables’ list box.
Edit – Select a variable in the ‘Interface Variables’ list box, and then click the ‘Edit’ button to change the variable name or value.
Remove – Select a variable in the ‘Interface Variables’ list box, and then click the ‘Remove’ button to remove the interface variable.

FAQs

How do you create an interface variable?

Document Settings: Interface Variables Tab

Document Settings: Default Range Selections

Click on the ‘Default Range Selections’ tab to access the properties used to do default range selections for the entire simulation without using an explicit range controller. Note that selections are made from subscripted array variables in the model.

Select User Role From Multiplayer Roles Range – Place a check in the ‘Select User Role From Multiplayer Roles Range’ checkbox to make the selection from the multiplayer roles range, using the users current role. This option allows a specific subscript of an array.
Name – Click the ‘Name’ drop-down menu arrow to select the Range to make the selection from. Note that the ranges come from the model.
Value – Click the ‘Value’ drop-down menu arrow to select the subscript you want selected from the previously selected range. Note that the values are the elements of the above subscripted array variable.
Force Selection – Place a check the ‘Force First Selection’ checkbox to ensure that this selection is set and given priority above those of a Range Controller. This will override any selections that the user may have made on previous pages or in previous controllers.
Add – Click the ‘Add’ button to add the selections made in the ‘Name’ and ‘Value’ drop-down menus, and also in the ‘Force Selection’ checkbox.
Edit – Click the ‘Edit’ button to edit a range selection that has been selected in the ‘Default Range Selections’ list box.
Remove - Click the ‘Remove’ button to remove a selected range selection from the ‘Default Range Selections’ list box.

Document Settings: Default Range Selections Tab

Document Settings: On Load Simulation

Click the ‘On Load Simulation’ tab in the component panel to access the properties used to select which page of the sim the user is taken to if they are logged in, not logged in, or if a facilitator is logged in.

Step to end on load – Place a check mark in the ‘Step to end on load’ checkbox to run the sim to the end while the sim is loading.
If user isn’t logged in go to – Click the ‘If user isn’t logged in go to’ drop-down menu arrow to select a sim page. The user will be taken to the selected page if the user is not logged in.
If user is logged in go to – Click the ‘If user is logged in go to’ drop-down menu arrow to select a sim page. The user will be taken to the selected page when the user is logged in.
If facilitator is logged in go to – Click the ‘If facilitator is logged in go to’ drop-down menu arrow to select a sim page. The facilitator will be taken to the selected page when the facilitator is logged in.

Document Settings: On Load Simulation

Document Settings: On Advance Simulation

Click the ‘On Advance Simulation’ tab in the component panel to set the default page, and to set conditions for skipping to other pages.

Default Page – Click the ‘Default Page’ drop-down menu arrow to select a default page.
Goto Page – Click the ‘Goto Page’ drop-down menu arrow to select a page to skip to based on a condition.
When – Click the ‘When’ drop-down menu arrow, and then click ‘Browse’, to select a variable for establishing a condition.
Is Equal To – Click the ‘is equal to’ drop-down menu arrow to create a condition, and then enter a value in the text entry box to compare to the ‘When’ option. The 'Is equal to' drop-down menu options include the following:
- “is greater than or equal to”
- “is equal to”
- “is greater than”
- “is less than”
- “is less than or equal to”
- “is not equal to”
Add Conditional – Click the ‘Add Conditional’ button to create the condition, and place it in the list box located above the ‘Add Conditional’ button.
Remove Conditional – Click the ‘Remove Conditional’ button to remove a conditional selected in the list box located above the ‘Remove Conditional’ button.
Edit Conditional – Click the ‘Edit Conditional’ button to edit a conditional selected in the list box located above the ‘Edit Conditional’ button.

Document Settings: On Advance Simulation Tab

Document Settings: On End of Simulation

Click the ‘On End of Simulation’ tab in the component panel to access the properties used to set conditions for the end of the simulation.

Goto Page - Click the ‘Goto Page’ drop-down menu arrow to select a page to go to based on the set condition.
When – Click the ‘When’ drop-down menu arrow, and then click ‘Browse’, to select a variable for establishing a condition.
Is Equal To – Click the ‘is equal to’ drop-down menu arrow to create a condition, and then enter a value in the text entry box to compare to the ‘When’ option. The 'Is equal to' drop-down menu options include the following:
- “is greater than or equal to”
- “is equal to”
- “is greater than”
- “is less than”
- “is less than or equal to”
- “is not equal to”
Add Conditional – Click the ‘Add Conditional’ button to create the condition, and place it in the list box located above the ‘Add Conditional’ button.
Remove Conditional – Click the ‘Remove Conditional’ button to remove a conditional selected in the list box located above the ‘Remove Conditional’ button.
Edit Conditional – Click the ‘Edit Conditional’ button to edit a conditional selected in the list box located above the ‘Edit Conditional’ button.

Document Settings: End of Simulation

Document Settings: On New Run Event

Under Construction

Document Settings: Scenarios

Click the ‘Scenarios’ tab in the component panel to access the properties used to set scenarios for the scenario selector component.

Scenarios – The ‘Scenarios’ list box stores the list of scenarios.
Add Scenario – Click the ‘Add Scenario’ button to add the scenario to the ‘Scenarios’ list box.
Edit Scenario – Click the ‘Edit’ Scenario button to edit a scenario selected in the ‘Scenarios’ list box.
Remove Scenario – Click the ‘Remove Scenario’ button to remove a scenario selected in the ‘Scenarios’ list box.
Scenario Name – Enter a name for the scenario in the ‘Scenario Name’ text entry box.
Model Decisions to Set – Contains a list of decisions and values that have been chosen for the selected scenario.
Add a Decision – Click the ‘Add a Decision’ drop-down menu arrow, and then click ‘Browse’ to select a decision variable.
Value to Set - Enter a value in the ‘Value to Set’ text entry box.
Add Decision – Click the ‘Add Decision’ button to add the decision variable and value to the ‘Model Decisions to Set’ list box.
Remove Decision - Click the ‘Remove Decision’ button to remove a decision selected in the ‘Model Decisions to Set’ list box.
Interface Variables to Set – The ‘Interface Variables to Set’ list box contains interface variables for the selected scenario.
Add a Variable – Click the ’Add a Variable’ drop-down menu arrow, and then click ‘Browse’ to select a variable to add.
Value to Set - Enter a value in the ‘Value to Set’ text entry box to set the variable selected in the ‘Add a Variable’ text entry box.
Add Interface Variable – Click the ‘Add Interface Variable’ button to add the variable to the ‘Interface Variables to Set’ list box.
Remove Interface Variable – Click the ‘Remove Interface Variable’ button to remove an interface variable from the ‘Interface Variables to Set’ list box.

FAQs

How do I set a scenario?

Document Settings: Scenarios Tab

Document Settings: Facilitator Settings

Click the ‘Facilitator Settings’ tab in the component panel to access the properties used to set the refresh rate, and the page to go to when a user has reached their run limit. Note that the run limit is set using the ‘Run Limiter’ component.

Facilitator Data Refresh Rate – Enter a number in milliseconds to determine how often the sim should refresh itself when the facilitator is looking at a page that contains data for users. Any number 0 or below means it will not refresh.
Page to goto When Run Limit Reached – Click the ‘Page to goto When Run Limit Reached’ drop-down menu arrow to select the page to send the user when they have reached their run limit.

Document Settings: Facilitator Settings Tab

Document Settings: Default Run Compare Settings

Click the ‘Default Run Compare Settings’ tab in the component panel to access the properties used to set (a) base runs(s) for the simulation. The base run(s) will be displayed on all tables or graphs marked as ‘Make a Compare Runs Graph’ and will not be de-selectable by the user.

Confirm – Click the ‘Confirm’ button to confirm that the selected run(s) in the table located above the ‘Confirm’ button will be used as (a) base run(s).
Clear – Click the ‘Clear’ button to remove any runs that are currently set to be loaded as a base run in the table located above the ‘Clear’ button.

Document Settings: Default Run Compare Settings Tab