Data Elements
This appendix lists the storyboard and child element persisted properties created by the CCT or the Base Class Framework, or created by a runtime engine and recognized by the BCF. Refer to the documentation for the player classes in the impression.players namespace for more information on how these properties are used by the BCF. Note that some properties may only be supported by selected storyboard types or available with specific project configurations.
- Storyboard Types
- Storyboard Properties
- ChildElement Types
- ChildElement Properties
- Sequencer and Command Properties
Storyboard Types
The table below lists the storyboard types supported by the CCT, the type string (the Storyboard object's sbType property) of each storyboard type, and the dedicated player class in the BCF that supports playback of the given type. It is up to the runtime author to determine which player to use for storyboard types that don't have a dedicated player, although the BasePlayer is typically used.
| Storyboard Type | Type String | Player |
|---|---|---|
| Audio Sequencer | audio sequencer | AudioSequencer |
| Canvas | canvas | CanvasPlayer |
| Command | command | |
| Command Sequencer | command sequencer | CommandSequencer |
| Container | container | |
| Flash Object | flashObject | FlashObjectPlayer |
| Flash Question | flashQuestion | FlashObjectPlayer1 |
| Flash Video | flashVideo | SWFVideoPlayer |
| Matching Graphics to Graphics | matching graphics to graphics | MatchingPlayer |
| Matching Graphics to Text | matching graphics to text | MatchingPlayer |
| Matching Text to Graphics | matching text to graphics | MatchingPlayer |
| Matching Text to Text | matching text to text | MatchingPlayer |
| Menu | menu | MenuPlayer |
| Multiple-Choice Text | multiple-choice text | MultipleChoicePlayer |
| Multiple-Choice Graphics | multiple-choice graphics | MultipleChoicePlayer |
| Placeholder | placeholder | |
| Rich Text | richText | RTFPlayer |
| Simulation | simulation | SimulationPlayer |
| Summary | summary | |
| Time Sequencer | time sequencer | TimeSequencer |
| Title | title |
Footnotes
- The FlashObjectPlayer does not include explicit support for Flash Question storyboard types, but is a good place to start when building your own player/face.
Storyboard Properties
The table below lists the storyboard persisted properties created by the CCT or the Base Class Framework, or created by a runtime engine and recognized by the BCF. Refer to the documentation for the player classes in the impression.players namespace for more information on how these properties are used by the BCF. Note that some properties may only be available with specific project configurations.
| Property Name | Description | Data Type | Storyboard Types | Created By | Used By | Modified By |
|---|---|---|---|---|---|---|
| AdditionalActionsComplete | Indicates wheter additional, non-simulation state actions have been completed. | Boolean | Simulation | BCF | BCF | BCF |
| AdditionalText | Additional text to display. | String | Title | CCT | ||
| Answer | The answer. | String, AssetData | [multiple-choice storyboards] | CCT | BCF | |
| Answer[n] | The [n]th answer. | String, AssetData | [matching storyboards] | CCT | BCF | |
| AnswerIndex | Indicates the order in which the Answer persisted property should be displayed. | Number | [multiple-choice storyboards] | BCF1 | BCF | BCF1 |
| Answer[n]Index | Indicates the order in which the Answer[n] persisted property should be displayed. | Number | [matching storyboards] | BCF1 | BCF | BCF1 |
| Answer[n]Valid | Indicates whether the Answer[n] persisted property contains valid data. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| Asset | The asset associated with the placeholder. | AssetData | Placeholder, [matching and multiple-choice storyboards], Simulation | CCT | ||
| AudioFile | Specifies the audio file to play. | AssetData | Audio Sequencer | CCT | BCF | |
| AutoAdvanceWhen | Identifies the criteria for automatically advancing the storyboard. | String | [all storyboards] | CCT | ||
| AutoPlay | Indicates whether playback should begin when the video is loaded. | Boolean | SWF Video | CCT | BCF | |
| BackButtonEnabled | Identifies when the runtime's Back button should be enabled for the storyboard. | String | [all storyboards] | CCT | ||
| Background | Specifies the background graphic to display. | AssetData | Canvas, Menu, RTF | CCT | BCF2 | |
| BackgroundAlpha | Specifies the transparency of the background. | Number | Menu, RTF | CCT | BCF2 | |
| Commands | Specifies additional functionality for the storyboard. | ChildElementCollection | [all storyboards] | CCT | BCF | BCF3 |
| CommandType | The type of command. | String | Command | CCT | ||
| Complete | Indicates whether the storyboard is complete. | Boolean | [all storyboards] | BCF | BCF | BCF |
| CompleteWhen | Identifies the criteria required to mark the storyboard as complete. | Semicolon-delimited string. | [all storyboards] | CCT | BCF | |
| CompleteRemaining | Identifies completion criteria not yet met. | Semicolon-delimited string. | [all storyboards] | BCF | BCF | BCF |
| Configuration | Additional data for the storyboard. | String | [all storyboards] | CCT | ||
| ConfigurationFile | An external file containing configuration information for the Flash object. | AssetData | Flash Object, Flash Question | CCT | ||
| Correct | For matching storyboards, indicates whether all questions have been evaluated correctly. For multiple-choice storyboards, indicates whether the question has been evaluated correctly. | Boolean | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| Directions | Directions for completing the storyboard. | String | [matching storyboards] | CCT | ||
| Distractor | The distractor, or, for matching storyboards only, the first distractor if multiple distractors are defined. | String, AssetData | [matching and multiple-choice storyboards] | CCT | BCF | |
| Distractor[n] | For matching storyboards, the [n+1]th distractor if multiple distractors are defined. For multiple-choice storyboards, the [n]th distractor. | String, AssetData | [matching and multiple-choice storyboards] | CCT4 | ||
| DistractorIndex | Indicates the order in which the Distractor property should be displayed. | Number | [matching storyboards] | BCF1 | BCF | BCF1 |
| Distractor[n]Index | For matching storyboards, indicates the order in which the [n+1]th distractor should be displayed if multiple distractors are defined. For multiple-choice storyboards, indicates the order in which the [n]th distractor should be displayed. | Number | [matching and multiple-choice storyboards] | BCF1,4 | BCF | BCF1,4 |
| DistractorValid | Inidcates whether the Distractor persisted property contains valid data. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| Distractor[n]Valid | For matching storyboards, indicates whether the [n+1]th distractor contains valid data. For multiple-choice storyboards, indicates whether the [n]th distractor contains valid data. | Boolean | [matching and multiple-choice storyboards] | BCF4 | BCF | BCF1,4 |
| EvaluatedIndex | The index of the evaluated response. | Number | [multiple-choice storyboards] | BCF | BCF | BCF |
| FlashObject | Specifies the .SWF to load. | AssetData | Flash Object, Flash Question | CCT | BCF | |
| Graphic | Specifies a graphic to accompany the storyboard. | AssetData | [matching and multiple-choice storyboards], Simulation | CCT | ||
| htmlText | The Flash-conformant HTML text to display. | String | RTF | BCF | BCF | BCF |
| InitialCommand | Data used for initialization of the object. | String | Flash Object, Flash Question | CCT | ||
| Initialized | Indicates whether the storyboard has previously been initialized. | Semicolon-delimited string. | [all storyboards] | BCF | BCF | BCF |
| InitialSequence | Instructions for setting the initial state of the simulation. | String | Simulation | CCT | BCF | |
| IsPracticeQuestion | Indicates whether the question should be treated as a practice question or a test question. | Boolean6 | [matching and multiple-choice storyboards], Simulation, [sequencer storyboards], Flash Question | CCT5 | ||
| IsQuestion | Indicates whether the storyboard should be treated as a question. | Boolean | Simulation, [sequencer storyboards] | CCT | ||
| LastPosition | Indicates the last position of the storyboard. For an audio sequencer, this is the last position of the playhead in the audio file. For a time sequencer, this is the elapsed time, and for a command sequencer, this is the last value of the position properrty. | Number | [sequencer storyboards] | BCF | BCF | BCF |
| Locked | Indicates whether the responses for the storyboard are locked, preventing selection. | Boolean | [multiple-choice storyboards] | BCF | BCF | BCF |
| Loop | Indicates whether playback should continuously repeat. | Boolean | SWF Video | CCT | BCF | |
| NarrationComplete | Indicates whether the storyboard's narration has finished playing. | Boolean | [all storyboards] | BCF | ||
| NarrationFile | The narration audio file for the storyboard. | AssetData | [all storyboards] | CCT | ||
| NarrationText | The text to be narrated. | String | [all storyboards] | CCT | ||
| NextButtonEnabled | Identifies whe the runtime's Next button should be enabled for the storyboard. | String | [all storyboards] | CCT | ||
| NumberCorrect | 1 if the question has been correctly evaluated, 0 else. | Number | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| NumberIncorrect | 0 if the question has been correctly evaluated, 1 else. | Number | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| ObjectData | Additional data for the Flash object. | Sting | Flash Object, Flash Question | CCT | ||
| ObjectiveID | The learning objective associated with the storyboard. | String | [all storyboards] | CCT | ||
| PlaceholderData | Additional information for the placeholder. | String | Placeholder | CCT | ||
| PlaceholderType | The type of the placeholder. | String | Placeholder | CCT | ||
| PlayComplete | For a traditional (non-stepped) video, indicates whether playback is complete. | Boolean | SWF Video | BCF | BCF | BCF |
| ProductionNotes | Production-related information for the storyboard. | String | [all storyboards] | CCT | ||
| Question | The question. | String | [multiple-choice storyboards], Flash Question | CCT | ||
| Question[n] | The [n]th question. | String, AssetData | [matching storyboards] | CCT | BCF | |
| Question[n]Correct | Indicates whether the response evaluated for Question[n] is Answer[n]. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| Question[n]EvaluatedResponseIndex | Indicates the index of the response evaluated for Question[n]. | Number | [matching storyboards] | BCF | BCF | BCF |
| Question[n]Index | Indicates the order in which the Question[n] persisted property should be displayed. | Number | [matching storyboards] | BCF1 | BCF | BCF1 |
| Question[n]Locked | Indicates whether Question[n] is locked, preventing selection changes. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| Question[n]SelectedResponseIndex | Indicates the index of the response selected (but not evaluated) for Question[n]. | Number | [matching storyboards] | BCF | BCF | BCF |
| Question[n]Valid | Indicates whether the Question[n] persisted property contains valid data. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| QuestionIndexesGenerated | Indicates whether the Question[n]Index properties were generated by the player on initialization. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| References | Identifies the source material used to develop the storyboard. | String | [all storyboards] | CCT | ||
| RemediationCount | Indicates the number of times remediation has been requested by the rules engine. | Number | Simulation | BCF | BCF | BCF |
| RemediationRange | The range of storyboards to use for remediation. | LocationData | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemediationType | Identifies the type of remediation that used be used for the storyboard. | Semicolon-delimited string | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedMessageCorrect | The message to display when the status of the storyboard is QuestionStatusTypes.CORRECT. | String | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedMessageCorrectIncomplete | The message to display when the status of the storyboard is QuestionStatusTypes.CORRECT_INCOMPLETE. | String | [matching storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedMessageIncorrect | The message to display when the status of the storyboard is QuestionStatusTypes.NONE_CORRECT. | String | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedMessageIncorrect1 | The message to display when Distractor1 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedMessageIncorrect2 | The message to display when Distractor2 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedMessageIncorrect3 | The message to display when Distractor3 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedMessageSomeIncorrect | The message to display when the status of the storyboard is QuestionStatusTypes.SOME_CORRECT. | String | [matching storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedNarrationCorrect | The narration file to play when the status of the storyboard is QuestionStatusTypes.CORRECT. | AssetData | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedNarrationCorrectIncomplete | The narration file to play when the status of the storyboard is QuestionStatusTypes.CORRECT_INCOMPLETE. | AssetData | [matching storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedNarrationIncorrect | The narration file to play when the status of the storyboard is QuestionStatusTypes.NONE_CORRECT. | AssetData | [matching and multiple-choice storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| RemedNarrationIncorrect1 | The narration file to play when Distractor1 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedNarrationIncorrect2 | The narration file to play when Distractor2 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedNarrationIncorrect3 | The narration file to play when Distractor3 is the evaluated response. | String | [multiple-choice storyboards] | CCT | ||
| RemedNarrationSomeIncorrect | The narration file to play when the status of the storyboard is QuestionStatusTypes.SOME_CORRECT. | AssetData | [matching storyboards], [sequencer storyboards], Command, Flash Question | CCT5 | ||
| ResponseIndexesGenerated | For a matching question, indicates whether the Answer[n]Index, DistractorIndex, and Distractor[n]Index persisted properties were generated by the player on initialization. | Boolean | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| rtfText | The Rich Text Format text to convert to Flash-conformant HTML text and display. | String | RTF | CCT | BCF | |
| Rules | Instructions for handling user interaction with the simulation | String | Simulation | CCT | BCF | |
| SecondaryText | Additional accompanying text for the storyboard. | String | [all storyboards] | CCT | ||
| SelectedIndex | The index of the selected response. | Number | [multiple-choice storyboards] | BCF | BCF | BCF |
| SelectedQuestionIndex | The index of the currently selected question. | Number | [matching storyboards] | BCF | BCF | BCF |
| SelectionsComplete | Indicates if all questions that have not yet been evaluated have a selected response and at least one question has not yet been evaluated. | Boolean | [matching storyboards] | BCF | BCF | BCF |
| SimulationFile | Specifies the simulation file to use. | AssetData | Simulation | CCT | ||
| SimulationType | Specifies the simulation or simulation type to use. | String | Simulation | CCT | ||
| Snapshot | The file specirying the initial state of the simulation. | AssetData | Simulation | CCT | BCF | |
| Status | For a matching question, the aggregate status of the questions. For a multiple-choice question, indicates the status of the question in the current storyboard. | String | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| Stepped | Indicates the type of video. | Boolean | SWF Video | BCF | BCF | |
| StudentDirections | Accompanying text for the storyboard. | String | [all storyboards] | CCT | ||
| SummaryText | The text to display | String | Summary | CCT | ||
| TitleText | The title to display | String | Title | CCT | ||
| TotalCorrect | Indicates the total number of questions with a non-zero evaluated response index matching the answer for the question. | Number | [matching storyboards] | BCF | BCF | BCF |
| TotalEvaluated | Indicates the total number of questions with a non-zero evaluated response index. | Number | [matching storyboards] | BCF | BCF | BCF |
| TotalIncorrect | Indicates the total number of questions with a non-zero evaluated response index that doesn't match the answer for the question. | Number | [matching storyboards] | BCF | BCF | BCF |
| TotalQuestions | Indicates the total number of questions with valid data. | Number | [matching storyboards] | BCF | BCF | BCF |
| TotalResponses | Indicates the total number of answers and distractors with valid data. | Number | [matching and multiple-choice storyboards] | BCF | BCF | BCF |
| TotalSelected | Indicates the total number of questions with a non-zero selected response index. | Number | [matching storyboards] | BCF | BCF | BCF |
| User1 | Additional data for the storyboard. | String | [all storyboards] | CCT | ||
| Video | Specifies the video to display. | AssetData | SWF Video | CCT | BCF |
Footnotes
- If present in the initial data, the player will not create new values at runtime. As of this writing, the CCT does not support creation of these values.
- This property is not used by the MenuPlayer.
- The Complete persisted property of each ChildElement is modified by the BCF at runtime.
- As of this writing, the CCT does not support creation of multiple distractors for matching storyboards.
- Sequencers, command storyboard: Only if integrated question support is turned on for the storyboard.
- Sequencers, command storyboard: If the property is defined by the storyboard or command layout, the defined value type will be used; otherwise a Boolean value will be created if integrated question support is turned on.
ChildElement Types
The table below lists the names and types of ChildElement objects supported by the CCT, the type string (the ChildElement object's elementType property) of each child element, and how (or if) the element's name property is used.
| Storyboard | ChildElement Type | Name Usage |
|---|---|---|
| [all storyboards] - Commands collection | Command | Identifies the specific command type. |
| [sequencer storyboards] | Command | Identifies the specific command type. |
| Canvas | canvasElement | Names the element. |
| Menu | menuItem | Not used. |
| SWFVideo | videoStep | Human-readable step number. |
ChildElement Properties
The table below lists the child element persisted properties created by the CCT or the Base Class Framework, or created by a runtime engine and recognized by the BCF. Refer to the documentation for the player classes in the impression.players namespace for more information on how these properties are used by the BCF. Note that some properties may only be available with specific project configurations.
| Property Name | Description | Type | Applies To | Created By | Used By | Modified By |
|---|---|---|---|---|---|---|
| ActionType | Specifies the action associated with the element. | String | canvasElement | CCT | BCF | |
| Active | Indicates whether the element is active. | Boolean | canvasElement | BCF | BCF | BCF |
| AutosizeGraphic | For an element with a DisplayType property value of graphic, specifies whether the graphic should be sized to fit within the bounds of the element. | Boolean | canvasElement | CCT | BCF | |
| Command | For an element with an ActionType property value of command, specifies the command data for the element. | String | canvasElement | CCT | ||
| Complete | For a canvasElement , indicates whether or not the action associated with the element is complete. For a videoStep element, indicates whether or not the step has been shown. For a Command element, indicates whether the element should be considered complete. | Boolean | canvasElement, videoStep, Command | BCF | BCF | BCF |
| CustomColor | For an element with a DisplayType property value of shape or text, identifies the color to use to render the element. | ColorData | canvasElement | CCT | BCF | |
| CustomFont | For an element with a DisplayType property value of text, identifies the font to use to render the element. | FontData | canvasElement | CCT | BCF | |
| CustomWidth | For an element with a DisplayType property value of shape, identifies the stroke width to use to render the element. | Number | canvasElement | CCT | BCF | |
| Destination | In a canvasElement, for an element with an ActionType property value of jump, identifies the destination to jump to. In a menuItem element, identifes the destination of the item. | LocationData | canvasElement, menuItem | CCT | BCF | |
| DestinationStatus | In a canvasElement, for an element with a ActionType property value of jump or displayRange, indicates the status of the destination or range. In a menuItem element, identifes indicates the status of the destination of the item. | String | canvasElement, menuItem | BCF | BCF | BCF |
| Dimensions | Specifies the bounds of the element. | Rectangle | canvasElement | CCT | BCF | |
| DisplayType | Specifies how the element should be rendered. | String | canvasElement | CCT | BCF | |
| Graphic | For an element with a DisplayType property value of graphic, identifies the graphic to render. | AssetData | canvasElement | CCT | BCF | |
| Hyperlink | For an element with an ActionType property value of hyperlink, specifies the hyperlink for the element. | String | canvasElement | CCT | ||
| IsQuestion | Indicates whether the storyboard should be treated as a question. | Boolean | Command (Command storyboards only) | CCT | ||
| ItemTitle | Specifies the title to be displayed for the item. | String | menuItem | CCT | ||
| Narration | The narration audio file for the element. | AssetData | canvasElement | CCT | ||
| PopupGraphic | For an element with an ActionType property value of popupGraphic, specifies the graphic that should be shown. | AssetData | canvasElement | CCT | ||
| PopupText | For an element with an ActionType property value of popupText, specifies the text that should be shown | String | canvasElement | CCT | ||
| Range | For an element with an ActionType property value of displayRange, identifies the destination to jump to. | LocationData | canvasElement | CCT | BCF | |
| ShapeType | For an element with a DisplayType property value of shape, identifies the type of shape to render. | String | canvasElement | CCT | BCF | |
| Sound | For an element with an ActionType property value of playSound, specifies the audio file that should be played. | AssetData | canvasElement | CCT | ||
| StepDirections | Directions to the student for the step. | String | videoStep | CCT | ||
| StepNarration | The audio file to accompany the step. | AssetData | videoStep | CCT | ||
| StepNotes | Additional data for the element | String | videoStep | CCT | ||
| Tags | Additional data for the element. | String | canvasElement, videoStep | CCT | ||
| Text | For an element with a DisplayType property value of text, identifies the text to render. | String | canvasElement | CCT | BCF | |
| UseCustomColor | For an element with a DisplayType property value of shape or text, indicates whether the CustomColor property value should be used to render the element. | Boolean | canvasElement | CCT | BCF | |
| UseCustomFont | For an element with a DisplayType property value of text, indicates whether the CustomFont property value should be used to render the element. | Boolean | canvasElement | CCT | BCF | |
| UseCustomWidth | For an element with a DisplayType property value of shape, indicates whether the CustomWidth property value should be used to render the element. | Boolean | canvasElement | CCT | BCF |
Sequencer and Command Properties
The Command Sequencer, Time Sequencer, Audio Sequencer, and Command storyboard types have no predefined properties other than the common properties available to all storyboards. Instead, needed properties (both storyboard properties and child element properties) are defined in project properties, and the CCT generates a data entry form based on the defined properties.
You can also use project properties to define Storyboard Commands, which are available to all storyboard types.