ARCHIVE

This tag contains at least one PACKAGE tag.

Required attribute is name.

Optional attributes are description, uimode and error_action.

uimode: Mode of interaction with the user. Possible values:

●      full – The user sees the progress of the installation process and gets information about the actions currently being performed and all error messages. (Default)

●      simple – The user sees error messages only.

●      none – The user does not get any messages.

error_action: Behavior in case of errors. Possible values:

●      abort – The installation is canceled. The administrator sees that the installation failed.

●      ignore – The error is ignored. No error is reported.

●      retry – The step that failed is repeated (maximum of three times).

●      ask – The user is asked if the installation should be canceled, the error ignored, or the failed step repeated. (Default)

PACKAGE

This tag optionally contains a PREREQ tag and at least one TASK tag.

Required attribute is name.

Optional attribute is description. 

PREREQ

This tag contains one or more tags of type APPLICATION. If the check of one of the APPLICATION tags is negative, execution is canceled.

APPLICATION

The information given here is used to check if the package can be installed.

The required attributes name and version correspond to those in the Mobile Component Descriptor.

The optional attributes prefixmatch and comparator are used to compare the name and version with the installed version. 

Possible values for the comparator: less, less_equal, equal, greater_equal, greater, not_equal, dont_care.

The optional attributes prefixmatch: true, false

TASK

This tag contains at least one instruction tag. Possible instructions are:

●      REMOVE_FROM_ARCHIVE

●      ADD_TO_ARCHIVE

●      REMOVE_FROM_CLASSPATH

●      ADD_TO_CLASSPATH

●      SET_PROPERTIES

●      DELETE

●      COPY

●      EXECUTE

Optional attributes are description and name.

REMOVE_FROM_ARCHIVE

Removes files or directories from a ZIP of JAR archive.

The attribute targetArchive defines the storage location of the client file. Additional placeholders can be used; see the table below for more details.

The attribute target identifies a file or directory relative to the archive root directory. If the attribute pattern is used, target must be a directory. The value of pattern is interpreted as relative to target.

SAP MI must not run during this instruction.

ADD_TO_ARCHIVE

Adds files or directories to a ZIP or JAR archive. Existing files and directories are overwritten.

The attribute source identifies the source directory of the file. If it is local, the permitted placeholders can be used; see below for details. If the attribute pattern is used, source must be a directory.

The attribute targetArchive defines the directory to be updated. The attribute target identifies a file or directory relative to the archive root directory.

If source is a file, target must also be a file.

SAP MI must not run during this instruction.

REMOVE_FROM_CLASSPATH

Removes an entry from file listOfJars.txt.

The attribute classpathentry defines the absolute path to an archive. It can contain the permitted placeholders; see the table below for details.

It is of no importance whether or not SAP MI is running at this point.

ADD_TO_CLASSPATH

Adds an entry to file listOfJars.txt.

The attribute classpathentry defines the absolute path to an archive. It can contain the permitted placeholders; see below for details.

It is of no importance whether or not SAP MI is running at this point.

SET_PROPERTIES

Updates PROPERTIES files.

The attribute source defines the source file. If it is local, the allowed placeholders can be used; see below. The file must conform to java.util.properties.

The attribute target defines the file to be updated. Entries in the source file overwrite corresponding entries in the file to be updated.

Entries marked R_E_M_O_V_E. in the source file are deleted from the file to be updated.

It is of no importance whether or not SAP MI is running at this point.

DELETE

Deletes local files and directories.

Together with pattern, the attribute targetFolder defines the files to be deleted. Additional placeholders can be used; see the below table for details.

SAP MI must not run during this instruction.

COPY

Deletes local files and directories. Existing files and directories are overwritten.

Valid placeholders can be used for target and source; see the table below for details.

EXECUTE

Executes executable files in a separate process.

The attribute executable must be set and defines the executable file. Additional placeholders can be used; see the table below for details.

Attribute commandline is optional; placeholders can be used.

The attribute blocking defines if the installation process is blocked until file execution has completed (value true) or if both processes run in parallel (value false).

Attribute

Purpose

description

Defines the text to be displayed while the instruction is executed or if there is an error.

mi_running

Defines if the SAP MI Client Component is permitted to run when an instruction is executed. Possible values:

true – SAP MI must be running

false – SAP MI must not be running (default)

pattern

Uses pattern files to define which files and directories are affected by the instruction.

The following patterns are possible:

●      Relative file names with folders. The folder separator is /.

●      For characters in file names (once per pattern)

●      For all subdirectories

Example:

/test/xyz.properties – for exactly one file

**/ xyz.properties – all files named xyz.properties in all subdirectories

**/*.properties – all files with ending .properties in all subdirectories

sourcelocation

Defines how the source is defined.

local – local path to the mobile device

archive – relative path in the installation archive

Placeholder

Purpose

MI_HOME

Installation directory of the SAP MI Client Component

JAVA_HOME

Java installation directory.

JAVA_LIB

Directory of the Java libraries (%MI_HOME%\lib)

NATIVE_LIB

Directory of the native libraries (%MI_HOME%\bin)

CI_HOME

Installation directory of the client installer

WINDOWS

Windows directory (C:\WINNT, C:\WINDOWS)

WINDOWS_STARTUP

Windows startup directory

PROGRAM_FILES

Windows program directory

MI_PERSONAL

File system directory used for common storage of documents

OS

Operating system. Can be used if an archive is used for multiple platforms.