Previous Topic

Next Topic

Book Contents

Book Index

OCM.INI Property Descriptions

AuthentixCookie=

 

When SkillPort is configured to use Authentix, SkillPort will send an Authentix cookie string to the SCM via an SSO file. This Authentix cookie string will be stored in this parameter; the SCM will need to include this string in every command's header which is sent to SkillPort. If this string is not included in the command's header, or not correct, SkillPort (with Authentix enabled) won't process the request from the SCM.

 

AUTO_SYNCHRONIZE=false

 

Applicable values: true, false

true: The SCM will synchronize the Course Catalogue view with SkillPort.

false: The SCM will not synchronize the Course Catalogue view with SkillPort.

AUTODETECT_PROXY_SETTINGS=true

AUTODETECT_PROXY_SETTINGS=true

true: The SCM automatically detects proxy server details configured in the user’s default browser and uses them.

false: The SCM does not automatically detect proxy server details configured in the user’s default browser and does not use them.

CD_Root=

CD_Root=

Applicable values: one character, alphabetic

Indicates the drive letter for the CD-ROM drive.

CDSS_Root=

CDSS_Root=

If the course content is installed into a different directory than the default then this field should be filled in with a forward slash (or two back slashes) and the new directory (e.g. \\myskillsoftDir or /myskillsoftDir)

CLASSIC_AICC_SEPARATOR=PLATEAU

CLASSIC_AICC_SEPARATOR=PLATEAU

Sets the SCM to synchronize Classic results correctly on the Plateau LMS.

Note: This is not a standard setting for the OCM.ini, and should only be added to the OCM.ini for deployment on the Plateau LMS.

ContentRoot=

ContentRoot=

Applicable values: numeric

Specifies a fully qualified URL to download the course to.

DEBUG=1

DEBUG=1

Applicable values: 1, 0

1: Enables the debug messages in the Java console.

0: Disables the debug messages in the Java console.

DEFAULT_AICC_VERSION=3.5

DEFAULT_AICC_VERSION=3.5

Applicable values: 2.2 or 3.5

Sets the AICC version that the SCM uses to communicate by default. Supported values are 3.5 and 2.2.

Note: if the SCM is being used with a SkillPort or an LMS that uses AICC version 2.2, then you must set this property to 2.2. The value of this property must match the value of LMS_AICC_VERSION in PagePlayer.properties.

dirName=SkillSoft

 

Applicable values: alphanumeric

Specifies the folder name where the icons can be placed when installing the SCM.

DOWNLOAD_ZIP_SLEEPING_TIME=1.5

DOWNLOAD_ZIP_SLEEPING_TIME=1.5

Applicable values: Number between 1.5 and 10. (Default is 1.5 seconds.)

The sleep time ensures that the application has waited long enough for the connection to be created before downloading the course file.

The specified value dictates the time in seconds that the application goes to sleep after trying to create the connection to the server.

Note: Slower networks may need more time to create the connection.

Enable508=false

 

Applicable values: true, false

true: The UI for the SCM will change to 508 mode and will be readable by JAWS screen readers.

false: The UI for the SCM will be in normal mode.

exportResult=true

exportResult=

Applicable values: true, false

true: Enables the Export button for use with RUM.

false: Disables not display the Export button.

FE_URL=http\://aeeval.skillport.com\:80/skillportfe

 

Applicable values: the valid SkillPort FE URL.

This is for the SCM to call the BCS command against SkillPort in order to obtain the SkillPort BE.

FORCE_PLAYERLAUNCH_WITH_IE

FORCE_PLAYERLAUNCH_WITH_IE

true: The SCM detects and uses an IE browser.

false: The SCM uses the default browser.

HIERARCHY_URL=http\://pvsp70babe.skillport.com/skillportbe/spaeeval/Cmd.be

 

Applicable values:

This is the SkillPort BE URL which the SCM can use to retrieve a list of hierarchy structures of a specific course.

Note: When AUTO_SYNCHRONIZE parameter is set to TRUE, this URL is required.

HTTP_TIMEOUT_SECS=5

HTTP_TIMEOUT_SECS=5

Applicable values: numerical (seconds)

Sets the timeout value to retry HTTP connections.

https.proxyHost=

https.proxyHost=

Proxy host needs to be used in SSL mode. If not specified, the SCM will use a direct connection to SkillPort. This parameter is automatically set when the AUTODETECT_PROXY_SETTINGS option is enabled.

https.proxyPort=

https.proxyPort=

 

Proxy port needs to be used in SSL mode. If not specified, the SCM will use a direct connection to SkillPort. This parameter is automatically set when the AUTODETECT_PROXY_SETTINGS option is enabled.

InvisibleRemovePanel=

InvisibleRemovePanel

Applicable values: true, false

true: Eliminates access to the Remove panel in the SCM.
false: Users have access to the Remove panel in the SCM.

JETTY_DEBUG=

JETTY_DEBUG=

Applicable values: true, false

true: The SCM writes internal web server debug info to the log.

false: The SCM does not write internal web server debug info to the log.

LMS_AICC_V2_POST=false

LMS_AICC_V2_POST=false

Applicable values: true, false

true: The SCM posts a complete [Objective_Status] block every time it writes AICC data in the HTTP transport (to an LMS).

false: The SCM writes only changes to objective status (and scores) since the last post.

LMS_DEBUG=true

 

Applicable values: true, false

true: Enables detailed LMS related information, such as connection and results tracking data, to be logged in the Java Console or the SCM log file.

false: Disables detailed LMS related information, such as connection and results tracking data, to be logged in the Java Console or the SCM log file.

LMS_SECURE_CONNECTION=false

LMS_SECURE_CONNECTION=false

Applicable values: true, false

true: The SCM sets the protocol on any URL connections to https instead of http. This is only done in the HTTP Transport to set up the connection to the LMS. This is required when the SCM needs to conenct to a SSL SP.

false: The SCM always uses the http protocol.

LMS_VENDOR=SKILLSOFT

LMS_VENDOR=SKILLSOFT

Applicable values: alphanumeric

Customizes SCM AICC communication for a specific vendor.

LMSPostURL=

LMSPostURL=

Applicable values: alphanumeric

Specifies where to post results for offline play when synchronizing (not including protocol).

LOCAL_RESULTS_PORT=9090

LOCAL_RESULTS_PORT=9090

Sets the port that the embedded web server uses; the default is 9090.

MANUAL_PROXY_SETTINGS=false

MANUAL_PROXY_SETTINGS=false

Applicable values: true, false

Determines whether or not the SCM users currently have the Manual Proxy Setting enabled in the SCM.

true: enables manual proxy settings in the SCM.

false: disables manual proxy settings in the SCM.

ocmLang=en

ocmLang=en

Applicable values: frca (Canadian French), eses (Castilian Spanish), zhyue (Chinese Cantonese), zh (Chinese Mandarin)

zhtw, (Chinese Traditional), en (English), fr (French), de (German), el (Greek), it (Italian), jp (Japanese), ko (Korean), esdo (Latin American Spanish), pl (Polish), tr (Turkish)

Sets the language of the SCM user interface.

playerLang=en

Applicable values:frca (Canadian French), eses (Castilian Spanish), zhyue (Chinese Cantonese), zh (Chinese Mandarin)

zhtw, (Chinese Traditional), en (English), fr (French), de (German), el (Greek), it (Italian), jp (Japanese), ko (Korean), esdo (Latin American Spanish), pl (Polish), tr (Turkish)

The default player language to be used when launching a course.

proxyHost=

proxyHost=

Proxy host needs to be used in non-SSL mode. If this parameter is empty, the SCM will use a direct-connection to SkillPort. This parameter is automatically set when the AUTODETECT_PROXY_SETTINGS option is enabled.

proxyPacAddress

proxyPacAddress

Applicable values: valid URL address

Sets the URL of proxy PAC file to use if proxyUsePac=true

proxyPort=

proxyPort=

Proxy port needs to be used in non-SSL mode. If this parameter is empty, the SCM will use a direct-connection to SkillPort.. This parameter is automatically set when the AUTODETECT_PROXY_SETTINGS option is enabled.

proxySet=

proxySet=

Applicable values: true, false

true: Sets the SCM to be configured with a proxy.

false: Sets the SCM to be configured without a proxy.

proxyUsePac=

proxyUsePac=

Applicable values: true, false

true: The SCM uses a PAC file to determine proxy server and port.

false: The SCM does not use a PAC file to determine proxy server and port.

Results_Data_Decoded=

Results_Data_Decoded=

Applicable values: true, false

true: Decode score from AICCData.

false: Do not decode score from AICCData

RETRY_COUNT=3

RETRY_COUNT=3

Applicable values: numerical

Determine how many times the SCM tries to reestablish communication after an AICC communication error.

ROUND_CLASSIC_SCORES

ROUND_CLASSIC_SCORES

Applicable values: true, false

true: Enables results rounding for classic courses.

false: Turns off results rounding for classic courses.

ServerHost=127.0.0.1

ServerHost=127.0.0.1

Applicable values:

  • specific IP address
  • use_local_ip
  • localhost

This is the host used for the SCM embedded web server, if not present or set the default is 127.0.0.1.

Options include:

  • specific IP address: this IP address will always be used.
  • use_local_ip: the SCM will retrieve the current IP address of the machine and will use this.
  • localhost: the SCM will use the hostname "localhost" instead of an IP address.

Server_Root_bkp

Server_Root_bkp

If a user wishes to hardcode the content server and LMS on their CD, they will need to fill this in (rather than filling in Server_Root) and it will get swapped in the Server_Root field at runtime after installation.

ServerRoot=

ServerRoot=

Specifies a fully-qualified URL where to look for SCM component updates.

ServerSocketValue=

ServerSocketValue=

The port that the SCM should use at every start up. If this entry is empty, the SCM will use the port 2492 as default. The SCM uses this port to determine if an instance of the software is already running.

Show_Config_Panel=false

Show_Config_Panel=

Applicable values: true, false

true: The SCM displays the configuration panel.

false: The SCM does not display the configuration panel.

SHOW_COURSE_SCORE=true

SHOW_COURSE_SCORE=true

Applicable values: true, false

This is an optional flag used to display course score.

true: Course score will be displayed in the Progress Tab for every result.

false: Course score will display as normal.

showSessionIDErrorDialog=false

showSessionIDErrorDialog=false

Applicable values: true, false

true: Enables a message dialog, which pops up when progress cannot be synched between the SCM and SkillPort. The reason for this is usually that the session id being used for the login to SkillPort (from the SCM) is no longer valid.

false: Disables a message dialog, which pops up when progress cannot be synched between the SCM and SkillPort.

SKILLPORT_SECURE_LOGIN=true

SKILLPORT_SECURE_LOGIN=true

Applicable values: true, false

true: The SCM uses the SkillPort v3 Secure Login Model. During SCM login the user is required to enter a valid SkillPort User ID and Password.

false: The user is only required to enter a user ID for SCM login and it is not validated against SkillPort. However, if VALIDATE_SCM_LOGIN=true the SCM will validate that the user ID is an ID that has been downloaded from SkillPort.

If you are using SCM 2.8 or higher with SkillPort 2.5 or earlier, you must set SKILLPORT_SECURE_LOGIN=false.

SKILLPORT_USER_LOGIN=true

SKILLPORT_USER_LOGIN=true

Applicable values: true, false

Enables the Single Sign On mode (SSO).

true: Logs in as normal and disables the Single Sign On mode (SSO).

false: The SSO mode will be enabled in the SCM.

Note: When configured to use SSO mode,the SCM will use the last userid synchronized to the user's machine. The userid is synchronized when the user downloads content or when the automatic synchronization is triggered during login to SkillPort. The userid is stored in a text file singlesignon.properties in the SCM directory.

SoftwareUpdateCheckInterval=30

SoftwareUpdateCheckInterval=

Applicable values: numeric (minutes)

Sets the time (in minutes) that the SCM waits before checking for a software update.

SoftwareUpdateCheckOption=1

SoftwareUpdateCheckOption=

Applicable values: 1, 0

1: the SCM automatically checks for software updates.

0: the SCM does not automatically checks for software updates.

Note: If this field is not present in your ocm.ini file then auto-detection will default to '1' (On).

SoftwareUpdateCheckTime=blank

SoftwareUpdateCheckTime=

Applicable values:

The last time the SCM checked for new update. By default (first time launch) the value is blank.

SYNCHRONIZE_ON_LOCAL_LAUNCH

SYNCHRONIZE_ON_LOCAL_LAUNCH

true: Synchronization is switched on for local launch.

false: Synchronization will not occur as part of the local launch of the SCM.

TIMEOUT_SECONDS=27000

 

Applicable values: numerical (seconds)

Sets the timeout value for SCM to wait for a response from SkillPort or the course content, before closing the connection.

USE_EMBEDED_JRE=false

USE_EMBEDED_JRE=false

Applicable values: true, false

Determines whether or not the SCM should use the embedded JRE.

true: Use the JRE version included with SCM.

false: Use the JRE version installed on the user's machine.

UseLogFile=true

UseLogFile=true

C 1, 0

1: Writes SCM information to a log file.

0: Does not write SCM information to a log file.

VALIDATE_SCM_LOGIN=false

VALIDATE_SCM_LOGIN=false

Applicable values: true, false

true: Set this value to true if the following scenario:

You are using SkillPort, the user's SkillPort login ID is downloaded for use with the SCM when the user first downloads or plays a course from SkillPort using NetPlay. Then a valid user IS available when the user starts the local SCM and that ID must be used in order for the results to synchronize into SkillPort.

If you are NOT using SkillPort, as when accessing courses from a content only server, the user is not assigned a valid user ID when they download the SCM. Therefore, no user ID is available when the user starts the local SCM. In this case, set this variable as:

 

false: Set this value to false if either the following scenarios:

 

You are using the SkillPort, under some circumstances you might want to permit users to start the SCM without a valid user ID. For example, you may want to allow a user to start the downloaded SCM before they download any content.

You want to trouble shoot an installation by starting the SCM and playing a course without sending scores to SkillPort.

 

Optional Properties

LEVEL_DISPLAY=-1

LEVEL_DISPLAY=-1

Applicable Values: -1, 00, 1, 2, 3, 4

The level of displaying course hierarchy. Default value is -1. Below are meanings of values:

-1: Display all levels of hierarchy (all course catalogues).

0: Disable display course hierarchy (disable course catalog view).

1,2,3,4: The level of displaying.

MULTI_USER_SYNCHRONIZE =false

MULTI_USER_SYNCHRONIZE =false

Applicable Values: true, false

true: Enables the SCM to synchronize results of all users.

false: The SCM does not synchronize results of all users.