K-install - Getting Started

Getting Started

The example XML setup scripts should be the basis of any custom install script you make. The quickest method to create a new script is to cut and paste components from the examples and change the values to suit your application. If you are familiar with XML's DTD/Schema this can help by showing the possible input values allowed.

A compiled html (.chm) file detailing the construction of a K-install setup document is also available for download: K-install Programmers Guide.chm (~35k)

Examining and running the example setup scripts with the sample database (available from the download section) remains the quickest way of getting started and evaluating K-install. If you wish to write your own setup script then the following guidelines will help.

Constructing an install script is a 3 step process:

Write the XML file (k-setup.xml)

Check the XML file. Use the Checksum Generator program to check syntax and highlight errors

Save the XML file. Use the Checksum Generator to add the correct checksum value and save the file ready for use.

Common parts:
Some things are common to all install scripts and should not be altered.

The start of the XML file must begin :

<?xml version="1.0" encoding="UTF-8"?>

        

<!DOCTYPE K-SolutionsInstall [
...
    ......
    ......
    (DTD)
    ......
    ......
...
]>

<K-SolutionsInstall Ver="0.3" Collection="Collection" DocTypeChecksum="031YYEFS^^s024Z" CheckName="CheckName" Checksum="028Y_DFP_Uz030\ZC">

It is important that the DocTypeChecksum value and any of the DTD is not altered or the install file will fail to load.

"Collection" can be edited to contain the product name to be installed or collection name.

CheckName contains your company name. This is automatically added along with the Checksum value by the CheckSum Generator program.

The main install script structure consists of an Initialise and Execute block. Contained in the Initialise block are instructions for user input/selection and for giving instructions to the user and defining dependencies for files and programs needed. The Execute block contains the actually install processes need. The parts of the Execute block that actually get run depends on options selected from the user.

Shown Below is a very basic layout showing the two main blocks and example components contained within.

                                 ....

            </ProgramDef>
        </Components>
        <Comment Text="TEXT"/>
    </Initialize>

    <Execute>
        <CommonExe>
            <Comment Text="TEXT"/>
        </CommonExe>
        <ProgramExe Name="NAME">
            <Comment Text="TEXT"/>
        </ProgramExe>
    </Execute>
</K-SolutionsInstall>

Comment text can be placed in a number of locations. The optional Icon value defines which icon is displayed alongside the text (list of icons and their value can be found in the CheckSum Gen program)

Programs defined in the Initialize block e.g <ProgramDef Name="name"> can be selected by the user. Those selected are executed within the Execute block with a corresponding name e.g <ProgramExe Name="name">

<CommonExe> block contains instructions that are executed regardless of programs selected.

Chart showing main structure of K-install setup XML

Feedback >>