Preview Scenario SDK - API

[griemens]

Hi,

Would like to build a custom training solution using walkinside SDK. And I checked out the preview SDK but some required features are missing I think.

The ITS training has the following requirements:

• Scenarios will be for individual training
• The UX must be as simple as possible. (trainees will not have time to read a manual of Walkinside, trainees can at any time go to the workstation and start a training when they have time)
• When the scenario module is started, the user must select the scenario and if he wants to do a training or as a test. Training = pathway visible, and 3d labels of actions visible, test = no action window in bottom left corner, no pathways no icons.)
• The procedure requires in some cases decisions from trainee after or before an action. (Ex. To what level must the presure drop before continuing)
• The procedure requires in some cases a notification text to be displayed to the trainee after or before an action. (Ex. Example the temperature of fluid is 60degrees)
• There must be a scoring displayed (for example the clock is replaced by current score/total score) Each action is 1 point, each correct answer to a question is 1 point -> sum = total score for the scenario
• The report must display the score, and it is required to match the companies report template as much as possible.

The API that I believe is missing.

Player

SDKViewer.ForPreview.Its.ScenarioManager

• Get all existing scenarios (Allows to have a form that is shown on top of the 3D full screen. The user will select the scenario using this dialog) Official toolbar is to hard/risky, as users could modify this, and so next trainee will not find it.
• DisableDisplay (ActionWindow | Clock | ActionVisuals | PathWay) : Visuals = icons, text and labels of action item types.
• Start scenario
• Stop Scenario (when user presses ESC)

IItsAction

• GetAttributeValue(name) -> Similar like IVREntity name can be MessageBefore, MessageAfter, Question, Answer

ItsScenarioGameOverEventArgs or ItsScenarioStoppedEventArgs:

• ShowReport = false (So I can display my own report), alternative IitsScenarioManager.GlobalReport = new MyReportImplementation()

Editor

The instructore will need to create a normal scenario and afterward use a custom scenario editor to add the questions and Notifications to the actions.

SDKViewer.ForPreview.Its.ScenarioManager

• Get all existing scenarios

SDKViewer.ForPreview.Its.IitsScenario

• GetAllActions

SDKViewer.ForPreview.Its.IitsAction

• GetAttributeValues
• SetAttributeValues

Please let me know if there is an interface I overlooked in SDK that could help solve any of above issues. If not maybe it can be handled as an API proposal for next versions.

Thanks,

[kveretennicov]

Thank you. We will discuss this internally.

CC @walkinside/devs @walkinside/staff

[kveretennicov]

OK, after discussion we see the first few items as more or less aligned with our roadmap:

• get all existing scenarios
• start and stop a scenario

Those items have been placed on the current backlog. We will update here when they become available or when we need more input.

The rest we agree would be very nice to have. There are, however, other topics that require our resources short-term. So it's not possible to give an idea when exactly we get to implementing a fully customizable ITS.

CC @walkinside/devs @walkinside/staff

[griemens]

Good news. With these methods it will be possible to make from Walkinside an unattended training box. And provide users a slim user interface to start a scenario. Thank you for the review.

[kveretennicov]

I see, sort of Walkinside Training Kiosk.