Introduction

Device Manager is software that helps private networks and enterprises manage devices, which include personal digital assistants (PDAs), handheld PCs, subnotebooks, in-vehicle information systems, wireless phones, and other emerging devices for pervasive computing. The management tasks for these devices include:

From the Device Manager console, an administrator can manage Device Manager servers, a single device, a device class, parameters for a single device, parameters for a device class, software packages for devices, and jobs for devices. Administrators can initiate a job, targeting it to all devices, a specific device class, a single device, or a specific group of devices selected with a query. Administrators can view jobs and their status, cancel jobs, and otherwise manage the Device Manager environment.

Sharp Linux Zaurus Plug-in Guide

The Sharp Linux Zaurus Plug-in Guide provides information for administrators to:

Plug-in and the Device Agent

To manage a Sharp Linux Zaurus device, the plug-in and the device agent for Sharp Linux Zaurus are needed. The plug-in and the device agent communicate with each other using HTTP and perform system management tasks.

The plug-in is written as a servlet and resides on the Device Manager server. The plug-in is installed with Device Manager.

The device agent for Sharp Linux Zaurus resides on the device and functions as the client. The device agent is shipped with Access Client and configured as part of the installation of Access Client.

The job types implemented by the plug-in for Sharp Linux Zaurus devices are:

Processing jobs is the main task of the device agent. If the plug-in for Sharp Linux Zaurus has a job for a device, the plug-in puts the job in the polling queue. The Access Client invokes the device agent so that all pending jobs are processed and then immediately shuts down the device agent. The device agent does not continue to run in the device.

Java Code Structure for a Plug-In

The plug-in resides on the Device Manager server and provides device identification, communications, job processing, management tasks for the device class, and so on.

The plug-in is structured in two Java programming layers:

Device class layer
The device class layer defines a set of Java methods to perform low-level primitive operations on the device.
Job type layer
The job type layer implements high-level management tasks, such as software distribution and device configuration, by invoking the methods of the device class layer.

About Sharp Linux Zaurus Devices

Sharp Linux Zaurus devices include PDAs that use Linux and Qtopia.

Getting Started Scenarios

With such a variety of devices and device distributors, many enrollment and job scenarios are possible. The following scenarios are representative for Sharp Linux Zaurus devices, but are not the only tasks possible. The getting started scenarios are:

A Sharp Linux Zaurus device can be preconfigured to connect to a network. If the device does not come preconfigured, collecting inventory data and device configuration are generally the initial tasks performed after an enrolled device owner connects to the network and registers the device.

The scenarios in the Sharp Linux Zaurus Plug-in Guide assume:

Scenario: Installing the Device Agent

The Device Agent is installed as a part of Access Client installation.

Scenario: Changing the Device Configuration

Assume a device wants to change the Appearance Style for Qtopia. For this scenario, a device configuration parameter value is changed:

For this scenario, a device configuration job is used.

Scenario: Distributing Software Packages

The administrator creates a software package and then uses the Device Manager console to submit the software package for distribution to devices as a software distribution job.

For a software package, there is a file that specifies the properties that affect the entire software package and it also lists all the application packages which make up that software package. Each application package in the software package can have separate properties that affect only that application package.

The software distribution job is processed when the Access Client starts the refreshing task.

Software Package Files

For each software package, you prepare one meta package definition file. For each application package in a meta package definition file, you prepare a package definition file.g

The meta package definition file groups several application packages into a single collection for downloading as a software package. The meta package definition file points to the package definition file for each application package in the software package.

Scenario: Using the Inventory Data

A query is used for grouping devices into a list, for viewing data, for targeting jobs to devices, and so on. Queries contain a WHERE clause that generates a list of devices. When a query is created, it references a database table or view in the query view database table.

Queries are assigned a unique identifier (a query ID), and the query ID is stored in the named query database table. When a job is submitted based on one of these queries, the query ID is stored in a database table listing all submitted jobs.

Using the Device Manager console, you can create a list of devices based on a predefined named query. A query can be associated with a device class or can apply to all device classes. For example, a query can be used to determine the list of devices owned by a person.

Note: A query is always run against the database before being created and stored to avoid possible syntax errors or access exceptions for the query.

Scenario: Processing a Job

An administrator uses the Device Manager console to submit a job for one or more Sharp Linux Zaurus devices. Some time later, a connected device looks for and runs any waiting jobs.

Note: Because most devices connect to the network for short periods of time, Device Manager uses a checkpoint and restart technique when distributing files. If some files of a software distribution job are downloaded to a device and then the connection with the device is broken, the software distribution will continue "where it left off" when the connection resumes. Files that are already downloaded to the device are not sent again when the device connects again.

Device Configuration

For every device, there are configuration parameters that are specific to that device. The configuration parameters identify the device and the device user (such as a device name and user ID), the network connection (such as a phone number, DNS address, and IP address), the services (such as a printer address, POP server address, and time server address), and so on.

When a device enrolls with Device Manager, the configuration parameters for that device can be set to initial values with a device configuration job. As appropriate, the configuration parameters can be changed at a later date with another device configuration job. For example, a device configuration job can be sent to devices on a periodic basis, such as monthly, or as needed, to update a server address, a phone number, and so on.

The values for the configuration parameters are set for a device, a group of devices in the same device class, or all devices in the device class with a job parameter definition file for device configuration. Device Manager supplies a job parameter definition file for Sharp Linux Zaurus devices.

Using the Device Manager console, an administrator can view and modify the values of the configuration parameters for the device class, a single device, or a specific group of devices selected with a query. The job parameter definition file conforms to a specific file structure so that the file can be parsed and displayed by the Device Manager console.

To prepare a device configuration job, an administrator uses the Device Manager console to set values for configuration parameters that will be changed. Then a device configuration job is submitted for processing. Use the steps that follow as a guide when preparing your device configuration jobs.

Steps to Make a Device Configuration Job

You can configure an individual device, several devices in the same device class, or all devices of a device class. When a device enrolls with Device Manager, the device configuration parameters for that device can be set to initial values with a device configuration job. As appropriate, the device configuration parameters can be changed at a later date with another device configuration job.

To make a device configuration job, do the following:

  1. Select the target device, a group of devices, the device class, or criteria for running the job, such as newly enrolled devices. Then right-click a device or the device class, and select Submit Job from the context menu.

  2. Use the Attributes window to specify the attributes for this job. The job attributes include the job type, activation date, expiration date, priority, description, and so on.

    Select Device Configuration in the Job Type field.

  3. Use the Device Configuration Parameters window and the Job Parameters window to set the values for the configuration parameters for this job.

    Use the tabs or the tree on the Device Configuration Parameters window to navigate to the parameters you want to set for this job.

    Note: Device configuration parameters are specific for a particular device class and are defined in a job parameter definition file.

  4. Use the Submit Job Summary window to review and verify the target devices, attributes, and parameter information you specified for this job. Click OK to submit the job.

If the job is submitted successfully, the administrator receives a message that gives the job ID for the created job. You can use the job ID to do other tasks such as:

For assistance, refer to Configuring Devices in the Administrator's Guide for Device Manager.

Job Parameter Definition File for Device Configuration

Each device class shipped with Device Manager provides a job parameter definition file for device configuration that describes and sets many values for the device-specific configuration parameters used by all devices in that device class. The job parameter definition file defines how the Device Manager console builds a graphical user interface (GUI) to display the configuration parameters to an administrator.

For Sharp Linux Zaurus devices, the supplied job parameter definition file for device configuration jobs is named SLZConfig_jobparms.xml. This file defines the tabs that appear in the Device Manager console, each parameter on a tab, the field (parameter) label and flyover help, the data type, default values, and so on.

Software Distribution

The administrator creates a software package and then uses the Device Manager console to submit the software package for distribution to devices as a software distribution job. The software distribution job is processed when the user starts the refreshing task of the Access Client.

The meta package definition file contains properties that affect the entire software package and lists all the application packages which make up a single software package. For each software package, there is one meta package definition file. The meta package definition file is the URL for the software package.

The properties for each application package are defined in a package definition file. The package definition file lists the files that make up the application package, such as graphics files, database files, compiled files, and distribution properties for that application package, such as running a setup file after the files are downloaded and allocating disk space.

There is one package definition file for each application package in a software package. So if you are distributing three application packages, each application package can have distribution and installation properties that are unique to that application package within the software package. For example:

Software Package - One meta package definition file
  - URL for the software package
  - Properties affect the entire software package
  - Lists all the application packages

   Application Package - A package definition file
    - Properties for this application package
    - Lists files for this application package

   Another Application Package - Another package definition file
    - Properties for this application package
    - Lists files for this application package

   And so on for each application package in the software package

Because most devices connect to the network for short periods of time, Device Manager uses a checkpoint and restart technique when distributing files. If some files of a software distribution job are downloaded to a device and then the connection with the device is broken, the software distribution will continue "where it left off" when the connection resumes. Files that are already downloaded to the device are not sent again when the device connects again.

Device Manager does not maintain a library of software packages that you distribute to devices. Device Manager stores only a software ID and the corresponding software URL that points to a software package that you distribute. The files that make up a software package are on an application server.

When preparing a software package for a software distribution job:

Software Distribution Tips

Because each package definition file is identified in the meta package definition file, it is often convenient to prepare all of your package definition files before you prepare the meta package definition file.

Display the User Selection Window

The setting for the PackageUserSelection keyword determines which actions are available to the device owner in the User Selection window. To display this window, the PackageUserSelection keyword must be set to yes (or some combination value which includes yes) in the meta package definition file.

The application list in the User Selection window includes the name, version, description, size, and reboot necessity for each application package.

Setting this keyword to no hides the User Selection window.

Delay or Reject a Software Package

When distributing a software package to devices, it is often appropriate to allow the user to choose whether the software package should be downloaded and installed at the current time, to delay the download, or cancel the download. To provide the user with these choices, set the PackageUserSelection keyword to yes/delay/reject in the meta package definition file.

In this scenario, the device owner is presented with a list of application packages in the User Selection window. The device owner selects some or all of the application packages, and then clicks a button to install, delay, or reject the distribution of the selected application packages. To download and install the selected application packages, the device owner clicks Install Now.

No User Selection for the Timing of the Distribution

If you want a software package downloaded and installed the next time a device connects to the Device Manager server (no user selection to delay or reject), set the PackageUserSelection keyword to no in the meta package definition file. In this scenario, the User Selection window never appears. When the device connects to the server, the software packages that are waiting in the software distribution job queue are distributed to the Sharp Linux Zaurus device.

Note: The value for the ApplicationSelectionDisable keyword for each application in the meta package definition file has no effect on which application packages are downloaded with the software distribution job when the PackageUserSelection keyword is set to no. All application packages listed in the meta package definition file are downloaded.

Allow the User to Select an Application Package

To allow the device owner to select or deselect an application package in the User Selection window, set the ApplicationSelectionDisable keyword to no for that application. Each application package in the meta package definition file has a separate setting for this keyword. The PackageUserSelection keyword must be set to yes (or some combination value which includes yes) to display the User Selection window.

If you always want an application package selected in the User Selection window, then set the ApplicationSelectionDisable keyword to yes. When the keyword is set to yes, that application package cannot be deselected by the device owner. In this scenario, the device owner action in the User Selection window (clicking Install Now, Install Later or Never want this package ) always occurs for that application package.

Run an Installation Program

For each application package, an installation program can be run after the entire software package is distributed on device. To implement this feature, use the after_prog_path keyword in the package definition file for the application package.

For example, you can distribute the device agent for Sharp Linux Zaurus devices and start the setup file by using the after_prog_path parameter.

Files for Different Languages and Countries

For meta package definition files and package definition files, the search priority is based on the language and country setting for the device. The language and country abbreviations are appended to the file_name (before the file extension) to generate a fully qualified file name.

Because there is a search priority, fully qualified file names with a language or country identifier (or both) are found "before" the corresponding file name with no identifier.

For meta package definition files and package definition files, the search priority is based on the language and the country as follows:

Search Priority Fully Qualified File Name
  1 (first) http://server_name / file_name_language_country.txt
  2 http://server_name / file_name_language.txt
  3 http://server_name / file_name_country.txt
  4 (last) http://server_name / file_name.txt

This feature allows you to use the same URL reference in a meta package definition file or a package definition file when you distribute files to Sharp Linux Zaurus devices with different languages and countries. In other words, you do not need to have separate meta package definition files or package definition files because the URL reference is resolved to different directory paths based on the language and country.

Steps to Make a Software Distribution Job

You can distribute a software package to an individual device, several devices in the same device class, or all devices of a device class. A software package can have one or more application packages. To prepare a software package for a software distribution job, do the following:

  1. Put the files to be distributed on a Web server. The location must be accessible using the HTTP, HTTPS, or FILE protocols.

    The Web server administrator can identify an appropriate directory.

  2. Prepare a package definition file for each application package or group of data files you are distributing.

    It is convenient to put the package definition files on the Web server in the same directory as the files you are distributing (previous step). Use the sample files as a guide.

  3. Prepare a meta package definition file for the software package. The meta package definition file references each of the package definition files that make up a software package.

    It is convenient to put the meta package definition file on the Web server in the same directory as the package definition files. Use the sample files as a guide.

  4. Register the software package with Device Manager.

    Using the Device Manager console, click Device Classes. Then right-click the target device class for the software package, and select New Software from the context menu.

    Complete all the required fields for the software properties, including the software name, the software version, and the software URL, which is the URL for the meta package definition file.

    For assistance, refer to registering software in the Administrator's Guide for Device Manager.

  5. Select the target device, a group of devices, or the device class to receive the software package with a software distribution job. Then right-click a device or the device class, and select Submit Job from the context menu.

  6. Use the Attributes window to specify the attributes for this job. The job attributes include the job type, activation date, expiration date, priority, description, and so on.

    Select Software Distribution in the Job Type field.

  7. Use the Job Parameters window to select the software name and version from the Software list.

    If there are additional job parameters displayed in the Job Parameters window, select their values as appropriate. Use the tabs or the tree on the Job Parameters window to navigate to the parameters you want to set for this job.

    Note: Additional job parameters are specific for a particular device class and job type and are defined in the job parameter definition file. For software distribution jobs, there might not be any additional job parameters displayed.

  8. Use the Submit Job Summary window to review and verify the target devices, attributes, software package name, and parameter information you specified. Click OK to submit the job.

If the job is submitted successfully, you receive a message that gives the job ID for the created job. You can use the job ID to do other tasks such as:

It is the responsibility of the application package provider to determine if the Sharp Linux Zaurus device must restart after the installation of an application package or to resolve situations when the target copy of a file cannot be replaced, and other installation considerations. Each application package must provide its own installation scenario.

For information on administrative tasks for managing software packages, such as displaying software packages on the Device Manager console, modifying software properties, or deleting software packages from the Device Manager database, refer to the Administrator's Guide for Device Manager.

Package Definition File

The properties for each application package are defined in a package definition file. The package definition file lists the files that make up the application package, such as graphics files, database files, compiled files, and distribution properties for the application package, such as running a setup file after the files are downloaded and allocating disk space.

There is one package definition file for each application package in a software package. So if you are distributing three application packages, each application package can have distribution and installation properties that are unique to that application package within a software package.

An application package is included in a software distribution job by naming its package definition file with the ApplicationURL keyword in the meta package definition file. Because each package definition file is identified in the meta package definition file, it is often convenient to prepare all of your package definition files before you prepare the meta package definition file.

Sections for the Package Definition File

The package definition file is made up of a header line and five sections. The sections are:

Use the sample package definition file as a guide when preparing your package definition file. Use a plain text file for the package definition file and, by convention, use a file name for the package definition file that is similar to the application package name.

The required format for the package definition file follows the sample file. The header line and all the sections are described following the sample file and the file format.

For software distribution jobs, the sequence of the job is:

  1. Files that are identified in the excluded files section are removed from the Sharp Linux Zaurus device.
  2. Files identified in the files and directories section are copied to the Sharp Linux Zaurus device.
  3. Job parameters identified in the extra section are changed.
  4. Finally, installation programs identified in the keyword section are run.

Delimiting the Sections

The package definition file always starts with a one-line header. There is no delimiter between the header line and the first section, the keyword section. After the header line, enter the information for the five sections in the above order. You must use a percent (%) symbol as a delimiter between each section.

Note: A package definition file must have four percent symbols delimiting the five sections. Even if there are no parameters for a section, there must be a percent symbol delimiting each section.

Sample Package Definition File for Sharp Linux Zaurus Devices

#*DFP-v1.00 DMS Filepack (version v1.00)
after_prog_path=/usr/apps/instapps.sh /usr/apps/apps.dat
need_space=200000
%
http://pkgserver.isp.com/latest4SLZ/apps.dat d=/usr/apps
http://pkgserver.isp.com/latest4SLZ/instapps.sh d=/usr/apps m=755
%
%
%
[setProperty]
/Qtopia/Appearance/Style=Windows
Return to:
Section list for the package definition file

Format for the Package Definition File

#*One-line Header
#*Keyword section - options for the application package
keywordOption1=value
keywordOption2=value
:: and so on for all keywords used
%
#*Files and directories for distribution
file1_in_the_application_package
file2_in_the_application_package
file3_in_the_application_package
:: and so on for all files in the application package
%
#*Nested file packages -- not used with Sharp Linux Zaurus devices
%
#*Excluded files - list files to be removed from the device
%
#*Extra section options
[setProperty]
jobParameter1=value
jobParameter2=value
:: and so on for other job parameter

Note: A package definition file must have four percent symbols delimiting the five sections. Even if there are no parameters for a section, there must be a percent symbol delimiting each section. There is no delimiter between the header line and the first section. The first section starts on the second line of the package definition file.

Return to:
Section list for the package definition file

Header Line

The header line must be the first line of the package definition file. The header line typically lists the version number. For example:

#*DFP-v1.00 DM FilePack (version 1.00) 
Return to:
Section list for the package definition file

Keyword Section

The keyword section contains a list of keywords and values that control the behavior of the software distribution job. Each keyword is optional.

The format for the keyword section is a keyword followed by an equal sign (=) and then a value for that keyword. Do not include spaces around the equal sign. For example:

keyword=value

For example, to run an installation program on the Sharp Linux Zaurus device after the application package was downloaded, specify the name of the installation program with the after_prog_path keyword.

If all files being distributed are in the same applications area on a Web server, then the src_relpath keyword is not specified. Typically, the disk space needed for the application package, the default destination, and the file to be run after the job options are specified. For example:

need_space=200000
default_dest=/usr/apps
after_prog_path=/usr/apps/instapps.sh /usr/apps/apps.dat

The overall length for each keyword line is 1023 characters.

Keywords for Sharp Linux Zaurus Devices

Keyword Description Samples/Notes
after_prog_path Specifies the full path of the file to be run after the application packages are distributed.
See the notes below for:
Complete file name.

Arguments can follow the file name.
after_prog_option Specifies whether or not reboot is required before executing the file specified with the after_prog_path keyword. after_reboot when reboot is required.
default_dest Specifies the default destination directory for all entries in the application package. There is no default value.
need_space Specifies the needed disk space in bytes. Any valid numeric value

For example:
10000
200000
src_relpath Specifies the path on the source host relative to the files and directories in the package definition file. A full path or a relative path from the current directory on the source host.

There is no default value.
reboot Specifies whether or not reboot is required just before completing the software distribution. yes when reboot is required.

Reporting and error handling with after_prog_path

The following error checking and reporting occurs when running a file on a device (initiated with the after_prog_path keyword) after an application package was distributed:

Return to:
Section list for the package definition file

Files and Directories Section

The second section of the package definition file contains the names of the files and directories to be distributed. Each file entry (or directory) is listed on a separate line. File options might be specified on each line. The file options are:

Option Description
   d Specifies the destination directory. The last path component from the source path is concatenated to the destination path to form the path.
Use the format:  d=/home
Overrides the default_dest keyword listed in the keyword section.
   s Specifies a path on the source host from which to obtain the file and directory.
Overrides the src_relpath keyword listed in the keyword section.
   u Specifies the owner of the file.
For Example:
u=root
u=15
   g Specifies the group of the file.
For Example:
g=system
g=2
   m Specifies the mode of the file.
For Example:
m=rwx-r-x-r-x
m=644

Examples:

%
http://rtp.ibm.com/src/addr.html d=/home
http://rtp.ibm.com/src/addr.gif d=/ u=root g=system m=rw-r--r--
addr.dat s=file:///d:/swd/data d=/data
filename.html d=/

You can specify one or more file options for each file. The file options affect the file name and the directory name for which they are specified, and they alter how the file or directory is processed.

Return to:
Section list for the package definition file

Nested File Packages Section

The nested file package section is not used for Sharp Linux Zaurus devices. This section is reserved for future use.

Even though this section is not used, you must include a percent (%) symbol to delimit the nested file packages section from the other sections.

Return to:
Section list for the package definition file

Excluded Files Section

The excluded files section removes the listed files from the Sharp Linux Zaurus device. For example:

%
EraseFile.1

Typically, a programmer prepares a list of files that will be deleted from the device as part of the software distribution job. Generally, the administrator does not need to know the file names for the Sharp Linux Zaurus software packages.

Even when this section is not used, you must include a percent (%) symbol to delimit the excluded files section from the other sections.

Return to:
Section list for the package definition file

Extra Section

The extra section for Sharp Linux Zaurus devices specifies a [setProperty] stanza to identify job parameters to be set (or changed) on the Sharp Linux Zaurus device. Each job parameter is listed on a separate line under the [setProperty] stanza. For each line, use the format:

jobParameter=value

Changing the Value for a Job Parameter

You can change the value for a job parameter defined in the job parameter definition file for device configuration. For example, the job parameter for the Qtopia Appearance Style (/Qtopia/Appearance/Style) can be changed in the extra section of the package definition file. This feature allows you to perform device configuration within a software distribution job by changing the value of a job parameter in the [setProperty] stanza.

Example:

This example changes the value of one job parameter.

%
[setProperty]
/Qtopia/Appearance/Style=Windows

Note: The stanza label, [setProperty], is case-sensitive.

Return to:
Section list for the package definition file

Meta Package Definition File

The meta package definition file lists each application package (by their package definition file name) that make up a software package for the software distribution job. Because each application package is identified in the meta package definition file, it is often convenient to prepare all of your package definition files before you prepare the meta package definition file.

The meta package definition file also defines:

The meta package properties include the name for the software package, a version number for the software package, user selection options for the software package, and so on.

The meta package definition file has an application stanza for each application package which identifies the application properties. The application properties include a name for the application, the application URL, a version for that application package, and so on.

For each software distribution job, there is one meta package definition file. Use a plain text file for the meta package definition file and, by convention, use a file name that identifies the software package and is prefixed with the word meta. Use the sample meta package definition file as a guide when preparing your file.

When an administrator creates a software distribution job with the Device Manager console, the URL for the meta package definition file is entered in the Software URL field.

Follow the steps to make a software distribution job or refer to the Administrator's Guide for Device Manager for details on registering software packages (a meta package definition file) with the Device Manager database and then submitting a software distribution job.

Sample Meta Package Definition File

In the meta package definition file, the meta package properties are always listed first and are followed by the stanzas listing the application properties.

PackageUserSelection=yes/delay/reject
PackageName=Package1
PackageVersion=1.0
PackageDescription=My Package

[Application1]
ApplicationUrl=http://pkgserver.ibm.com/19991220/package.txt
ApplicationSelectionDisable=yes
ApplicationName=My Application 1
ApplicationVersion=1.01
ApplicationDescription=Sample Application for Sharp Linux Zaurus

This meta package definition file sample has only one application package. You can include more than one application package in a software distribution job.

Note: Never specify the same file to be sent to one directory more than once in a meta package definition file.

Meta Package Properties

The meta package properties describe and control the properties that affect the entire software package.

The meta package properties are defined by a list of keywords and values. The format for the meta package properties is a keyword followed by an equal sign (=) and then a value for that keyword. Do not include spaces around the equal sign. For example:

keyword=value

For example, setting the PackageUserSelection keyword allows the user to choose to download the application packages in the software distribution job at the current time, delay the download, or never download (reject) the application packages. The meta package properties also identify a name, version, and description for the entire software package.

Meta Package Properties for Sharp Linux Zaurus Devices

Keyword Description Samples/Notes
PackageUserSelection User selection allowed or automatic for downloading this software distribution job.

  =yes
  =yes/delay
  =yes/reject
  =yes/delay/reject

The user can choose to download all selected application packages now (yes), delay the choice to download the application packages (delay), or reject the download of this software distribution job (reject)
Note: If delay or reject are not included, the corresponding buttons are inactive in the User Selection window.

  =no

The user has no choice. All application packages in the software package are downloaded.
yes

yes/delay

yes/reject

yes/delay/reject

no
PackageName Name for the software package.
Displayed in the Device Manager console.
Any value
PackageVersion Version for the software package.
Displayed in the Device Manager console.
Any value
PackageDescription Description for the software package.
Displayed in the Device Manager console.
Any value
Note:
When the PackageUserSelectionkeyword is set to yes/delay/reject in the meta package definition file, the user selects application packages on the list and clicks Install Now to download and install the selected application packages. If the user selects to delay or reject the download, that selection affects all application packages, whether the package was selected or deselected.

The user cannot select to install one group of application packages, to delay another group, and to reject a third group of application packages.

Example settings for the meta package properties are:

PackageUserSelection=yes/delay/reject
PackageName=CostPlus10
PackageVersion=1.00
PackageDescription=Cost plus 10% job estimator

Application Properties

The application properties describe and control the properties of each application package in a software package. There are separate application properties for each application package listed in the meta package definition file.

The meta package definition file has a separate application stanza for each application package in the software package. The application stanza for each application package has a unique number starting at 1. The application stanzas must be identified as [Application1], [Application2], and so on, through [ApplicationN]. There is one stanza for each application package.

The application properties are listed as keywords and values in a stanza for each application. The format for application properties is a keyword followed by an equal sign (=) and then a value for that keyword. Do not include spaces around the equal sign. For example:

keyword=value

An application properties stanza contains the ApplicationURL keyword which identifies the file name or URL for the package definition file. The application properties also provide a name, version, and description for the application package.

Application Properties for Sharp Linux Zaurus Devices

Keyword Description Samples/Notes
ApplicationURL Identifies the file or URL that contains the package definition file. A valid URL

For a file, the relative path from the current directory
ApplicationSelectionDisable Determines if a user can select that application package in a User Selection window or if it is automatically selected.


  =yes

The application package is automatically selected in the User Selection window. The user cannot deselect the application package in the list.


  =no

Allows the user to select the application package in the User Selection window.

When set to no
- The application package name is displayed and selected in the user's window by default

- The application package is downloaded only if the user selects that application package and clicks Install Now

- A selected application package can also be delayed or rejected if PackageUserSelection
 =yes/delay/reject.


yes

(that application package is selected and the user cannot deselect it)



no

(selections can be made by the user; this application package is selected by default)
ApplicationName Name for the application package. Any value
ApplicationVersion Version for the application package. Any value
ApplicationDescription Description for the application package. Any value

For example:

[Application1]
ApplicationUrl=http://rtp.tivoli.com/app1.txt
ApplicationSelectionDisable=yes
ApplicationName=Application1
ApplicationVersion=1.0
ApplicationDescription=Application #1

In this example, the package definition file for [Application1] is located at http://rtp.tivoli.com/app1.txt.

Note: Make the application stanza names unique. Each stanza must begin with the word Application. By convention, each application stanza is numbered, [Application1], [Application2], and so on.

Job Parameter Definition File for Software Distribution

The only job parameter required for software distribution to Sharp Linux Zaurus devices is an ID for the software package. This parameter and a Java class that generates the list of software packages for the user is defined in the job parameter definition file for software distribution jobs.

There are other device classes that also use the ID for the software package, so the same job parameter definition file for software distribution jobs is used by more than one device class. For the device classes supplied by Device Manager, the job parameter definition file for software distribution jobs is named swdist_jobparms.xml.

Sample Files for Software Distribution

The following samples illustrate typical files that are needed for a software distribution job. Use these samples as a guide and follow the steps to make a software distribution job.

Software Package with One Application Package

A meta package definition file is required and one package definition file is required.

When an administrator registers a software package with the Device Manager console, the URL for the meta package definition file is specified in the Software URL field.

Sample Meta Package Definition File

PackageUserSelection=yes/delay/reject
PackageName=Package1
PackageVersion=1.0
PackageDescription=Single Application in Package

[Application1]
ApplicationUrl=http://pkgserver.ibm.com/package.txt
ApplicationSelectionDisable=yes
ApplicationName=SampleApplication
ApplicationVersion=1.01
ApplicationDescription=Sample Application Package

Sample Package Definition File (package.txt for this sample)

#*DFP-v1.00 DMS Filepack (version v1.00)
after_prog_path=/usr/apps/instapps.sh /usr/apps/apps.dat
need_space=200000
%
http://pkgserver.isp.com/latest4SLZ/instapps.sh d=/usr/apps m=755
http://pkgserver.isp.com/latest4SLZ/apps.dat d=/usr/apps
%
%
%
[setProperty]
/Qtopia/Appearance/Style=Windows

Software Package with Multiple Application Packages

A meta package definition file is required and two package definition files are required.

When an administrator registers a software package with the Device Manager console, the URL for the meta package definition file is specified for the Software URL.

Sample Meta Package Definition File

PackageUserSelection=yes/delay/reject
PackageName=Package1
PackageVersion=1.0
PackageDescription=Multiple Applications in Package

[Application1]
ApplicationUrl=http://pkgserver.ibm.com/package1.txt
ApplicationSelectionDisable=yes
ApplicationName=Application A
ApplicationVersion=3.01
ApplicationDescription=Sample Application

[Application2]
ApplicationUrl=http://pkgserver.ibm.com/package2.txt
ApplicationSelectionDisable=yes
ApplicationName=Sample Data for Application A
ApplicationVersion=3.01
ApplicationDescription=Sample Data for Application A

Sample Package Definition File (package1.txt for this sample)

#*DFP-v1.00 DMS Filepack (version v1.00)
after_prog_path=/usr/apps/instapps.sh /usr/apps/apps.dat
need_space=150000
%
http://pkgserver.isp.com/latest4SLZ/instapps.sh d=/usr/apps
http://pkgserver.isp.com/latest4SLZ/apps.dat d=/usr/apps
%
%
%
[setProperty]
/Qtopia/Appearance/Style=Windows

Sample Package Definition File (package2.txt for this sample)

#*DFP-v1.00 DMS Filepack (version v1.00)
need_space=20000
%
http://pkgserver.isp.com/latest4SLZ/Sample.dat d=/usr/apps/samples
%
%
%

Inventory Collection

For this device class, hardware, software, and configuration inventory information can be collected that is specific to the device class. The inventory information might include items such as the computer model, processor type, memory size, battery type, software packages, file path, file size, and so on.

An inventory collection job obtains the hardware and software inventory information from the device agent, returns the information to the Device Manager server, and stores the inventory information in the appropriate Device Manager database. The inventory information for a device can then be displayed in the Device Manager console.

A device class that supports inventory collection jobs provides:

Typically following device enrollment, the Device Manager inventory tables are initially populated by running an inventory collection job as part of the device enrollment process.

To keep the inventory information up-to-date, it is important to schedule inventory jobs to run periodically. It is the administrator's responsibility to make sure that inventory information is up-to-date before performing a job based on an inventory query.

Note: Inventory information identifies resources that reside on the device. The resources include resident software packages, device hardware, and so on. By contrast, the software package list, which is available from the Device Manager console, is only a log or audit trail of all the software packages distributed to the device by Device Manager using software distribution jobs. These software packages may or may not reside on the device.

Steps to Make an Inventory Collection Job

You can collect inventory information from an individual device, several devices in the same device class, or all devices of a device class. The inventory collection job can retrieve hardware inventory, software inventory, or both based on the defined inventory types. To prepare an inventory collection job for Sharp Linux Zaurus devices, do the following:

  1. Select the target device, a group of devices, or the device class. Then right-click a device or the device class, and select Submit Job from the context menu.

  2. Use the Attributes window to specify the attributes for this job. The job attributes include the job type, activation date, expiration date, priority, description, and so on.

    Select Inventory Collection in the Job Type field.

  3. Use the Job Parameters window to select the inventory types to be collected with this job.

    If you do not select at least one inventory type, the device agent collects and returns inventory information for all available inventory types.

    Note: Inventory collection job parameters are specific for a particular device class and are defined in a job parameter definition file.

  4. For software inventory collection only, specify the top directory and a name filter. For example: /usr and *.desktop

    If the top directory or a name filter is not specified, the installed file information, which is a part of software inventory, will not be collected.

    Asterisks (*) are allowed as wildcards when specifying a name filter, but blanks or other special characters (like /) are not allowed.

  5. Use the Submit Job Summary window to review and verify the target devices, attributes, and parameter information you specified for this job. Click OK to submit the job.

If the job is submitted successfully, you receive a message that gives the job ID for the created job. You can use the job ID to do other tasks such as:

For information on administrative tasks for inventory tables, inventory types, inventory display views, and query view, refer to the Administrator's Guide for Device Manager.

Inventory Tables

In a database, there are many database tables and database table views. Device Manager uses SQL relational database tables and database table views to store, retrieve, and display inventory information.

A database table that stores inventory information and is registered with Device Manager is called an inventory table. When a database table view for inventory information is registered with Device Manager, it is called an inventory display view.

Inventory tables for a device class must include a column for the device ID and a column for the last modified date. These columns are always set by the Device Manager server and do not have to be passed by the plug-in to Device Manager.

Typically following device enrollment, the Device Manager inventory tables are initially populated by running an inventory collection job as part of the device enrollment process. Periodic inventory collection jobs will update the inventory information in the inventory tables.

Auxiliary Tables

An auxiliary table contains a list of items which are not device specific, but are used for all devices in the device class. For example, there can be an auxiliary table listing the different types of processors which are used in Sharp Linux Zaurus devices.

Auxiliary tables:

When a record of an auxiliary table is sent by the plug-in, Device Manager always inserts the record into the table if it does not already exist.

Inventory Types

The categories of inventory information that can be collected for the selected devices are called the inventory types. When you make an inventory collection job in the Device Manager console, you select the inventory type from a list. You can select one or more of the available inventory types for a job. If you do not select at least one inventory type, the device agent collects and returns inventory information for all available inventory types.

For the Sharp Linux Zaurus device class, the inventory types are:

By selecting appropriate inventory types when submitting a job, the administrator controls system resources, such as memory, and controls performance factors, such as the amount of inventory collection traffic on the network. Because inventory collection jobs are resource and performance intensive, the administrator should take appropriate steps to control these system resources.

The inventory types for Sharp Linux Zaurus devices are listed in the SLZInvTypes file. The inventory types vary from one device class to another.

Note: Device Manager only supports inventory scans by inventory type. Device Manager does not support partial inventory scan requests; that is, requesting the inventory information for an individual inventory parameter of an inventory type.

Inventory Display Views

An inventory display view is a database table that is registered with Device Manager for the explicit purpose of displaying its contents in the Device Manager console for inventory-related tasks.

Table and column information are needed so the Device Manager console can display and format the columns and the translations of the column names properly. Inventory display views are specific to devices within a device class.

As part of the Device Manager installation, several database tables supplied with Device Manager are automatically registered as inventory display views. The registered display views are defined in the inventory display view definition file for the Sharp Linux Zaurus device class.

Using an Inventory Display View

To view the inventory information for a device from the Device Manager console:

  1. Select the Devices node in the left pane of the Device Manager console. The Device Search window is displayed.
  2. Use the Device Search window to display a list of devices.
  3. Select and right-click one or more devices of the same device class.
  4. From the context menu, click View Inventory.
  5. Select the tab that corresponds to the inventory display view for the information you want to view.
  6. Click Close.

Refer to the online help in the Device Manager console for more information on using inventory display views.

List of Registered Inventory Display Views

The registered inventory display views are listed below. To list the column headings for one of the inventory display views, click the inventory display view name.

Application Packages View
Computer Information Table
Databases View
Device Internals View
Installed Cards View
Installed Files View
Qtopia Settings View
Network Settings View
Network Service View
  

Note: An inventory display view cannot span device classes.

Inventory Display View Definition File

When viewing inventory information for a device, the Device Manager console displays the list of database tables and database views defined for the device class. The administrator selects a database table or database view and then the row of inventory information is displayed for the device.

When displaying inventory information for a device, Device Manager console first imports an XML file that defines the database tables and table columns that contain the inventory information. The XML file is referred to as an inventory display view definition file. There is one inventory display view definition file for each device class.

Note: Inventory information is viewed, but cannot be changed with the Device Manager console.

Query Views

A Device Manager query defines criteria for searches performed against the Device Manager database. You use a query in the Device Manager console when you want to narrowly define the information that is displayed when you search for devices in the database or when you target a job to a set of devices with particular characteristics.

A query view is a logical table that joins multiple database tables for the purpose of creating user-defined custom queries. Query views are typically defined for your Device Manager environment by a database administrator.

The Device Manager console uses the query views to create named queries by generating an SQL WHERE clause from the user-selected table columns. Devices that meet the criteria in a named query can be selected as targets for Device Manager jobs, such as inventory collection or software distribution. Named queries can be saved and reused.

Modification of the WHERE clause of a named query is not allowed because it might affect enrollment jobs that reference the query and might result in devices getting a job for which they no longer qualify.

As part of the Device Manager installation, several database tables supplied with Device Manager are automatically registered as query views. The registered query views are listed in the base_query_views file.

Using a Query View

To use a query view in a device search from the Device Manager console:

  1. Select the Devices node in the left pane of the Device Manager console. The Device Search window is displayed.
  2. Click Return devices using a new query
  3. Select a query view by clicking the Choose button.
  4. You can display all the defined query views or only the query views for a device class.
  5. Select a query view from the list.
  6. Click OK.

Refer to the online help in the Device Manager console for more information on using query views and named queries.

List of Registered Query Views

The registered query views are listed below. To list the column headings for one of the query views, click the query view name.

Application Packages View
Computer Information Table
Databases View
Device Internals View
Device Table View
Installed Cards View
Installed Files View
Job History View
Qtopia Settings View
Network Settings View
Network Service View
  

Application Packages View

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
File Path File path for the application package.
Package Name Application package name.
Return to:
List of inventory display views
List of query views

Computer Information Table

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Computer Model The name of the computer model for this device.
Computer Scan Time The actual scan time. The time is stored in GMT in the database and displayed in the local time in the Device Manager console.
Operating System Name The name of the operating system for this device.
OS Version Operating system version.
Registered owner The owner information.
Timezone The time zone for this device.
Return to:
List of inventory display views
List of query views

Databases View

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Database Name Database Name.
Size (kb) Size of the database in kilobytes.
Database Type Database integer "type" identifier (application specific).
Memory Location Always "RAM" (or the translated equivalent).
Last Modified Timestamp.
Number of Records Number of records in the database.
Return to:
List of inventory display views
List of query views

Installed Cards View

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Capability Always "SYSTEM_MEM" (or the translated equivalent).
Card Name Always "SYSTEM_MEM" (or the translated equivalent).
Card Type Currently this is "SYSTEM_MEMORY".
Free Memory (kb) Memory available (unallocated) on this card in kilobytes.
Manufacturer The "manufacturer" cannot be obtained for system memory cards. Other expansion card types may support this in the future.
RAM size (kb) RAM size in kilobytes.
Serial number Device serial number.
Return to:
List of inventory display views
List of query views

Device Internals View

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Battery Percentage Percentage of available battery capacity.
Battery Type Battery type description (or the translated equivalent).
ANSI Code Page ANSI code page (number) used by the operating system.
Free Memory (kb) Memory available (unallocated) on this card in kilobytes.
Processor Model Processor model description.
RAM Size (kb) RAM size in kilobytes.
Return to:
List of inventory display views
List of query views

Device Table View (Query View Only)

Column Name Description
Device name
Device name and unique numeric identifier in the database for this device record.
Device class Device class (WinCE).
Friendly name Friendly name for the device.
Owner Device owner's name.
Realm Realm that the device belongs to.
Description Device description.
Serial number Serial number of the device.
Model Device model.
Make Device make.
Return to:
List of query views

Installed Files View

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
File Name File name without path qualifier.
File Path Path qualifier (no file name).
File Size Size of file in bytes.
File Owner Owner of file
File Group Group of file
File Permissions Permissions of file
Memory Location RAM or ROM (or the translated equivalent).
Last Modified Timestamp.
Last Accessed Timestamp.
Return to:
List of inventory display views
List of query views

Job History (Query View Only)

Column Name Description
Job ID An identifier created for jobs submitted successfully. Use the the job ID to view job history, upcoming jobs, and exclude the device from jobs.
Device name
Device ID
Unique numeric identifier in the database for the device.
Device class ID Device class.
Job completion status Completion status for the job.
Entry date Date the job was submitted.
Message key Message translation key.
Device Manager ID Device Manager ID.
Message parameters Message parameters.
Last modified Date the job was last modified.
Job type Job type.
Query ID Query used to identify target devices the job was intended to run on.
Group name Group name.
Submitted time Time the job was submitted.
Activation time Activation time for the job.
Expiration time Expiration time for the job.
Job status Current job status.
Job priority Job priority.
Job description Job description.
Interval Specifies how often the new or registered job is submitted to run on its target devices.
Interval unit The interval to run periodic jobs.
Enrollment job Job performed when the device is enrolled.
Results handler Results handler name.
Return to:
List of query views

Qtopia Settings

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Color Scheme
Qtopia's color scheme
Shade Text
Shade the type style of the application name on each Home screen.
Style Qtopia's visual style
Theme
Qtopia's theme
Title Bar
Color of the title bar
Wall Paper
Name of the file applied th the wall paler.
Center Top
Key assigned to the CenterTop key
Left 2nd
Key assigned to the Left2nd key
Left End
Key assigned to the LeftEnd key
Right 2nd
Key assigned to the Right2nd key
Right End
Key assigned to the RightEnd key
Time zone 1
Time zone 1 (in the CityTime application)
Time zone 2
Time zone 2 (in the CityTime application)
Time zone 3
Time zone 3 (in the CityTime application)
Time zone 4
Time zone 4 (in the CityTime application)
Time zone 5
Time zone 5 (in the CityTime application)
Time zone 6
Time zone 6 (in the CityTime application)
Date format Date format
Time format
Time format
Time zone
Time zone
Weeks start on Weeks start on
Language Language
Brightness (on External Power)
The brightness of the front light (on External Power)
Screen saver (on External Power)
The screen saver will be activated if no operation is performed in the specified time (minutes).
Suspend after (on External Power)
The power will turn off if no operation is performed in the specified time.
Brightness (on Battery Power)
The brightness of the front light (on Battery Power)
Dim light after (on Battery Power)
Dim light after in seconds
Dim light after enable (on Battery Power)
Dim light after enable
Light off after (on Battery Power)
Light off after in seconds
Light off after enable (on Battery Power)
Light off after enable
Suspend after (on Battery Power)
Suspend after in minutes
Rotation Rotation
ReceivedMail
Sound for received email.
SambaEvent
Sound for additional software.
StartSync
Sound for starting synchronization with a PC.
Startup
Sound at startup.

For a more detailed description and sample values for these column names, refer to the configuration parameter descriptions for Sharp Linux Zaurus devices.

Return to:
List of inventory display views
List of query views

Network Settings

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Default Service Default Service Name

For a more detailed description and sample values for these column names, refer to the configuration parameter descriptions for Sharp Linux Zaurus devices.

Return to:
List of inventory display views
List of query views

Network Service

Column Name Description
Device Name
Device name and unique numeric identifier in the database for this device record.
Network Type (WLAN)
One of the follwing value is returned.
  • Infrastructure
  • 802.11_Ad-Hoc
If the service type is not "wlan", "n/a" is returned.
AT-dial Modem AT dial mode. ATDT for tone dian, ATDP for pulse.
If the service type is not "dialup", "n/a" is returned.
Channel
Channel number for Ad-Hoc network connection,
If the service is not "wlan", null is returned. i.e. this field will be blank.
Wait time
Time out value to connect modem.
If the service type is "lan" or "wlan", null is returned. i.e. this field will be blank.
Hardware flow control
Hardware flow control to modem. "ON" or "OFF" is returned.
If the service type is "lan" or "wlan", "n/a" is returned.
DHCP
One of the following value is returned.
  • OFF - Specify TCP/IP information
  • ON - Obtain TCP/IP information automatically.
If the service type is "dialup" or "irda", "n/a" is returned.
Primary DNS
Primary DNS address if configured.
Secondary DNS
Secondary DNS address if configured.
Default domain
Default domain if configured.
If the service type is "dialup" or "irda", "n/a" is returned.
Gateway
Gateway address if configured.
If the service type is "dialup" or "irda", "n/a" is returned.
Init commands
Init commands if configured.
If the service type is "lan" or "wlan", "n/a" is returned.
IP Address
IP address if the device if configured.
If the service type is "dialup" or "irda", "n/a" is returned.
Subnet Mask
Subnet mask if configured.
If the service type is "dialup" or "irda", "n/a" is returned.
Phone
Phone number of the dial-up account if configured.
If the service type is "lan" or "wlan", "n/a" is returned.
Host (FTP)
FTP Proxy address if configured.
Port (FTP)
FTP Proxy port number if configured.
Host (HTTP)
HTTP Proxy address if configured.
Port (HTTP)
HTTP Proxy port number if configured.
No Proxy for
Address range not to use proxy if configured.
Proxy Settings
One of the following value is returned.
  • No - No proxy
  • Manual - Set proxy
Service Name
Name of this network service.
Service Type "lan", "wlan", "dialup" or "irda" to indicate network service type.
Speed
Modem speed for dial-up service. Returned value is "9600", "19200", "38400", "57600" or "115200".
If the service type is "lan" or "wlan", null is returned. i.e. this field will be blank.
Auto-detect name servers
Auto-detect name servers enabled or disabled. "ON" or "OFF" is returned.
If the service type is "lan" or "wlan", "n/a" is returned.
Key Type (WEP)
Key Type for WEP.
If the service type is not "wlan", "n/a" is returned.
Authentication Type (WEP)
Authentication Type for WEP.
If the service type is not "wlan", "n/a" is returned.

For a more detailed description and sample values for these column names, refer to the configuration parameter descriptions for Sharp Linux Zaurus devices.

Return to:
List of inventory display views
List of query views

Job Parameter Definition File for Inventory Collection

Each device class shipped with Device Manager provides a job parameter definition file for inventory collection jobs. For Sharp Linux Zaurus devices, the supplied job parameter definition file for inventory collection jobs is named SLZInv_jobparms.xml.

For Sharp Linux Zaurus devices, the default inventory job parameters are:

Install the Device Plugin

To manage Sharp Zaurus, Sharp Zaurus plugin is needed. To install and configure the device plugin:

  1. Install the DMS component of WEA.

    The DMS component of WEA should be installed and configured.

  2. Install the Device Plugin.

    The device plugin should be installed and configured.

Install the DMS component of WEA

To install the DMS component of WEA, refer to the Device Manager in the Everyplace Access InfoCenter.

Install the Device Plugin

The installation requires:

You need to setup the plug-in modules in order to manage Sharp Zaurus device using Device Manager. The Device Manager server must already be installed before you can install the device plug-in.

This is the overall setup procedures for plug-in. The detail steps are vary on the Device Manager Server's platform. You need to review based on your Device Manager Server's platform.

  1. Create the database table for Sharp Zaurus
  2. Install the files for the Device Manager console
  3. Register Sharp Zaurus device class
  4. Update the dmsserver.war
  5. Configure the Device Manager application (DMS AppServer)

Device Manager on Windows

Create the Database Table for Sharp Zaurus
Windows

If you uses DB2 as the Device Manager database system, review "Create the DB2 Database Table". If you uses Oracle as the Device Manager database system, review "Create the Oracle Database Table".

Create the DB2 Database Table

  1. On the Device Manager server, click Start > Programs > IBM DB2 > Command Window.

  2. Change directory to the sql directory under the Device Plugin package directory.

  3. Enter the following command:
    db2 connect to dms user <db2user> using <db2pass>
    

    Where <db2user> should be the username for DMS database access, and <db2pass> should be the password for <db2user>.

  4. Enter the following command:
    db2 -tvf createSLZ.sql
    

  5. After the execution of the db2 command, enter the following command:
    exit
    

Create the Oracle Database Table

  1. On the Device Manager server, start command prompt.

  2. Change directory to the sql directory. This directory can be found under the Device Plugin package directory.

  3. Enter the following command to start SQL*Plus:
    sqlplus <dbuser>/<dbpassword>@<db_name>
    

    Where <dbuser> represents the Device Manager database user name, <dbpassword> represents the password for the same user, and <db_name> represents the the Device Manager database name.

  4. Enter the following command:
    SQL>@createSLZ_ora
    

  5. After completing the command, enter the following command:
    quit
    

Install the Files for DM Console
Windows

Copy the following five files from the bin/data directory under the Device Plugin package directory to the %WAS_HOME%\..\DMS\bin\data directory.

Register Sharp Zaurus Device Class
Windows

To register Sharp Zaurus device class:

  1. Open a command window
  2. Change directory to the config directory under the Device Plugin package directory.
  3. Enter the following command:
    addSLZ.bat <FQDH>
    

    Where <FQDH> should be the Fully Qualified Host Name of the server.

  4. When prompted, check the values and hit the Enter key

    Note:This may take several minutes.

  5. After the execution of the addSLZ.bat file, enter the following command:
    exit
    

Update the dmserver.war:
Windows

  1. On the server, click Start > Programs > IBM WebSphere > Application Server V4.0 > Application Assembly Tool.

  2. Select Existing tab, and click Browse...

  3. Choose dmserver.war under the %WAS_HOME%\..\DMS directory, and click Select then OK.

  4. Click Device Manager Server, and right click Web Components > New.

    1. For the Component name field, type:
      SLZServlet

    2. For the Class name field, type:
      com.tivoli.dms.plugin.slz.SLZServlet

    3. Check the load on startup, and click OK.

  5. Click Security Constraints > DMS Security Constraint > Web Resource Collections > DMS Agent Resource.

    1. For the URLs field, click Add...

    2. For the URL pattern field, type:
      /SLZServlet

    3. Click OK then Apply.

  6. Right click Servlet Mapping > New.

    1. For the URL pattern field, type:
      /SLZServlet

    2. For the Servlet field, type:
      SLZServlet

    3. Click OK.

  7. Click Files, and right click Jar Files > Add Files.

    1. For the Root Directory or Archive field, click Browse...

    2. Choose dmserver under the Device Plugin package directory, and click Select.

    3. Click WEB-INF > lib, and click SLZPlugin.jar.

    4. Click Add, then OK.

  8. Click Files > Save, then OK.

  9. Click Files > Exit.

Configure the DMS_AppServer
Windows

  1. Click Start > Programs > IBM WebSphere > Application Server V4.0 > Administrator's Console.

  2. Click WebSphere Administrative Domain > Nodes > HostName > Application Servers.

    Where HostName is the host name of the server.

  3. Right click DMS_AppServer > Stop, then OK.

  4. Click Enterprise Applications.

  5. Right click HostName_DMS_WebApp > Remove, then No, Yes, and OK.

    Where HostName is the host name of the server.

  6. Right click Enterprise Applications > Install Enterprise Application.

  7. In the Specifying the Application or Module window:

    1. Check the Install stand_alone module.

    2. For the Path field, click Browse...

    3. Choose %WAS_HOME%\..\DMS\dmserver.war, and click Open.

    4. For the Application name field, type:
      HostName_DMS_WebApp
      
      Where HostName is the host name of the server.

    5. For the Context root for web module field, type:
      /dmserver
      

    6. Click Next.

  8. In the Mapping Users to Roles window:

    1. Click DMS Agent Role, then Select...

    2. Check All authenticated users(*), and click OK.

    3. Click Next.

  9. In the Mapping EJB RunAs Roles to Users window, Click Next.

  10. In the Binding Enterprise Beans to JNDI Names window, Click Next.

  11. In the Mapping EJB References to Enterprise Beans window, Click Next.

  12. In the Mapping Resource References to Resources window, Click Next.

  13. In the Specifying the Default Datasource for EJB Modules window, Click Next.

  14. In the Specifying Data Sources for Individual CMP Beans window, Click Next.

  15. In the Selecting Virtual Hosts for Web Modules window:

    1. Click Device Manager Server, then Select Virtual Host...

    2. Choose default_host, and click OK.

    3. Click Next.

  16. In the Selecting Application Servers window:

    1. Click Device Manager Server, then Select Server...

    2. Choose DMS_AppServer, and click OK.

    3. Click Next.

  17. In the Completing the Application Installation Wizard window, click Finish, then OK.

  18. Right click DMS_AppServer > Start, then OK.



Device Manager on AIX or Solaris

Create the Database Table for Sharp Zaurus
AIX or Solaris

If you uses DB2 as the Device Manager database system, review "Create the DB2 Database Table". If you uses Oracle as the Device Manager database system, review "Create the Oracle Database Table".

Create the DB2 Database Table

  1. Start a terminal, and swirch user to <dbuser>.

    #su - dbuser
    Where <dbuser> represents the Device Manager database user name.

  2. Change directory to the sql directory under the Device Plugin package directory.

  3. Enter the following command:
    db2 connect to dms user <db2user> using <db2pass>
    Where <db2user> should be the username for DMS database access, and <db2pass> should be the password for <db2user>.

  4. Enter the following command:
    db2 -tvf createSLZ.sql
    

  5. After the execution of the db2 command, enter the following command:
    exit
    

Create the Oracle Database Table

  1. On the Device Manager server, start a terminal, and switch user to <oracle>.
    #su - oracle
    
    Where <oracle> represents the Oracle database user name.

  2. Change directory to the sql directory. This directory can be found under the Device Plugin package directory.

  3. Enter the following command to start SQL*Plus:
    sqlplus <dbuser>/<dbpassword>@<db_name>
    

    Where <dbuser> represents the Device Manager database user name, <dbpassword> represents the password for the same user, and <db_name> represents the the Device Manager database name.

  4. Enter the following command:
    SQL>@createSLZ_ora
    

  5. After completing the command, enter the following command:
    quit
    

Install the Files for DM Console
AIX or Solaris

Copy the following five files from the bin/data directory under the Device Plugin package directory to the %WAS_HOME%\..\DMS\bin\data directory.

Register Sharp Zaurus Device Class
AIX or Solaris

To register Sharp Zaurus device class:

  1. Open a terminal.
  2. Change directory to the config directory under the Device Plug-in package directory.

  3. Set an environment variable WAS_HOME. Please specify the directory where WebSphere Application Server is installed.
    For example, enter the following command:
    #export WAS_HOME=/usr/WebSphere/AppServer
    
  4. Enter the following command:
    #./addSLZ.sh <FQDH>
    

    Where <FQDH> should be the Fully Qualified host name of the server.

  5. When prompted, check the values and press the Enter key

    Note:This may take several minutes.

  6. After the execution of the addSLZ.sh file, enter the following command:
    #exit
    

Update the dmserver.war:
AIX or Solaris

  1. Change directories to the <WAS_HOME>/bin
    Enter the following command to launch Application Assembly Tool:
    #./assembly.sh &
    
  2. Select Existing tab, and click Browse...

  3. Choose dmserver.war under the %WAS_HOME%\..\DMS directory, and click Select then OK.

  4. Click Device Manager Server, and right click Web Components > New.

    1. For the Component name field, type:
      SLZServlet

    2. For the Class name field, type:
      com.tivoli.dms.plugin.slz.SLZServlet

    3. Check the load on startup, and click OK.

  5. Click Security Constraints > DMS Security Constraint > Web Resource Collections > DMS Agent Resource.

    1. For the URLs field, click Add...

    2. For the URL pattern field, type:
      /SLZServlet

    3. Click OK then Apply.

  6. Right click Servlet Mapping > New.

    1. For the URL pattern field, type:
      /SLZServlet

    2. For the Servlet field, type:
      SLZServlet

    3. Click OK.

  7. Click Files, and right click Jar Files > Add Files.

    1. For the Root Directory or Archive field, click Browse...

    2. Choose dmserver under the Device Plugin package directory, and click Select.

    3. Click WEB-INF > lib, and click SLZPlugin.jar.

    4. Click Add, then OK.

  8. Click Files > Save, then OK.

  9. Click Files > Exit.

Configure the DMS_AppServer
AIX or Solaris

  1. Change directories to the <WAS_HOME>/bin
    Enter the following command to launch Administrator's Console:
    #./adminclient.sh &
    
  2. Click WebSphere Administrative Domain > Nodes > HostName > Application Servers.

    Where HostName is the host name of the server.

  3. Right click DMS_AppServer > Stop, then OK.

  4. Click Enterprise Applications.

  5. Right click HostName_DMS_WebApp > Remove, then No, Yes, and OK.

    Where HostName is the host name of the server.

  6. Right click Enterprise Applications > Install Enterprise Application.

  7. In the Specifying the Application or Module window:

    1. Check the Install stand_alone module.

    2. For the Path field, click Browse...

    3. Choose %WAS_HOME%\..\DMS\dmserver.war, and click Open.

    4. For the Application name field, type:
      HostName_DMS_WebApp
      
      Where HostName is the host name of the server.

    5. For the Context root for web module field, type:
      /dmserver
      

    6. Click Next.

  8. In the Mapping Users to Roles window:

    1. Click DMS Agent Role, then Select...

    2. Check All authenticated users(*), and click OK.

    3. Click Next.

  9. In the Mapping EJB RunAs Roles to Users window, Click Next.

  10. In the Binding Enterprise Beans to JNDI Names window, Click Next.

  11. In the Mapping EJB References to Enterprise Beans window, Click Next.

  12. In the Mapping Resource References to Resources window, Click Next.

  13. In the Specifying the Default Datasource for EJB Modules window, Click Next.

  14. In the Specifying Data Sources for Individual CMP Beans window, Click Next.

  15. In the Selecting Virtual Hosts for Web Modules window:

    1. Click Device Manager Server, then Select Virtual Host...

    2. Choose default_host, and click OK.

    3. Click Next.

  16. In the Selecting Application Servers window:

    1. Click Device Manager Server, then Select Server...

    2. Choose DMS_AppServer, and click OK.

    3. Click Next.

  17. In the Completing the Application Installation Wizard window, click Finish, then OK.

  18. Right click DMS_AppServer > Start, then OK.

Administrative Tasks

After the device agent is installed and configured, the device is ready to be managed by Device Manager. Administrative tasks that may need to be done in the future for these devices include:

SSL and the Device Agent

This version of device agent does not support SSL communication.

Files, Keywords, and File Formats

Select from the list to display the files, keywords, or file formats:

Device configuration Job types JAR files
Software distribution Enrollment servlet Translation files
Inventory collection Plug-in
Device class

Device Configuration

Job Parameter Definition File

SLZConfig_jobparms.xml
Job parameter definition file for device configuration for the Sharp Linux Zaurus device class.

The job parameter definition file for device configuration jobs identifies a set of job parameters, such as the IP gateway or domain name server. Administrators use these job parameters to manage devices. The job parameters are specific for a job type and apply to all devices of the device class.

The job parameter definition file is registered with the Device Manager database.

Software Distribution

Job Parameter Definition File

swdist_jobparms.xml
Job parameter definition file for software distribution jobs for the Sharp Linux Zaurus device class.

The job parameter definition file for software distribution jobs identifies the ID for the software package. The job parameter is specific for a job type and applies to all devices of the device class.

The job parameter definition file is registered with the Device Manager database.

There are other device classes that also use the ID for the software package, so the same job parameter definition file for software distribution jobs is used by more than one device class.

Software Distribution Job Definition Files

Definition files for software distribution
Meta package definition file (plain text format)
Package definition file (plain text format)

Inventory Collection

Job Parameter Definition File

SLZInv_jobparms.xml
Job parameter definition file for inventory collection for the Sharp Linux Zaurus device class.

The job parameter definition file for inventory identifies a set of job parameters, such as the inventory type or top directory. Administrators use these job parameters to manage devices. The job parameters are specific for a job type and apply to all devices of the device class.

The job parameter definition file is registered with the Device Manager database.

Inventory Display View Definition File

Before the Device Manager console displays inventory information from a Device Manager inventory table or other database tables, the format for the inventory display view must be created and registered with Device Manager. The format for the inventory display view is defined using XML tags in the inventory display view definition file. The inventory display view definition file is registered with the Device Manager database.

For the Sharp Linux Zaurus device class, the inventory display view definition file is named SLZDisplayViews.xml.

Inventory Types

The inventory types for Sharp Linux Zaurus devices are listed in the SLZInvTypes file. The inventory types include categories such as computer hardware, battery, memory card, installed software packages, and so on.

Query Views

Some database tables supplied with Device Manager are automatically registered as query views during installation. These registered query views are listed in the base_query_views file.

Some device classes also suppliy a device class specific query views definition file. For the Sharp Linux Zaurus device class, the device class specific query view definition file is named SLZQueryViews.

Device Class

SLZ
The device class short name for Sharp Linux Zaurus devices.

The Device Manager console uses the device class short name.

com.tivoli.dms.plugin.slz.SLZ
The Java class for the Sharp Linux Zaurus device class.

Job Types

Device Configuration

DEVICE_CFG
The job type name for the device configuration jobs for the Sharp Linux Zaurus device class.

com.tivoli.dms.plugin.base.rdmi.RdmiDeviceConfigurationJob
The Java class for the device configuration job type for the Sharp Linux Zaurus device class.

Software Distribution

SW_DIST
The job type name for the software distribution jobs for the Sharp Linux Zaurus device class.

com.tivoli.dms.plugin.base.rdmi.RdmiSoftwareDistributionJob
The Java class for the software distribution job type for the Sharp Linux Zaurus device class.

Inventory Collection

INVENTORY
The job type name for the inventory collection jobs for the Sharp Linux Zaurus device class.

com.tivoli.dms.plugin.slz.SLZInventoryJob
The Java class for the inventory job type for the Sharp Linux Zaurus device class.

Device Manager Enrollment Servlet

http://server_name/dmserver/DeviceEnrollmentServlet
Device enrollment servlet. For server_name, supply the name of your Device Manager server.

The enrollment URL is a Web address stored in the Device Manager database and used by the plug-in to direct a device that is not enrolled to the enrollment server for device registration.

Port 80 is the default port for the IBM HTTP Web Server used by Device Manager.

Before installation of a Device Manager server, the default port for the Web server can be changed. If the port number was changed, then you must include the new port number in the server name portion of the URL. For example, if the port number changed to 8080, the URL would be:

http://server_name:8080/dmserver/DeviceEnrollmentServlet

Plug-in for Sharp Linux Zaurus

com.tivoli.dms.plugin.slz.SLZServlet
The Java class for the Sharp Linux Zaurus plug-in on the Device Manager server.

Device Agent Files

All the device agent files are included in the Access Client installation package.

JAR Files

baseplugin.jar
Common code for all plug-ins supplied by Device Manager.

SLZPlugin.jar
Plug-in for the Device Manager Sharp Linux Zaurus device class.

Device Class Translation Files

The device class translation file contains the translated text for the job parameters from the job properties definition file, other translated text (such as display view column names, database table names, and query view table names), plug-in messages, and any new job types defined for the device class.

If translated versions of the device class translation file are used, the file naming format for each language-specific file must include a language identifier (SLZMsgs_language.properties).

Examples for English and Spanish are:

SLZMsgs_en.properties
SLZMsgs_es.properties