Asset Management Suite

 View Only

Mobile Management Solution - Software Management Install Actions, Settings and Parameters & Notes 

Mar 03, 2011 01:22 PM

Install Actions

The following table describes the Install Actions, settings and parameters that can be entered when configuring packages.

 

Install Action

Description/Settings/Parameters

Download

Install Action that executes a file download specified by the following settings:

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Download Actions Settings

Source- contains the web server directory path and file name of the file to be downloaded to the device if required by versioning.

Target- {DEVICEFILENAME} data type. Text value that specifies the web server directory path and file name of the file to be downloaded to the device if versioning indicates it is required.  This string can contain any device subdirectories prefixing the file name. 

Note: AppUpdate Runtime Substitution Token values can be used within the value to define target subdirectories for target files. See Appendix C Runtime Substitution Tokensfor more information.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

Install

Specifies an Install Action that installs an installable file such as a CAB.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are run if this step fails.

Install Action Settings

The name of the installable file is specified by the following parameters:

Command- {command value} data type. Optional text value that specifies an installation command.

File- {LOCALFILENAME} data type. Text value which specifies a file name of an installable file residing on the device. Installable files include CAB files, ActiveX DLL files, REG import files, CPF files in OMA format and other XML formats which follow install file guidelines. 

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

Uninstall

Specifies an Install Action that uninstalls an installed CAB file.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Uninstall Action Settings

The application to uninstall is specified by the following:

Name- {APPLICATIONNAME} data type. Text that specifies the name of an application installed on a device. The application name can be located by navigating on the device to Start > Settings > System > Remove Programs. Any applications appearing in the list can be specified for Uninstall.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

 

 



Process >WarmBoot

Specifies an Install Action that soft/warm resets the device when all actions for the specified package are completed (not at the time the WarmBoot Action is encountered or after the last action of all packages). The WarmBoot Install Action does not require parameters. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

Note: To customize the warm boot logic, place a custom executable, which must be named warmboot.exe, in the same directory as the AppUpdate executable. When the file warmboot.exe is found, it is executed instead of the default warm boot Install Action.

Process > Run

Specifies an Install Action that executes a program locally on the device.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Run Action Settings

This command execution is specified by the following:

Command- {COMMANDLINE} data type. Text value that specifies a directory path and file name on the device of the file to be run and any command line arguments to modify the run. Embedded blanks are allowed and double quotes are not required in the program path to enclose directories with embedded blanks. Command line arguments with embedded blanks should be tested as shortcuts prior to using here. 

Note: AppUpdate Runtime Substitution Tokenvalues can be used within a value to define subdirectories for executable files and command line arguments as needed.  See Appendix C Runtime Substitution Tokensfor more information.

Timeout- {Timeout value} data type. Integer value that specifies how long the device should wait when executing the Run Action before continuing processing. 

The following are the allowable values:

{value less than zero, ex. -1}- (default) specifies that device processing will wait indefinitely for the action to finish before continuing with subsequent steps.

{"0"}- Device processing will not wait for the action to finish before continuing with subsequent steps.

{value greater than zero, ex. 10}- device processing will wait (value specified in milliseconds) for the action to finish before continuing with subsequent steps.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.


Process>Terminate

Specifies an Install Action that terminates a module process running on the device. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Note:  The Terminate Install Action will issue an error return code if the process to be terminated was not running at the time the call was made. Changing the default Critical continue only on success Action Setting to Critical continue will allow subsequent Install Action processing to continue if the Install Action cannot install a specified file or stop a process that is not running.

 

 

 

 

 

Terminate Action Settings

The name of the process(es) are specified by the following:

Modules- {MODULENAME} data type. Text value that specifies an executable name (cmd.exe) or wildcard inclusion of multiple executable names running on the device (ex c*.* or * for all processes).

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

File System > Copy Files

Specifies an Install Action that copies one or more files from one area (directory or folder) of the device to another. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Copy Files Action Settings

The name of the source folder and file name and the target folder are specified by the following:

Source- {LOCALSOURCEFILESPEC} data type. Path and file name(s) existing on the device to copy from during provisioning.  Using wild card characters is allowed.

Target- {LOCALTARGETFOLDERNAME} data type. Path existing on the device to receive files during provisioning.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

 

 

 

 

File System > Move Files

Specifies an Install Action that moves one or more files from one area (directory or folder) of the device to another. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Move Files Action Settings

The name of the source folder and file name and the target folder are specified by the following:

Source- {LOCALSOURCEFILESPEC} data type. Path and file name(s) existing on the device to move from during provisioning.  Using wild card characters is allowed. Files are removed from this location upon successful move to target.

Target- {LOCALTARGETFOLDERNAME} data type. Path existing on the device to receive the moved files during provisioning.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

File System > Delete Files

Specifies an Install Action that deletes a local file on the device.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Delete Files Action Settings

The name of the file to be deleted is specified by the following:

Path- {LOCALFILENAME} data type. File name(s) on the device to delete during provisioning. Using wild card characters is allowed.

 

 

 

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

File System > Rename File

Specifies an Install Action that renames a file in a specified folder on the device. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Rename File Action Settings

The name of the source file (existing file name) and the target file name (new file name) are specified by the following:

Source- {EXISTINGFILENAME} data type.Path and file name existing on the device to be renamed during provisioning.

Target- {NEWFILENAME} data type. New file name not yet existing in the path specified in source.  Note: Do not prefix with the path/folder specification. Use the raw file name.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.



File System > Create Folder

Specifies an Install Action that creates a local folder (directory) on the device.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

 

Create Folder Action Settings

The name of the folder (directory) to be created is specified by the following:

Path- {LOCALFOLDERNAME} data type. Folder name on the device to be created during provisioning.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

File System > Remove Folder

Specifies an Install Action that deletes a local folder (directory) on the device.

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Remove Folder Action Settings

The name of the folder (directory) to be deleted is specified by the following:

Path- {LOCALFOLDERNAME} data type. Folder name on the device to delete during provisioning. All files in this folder are also deleted.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

 

 

 

 

 

 

 


File System > Rename Folder

Specifies an Install Action that renames a folder on the device. 

Actions Settings

Critical- continue only on success- (default) specifies that subsequent action steps in the package are only run if this step completes successfully. continue- specifies that subsequent action steps in the package are run regardless of the success or failure of this step. continue only on error- specifies that subsequent action steps in this package are only run if this step fails.

Rename Folder Action Settings

The name of the source folder name (existing folder/directory on the device) and the target folder name (new folder/directory on the device) are specified by the following:

Source- {EXISTINGFOLDERNAME} data type. Path existing on the device to be renamed during provisioning.

Target- {NEWFOLDERNAME} data type. New folder name not yet existing on device.

Targeted Device Type

Used to provision specific devices by processor, major version, and platform:

CPU- contains the processor type of the device.

OS Major- {osmajor value} data type. Integer that specifies the major version number of the device operating system.

OS Platform- contains the mobile operating system of the device.

 

Install Metrics

Install Action

Description/Parameters

File Hash

Specifies a file hash to compare and determine whether provisioning needs to be performed.

File Hash Metric Settings

The file hash is defined by the following:

File- device file name and path used for comparing the hash value.

Hash- MD5 hash value of specified file (Read Only).

Metric Generation Settings

Metric Source- file name and path of the server repository source file used to derive the file version for comparing to the device file. The device file version must match this file version. The Metric source cannot be manually entered.

Folder- path for Metric source file.

CAB File- CAB file containing Metric source file.

Virtual File- Metric source file contained in the CAB file.

Targeted Device Type

CPU- specifies the processor type of a device.

OS Major- specifies the major version number of a device OS.

OS Platform- mobile operating system of a device.

File Version

Specifies a file version to compare and determine whether package provisioning actions need to be run to update a device.

File Version Metric Settings

The file version is defined by the following:

Field- file version field used as the file version definition. Values are File or Product. The literal file version or a field in the file version set should be used. If the application has an embedded assembly, a sub class of File (file version) or Product (product version) may be specified.

File- device file name and path used for comparing the hash value.

Operator- comparison operator for file version. Values are equal to (EQ), not equal to (NE), greater than (GT), greater than or equal to (GE), less than (LT), and less than or equal to (LE).

Value- file version of specified file (Read Only).

Metric Generation Settings

Metric Source- file name and path of the server repository source file used to derive the file version for comparing to the device file. The device file version must match this file version.

Folder- path for Metric source file.

CAB File- file containing Metric source file.

Virtual File- metric source file contained in the CAB file.

Targeted Device Type

CPU- specifies the processor type of a device.

OS Major- specifies the major version number of a device OS.

OS Platform- mobile operating system of a device.

File Size

Specifies the file size to compare and determine whether package provisioning actions need to be run to update a device.

File Size Metric Settings

The file size is defined by the following:

Metric Type- file content properties used to indicate whether package provisioning actions are run to update/align a parent product.

File- device file name and path used for comparison.

Operator- comparison operator for file size.  Values are equal to (EQ), not equal to (NE), greater than (GT), greater than or equal to (GE), less than (LT), and less than or equal to (LE).

Size- size value in bytes (Read Only).

Metric Generation Settings

Metric Source- file name and path of the server repository source file used to derive the file version for comparing to the device file. The device file version must match this file version. The Metric source cannot be manually entered.

Targeted Device Type

CPU- specifies the processor type of a device.

OS Major- specifies the major version number of a device OS.

OS Platform- mobile operating system of a device.

 

Other Notes:

For metrics, the comparison operators for filesize and fileversion are:

  • EQ: equal to
  • NE: not equal to
  • GT: greater than
  • LT: less than
  • GE: greater than or equal to
  • LE: less than or equal to

 

MD5 Hash:

The hash is the MD5 hash of the file.  This is a standard hash.  The recommended way to do this is to autogenerate from the source/downloaded files and delete or change the metrics that are no longer required.  Hashes of all the (non-versioned) source/downloaded files are generated through autogenerate.

 

What is the default command line? 

 An install action of:

File=whatever.cab
Command=<blank>

 is equivalent to:

File=whatever.cab
Command=wceload.exe “%1”

 

 Maintenance Windows: 

Automatic software install (and ‘health check’) only happens during each configured mobile maintenance window.  It is evaluated once for a device at a random time during the mobile maintenance window.   Only software packages that are set to “Automatic” are installed automatically.

Statistics
0 Favorited
0 Views
0 Files
0 Shares
0 Downloads

Tags and Keywords

Comments

Jun 13, 2011 09:24 AM

How to use these options, i mean where is the UI for this.

Mar 03, 2011 03:47 PM

Any news on the new version? With agent support for IOS?

I was wondering also if it´s gonna have any support for Microsoft Office 365 (BPOS) or Exchange on the cloud, since NS deppends on the Management Tools commandlets to work...

Just a tought, since i got a lot of customers migration e-mail to the cloud.

Related Entries and Links

No Related Resource entered.