Package Installation

From SIMboxWiki
Jump to navigation Jump to search

The purpose of the Package Installation is to deploy your newly created content to computers that have KnowBook installed on them.
The SIMbox Packages Editor provides an installation template and allows you to add files to it as required.

The output package installation can be modified manually, to add files to KnowBook directories and general directories on the client's computer, run scripts near the end of the package installation and manipulate the installation preferences.


Create a package:

The first thing is to create a content package. Open the SIMbox Toolkit (Start>Programs>KnowBook>SIMbox Toolkit). In the Simulation Tree pane, scroll down and expand the Packages tree. You can see inside all the content packages that are installed on your machine. Notice that many of the packages have a box icon with a black lock; this lock indicates that the package was created by another SIMCO and that you don’t have the ability to deliver those packages to your customer.

Right-click on the Packages node to add your new content package.
  Create content package - Add new package.png

Add your entities:

The next step involves adding the your entity/entities (that you created) to the package.
You can use the Find field to easily locate the entity you want to add to your package. Select the entity (in the Source pane) and press the green arrow (or double-click on the entities) to add the entity to the Destination pane. You will see that the entity appears in the Destination pane (on the right) to be compiled in your content package (when you compile your package later).

Add Events to the package:

You need to add any events that you created to the package. This is important!!! (Tip: if you are expecting a presence of an event, that you didn't create, make sure that it is a prerequisite for your installation, for example, either the event is base content, or by installing another content package that incudes the event).

To add an event, locate and select your event in the Source pane and press the green arrow (or double-click it) to add it to the Destination pane.

Add extensions or extension collection to the package:

To add an extension, locate your extension in the Source pane and press the green arrow (or double-click it) to add it to the Destination pane.
Tip: If you created an extension collection you don’t need to explictly add the extensions. The Toolkit automatically adds all of the extensions that are part of the extension collection that was added.

Add your own custom files to the installation package:

There are several directories in the root directory of the package installation. The SIMbox Packages Editor automatically adds files to the appropriate directories during the build of the package as required, but you can manually add your own files to include in the package installation. When running the package installation on a client machine, the installation will copy the files from the directories of the installation to the appropriate location on the client’s machine.

The directories structure of the package installation is as follows:  

Application directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the KnowBook Application directory (i.e. C:\Program Files\KnowBook\Application). Note: Adding files to this directory can also be done using the Package Editor.    

Auto Publish directory - Any exported KnowBook Shell Items (*.ZIP files) placed in this directory will be imported to the KnowBook LMS.  

Bin directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the KnowBook Bin directory (i.e. C:\Program Files\KnowBook\Bin).

Note: Adding files to this directory can also be done using the Package Editor.  

Desktop directory - Any files, folders (and their sub-folders) and shortcuts placed in this directory will be copied to the Desktop directory on the client's computer.  

Executables directory - In this directory you can place *.EXE and *.BAT files that can be automatically launched individually near the end of the package installation.

Note: Adding files to this directory can also be done using the Package Editor.

To launch an executable file open the Preferences.ini file (that is located in the Executables directory), and add Relative Path\File Name under the [Files] section.
For example:
[Files]
1=DirectoryOfFirstExe\MyFile1.exe
2=DirectoryOfSecondExe\MyFile2.bat
Note: You may also specify command line switches after the file name.  


Copy To User Destination directory – Any files, folders (and their sub-folders) and shortcuts placed in this directory will be copied to a directory that will be determined by the end-user in a dialog box (“Choose destination” dialog box) during the package installation. If Copy To User Destination directory is empty the “Choose destination” dialog box will not appear during the package installation. 

 

Sitec directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the KnowBook Sitec directory (i.e. C:\Program Files\KnowBook\Sitec).

Note: Adding files to this directory can also be done using the Package Editor. 

 

Sitec\Resource\Import directory - Any *.SLE, *.DTF and *.REG files located under this folder are activated individually near the end of the package installation.  


Sitec\Resource\Import\Bin Reg directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the KnowBook Bin directory (i.e. C:\Program Files\KnowBook\Bin), and are then self-registered. This directory should only contain self-registerable files.  


SDK directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the KnowBook SDK directory (i.e. C:\Program Files\KnowBook\SDK).  Note: Adding files to this directory can also be done using the Package Editor.


System Directory folder - Any files and folders (and their sub-folders) placed in this directory will be copied to the Windows system directory (i.e. C:\Windows\System32) of the end-user’s computer.  


Windows Directory folder - Any files and folders (and their sub-folders) placed in this directory will be copied to the Windows directory (i.e. C:\Windows) of the end-user’s computer. Note: Adding files to this directory can also be done using the Package Editor.  


Program Files folder - Any files and folders (and their sub-folders) placed in this directory will be copied to the Program Files directory (i.e. C:\Program Files) of the end-user’s computer. Note: Adding files to this directory can also be done using the Package Editor.


Visual Studio directory - Any files and folders (and their sub-folders) placed in this directory will be copied to the Visual Studio directory (i.e. C:\Program Files\Microsoft Visual Studio 8) of the end-user’s computer. Note: Adding files to this directory can also be done using the Package Editor.

 

Compiling:

Click the Save icon from the toolbar to save the new package you have created in the SIMbox Toolkit. 

Click the Compile button (bottom right) to get to the final step.

Check the Generate SCORM Package Item to create a drag and drop zip file for the Knowbook.
Check the Include Detailed Documentation and the toolkit package editor will include an html file that contains the documentation of all the components and tokens in the content package.

Manipulate the Package Installation's Preferences:

You have the option to modify the behavior of the package installation using the Preferences.ini located in the root directory of the installation. The Preferences.ini file includes several parameters that can be manually modified:  

Silent - provides the option for a silent installation with no user interface. Use 1 for a silent installation, 0 for a non-silent installation.  

Show finished dialog - provides the option to show/hide the Finish dialog box at the end of the package installation. Use 1 to show the dialog, 0 to hide it.   

User Destination path - provides the default path to be shown in the "Choose Destination" dialog box, if files are being placed in the Copy To User Destination directory.  

User Destination Title - provides the option to set the "Choose Destination" dialog box title.  

User Destination Message - provides the option to set the "Choose Destination" dialog box message.  

AlwaysOverwrite - provides the option to over write files in the destination directories. By default the package installation will copy files only if newer. Use 1 to always overwrite, 0 to copy only if newer.  

VersionNumber - Determine the version that the package installation is suitable for.  

CheckVersionCompatibility - provided the option to check if the package installation version (as appears in the parameter VersionNumber) is compatible with the KnowBook version it is installed on and if not, display a warning message at the beginning of the installation. Use 1 to check version compatibility, 0 to not.
 

--Orenf 15:38, 8 June 2010 (UTC)