Business objects KNOWLEDGE ACCELERATOR DEVELOPER V8.7.2 User Manual

KNOWLEDGE ACCELERATOR

CONTENT DEPLOYMENT

Version 8.7.2

Depending on your requirements, you can deploy Knowledge Accelerator to a Learning web server, file server, Learning Management System (LMS), CD-ROM, or user workstation. A plug-in is not required for any of these deployments.

Knowledge Accelerator is published as:

- Player Package (Browser Based Player). This is the most common deployment.

- LMS Package. This is used only if you have a Learning Management System.

- HTML web site. This is used only if you have to display content as static pages.

If you want to track your user’s progress within the Knowledge Accelerator you will need to:

- deploy the Knowledge Accelerator - LMS Package to your Learning Management System (LMS) or

- install and Configure Usage Tracking and then deploy the Knowledge Accelerator Player Package to the Usage Tracking. The Usage Tracking is a separate installation.

For additional information please refer to Usage Tracking document. If you want to customize the content within the Knowledge Accelerator you will need to:

- Install the Ondemand Developer tool and import the Knowledge Accelerator source files. For additional information please refer to the Knowledge Accelerator Developer document.

For additional training needs please refer the Business Objects Education Services website:

http://www.businessobjects.com/services/training/default.asp?intcmp=ip_services3

For Technical Support please refer to the Business Object Technical Support website:

http://technicalsupport.businessobjects.com/KanisaSupportSite/supportcentral/supportcentral.do;j sessionid=5A83CB6CC56F9305A34C0EA3EFD4AECC?id=m1

Deploying Knowledge Accelerator on a Stand-alone Computer

Knowledge Accelerator – Player Package (Browser Based Player) or HTML web site

To use the Knowledge Accelerator, go to Start > Programs > BusinessObje cts Knowledge Accelerator and select your Knowledge Accelerator. Also, you can navigate to the location where you installed it and double click the index.html or default.htm file.

Note: HTML Web site (**_html.zip ) is not the preferred option for deploying content.

Deploying Knowledge Accelerator on a Local Area Network

Knowledge Accelerator – Player Package (Browser Based Player) or HTML web site

Assign access rights to network users as required (users only require READ access to the directory).

To allow users to access Knowledge Accelerator, creates a shortcut, map a drive or distribute a UNC address of the location where you installed Knowledge Accelerator.

For Example:

\\myserver\KA\index.html or \\myserver\KA\default.htm

Note: HTML Web site (**_html.zip ) is not the preferred option for deploying content.

Deploying Knowledge Accelerator on a Web Server

Knowledge Accelerator – Player Package (Browser Based Player) or HTML web site

Extract the Knowledge Accelerator **_deploy.zip file, and then extract the **_player or **_ html.zip file. To install the Knowledge Accelerator, double-click **_player.exe or **_html.exe and follow the installation wizard. You can install the Knowledge Accelerator to desired location or you can accept the default location. You can create a link to the index.html. or default.html page from an existing Web site, or make the index.html or default.html page itself available to users.

It is also possible to create a virtual directory on the web server to access network drives if desired.

The following examples are for configuring Knowledge Accelerator on a Microsoft Internet Information Server and Apache web server.

Microsoft Internet Information Server 5

• Add a new virtual directory to the website

• Name the virtual directory as required

• Enter the path to the location where you installed Knowledge Accelerator (**_player.exe

or **_html.exe)

• Set access permissions to the virtual directory (read and run required)

• Set the default start page of the directory to be index.html or default.htm

For Example:

Knowledge Accelerator should now be accessible to web browsers via the address

http://machinename/KA

Apache Web Server

• Stop the Apache server

• Add the following into the httpd.conf file within the Apache/Conf directory

Alias /ka/ "C:/KA/" <Directory "C:/KA"> Options Indexes FollowSymLinks </Directory>

Note: The path in this example is C:/KA, modify this path to point to the location where you have installed the Knowledge Accelerator.

• You also need to change the default home page. Find the following line in the httpd.conf file…

DirectoryIndex index.html default.html

Change this to read…

DirectoryIndex index.html

• Save the changes to the file and start the Apache server

For Example:

Knowledge Accelerator should now be accessible to web browsers via the address

http://machinename/KA

Note: However there are some considerations with a UNIX based OS. UNIX based OS's a re case sensitive. The Knowledge Accelerator uses mixed case in it's file structure. This does not cause a problem on a UNIX based OS because all calls to our files are in the correct case. e.g., a file named "Test" will always be called as "Test" - it will never be called as "test". However, there is a module in Apache called "mod_rewrite" that can automatically lower-case (or upper case depending on the configuration) all URLs. Unfortunately, if your server is using this module, then our calls to OnDemand files will now be called in lower-case, but since the file is mixed-case, it will generate an error (web error number 404.) Please note, this is a very popular module in Apache. Information on mod_rewrite can be found at:

http://httpd.apache.org/docs/mod/mod_rewrite.html

Deploying Knowledge Accelerator on a LMS (Learning Management System)

Knowledge Accelerator – LMS Package (Learning Management System Compliant Content)

Extract the Knowledge Accelerator **_deploy.zip file, and then extract the **_lms.zip file. To install the Knowledge Accelerator, double-click **_lms.exe and follow the installation wizard.

The LMS package enables the creation of a package that conforms to the AICC and SCORM learning specifications. Conformance to these learning specifications enables content to be launched from any AICC or SCORM compliant Learning Management System (LMS).

AICC does not recognize double-byte character sets, such as Japanese or Chinese. If your content uses double-byte characters, the published LMS package will only support a SCORM compliant Learning Management System.

At this time there are several published learning specifications with which both the customers and vendors of learning content and management systems can seek to be compliant. Content is compliant with the following specifications:

• AICC AGR-010: Web based CMI Guidelines (Version 3.5)

o CBT Course o Individual CBT AU

• SCORM Specifications - Version 1.2

o SCORM Version 1.2 Run-Time Environment – Minimum with some mandatory

data model elements (SCO-RTE1 + Mandatory)

o SCORM Version 1.2 Content Packaging (ADL CP-PIF1)

• SCORM Specifications - Version 1.3 (SCORM 2004)

o Content Package Run-Time Environment Version 1.3.1 (CP RTE 1.3.1)

o Content Package Content Aggregation Model Version 1.3.1 (CP CAM 1.3.1) o SCO Run-Time Environment Version 1.3.1 (SCO RTE 1.3.1)

For more information regarding AICC please visit regarding ADL and SCORM please visit

Learning specification compliance requires meeting certain Content Structure File and Communication requirements. An LMS package includes AICC and SCORM compliant course structure files and files that support LMS launch and communication. The course structure files describe the topics that are in the package and the hierarchy of these topics within modules and lessons. These files can then be imported into an AICC or SCORM compliant LMS. Files that support communication enable topics to be launched by an AICC or SCORM compliant LMS and enable the topic to send and receive tracking data from the LMS.

Content consists of three levels: modules, lessons, and topics. The actual content is recorded in the topics. Lessons are simply virtual groupings of topics. Each module is a folder containing the topics for the module. When content is published for an LMS package, modules and lessons will be represented only in course structure files as a block (AICC) or item (SCORM). A topic is represented in the course structure files as an Assignable Unit (AU) for AICC or Shareable Content Object (SCO) for SCORM.

AICC Compliance

The LMS Package adheres to the following compliance criteria as defined in the AICC specifications for AGR-010 (Web-based CMI):

• A set of AICC specified course structure files are provided that can be imported into an LMS.

• Content must be launched by an AICC-compliant LMS.

• Content communicates with the LMS with the HTTP based AICC/CMI protocol (HACP).

www.adlnet.org on the Internet.

www.aicc.org, and for more information

Content Structure and Description Files

The Developer generated the following four files to conform with AICC level I (descriptions for course content and course structure) requirements. These files are located at the root of the LMS for <Title> title in a published LMS package.

File

Course Description File (.CRS)

Assignable Unit File (.AU)

Descriptor File (.DES) output.des

Course Structure File (.CST)

Configure Content for a non-LMS server using AICC

When installing an LMS Package on a web server other than the LMS server, you receive an error message when starting any Topic and/or tracking data is not sent to the LMS server. Since the LMS Package is attempting to communicate with a server other than the server it was loaded from, cross domain restrictions prevent communication with the LMS.

Naming Convention

output.crs

output.au

output.cst

Purpose

Describes general information about the course package.

Describes each topic (AU) in the course hierarchy and provides data required to launch the topic (AU).

Describes each AU or block that appears in the course hierarchy.

Defines the hierarchical structure of the blocks and AUs within the course.

LMS Packages use a Java applet to handle communication with the LMS server. By moving the Java applet from the content server to the LMS server, cross domain restrictions are eliminated and the content can communicate with the LMS. Note that only one copy of the Java applet is needed on the LMS server for multiple LMS Packages on the content server.

1. Locate the file GetHTTPPostData.class in the …lms\scripts directory where the LMS Package is installed.

2. Copy this file to a location on the LMS web server that can be referenced through a URL. Note the full URL to the directory containing the file. For example http://lmsserver/somedirectory

3. Open the Lmsoptions.js file in the …\lms\scripts directory (where the LMS Package is installed) using any text editor such as Notepad.

4. Locate the following line in the file: var appletPath = "";

5. Change the appletPath value to the URL that was noted in step #2. For example: var appletPath = http://lmsserver/somedirectory

6. Save the file

7. The content will now successfully communicate with the LMS server.

SCORM Compliance

The Developer generates Learning Content that fully adheres to SCORM 1.2 Runtime Environment Conformance requirements:

• Content may be launched from a SCORM 1.2 or SCORM 1.3 conformant LMS.

• Content searches and finds an API adapter as a Document Object Model (DOM) object

• Content implements the LMSInitialize() and LMSFinish() (Initialize() and Terminate() for

SCORM 1.3) API functions in addition to other API functions

• Content correctly calls other API functions such as LMSGetValue() GetValue() for SCORM

1.3), LMSSetValue() (SetValue for SCORM 1.3), etc.

Content Structure and Metadata Files for SCORM 1.2 and 1.3

The Developer generates the following files in accordance with the SCORM (Version 1.2 and Version 1.3) Runtime Environment Conformance (Minimum). The table below describes the file that is generated; it also lists any supporting XML control documents that are supplied:

File

The IMS Manifest file imsmanifest.xml* adlcp_rootv1p2.xsd

*The publishing package for SCORM 1.2 also includes an imsmanifest13.xml file and the publishing package for SCORM 1.3 includes an imsmanifest12.xml file. These are the IMS manifest files used to switch SCORM versions for published content.

Naming Convention

Control Documents

imsmd_rootv1p2p1.xsd imscp_rootv1p1p2.xsd ims_xml.xsd imscp_v1p1.xsd adlcp_v1p3.xsd imsss_v1p0.xsd adlnav_v1p3.xsd

The control documents are located at the root of the LMS for <Title> title in a published LMS package.

Switching SCORM Versions in Published Packages

Regardless of which SCORM version you publish to, the published content contains the necessary files to support both versions. However, you must make a few changes to switch versions without republishing.

Both SCORM versions create a manifest file for the selected version and another manifest file for the alternate version. Consequently, when you publish for SCORM 1.2 compliance, the published package includes an imsmanifest.xml file for version 1.2 and an imsmanifest13.xml file for version

1.3. Alternatively, when you publish for SCORM 1.3 compliance, the published package includes an imsmanifest.xml file for version 1.3 and an imsmanifest12.xml file for version 1.2. Content published for one SCORM version can easily be used for the other by renaming the manifest files for the version and changing the version reference in the scormoptions.js file.

1. Rename imsmanifest.xml to either imsmanifest12.xml or imsmanifest13.xml depending on what the package is currently defaulting to. If you published for version 1.2, rename the imsmanifest.xml file to imsmanifest12.xml. If you published for version 1.3, rename the imsmanifest.xml file to imsmanifest13.xml.

2. Rename either imsmanifest12.xml to imsmanifest.xml to use SCORM version 1.2 or imsmanifest13.xml to imsmanifest.xml to use SCORM version 1.3.

3. Edit the scormoptions.js file and change the SCORM_Version variable to either “1.2” or “1.3” (the version you want to support).

Configure Preferences for the Player Interface

Administrators have the ability to pre-configure the Player interface. You can do this by running the DHTMLconfig.exe, which launches a Configuration wizard. The options set in this wizard are held in the defaultprefs.js file, which then affects the browser-based Player preferences. In the Configuration wizard, you customize the installation by selecting default options, such as the marquee color, when the Introduction frame shows, and whether the users have the ability to change the preferences. While you do not have to run the DHTMLconfig.exe before you run the Installation wizard, it does give administrators greater control over the installation process.

Run DHTMLConfig

You can run the DHTMLConfig.exe from a number of locations. If you run the configuration from the main installation of the Developer, all packages that you generate through publishing will use the same configuration. You can also run the DHTMLConfig.exe from the Installers folder of a Player package or from installed content; administrators at each location where the package is sent can then customize the configuration to suit their needs.

1. Navigate to the drive and folder where the LMS for <Title> package is located.

2. Navigate to the Installers folder.

3. Launch DHTMLconfig.exe.

4. Follow the instructions to complete the configuration.

You can open the defaultprefs.js in notepad to view the entries.

The Client Configuration wizard has several screens that allow you to choose installation optio ns.

Welcome screen: Contains general instructions.

• User Configuration Option screen: Allows you to determine whether the user will be able to

• change the preferences for the browser-based Player.

• Select Default Player Options screen: Allows you to set default options for the Player, including playing audio files, enabling skipping in Try It! Mode, setting the default color of the marquee, and indicating when the Introduction text displays.

Save Customization screen: You are ready to save the default settings you selected.

• Customization Complete screen: The customizations have been saved to the defaultprefs.js

• file.

Install Content on an LMS Server

To make published content available to your LMS with this type of package, copy or move the entire file structure within the LMS for <title> package to your Web server. Make sure that the upper and lower case letters of all file and folder names are preserved in the copy exactly as they were created by the publishing operation.

If you designated a prefix URL during the publishing process, you should copy the content into the folder indicated by the URL. The course descriptor files will have the correct URL inserted during publishing, and placing it in this folder means that you will not have to update URLs manually.

Use Content through an LMS

When you launch content through an LMS using the gateway page (LMStart.html, located in the folder for each topic), the Player interface appears in a browser window. The topic name appears at the top. The window is divided vertically into two panes. The left pane is the Concept pane. It contains any introductory information attached to the topic. The right pane is the Content pane. It lists the available playback modes for the topic and whether each playback mode is optional or required and whether the playback mode is complete. It also indicates whether the entire topic is complete and a score, if Know It? mode is present and has been completed.

Available Playback Modes

Depending on the options chosen when the LMS package is created in the Developer, topics can be played in See It!, Try It!, and/or Know It? modes.

How Topic Completion is Determined

When you publish content in an LMS package, you can specify which playback modes will be available to the user. Depending on which option you choose, it affects which playback mode is optional and which is required for completion. The following table lists the combination of playback modes and the criteria for completion.

Available Playback Modes

Try It, Know It Know It

See It, Try It, Know It

See It, Know It Know It

See It, Try It Try It

If a user has completed the required playback mode, the topic is marked comple te whether he/she has played the topic in any other mode or not.

Required Playback Mode

Know It

Topic Completion Criteria

The user has played the topic in Know It mode. Try It mode playback is optional.

The user has played the topic in Know It mode and achieved the required score. See It and Try It mode playback is optional.

The user has played the topic in Know It mode. See It mode playback is optional.

The user has played the topic in Try It mode. See It mode playback is optional.

If a topic is published with only one playback mode available, then the topic will be marked as complete when the user has completed playback of that mode.

Tracked Data

The ability to return data to the LMS is limited to the set of data values that the AICC and SCORM specifications allow. The following table lists the data values that are available and used.

Data value Description

lesson_status

score

time

core_lesson

When a user exits a topic, information is passed to the LMS that indicates the status of a topic (completed, incomplete, passed, failed) and score on the topic if Know It? mode is included for the topic. If a user exits a topic before completing it, the topic status will remain incomplete and information about the completed playback modes is passed to the LMS.

Data that is stored in the LMS and indicates the completion status of the topic. Values that will are used are completed, incomplete, passed, failed.

Data that indicates a user’s score on a Know It? mode playback of a topic. A score is only returned if Know It? mode is available.

Data that indicates the amount of time that the user spent within the topic.

Data that is stored in the LMS to indicate completion status for the playback modes available for the topic. When a user exits and re-enters the topic launch page, the status of each playback mode is restored and the user can resume at the same point he or she stopped.

Deploying Knowledge Accelerator on a Usage Tracking Server

Extract the Knowledge Accelerator **_deploy.zip file, and then extract the **_player.zip file. To install the Knowledge Accelerator to the Usage Tracking Server, double-click **_player.exe and install it to the ‘Content’ folder on your Usage Tracking Server. Refer to the Usage Tracking document for more information.

Note: When you install the Usage Tracking Server, Content folder is created by default. You can change the name of the Content folder and install the Knowledge Accelerator to that folder.

Additional Information Regarding Deployment

How to disable cookies in Player package

To disable cookies, the "systemEnableCookies" variable must be changed to false in the scripts/cookie.js. No other change is required.

Information on creating a htaccess file for Apache

All deployment options use UTF-8 encoding. The Developer sets the encoding by using the HTML "encoding" META tag. By default, Apache on non-Windows operating systems does not honor UTF-8 META tags without the 3 byte order mark (BOM). If you encounter this problem, an .htaccess file can be created in the Player directory to allow Apache to correctly serve UTF-8

pages. To do so, create an .htaccess file that contains the following line: "AddDefaultCharset UTF-8". The httpd.conf must be configured to allow .htaccess override.

http://apache-server.com/tutorials/ATusing-htaccess.html If "AllowOverride None" is set in the httpd.conf, then the .htaccess file is ignored. This needs to

be set to allow the .htaccess file to override the httpd.conf for this particular directory. After doing this, restart the Apache service and then the IE cache *must* be cleared if the content

was accessed before this change. (This is because file dates do not change, only the Apache is serving the files change. Therefore, IE will not realize it needs to get the file again unless the cache is cleared.)

Business objects KNOWLEDGE ACCELERATOR DEVELOPER V8.7.2 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual