impression logo

Impression Learning Content Framework

Support Article
Last modified: 28 November 2012

CCT Tokens

The Impression Content Creation Tool allows tokens—a type of placeholder—to be used in several places in the project properties of a content database.  When the CCT needs to use a tokenized field, the field is detokenized before use.  Tokens make it easier to create formatted storyboard identifiers, transport content databases, and allows for increased flexibility when creating lesson packages; reducing or eliminating post-packaging adjustments.

Token List

The following tables list the tokens that the CCT recognizes.

Application and Database Tokens

TokenDescription
%PROJECT_ROOT% The Project Root field.
%APP_PATH% The location of the CCT executable.
%MDB_PATH% The location of the .MDB-format content database.  If the content database is an SQL Server content database, this value is the empty string ("").
%DATABASE_TITLE% In .MDB mode, the name of the .MDB file (without extension). In SQL Server mode, the friendly title of the catalog. Invalid filename characters (including any backslash characters) present in the title are replaced by the underscore ("_") character.
%DATABASE_CATALOG% In .MDB mode, the name of the .MDB file (without extension). In SQL Server mode, the actual database catalog name. Invalid filename characters (including any backslash characters) present in the catalog name are replaced by the underscore ("_") character.
%MEDIA_PATH% The value of the Media Path field.

Autonumber/GUID Tokens

TokenDescription
%AUTONUMBER% The next number in the ImpressionAutonumbers table in the content database.  This number will be incremented by 1 after selection.  Note that autonumbers are only guaranteed to be unique in the content database if any content imported has its identifiers regenerated on import.
%AUTONUMBER_1%
%AUTONUMBER_2%
%AUTONUMBER_3%
%AUTONUMBER_4%
%AUTONUMBER_5%
%AUTONUMBER_6%
%AUTONUMBER_7%
%AUTONUMBER_8%
%AUTONUMBER_9%
The next number in the ImpressionAutonumbers table in the content database, with a minimum number of places (specified by the number following the underscore character).  For example, with a number of 123, %AUTONUMBER_5% will be replaced with 00123.  If the next number has more places than specified, the value will not be truncated.  For example, using %AUTONUMBER_2% with a number of 123 results in 123 being used.
%NEW_GUID% A new globally unique identifier (GUID).

Lesson and Storyboard Tokens

TokenDescription
%LESSON_TITLE% The title of the lesson.
%LESSON_IDENTIFIER% The identifier of the lesson.
%LESSON_ID% The GUID associated with the lesson.
%LESSON_CLASSIFICATION% The value of the classification property of the lesson.
%PARENT_TITLE% The title of the parent group or lesson.
%PARENT_IDENTIFIER% The identifier of the parent group or lesson.
%TOP_TITLE% The title of the top ancestor lesson or group.
%TOP_IDENTIFIER% The identifier of the top ancestor lesson or group.
%LESSON_TITLE_PATH% A backslash-delimited list of lesson/group titles from the current lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual title are replaced by the underscore ("_") character.
%LESSON_IDENTIFIER_PATH% A backslash-delimited list of lesson/group identifiers from the current lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual identifier are replaced by the underscore ("_") character.
%PARENT_TITLE_PATH% A backslash-delimited list of lesson/group titles from the parent group or lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual title are replaced by the underscore ("_") character.
%PARENT_IDENTIFIER_PATH% A backslash-delimited list of lesson/group identifiers from the parent group or lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual identifier are replaced by the underscore ("_") character.
%TOP_TITLE_PATH% A path-safe version of %TOP_TITLE%.  In fields that specify a path, this value will be the same as %TOP_TITLE%.
%TOP_IDENTIFIER_PATH% A path-safe version of %TOP_IDENTIFIER%.  In fields that specify a path, this value will be the same as %TOP_IDENTIFIER%.
%LESSON_TITLE_PATH_FILENAME% An underscore-delimited list of lesson/group titles from the lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual title are replaced by the underscore ("_") character.
%LESSON_IDENTIFIER_PATH_FILENAME% A underscore-delimited list of lesson/group identifiers from the lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual identifier are replaced by the underscore ("_") character.
%PARENT_TITLE_PATH_FILENAME% An underscore-delimited list of lesson/group titles from the parent group or lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual title are replaced by the underscore ("_") character.
%PARENT_IDENTIFIER_PATH_FILENAME% An underscore-delimited list of lesson/groups identifiers from the parent group or lesson up to the database root. Invalid filename characters (including any backslash characters) present in any individual identifier are replaced by the underscore ("_") character.
%SBID% The unique identifier of a storyboard.

Manifest Tokens

TokenDescription
%LESSON_DATA_LIST% An XML-formatted list of lesson data files relative to the detokenized value of the Root Path field.
%LESSON_MEDIA_LIST% An XML-formatted list of media files relative to the detokenized value of the Root Path field.
%OTHER_FILES_LIST% An XML-formatted list of other source files relative to the detokenized value of the Root Path field.

Tokenizable Fields

The following section lists the fields in the Project Properties dialog that support tokens, and the tokens each field supports.

General Tab

Project Root

The Project Root field defines a base location that can be used as a token in other tokenizable fields.  The CCT can decode the following tokens for Project Root:

Storyboard Identifier (autogen key)

The Autogen Key field specifies the format of storyboard identifiers automatically generated by the CCT when a new storyboard is created, or when a lesson is imported into a content database and the user has requested that identifiers be regenerated.  The Autogen Key field supports the following tokens:   

Previewer Application

The Previewer Application field defines the location of the executable program used for previewing.  This field supports the following tokens:   

Media/Reports Tab

Media Path

The Media Path field defines the location of supporting media files for a lesson.  By using lesson-specific tokens, the Media Path may be changed on a lesson by lesson basis.  Note that the detokenized string is checked to ensure it is a valid path name before use.  The Media Path field supports the following tokens:

Project Report Path

The Project Report Path field defines the location of custom reports for the content database.  Note that the detokenized string is checked to ensure it is a valid path name before use. The Project Report Path field supports the following tokens:

Media Substitution Path

The Media Substitution Path field defines the location of media files that should be used in place of the actual media files when printing reports.  When a report needs to display a media file, if there is a file in the Media Substituion Path folder, it is used instead of the file in the Media Path folder. Note that the detokenized string is checked to ensure it is a valid path name before use.  The Media Substituion Path field supports the following tokens:

Package Tab

Other Files Source

The Other Files Source field defines the location of the runtime files that should be copied to each packaged lesson.  All files, including files in any subfolders, are copied from this location to the package.  Note that the detokenized string is checked to ensure it is a valid path name before use.  The Other Files Source field supports the following tokens:

Root Path

The Root Path field defines the base location of an exported package.  Note that the detokenized string is checked to ensure it is a valid path name before use.  The Root Path field supports the following tokens:

Lesson Filename

The Lesson Filename field defines the filename of the lesson data file in an exported package.  Note that the detokenized string is checked to ensure it is a valid filename before use.  The Lesson Filename field supports the following tokens:

Manifest Template

The Manifest Template field defines the structure of a package's manifest file.  Note that, if created (that is, the field is not empty), the manifest is always called imsmanifest.xml and is stored in the root folder of the exported package.  The Manifest Template field supports the following tokens:

Exported Tokens

The CCT can export selected tokens in the lesson.  If tokens are exported, they are stored in a PersistedPropertyCollection named "tokens" in the lesson object's properties collection.  The following table lists the tokens that are exported:

TokenProperty Name
%DATABASE_TITLE% DatabaseTitle
%LESSON_ID% LessonID
%LESSON_IDENTIFIER% LessonIdentifier
%LESSON_IDENTIFIER_PATH% LessonIdentifierPath
%LESSON_TITLE% LessonTitle
%LESSON_TITLE_PATH% LessonTitlePath
%PARENT_IDENTIFIER% ParentIdentifier
%PARENT_IDENTIFIER_PATH% ParentIdentifierPath
%PARENT_TITLE% ParentTitle
%PARENT_TITLE_PATH% ParentTitlePath
%TOP_IDENTIFIER% TopIdentifier
%TOP_IDENTIFIER_PATH% TopIdentifierPath
%TOP_TITLE% TopTitle
%TOP_TITLE_PATH% TopTitlePath