This is the html version of the file http://rechten.uvt.nl/ictrechtenonderwijs/support/LinkedDocuments/Sieberdam-ROCS%20User%20Manual.doc.
G o o g l e automatically generates html versions of documents as we crawl the web.
To link to or bookmark this page, use the following url: http://www.google.com/search?q=cache:bGIDu7DL5s4J:rechten.uvt.nl/ictrechtenonderwijs/support/LinkedDocuments/Sieberdam-ROCS%2520User%2520Manual.doc+simbuild+help&hl=en&ct=clnk&cd=1&gl=us&client=firefox-a


Google is neither affiliated with the authors of this page nor responsible for its content.
These search terms have been highlighted: simbuild help 

Sieberdam/ROCS v1.0 User Manual

 

sofos

consultancy

Opdrachtgever:

VSNU RechtenOnline

Afnemer:

Stichting RechtenOnline 
 

Project Manager:

Pieter van der Hijden

Sofos Consultancy

Amsterdam, December 30th 2004

Ardcalloch by Paul Maharg inspired the VSNU Program RechtenOnline to fund three projects aimed at the development of a Dutch equivalent: 1. the Dutch virtual City of Sieberdam, 2. the e-learning suite for asynchroneous workflow based group simulations ROCS, and 3. the integrated Sieberdam/ROCS. Rudi Holzhauer (project management, content authorship, and design), Martin de Wit (Flash programming), Willem Mieras (visual design), and Sander Gellaerts (student-assistant) developed Sieberdam. Aernout Schmidt and Jeroen Leijen (project management and design), Lokman Tsui (design), Peter van Schijndel (design), and Collaboraid ApS København (software development) developed ROCS. Pieter van der Hijden (consultant to both projects) integrated Sieberdam and ROCS into Sieberdam/ROCS and extended the system (project management and design), together with Jarkko Laine (software development) and the former Sieberdam and ROCS project teams. The Dutch Foundation RechtenOnline (Law-Online) now is the owner of the product.

Preface

Sieberdam/ROCS is an electronic learning suite for (parallel) computer-supported asynchroneous gaming/simulations in the context of a virtual city. Sieberdam/ROCS has been developed for the Dutch Law Faculties; the source code is available under General Public Licence version 2. Its technical name is OpenACS Application Simulation. The Dutch Foundation RechtenOnline (Law-Online) now is the owner of the product.

Ardcalloch by Paul Maharg inspired the VSNU Program RechtenOnline to fund three projects aimed at the development of a Dutch equivalent: 1. the Dutch virtual City of Sieberdam, 2. the e-learning suite for asynchroneous workflow based group simulations ROCS, and 3. the integrated Sieberdam/ROCS. Rudi Holzhauer (project management, content authorship, and design), Martin de Wit (Flash programming), Willem Mieras (visual design), and Sander Gellaerts (student-assistant) developed Sieberdam. Aernout Schmidt and Jeroen Leijen (project management and design), Lokman Tsui (design), Peter van Schijndel (design), and Collaboraid ApS København (software development) developed ROCS. Pieter van der Hijden (consultant to both projects) integrated Sieberdam and ROCS into Sieberdam/ROCS and extended the system (project management and design), together with Jarkko Laine (software development) and the former Sieberdam and ROCS project teams.

The Sieberdam/ROCS User Manual describes the actual working of Sieberdam/ROCS V 1.0 december 2004 following the default System Administrator settings. The manual uses the preferred terminology. Where the system itself still uses older terms, this will be noted. Known anomalies in system functioning will be noted as well.

The manual is intended for different categories of users. The following table lists which chapters are relevant for which user categories.

  User Category
Chapter Simulation Session Participants (students) Simulation Session Administra-  tors (tutors) Simulation Model Authors (teachers) City Editors (teachers)
Simulation Home x x x x
Sieberdam x x x x
CityBuild       x
SimBuild     x  
SimInst   x x  
SimPlay x x x  
Miscellanea x x x x
 

Pieter van der Hijden

Sofos Consultancy

Amsterdam, December 30th 2004.

Inhoudsopgave

  1. Simulation Home
    1. Synopsis

Sieberdam/ROCS is an electronic learning suite for concurrent computer-supported asynchroneous gaming/simulations in the context of a virtual city. Participants to a simulation session will play a certain role (either individually or as a team). Each role refers to a character (organisation, particular person) in the virtual city of Sieberdam. During a simulation session, a role may freely exchange messages with other roles, i.e. other participants. Depending on the state of the session a role may execute certain activities (sometimes optional, sometimes compulsory) that could bring the session in another state.

The Simulation Home page is the portal to Sieberdam/ROCS functions. The main functions are: the Sieberdam City Map and the Sieberdam Directory that give access to the home pages of Sieberdam characters, the CityBuild gunction to maintain the virtual city, the SimBuild functions to write simulation models (roles, states, activities), the SimInst function to set-up simulation sessions and the SimPlay function to run the simulation sessions.

    1. Access

The Simulation Home page is the start page of Sieberdam/ROCS. All users have access to it. Users who have not been logged in, do not see the CityBuild, SimBuild, and SimInst functions.

    1. Terminology
preferred term old term
Sieberdam Directory Yellow Pages
    1. Screenshot
 
 
The Simulation Home page shows a control bar (top), a menu (left), the Sieberdam city map (right) and two more menu items (Map Help and Change Language) (bottom).
    1. Description

The menu lists the following items:

When the user clicks a menu item, the system displays the corresponding page.

The Control Bar (top) and the menu item Change Language (bottom) are visible on all Sieberdam/ROCS pages.

    1. See Also
    1. Anomalies
  1. Sieberdam
    1. Synopsis

The Sieberdam City Map is an interactive page element. It shows a part of the city map and popup windows and home pages with information on city objects. The Sieberdam Directory is a list of city objects that gives access to the home pages with information as well.

    1. Access

There exist two ways to have access to the Sieberdam City Map and the Sieberdam Directory:

    1. Terminology
    1. Screenshot
 
The screenshot shows an enlarged (zoomed-in) part of the city map with streets, street names and icons. Apparently, the mouse points to an icon (lower left corner). The corresponding city object's name is displayed ("Bibliotheek Sieberdam") and a popup window with a short description, a thumbnail picture and a hyperlink called "site" has been opened (upperright corner). The navigator popup window is open (upper left corner), the legenda popup window is closed. The Navigor Tab and the Legenda Tab act as controls to open and close these popups. The other controls are a zoom-in (+) button, a zoom-out (-) button and arrows in four directions. Not visible is the fact that the key's A and (big) "+" also behave as zoom- in, while the key's "Z" and "-" behave as zoom- out. Outside the map is a hyperlink to the Map Help text.
    1. Description

Sieberdam consists of a City Map and a Directory. Both have hyperlinks to the home pages of City Objects.

      1. Sieberdam City Map

The interactive City Map window has the following functions:

Clicking on the hyperlink to the help text for this map, displays this very text.

      1. Sieberdam Directory

The Sieberdam Directory lists all Sieberdam city objects. For each city object, it displays the type (location, character or prop), the name, and a short description. The user may sort this list by type, by name or by description.

The user can filter the list to select city objects matching a certain word or phrase, and clear the filter subsequently. Both the name and the description of the city objects are included into the filtering operation.

Clicking on an item's hyperlink, displays the home page of the selected City Object (text plus picture).

    1. See Also
    1. Anomalies
  1. CityBuild
    1. Synopsis

The purpose of CityBuild is to manage city objects like locations, characters and props. It is also used to manage additional data for these objects, like images and stylesheets. CityBuild further serves the upload of documents that will be attached to instructions for participants during simulation sessions.

    1. Access

CityBuild is accessible for users the have been logged-in. They should be members of the City Admin user group or the Simulation Admin user group. Members of the City Admin group may create new city objects, lookup all objects and see their contents. They may edit or delete the objects they created themselves. Members of the Sim Admin group also are permitted to edit or delete city objects created by other users.

    1. Terminology
    1. Screenshot
 
= edit - = delete

The CityBuild home page contains a hyperlink to the CityBuild Help text, a button to create a new city object, and a list of city objects. For each city object, the type, name, URI, description and object ID are listed. Sorting of the list is possible by type, by name, by URI and by description. Item names are hyperlinks. Items may have an icon for editing or deleting. The URI is a unique resource identifier which might be set by the user who created the city object. The object ID is an integer number determined by the system.

    1. Description

CityBuild has the following subfunctions:

The user executes these subfunctions via the CityBuild page. The subfunctions have their own pages, The City Build Home page also contains a Help hyperlink which displays this very text and a hyperlink to Return to the Simulation Home page.

      1. Create City Object

When a user activates the Create City Object subfunction an empty form is displayed. This form is used to enter various types of Sim Objects into the Sim Object database:

The fields on the form depend on the type of the object to be entered. The following table gives an overview.

      1. Lookup and Edit City Objects

A user may lookup any city objects by sorting and filtering the tabular listing of city objects. Depending on her access rights, the user may edit or delete a city object. When editing, the same form appears as used during the creation of the object.

      1. Manage City Object Notifications

At regular intervals, the system generates the City Map XML file. This file tells the interactive city map which City Objects to display. However, when no City Objects have been added, changed, or deleted, no new City Map XML file will be generated. The system can send an e-mail notification when a new City Map XML file has been created.

The user has various options to manage these City Object notifications:

    1. See Also
    1. Anomalies
  1. SimBuild
    1. Synopsis

The purpose of SimBuild is the creation and editing of simulation models. A model consists of roles, states, and activities.

    1. Access

SimBuild is accessible for users the have been logged-in. They should be members of the Template Author user group or the Simulation Admin user group. Members of the Template Author group may create new simulation models, lookup and/or copy all simulation models and edit or delete the models they created themselves. Members of the Sim Admin group also are permitted to edit or delete simulation models created by other users.

    1. Terminology
    1. Screenshot
 
= edit - = copy - = delete

The SimBuild home page contains a link to the SimBuild help text, a pushbutton to create a new simulation model, a pushbutton to import an existing simulation model, a table of existing simulation models. The table lists the simulation models the user may edit, copy and/or delete. It displays the model name, the model description, the author name (the user who created the model), the number of roles, the number of tasks and the current state (ready to simulate or not). The table may be sorted by model name, by description and by author name.

    1. Description

SimBuild has the following subfunctions:

The user activates these subfunctions via the SimBuild page. This page also contains a Help hyperlink which displays this very text and a hyperlink to Return to the Simulation Home page.

The subfunctions have their own pages. Via a hyperlink the user can return to the SimBuild home page or to the Simulation home page.

      1. Create Simulation Model

When a user clicks the Create a Simulation Model pushbutton a blank form is displayed.

 

This form is used to enter the metadata for a new simulation model:

Once the user presses OK, a new form is opened, the simulation model editing form.

The Edit form consists of the following elements:

The Simulation Model Edit form has no explicit OK or Cancel buttons at its bottom. In fact every change is saved immediately.

Metadata Section

The metadata section of the edit model form can be open or closed. Initially, it is open. By pressing OK or Cancel, it is closed. Then, by pressing the Edit button, it may be opened again.

 

The meaning od the fields Model Name, Suggested Duration and Description is explained before. See Create Simulation Model.

Now, an additional field is displayed: "Ready to simulate?", with a check box to indicate "yes" (check mark) or "no" (no check mark).

A new model always has the check box unchecked (e.g. "not ready"). The user has to check it explicitly in order to make simulation sessions with the model possible. When the model has apparent shortcomings, the system will not let the user mark the check box. Even when the check box has been marked, the system will reset it every time the user opens the model for editing.

Roles Section

The Roles Section of the Simulation Model Edit form is intended to enter the roles that during simulation sessions have to be played by human participants. Each role should have a unique name. Role names may be changed. Roles may be deleted. The sequence within the list of roles may be changed as well.

 
= edit - = move downwards - = move upwards- = delete

In a sample model six roles are distinguished: supplier, firm, big client, small client, authority and facilitator. The first four normally will be played by student teams, the authority will be played by an external consultant, the facilitator by the tutor.The figure shows the roles section of the model form for this sample model.

States Section

The States Section of the Simulation Model Edit form is intended to enter the states that during simulation sessions may be reached. Each state should have a unique name. State names may be changed. States may be deleted. The sequence within the list of states may be changed as desired. The actual sequence has no effect on simulation sessions; it serves presentation purposes only.

 
= edit - = move downwards - = move upwards- = delete

The screenshot shows the states section of the Simulation Model Edit form for a sample model.

 

A simulation session starts in a certain state. The actual state determines which activities can be executed. The execution of an activity may change the state. The session ends when a state is reached in which no further activities are possible.

In a simple sample model four states are distinguished: begin, ready to order, orders processed, and end. Note that the sample model states suggests a linear sequence of states. That is not necessary however.

Activities Section

The Activities Section of the Simulation Model Edit form is intended to enter activities and to enable activities in certain states.

When the user clicks the Create New Activity pushbutton a blank form is displayed.

 
Screenshot of the Create New Activity form.
 

This form is used to enter various types of activities:

The fields on the form depend on the type of the object to be entered. The following table gives an overview.

 

A role activity is assigned to a role. The activity description field contains the instruction for the participant who will play that role. The "# of attachments" field indicates the maximum number of attachments that will accompany the instruction for the participants. In the case of a message type role activity, the recipients field lists the recipients of the message and the "default message" field may contain a default text for that message.

All activities have a "next state" field. This field indicates the state of the session after completion of the activity. It might be "unchanged".

As an example we enter the pseudo role activity "start of the session", i.e. an initial action.

 
The screenshot shows the Create New Activity form for an initial action.
 

Next, we enter the following activities:

Once these activities have been entered, the model form displays a matrix which relates tasks to states. Each cell contains a checkbox. Marking a chackbox enables an activity during a certain state. The figure below shows the matrix for the sample model.

 

Note, that the matrix also offers the opportunity to arrange the order of activities, to open the activities for editing, to copy or delete them, and to rename or delete states.

      1. Import Simulation Model

When the user clicks the Import a Simulation Model pushbutton a blank form is displayed.

 
Screenshot of the Import a Simulation Model form.
 

In the spec field the software listing of a simulation model may be pasted. It could be a backup for a model, e.g. from another Sieberdam/ROCS server. This import function is the opposite of the export function on the Create Simulation Model page (hyperlink "Export this template as a text file").

      1. Edit Simulation Model

The system displays a table with models. The creator of a model and the Simulation Administrators may edit the model form or even delete it. All users may copy the model (making the copy their own) and change its content subsequently.

Each entry of the list contains the following fields:

The user can sort the list by model name, description, author.

    1. See Also
    1. Anomalies
  1. SimInst
    1. Synopsis

The purpose of SimInst is the creation and editing of simulation schedules, i.e. schedules for simulation sessions and to have these sessions started (either manually or automatically).

    1. Access

SimInst is accessible for users the have been logged-in. They should be members of the Case Author user group or the Simulation Admin user group. Members of the Case Author group may create new simulation schedules and to edit or delete their existing ones as long as the sessions have not been started. Members of the Sim Admin group also are permitted to edit or delete simulation schedules created by other users.

    1. Terminology
    1. Screenshot
 
= edit - = delete

The SimInst home page contains a link to the SimInst help text, a button to create a new simulation schedule, and two tables. The first table lists the simulation schedules that have not been completed. The fields displayed are: the session name, the state (of the scheduling process), the model description. The second table shows the simulation schedules that are ready to run. It displays the session name, the number of users that have been enrolled as participants, the number of parallel sessions that will be created, the planned start date of the simulation session(s) and a hyperlink to start immediately.

    1. Description

SimInst has the following subfunctions:

The user activates these subfunctions via the SimInst page. This page also contains a Help hyperlink which displays this very text and a hyperlink to Return to the Simulation Home page.

The subfunctions have their own pages. Via a hyperlink the user can return to the SimInst home page or to the Simulation home page.

      1. Create Simulation Schedule

When the user clicks the Create Simulation Schedule button, the system displays a list of models to choose from. Only models "ready to simulate" are listed.

 

The list contains all templates from all authors that have been set ready to simulate. For each model it displays the name, the suggested duration, the number of  roles, the number of tasks and a hyperlink to start preparing the schedule.

When the user selects a model, a new page opens and the user has to enter a unique name for the new schedule.

 
 
 

Next, the user has to fill in five forms which will be described in the next paragraphs. The names of these foms are:

The forms do not have OK or Cancel buttons. Every change is saved immediately. When a user stops filling in these forms and returns to the SimInst page, the List of Simulation Schedules under Construction displays the state of the scheduling process (not started, settings completed, roles completed, activities completed, participants completed, ready for casting. Only the last form has a finish button.

Settings

The first form the user has to fill is the Settings form.

 

The Settings form consists of a number of entry fields that all have been filled with a default value:

Roles

The second form the user has to fill is the Roles form.

 

The Roles form consists of the following entry fields:

Activities

The third form the user has to fill is the Activities form.

 

The Activities form consists of the following entry fields:

The Roles form lists the roles that belong to the simulation model. The user has to link each role to a character of Sieberdam.

The form contains pushbuttons to go to the previous or to the next form. When going to the next form, the state of the schedule changes to "Roles Completed".

Participants

The fourth form the user has to fill is the Participants form.

 
 

The Participants form consists of the following entry fields:

Casting

The fifth form the user has to fill is the Casting form.

 

The Casting form consists of the following entry fields:

      1. Edit Simulation schedule

The system displays a table with schedules under construction.

Each entry of the list contains the following fields:

The user can sort the list by schedule name. The user can open a schedule for editing or delete it.

      1. Activate Simulation schedule

The system displays a table with schedules ready-to-run:

Each entry of the list contains the following fields:

The user can sort the list by schedule name or start date. The user can start a session immediately.

    1. See Also
    1. Anomalies
  1. SimPlay
    1. Synopsis

The purpose of SimPlay is to let users participate in simulation sessions (either as a participant or as a session administrator). A simulation session follows a certain simulation schedule and is driven by a simulation model. SimPlay supports participants and Session Administrators.

    1. Access

SimPlay is accessible for users that have been logged-in. Depending on the enrolment rules included into the simulation schedule, users are enrolled as parrticipants. Members of the Case Author group may administer their own simulation sessions. Members of the Simulation Admin group may administer all simulation sessions.

    1. Terminology
    1. Screenshot
 
= edit - = delete

The SimPlay home page contains a link to the SimPlay help text, and three tables. The first table lists the simulation sessions in which the user is participating (playing a role), the second table lists the simulation sessions the user is administering, the third table lists all messages that have been generated in the sessions the user is administering.

    1. Description

Simplay has the following subfunctions:

The SimPlay home page also contains a Help hyperlink which displays this very text and a hyperlink to Return to the Simulation Home page.

The subfunctions have their own pages. Via a hyperlink the user can return to the SimPlay home page or to the Simulation home page.

In the case a user only participates in a single session and does not administer any sessions, the SimPlay home page is skipped entirely. The user goes directly to the Session Home page.

      1. Participate in Simulation Session

The Session Home page is the start page for session participants.

 

The navigation section displays the name of the simulation session and its number, the role the participant is playing and the actual state of the session (if not switched off during SimInst). Further, it lists the following menu items:

The navigation section ends with a list of all contacts (role + character) involved in the session (if not switched off during SimInst). When clicking on a contact, the character's home page appears in the right section. It contains a button to letthe current participant send a message to the contact.

      1. Administer Simulation Session

The Session Administration page belongs to a specific simulation session.

 

The Session Administration page has the following elements:

    1. See Also
    1. Anomalies
  1. Miscellanea
    1. Synopsis

The miscellaneous functions server different functions, mainly regarding user settings and user documentation.

    1. Access

Every user has access to the miscellaneous functions.

    1. Terminology
    1. Screenshot
 
The Simulation Home page shows a control bar (top), a menu (left), the Sieberdam city map (right) and two more menu items (Map Help and Change Language) (bottom).
    1. Description

The Simulation Home page gives access to the following miscellaneous functions:

      1. Control Bar

The control bar contains the following displays and controls:

      1. Other Functions
    1. See Also
    1. Anomalies

Glossary

Activity

An activity is a specific act during a simulation session. An activity may have been assembled from smaller activities. Activities that are not subdived further, atomic activities, are allocated to a role.

Authors define activities for a certain simulation model with SimBuild. Session administrators may slightly change the description of activities with SimInst. Roles (i.e. participants) execute activities during the simulation sessions.

The execution of an activity ends normally or abnormally, e.g. when the participant sends a message, or uploads a document, the corresponding activity ends normally. An activity ends abnormally by a time-out or by becoming obsolete due to the completion of some other activity.

The normal termination of an activity may or may not change the state of the simulation session. Every execution of an activity is logged.

Activities performed by participants are either archive actions or message actions:

Archive

A collection of files belonging to a role during a simulation session.

Author

The creator or editor of a simulation model. An author uses SimBuild to create or change a simulation model.

Character

A character is an inhabitant of the virtual city of Sieberdam. A role in a simulation is always linked to a character. A character lives on a certain location and works for (another) location in Sieberdam.

City Object

A city object is a location, a character or a prop.

Condition

Situation in which a certain activity can take place. The author of a simulation model specifies the conditions for an activity to take place, i.e. during which state it is available and which state will be reached after its completion.

Contact

A contact is a role plus the character associated to it.

Citybuild

The management of the virtual city of Sieberdam (changing the map, adding Sieberdam objects).

City Administrator

The user who administers the virtual city of Sieberdam, i.e. the "burgomaster" of Sieberdam.

Directory

A list of Sieberdam objects (locations, characters, props). The list items are hyperlinked to the Sieberdam objects' home pages.

Home Page

The base page for a Sieberdam object (location, character, or prop).

Location

A position on the Sieberdam map that may have its own home page. A location can contain other locations. Characters reside at a certain location and work for (another) location. Props are associated with a certain location.

User Group

A set of users with some common characteristic. Sieberdam/ROCS uses the user group concept as an efficietnt tool to manage access rights and to allocate participants to simulation sessions.

Multi-session

A set of concurrent simulation sessions based on the same simulation model and the same simulation schedule.

Model

The recipe for a simulation session, not the session itself. Also used: simulation model. A simulation model describes states, roles and activities and their mutual relations. A model has either the status "under construction" or "ready to simulate". When the Author has set it to "ready to simulate", a Session Administrator may use it to plan and execute sessions with it. At any moment an author may set a model "not ready". This does not effect any planned or active sessions.

Participant

A user who participates in a simulation session by playing a certain role; the role may be shared by a team of participants.

Player

Software to run a simulation based on a model, i.c. the SimPlay function of Sieberdam/ROCS.

Prop

A stage accessory. A prop might have a home page. It is associated with a location in Sieberdam.

ROCS

Originally, RechtenOnline Communication System, in fact an e-learning suite completed by a visualised knowledge domain, i.c. Sieberdam.

Role

A position or function in a simulation session, executed by either one or more human participants.

Schedule

The planning for a certain (set of) simulation session(s) including the adjusted simulation model, the enrolment rules and eventually the actual role allocations.

Session

A run of a simulation model. Also used: simulation session.

The life-cycle of a simulation session consists of the following phases:

The Session Administrator uses the SimInst functions to start the planning phase for a simulation based on a model that is ready to simulate. The same functions are used to go through the enrolment phase and the ready-to-start phase. Once the sessions are active the Session Administrator uses the SimPlay functions to administer them.

Session Administrator

A user responsible for the scheduling of simulation sessions. This user has access to the SimInst functions.

Sieberdam

A virtual city, in fact the visualised knowledge domain used by ROCS.

Simbuild

Subsystem of Sieberdam/ROCS to build a simulation model.

Siminst

Subsystem of Sieberdam/ROCS to schedule a simulation session.

The SimInst process is broken down in two phases:

Simplay

A subsystem of Sieberdam/ROCS to run (simulate) a simulation model.

Simulation

The concept of simulation has three different meanings:

Simulation Administrator

The user who administers the OpenACS package called "simulation", i.c. the Sieberdam/ROCS software.

State

A condition during a simulation session.

System Administrator

The user responsible for the OpenACS system.

User

A person registered as such in the OpenACS system, identified by a login name and a pasword. Users can be members of groups. Access rights can be assigned to users, but normally will be assigned to groups.