Note:

Before using this information and the product it supports, read the information in Notices.

(C) Copyright International Business Machines Corporation 2000, 2002. All rights reserved.

Note to U.S. Government Users Restricted Rights -- Use, duplication, or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.


This information contains many internal links, plus external links to other Device Manager information, including the Device Manager console help. Use this document online to ensure your access to all the available administration resources.

Introduction

This document describes how to perform administration tasks using Device Manager. Before performing these tasks, the Device Manager database server and the Device Manager server should already be installed and running.

Client Operations

Most administration tasks are client operations. Client operations are described in Part 1 of this document. They are performed from a computer running a supported Microsoft Windows operating system, using the Device Manager console shown in Figure 1:

Figure 1. Device Manager console, main window
Device Manager console, main window

From a Device Manager console running on a supported administration client computer, as described in Introduction to Device Manager, administrators can access the Device Manager relational database to manage the following:

Server Operations

Some administration tasks are server operations. Server operations are performed on a Device Manager server. Server operations are described in Part 2 of this document.

From the command line on any Device Manager server, administrators can, for example, manage large numbers of jobs or devices by issuing commands to do the following:

Administrators should also monitor important log files on the Device Manager servers for error and informational messages.

Who Should Use This Information

The information in Administrator's Guide for Device Manager is for administrators who need to provide device management support for enterprise device users.

Part 1: Client Operations

The tasks described in the following sections must be performed from a Microsoft Windows administration client using the Device Manager console.

Installing the Device Manager Console

You can install the Device Manager console on any supported administration client computer. To review the computer hardware and software requirements for client computers, see the Device Manager administration client requirements in Introduction to Device Manager or in the installing and configuring information provided with your IBM WebSphere Everyplace Access documentation.

To download and install the Device Manager console:

  1. Open a browser on the supported Microsoft Windows client.

  2. Point your browser to the following Web page:

    http://server_name/dmconsole/DMconsole

    where server_name is the host name and domain of a Device Manager server (for example, dmserver.raleigh.tivoli.com).

    Note: 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 will have to include the new port number in the server_name portion of the URL of the above Web page. For example, you will have to type a URL like:

    http://dmserver.raleigh.tivoli.com:8080/dmconsole/DMconsole

    where :8080 references the changed port number.

  3. Follow the instructions on the Web page to download and install the Device Manager console.

Starting the Device Manager Console

When you install the console as described in Installing the Device Manager Console, a Tivoli folder that contains a Device Manager Console selection is added to the Programs information in your Microsoft Windows Start menu.

To start the console:

  1. Click Start > Programs > Tivoli and select Device Manager Console.

  2. Enter your administrator user ID, password, and Device Manager server, and click Login.

    Note: 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 will have to include the changed port number when completing the Device Manager server field of the Login window. For example, the administrator will have to type a Device Manager server like:

    myserver.raleigh.tivoli.com:8080
    

    where :8080 references the changed port number.

It is important that the Device Manager server be up and running the first time a console startup is attempted. At every startup, the Device Manager console retrieves necessary properties files from the Device Manager server. Without these files you cannot log in to the console. After each successful startup, the most recent properties files are retained locally on the client and can be used as backup files to enable login, should the Device Manager server be unreachable for any reason. However, if the Device Manager server cannot be reached the very first time after installation, console login is not possible because no backup files exist on the client.

Following the first successful startup, the Device Manager console can access the Device Manager database directly and only needs to contact a Device Manager server to retrieve updated properties files or display help.

Troubleshooting tip: Unicode fonts

If you have trouble displaying Unicode fonts in the Device Manager console, installing another font and changing the fontName property in the preferences.properties file may resolve the problem:

  1. From the product CD, copy the zip file of the font for the language you want to the computer where the console is installed.

    For example, WebSphere Everyplace Access customers can copy any of the following Montotype Sans WT font files from the \dms\fonts directory of product CD 6:

  2. Extract the font file to a known location.

  3. On the Windows desktop, click Start > Settings > Control Panel, and double-click Fonts.

  4. To install the font, drag the extracted file to the Fonts window.

  5. Change the fontName property in the following file:

    console_directory\dm\dmspkgs\preferences.properties

    where console_directory is the Windows administration client directory where the Device Manager console is installed (for example C:\TivoliDM).

    Example fontName property statements:

Removing the Device Manager Console

To remove the Device Manager console:

  1. Delete DMconsole.zip from the temporary directory where it was downloaded.

  2. Delete the directory where the contents of DMconsole.zip was extracted to; for example, C:\TivoliDM.

  3. Go to the Programs directory:

  4. From the Programs directory, delete the Tivoli folder and its contents.

Typical Console Tasks

Use the Device Manager console to manage the jobs, devices, software, and queries in your network and to display Device Manager server information. Typical console tasks include the following:

Using Menu Options and Window Features

Selecting Objects and Actions

Use the left pane of the Device Manager console to select the type of object you want to display in the right pane. Right-click a node in the left pane or an object in the right pane to display a context menu of selectable actions. To select more than one object in the right pane, click the first object and then press and hold the Ctrl or Shift key and select additional objects.

Modifying Table Displays

You can modify a table display in the right pane by doing any of the following:

Refreshing the Console

In some cases, changes to the Device Manager database are not immediately displayed in the Device Manager console. To ensure you have the latest view of the database, select Refresh from the File menu.

Finding Objects in Lists

In the right pane, to find an object in a long list of objects (for example, to find a particular device when the console is showing thousands of devices), select Find from the Table menu. A window is displayed that enables you to find objects by specifying a text string to search for. Do not use wildcard characters, such as asterisks (*), in your text string.

Using the Status Bar

A status bar is located at the bottom of the Device Manager console. The status bar displays the number of selected objects and total objects currently displayed on the right side of the window.

Using Searches

Searching is a way to find particular database objects and to control the number of objects displayed in the Device Manager console.

In Device Manager, a search is used from the console to find jobs, job progress, devices, or software in the Device Manager database, in order to manage or manipulate them. A search window is displayed by default whenever the Jobs, Devices, or Software node in the left pane of the console is selected. Selecting search criteria creates an SQL where clause that runs against the Device Manager database and returns objects according to the specified criteria.

Using searches reduces the processing and network overhead of retrieving a large list of objects from the Device Manager database. Displaying thousands of objects at a time can result in out-of-memory problems or slow response times.

Always Select Search Criteria

If your site supports large numbers of devices, always set search criteria for the objects you want to display. Search for devices by using saved or new queries with search criteria like device name, device class, owner, or realm, to name just a few. Search for jobs by using search criteria like job ID, status, target device class, target query, job type, submission or other dates--use as many search criteria as possible with jobs. Search for software by using search criteria like software name, software version, or device class. Search for job progress by using search criteria like job number, device name, device class, or progress.

To bypass or disable the search function:

To set search criteria for the retrieval of jobs, software, or job progress:

Note: You can use the steps in this section to set search criteria for devices also, but only if the device search was initiated from the context menu of a selected object (such as a selected device class or software object) displayed in the right pane of the console. If the device search was initiated by selecting the left-pane Devices node, use the steps in the next section.

  1. From the search window, select a search criteria tab.

    Click Help on the search window for an explanation of particular search criteria tabs and fields or for more detail on how to use the search window.

  2. On the tab, select a button for the criteria you want to search on.

  3. Specify your search criteria in any corresponding text fields or selection boxes. Some text fields allow the use of an asterisk (*) as a wildcard character.

    After completing your search criteria, check the symbol on the search criteria tab to see whether proper search criteria have been specified on the tab.

  4. Repeat steps 1 through 3 for each search criteria tab you want to work with.

  5. To display a message indicating the number of existing items that match your current search criteria, click the How Many button on the search window panel.

    Use this button to help determine the effectiveness of your current search criteria. If the number of items returned is large, you can modify the current search criteria to make it more restrictive, or use the Maximum items returned field to limit the number of objects being returned to a more manageable quantity. Using the How Many button to return only a number is faster than requesting a search query that returns a full text result.

  6. On the search window, type a number in the Maximum items returned field that limits the number of database objects you want Device Manager to return and display. You can use the number of matching items displayed in step 5 to guide your decision. Otherwise you can accept the default of 500 items returned. This field must have a value.

  7. Click OK. The job, software, or job progress objects that meet your search criteria are displayed in the right pane.

To set search criteria for the retrieval of devices:

Note: Use the steps in this section to set search criteria for devices when the device search was initiated by selecting the Devices node displayed in the left pane of the console. If the device search was initiated from the context menu of a selected object (such as a selected device class or software object) displayed in the right pane of the console, use the steps in the previous section.

To select search criteria for devices using a saved query:

  1. From the Device Search window, select the Return devices using a saved query radio button.

  2. Select a saved query from the Query drop-down box.

    Before making your final selection, you can view the properties of any selectable saved query by first selecting the query and then clicking the Properties button.

  3. To display a message indicating the number of existing devices that match your current search criteria, click the How Many button on the search window panel.

    Use this button to help determine the effectiveness of your current search criteria. If the number of items returned is large, you can modify the current search criteria to make it more restrictive, or use the Maximum items returned field to limit the number of devices being returned to a more manageable quantity. Using the How Many button to return only a number is faster than requesting a search query that returns a full text result.

  4. On the search window, type a number in the Maximum items returned field that limits the number of devices you want Device Manager to return and display. You can use the number of matching items displayed in step 3 to guide your decision. Otherwise you can accept the default of 500 items returned. This field must have a value.

  5. Click OK. The devices that meet your search criteria are displayed in the right pane.

To select search criteria for devices using a new query:

  1. From the Device Search window, select the Return devices using a new query radio button.

  2. Use the associated fields and buttons to select a query view and create a query. The help information for the Device Manager console provides descriptions of the fields and buttons for this task.

  3. To display a message indicating the number of existing devices that match your current search criteria, click the How Many button on the search window panel.

    Use this button to help determine the effectiveness of your current search criteria. If the number of items returned is large, you can modify the current search criteria to make it more restrictive, or use the Maximum items returned field to limit the number of devices being returned to a more manageable quantity. Using the How Many button to return only a number is faster than requesting a search query that returns a full text result.

  4. On the search window, type a number in the Maximum items returned field that limits the number of devices you want Device Manager to return and display. You can use the number of matching items displayed in step 3 to guide your decision. Otherwise you can accept the default of 500 items returned. This field must have a value.

  5. Click OK. The devices that meet your search criteria are displayed in the right pane.

To change your search criteria for the current display after the search window has closed, click the node you want to display in the left-pane tree and make your changes as described previously.

To use the search function with a selected object to display its devices, jobs, software, or job progress, right-click the selected object and select a View task from the context menu.

For example, if you right-click a device class that is currently displayed in the right pane, and select View Devices from the context menu, the Device Search window is displayed. When you select the search criteria and click OK, the results are displayed in a secondary window, rather than in the right pane of the console.

Symbols on Search Criteria Tabs

Use the symbols on the search criteria tabs as a guide when specifying your search criteria:

{Active search criteria} symbol
A checkmark on the tab means search criteria are selected on that tab, and the search criteria are valid.

{Improper search criteria} symbol
An X on the tab means improper search criteria are specified on that tab.

For example, improper search criteria are specified on the Software Name tab of the Software Search window if Return anything with text that matches one of the listed search criteria is selected, but no text appears in the related list box.

If an X appears on any tab, the OK button on the search window is not available. To make the OK button available, correct any improper search criteria. Typically, this requires one of these actions:

[No symbol]
No symbol on the tab means no search criteria are selected on that tab. Instead, Return anything is selected.

Using Queries

Device Manager provides the capability to create and save queries. A query is a request for information from the Device Manager database. You can use a query when you want to narrowly define what displays when you search for devices in the database or when you target a job to a set of devices with particular characteristics. When you use a query to find an object, you can either create a query or display queries that were previously registered in the Device Manager database and select one. These registered queries are useful when you need to repeatedly perform the same search to manage a specific set of devices or objects.

A query consists of an SQL where clause that you use to specify the criteria you want to search for in the Device Manager database. When using the Device Search window or the Submit Job wizard to search for an object, you can enter the where clause directly in the Search criteria in SQL format field, or by selecting Assist and letting the SQL Assistant help you. The SQL Assistant is a window an administrator can use to generate the where clause without having knowledge of SQL syntax.

A query also includes a query view, which is a database table or database table view (a logical table that joins two or more database tables) that has been registered with Device Manager for use by the Device Manager console as the basis for search criteria in a user-defined query. A query view represents a useful collection of data about devices, device software, device hardware, device configuration, or some combination of device-related information. One query view can support any number of queries. Query views are supplied by Device Manager. When you create a query, you specify a particular query view for that query in the Query View field.

If you name and save the created query by registering it in the Device Manager database, you can reuse and manage the query. A query cannot be modified after it is registered in the Device Manager database. However, you can create a query using an existing query as a starting point.

Managing Jobs

A job is any specialized processing initiated through Device Manager and performed on a device or group of devices. Typical jobs include device inventory collection, device configuration, and software distribution. The Device Manager console provides a graphical user interface for manipulating job-related information in the Device Manager database. Console tasks you can perform include submitting, displaying, canceling, and deleting jobs, as well as querying the current status of jobs and displaying their properties.

Understanding Job Types

An administrator manages jobs based on job types. For example, there is a general job type for device configuration and another job type for software distribution. Job types of the same name are often defined for multiple device classes. For example, the device configuration job type applies to all device classes supplied with Device Manager. However, the way a job type is implemented (its underlying job class) differs from one device class to another.

You submit a job from the Device Manager console using the Submit Job wizard. The Submit Job wizard allows you to specify target devices, job attributes such as activation and expiration time, and job parameters, as well as the job type.

Job parameters are parameters that apply only to one particular job type in one particular device class. For example, the Palm device class has a set of job parameters defined for Palm device configuration jobs, a different set of job parameters defined for Palm software distribution jobs, and yet a different set of job parameters defined for Palm inventory collection jobs. The Windows CE device class also has unique sets of job parameters defined for each of its supported job types. Even if the job type (for example, software distribution) is the same for each device class, the job parameters will be different. Job parameters can include items such as the software package to be distributed or the type of inventory to be collected. Devices use the values for the job parameters when completing a job or when performing subsequent device actions. The job parameters you can specify from the Device Manager console are determined by the job type you are submitting, and by the device class of the target devices.

The following job types are supplied with Device Manager:

Device configuration
Updates the configuration of a device, including network parameters.

Software distribution
Sends a software package to a device. A software package is the collective meta package properties, application properties, and application package files comprising all the new or updated software being sent to the device.

Inventory collection
Retrieves a list of software applications, hardware, and current configuration parameters present on a device, including network parameters.

At the time the job is submitted using the Device Manager console, the administrator indicates the devices the job should run on, the job type, the activation and expiration time for the job, any job-specific parameters, and other relevant job properties.

Device plug-ins supplied by Device Manager provide the logic that handles device identification, job processing, communications, and high-level management tasks for each supported device class. For details on which job types are available with each device class, refer to the Device Plug-in Guides.

Submitting Jobs

To submit a job, Device Manager provides the Submit Job wizard. It allows you to specify the target devices, as well as attributes and parameters, for the job. The Submit Job wizard is described in each of the procedures for submitting jobs in this section.

You can start the Submit Job wizard the following ways:

If you start the Submit Job wizard from a selection list, the Target Devices window displays with the field for your selection already filled in.

Device Manager allows you to submit a job by targeting one or more devices, as follows. Target devices must always be of the same device class.

To submit a job to a single device:

You must know the name of the target device to do this task.

  1. Ensure that nothing is highlighted in the right pane of the Device Manager console.

  2. Open the File menu and select Submit Job. The Target Devices window appears.

  3. From the Target Devices window, select the A single device radio button.

  4. Select the device class of the target device from the Device class drop-down box.

  5. Type the name of the target device in the Device name field.

  6. Click Next to display the Attributes window of the Submit Job wizard.

  7. On the Attributes window, specify the attributes for the job you are submitting. Click Help for a description of the fields.

    Click Next to display the Parameters windows of the Submit Job wizard.

    Note:
    If you are submitting a device configuration job, device configuration parameters are displayed on the first Parameters window. Any available job parameters are displayed on a subsequent window, which may be accessed by selecting the Next button. Use Next and Back to navigate between the Device Configuration Parameters and Job Parameters windows.

  8. On the Parameters windows:

    Click Next to display the Submit Job Summary window of the Submit Job wizard.

  9. On the Submit Job Summary window, review and verify the target device, attributes, and parameters information you specified with the Submit Job wizard. If you need to modify any information, use the Back and Next buttons to navigate to the appropriate window of the Submit Job wizard.

    On the Submit Job Summary window, click OK to submit the job, or Cancel to exit the Submit Job wizard without submitting a job.

To submit a job to selected devices:

  1. Display a list of devices.

  2. Select multiple target devices of the same device class to submit the job to. To select multiple devices, select the first device and then press and hold the Ctrl or Shift key and select additional devices of the same device class.

  3. Right-click any selected device and select Submit Job from the context menu. This displays the Target Devices window of the Submit Job wizard. Click Help for a description of the devices table on the Target Devices window.

    Click Next to display the Attributes window of the Submit Job wizard.

  4. On the Attributes window, specify the attributes for the job you are submitting. Click Help for a description of the fields.

    Click Next to display the Parameters windows of the Submit Job wizard.

    Note:
    If you are submitting a device configuration job, device configuration parameters are displayed on the first Parameters window. Any available job parameters are displayed on a subsequent window, which may be accessed by selecting the Next button. Use Next and Back to navigate between the Device Configuration Parameters and Job Parameters windows.

  5. On the Parameters windows:

    Click Next to display the Submit Job Summary window of the Submit Job wizard.

  6. On the Submit Job Summary window, review and verify the target devices, attributes, and parameters information you specified with the Submit Job wizard. If you need to modify any information, use the Back and Next buttons to navigate to the appropriate window of the Submit Job wizard.

    On the Submit Job Summary window, click OK to submit the job, or Cancel to exit the Submit Job wizard without submitting a job.

To submit a job to all devices of a device class:

  1. To select your target devices, do one of the following:

  2. On the Attributes window, specify the attributes for the job you are submitting. Click Help for a description of the fields.

    Click Next to display the Parameters windows of the Submit Job wizard.

    Note:
    If you are submitting a device configuration job, device configuration parameters are displayed on the first Parameters window. Any available job parameters are displayed on a subsequent window, which may be accessed by selecting the Next button. Use Next and Back to navigate between the Device Configuration Parameters and Job Parameters windows.

  3. On the Parameters windows:

    Click Next to display the Submit Job Summary window of the Submit Job wizard.

  4. On the Submit Job Summary window, review and verify the target devices, attributes, and parameters information you specified with the Submit Job wizard. If you need to modify any information, use the Back and Next buttons to navigate to the appropriate window of the Submit Job wizard.

    On the Submit Job Summary window, click OK to submit the job, or Cancel to exit the Submit Job wizard without submitting a job.

To submit a job to devices qualified by a query, owner group, or both:

  1. Make sure nothing is highlighted in the right pane of the Device Manager console. Then open the File menu and select Submit Job.

    The Target Devices window displays. The Target Devices window is the first window of the Submit Job wizard.

  2. Select the Devices filtered by query, owner group, or both radio button. The help information for the Device Manager console provides descriptions of the fields and buttons on the Target Devices window.

  3. Select a device class from the Device class drop-down list. All target devices for the job must be of the same device class.

  4. Do one of the following:

  5. Select a status radio button to indicate the target devices that you want the job to run on. Click Help for a description of these radio buttons.

  6. Click Next. The Attributes window of the Submit Job wizard displays.

  7. On the Attributes window, specify the attributes for the job you are submitting. Click Help for a description of the fields.

    Click Next to display the Parameters windows of the Submit Job wizard.

    Note:
    If you are submitting a device configuration job, device configuration parameters are displayed on the first Parameters window. Any available job parameters are displayed on a subsequent window, which may be accessed by selecting the Next button. Use Next and Back to navigate between the Device Configuration Parameters and Job Parameters windows.

  8. On the Parameters windows:

    Click Next to display the Submit Job Summary window of the Submit Job wizard.

  9. On the Submit Job Summary window, review and verify the target devices, attributes, and parameters information you specified with the Submit Job wizard. If you need to modify any information, use the Back and Next buttons to navigate to the appropriate window of the Submit Job wizard.

    On the Submit Job Summary window, click OK to submit the job, or Cancel to exit the Submit Job wizard without submitting a job.

Job Status

After the job is submitted, a job status is assigned as follows:

When the job status becomes Executable, you can display job progress for each target device that the job was submitted to run on. Each job remains in the Device Manager database until you delete it.

Displaying Jobs

To display one or more jobs:

  1. Select the Jobs node in the left pane of the Device Manager console. The Job Search window is displayed.

  2. Specify your search criteria using the tabs and the associated search options.

  3. Click OK to submit the search. The jobs that meet your search criteria are displayed in the right pane of the Device Manager console.

To display jobs that were submitted to devices specified in a query:

  1. Select the Jobs node in the left pane of the Device Manager console. The Job Search window is displayed.

  2. Select the Target Query tab on the Job Search window.

  3. Select the Return anything with a query name that matches one of the listed search criteria radio button and select one or more query names.

  4. Click OK. A list of jobs that were submitted for the selected queries is displayed in the right pane of the Device Manager console.

To display the jobs submitted to a device:

  1. Display a list of devices.

  2. Right-click a device and select View Applicable Jobs from the context menu.

  3. On the Job Search window, select any job search criteria you want to use to find jobs related to the selected device, and click OK.

    A secondary window is displayed showing all jobs applicable to the device and the other search criteria you selected. The secondary window displays the jobs without overwriting the device information currently shown in the console. However, you cannot modify or perform an action on a job from a secondary window.

To display the progress of jobs attempted on a device:

  1. Display a list of devices.

  2. Right-click a device, and select View Job Progress from the context menu.

  3. On the Job Progress Search window, select any search criteria you want to use to find jobs related to the selected device, and click OK.

    A secondary window is displayed showing job progress information about all jobs attempted on the selected device. The secondary window displays the jobs without overwriting the device information currently shown in the console. However, you cannot modify or perform an action on a job from a secondary window.

To display the software distribution jobs for a particular software package:

  1. Display a list of software packages.

  2. Right-click a software package, and select View Applicable Jobs from the context menu.

    A secondary window is displayed showing all jobs applicable to the selected software package. The secondary window displays the jobs without overwriting the software package information currently shown in the console. However, you cannot modify or perform an action on a job from a secondary window.

Displaying Job Properties

Job properties are properties that apply to all job types. Job properties include information about the job, such as its job ID, submission date, status, target devices, and attributes (including job type, description, and activation and expiration dates). Taken together, the job property values for a job serve to uniquely identify that job among all others. The help information for the Device Manager console provides descriptions of the various job properties you can display. Job properties cannot be modified once a job is submitted.

To display job properties:

  1. Display a list of jobs.

  2. Right-click a job in the right pane of the Device Manager console and select Properties from the context menu.

    The Job Properties window is displayed. You cannot modify the fields. Click Help for a description of the fields.

  3. Click Close to close the window.

Displaying Job Progress

You can display the history of a job's processing as it runs, or attempts to run, on its target devices. Likewise you can display the history of expired or canceled jobs. You can search a job's history to show, for the devices you indicate, the job processing successes, delays, failures, retries, and job rejections by the user or by the device. You can also search the history by progress category, showing, for example, only the devices on which the job failed--or succeeded.

Jobs whose progress you can display have a status of either Executable, Expired, or Canceled. A job with Pending status has no progress information. After you select one of these jobs, you can do one of the following:

To display the progress of a job:

  1. Display a list of jobs.

  2. Right-click a job in the right pane of the Device Manager console and select View Job Progress from the context menu.

    The Job Progress Search window is displayed. Click Help for a description of the fields.

  3. Specify your search criteria and click OK.

    A secondary window is displayed showing the progress of the job for each device that meets your search criteria. You can sort the display by clicking the arrow in any column header. You can move the device table columns by dragging them. You cannot modify any information or launch other windows.

  4. Click Close to close the window.

Displaying a Job Progress Summary

You can display a job progress summary for any job, but the summary is most useful in understanding the progress of jobs submitted to multiple devices; that is, jobs submitted to a device class or to more than one device. A job progress summary shows:

As an alternative to displaying job progress, which is a history, displaying a job progress summary circumvents the return of potentially large amounts of information, including the history of every attempt by every eligible device to run the job. Remember, however, that a job progress summary counts only the latest attempts, even for periodic jobs. If a device made more than one attempt to run the job, those attempts would be in the job progress history, not the job progress summary.

Other information provided on the job progress summary includes the job's device class, status, and the job interval.

To display a summary of the progress of a job:

  1. Display a list of jobs.

  2. Right-click a job in the right pane of the Device Manager console and select View Job Progress Summary from the context menu.

    A secondary window is displayed showing a summary of the latest attempt by eligible devices to run the job, with the result of each attempt displayed in the appropriate job progress category. You cannot modify any information or launch other windows from this window.

  3. Click Close to close the window.

Canceling Jobs

You can cancel a job when its status is Pending, Executable, Expired, or Completed.

To cancel one or more jobs:

  1. Display a list of jobs.

  2. Select one or more jobs to cancel. To select more than one job, select the first job and then press and hold the Ctrl or Shift key and select additional jobs.

  3. Right-click any selected job and select Cancel Job from the context menu.

    A confirmation window is displayed.

  4. Click Yes on the Confirmation window.

    The job status changes to Canceled. After selected jobs are canceled, they remain in the Device Manager database until you delete them.

Deleting Jobs

When you use the Device Manager console to delete a job, the following information for the deleted job is removed from the Device Manager database:

You can delete a job only when its status is Canceled, Expired, or Completed.

To delete one or more jobs:

  1. Display a list of jobs.

  2. Select one or more jobs to delete. To select more than one job, select the first job and then press and hold the Ctrl or Shift key and select additional jobs.

  3. Right-click any selected job and select Delete from the context menu.

    A confirmation window is displayed.

  4. Click Yes on the confirmation prompt. The selected jobs are deleted from the Device Manager database and removed from the console.

Managing Devices

A device is any information appliance, including but not limited to personal digital assistants (PDAs), handheld PCs, subnotebooks, smartphones, and other pervasive devices, that can be integrated with a provider network and managed by Device Manager.

Enrolling Devices

Enrollment is the process by which an unknown device connects to Device Manager, is automatically redirected to the device enrollment server, and is registered in the Device Manager database. A device can also be enrolled manually by an administrator using the Device Manager console, but this is neither typical or recommended.

Before an unknown device can be enrolled, the plug-in for the device must be installed and its device class must be configured and defined in the Device Manager database. An unenrolled device is a device that is not yet registered in the Device Manager database or is registered but is not owned by a valid subscriber, or device owner.

In any up-and-running provider environment, a device should always be enrolled automatically. However, there may be special circumstances where manual device enrollment is appropriate, such as in a test environment where no enrollment server exists yet. Therefore the Device Manager console does allow the administrator to add a device, though it should never be a common practice.

Automatic Enrollment

Whenever a device connects to the provider network, Device Manager checks its relational database for a device record to verify that the device is enrolled. If the device is not registered or is not owned by a valid subscriber, or device owner, the device is not yet enrolled. In this case, Device Manager automatically gets the enrollment URL from the appropriate device class in the Device Manager database and redirects the device to the enrollment application. The enrollment application handles the unenrolled device as follows:

See the Device Plug-in Guides for detailed enrollment scenarios for different device types.

Manual Enrollment

For most supported devices, manual enrollment of a device by an administrator is not recommended in an up-and-running provider environment--that is, a provider environment where real subscribers are being enrolled. One reason manual enrollment is not recommended is that when assigning a name to the device, the administrator must use the exact naming convention provided by the device class of the device, and each device class has its own naming convention. Also, the naming convention may use information internal to the device and therefore not available to the administrator. Another reason manual enrollment is not recommended is that the naming convention of the device class can never be deviated from. If the convention is deviated from, the device will not be recognized by Device Manager as enrolled.

As a general rule, devices affiliated with the device classes supplied by Device Manager should always be enrolled automatically.

The exception to rule is devices that have no APIs for retrieving their device name information from them, such as Windows CE devices. Because their device name cannot be retrieved, Device Manager will automatically generate a device name for the device upon its first connection. However, the administrator can circumvent this automatic name generation by manually enrolling the device using either the device name stored in the device registry, or, if no name exists, any device name the administrator chooses. In the case where no device name exists in the device registry, the administrator is free to assign any device name, without the constraints of a naming convention, as long as the name is unique in its device class. Manual enrollment may be useful in this case because it permits the administrator to register devices and create jobs for them well in advance of their first connection. Whenever any of these devices does connect, Device Manager recognizes them as enrolled and immediately runs all their waiting jobs.

There are other situations when registering a device manually may be appropriate. One example is when you are setting up or testing a new environment, and there is no enrollment application or server yet available, and the environment has not actually gone live to device users.

Should you ever have to manually add a device in a live environment where you are enrolling real subscribers, you must use the exact naming convention when it is provided by the device class. Again, this is not recommended, except for Windows CE devices. To enroll a device manually, follow the instructions for registering devices.

Registering Devices

Registering a device through the Device Manager console is not recommended. Therefore, before attempting this task, be sure you understand the issues regarding enrolling devices.

To register a device in the Device Manager database you need to know the device class to which the device belongs. When naming the device, you must use the exact naming convention when it is provided by the device class. (If the device is a Windows CE device or any other device that supports generated device names, you can let Device Manager generate the device name for you.) To prevent duplicate devices, a device cannot have the same device name and device class as another device. A device name must be unique in its device class. For examples, see the help information.

To register one or more devices:

  1. From the Device Manager console, do one of the following:

    The New Device Properties window is displayed.

  2. From the New Device Properties window, select the appropriate device class from the Device class drop-down list. It lists all the currently installed device classes.

  3. Enter a device name.

    If the selected device class is Wince (Windows CE) or any other device class that supports generated device names, you can:

  4. Complete any of the optional fields you want to provide information for. If you choose to complete the Owner or Realm fields, make sure that owner and realm are valid in accordance with the product or component that manages subscribers in your Device Manager environment. Click Help for details about these fields.

  5. To save this information and close the window, click OK.

    To enter information for another new device, click Apply. The current information is saved and the fields are cleared to enter information for the next new device. Click OK to save this information and close the window.

Shortcut

Display and right-click the device class for the new device and select New Device from the context menu. The New Device Properties window is displayed with the name of the selected device class already filled in.

Displaying Devices

To display a list of one or more devices:

  1. Select the Devices node in the left pane of the Device Manager console. The Device Search window is displayed.

  2. Do one of the following:

    The help information for the Device Manager console provides descriptions of the fields and buttons on this window.

  3. Click OK. The devices that meet your search criteria are displayed in the right pane of the Device Manager console.

Alternatives

You can use a secondary window to display devices without replacing the current display in the Device Manager console. A secondary window cannot be used to modify or perform an action on a device.

To display devices in a secondary window:

  1. Display a list of device classes.

  2. Right-click a device class, and select View Devices from the context menu.

  3. Select your search criteria and click OK. A secondary window displays, showing devices for the device class that meet your search criteria.

You can also display devices that have received specific software in a secondary window.

Displaying Device Inventory

Device inventory is device software, hardware, configuration, network parameters, or other resources or information known to reside on a device. Inventory information may include items such as the computer model, processor type and speed, memory size, battery type and voltage, screen size and resolution, installed software packages, file path, file size, and so on. Each device class supports the collection of some amount of device inventory information.

Inventory information is retrieved by inventory collection jobs that query the device to determine its inventory and then store the results in the appropriate inventory tables in the Device Manager database. The inventory information for a device can then be displayed in the Device Manager console.

In addition, during device configuration job processing, Device Manager may store the device configuration parameter values it sent to the device in the same inventory tables as the inventory data from an inventory collection job. Storing device configuration parameters along with inventory data allows the device inventory and current parameter values to be used with queries and other administrative actions to manage the devices. Therefore, many inventory values that you can display in the Device Manager console are device configuration parameters, and you can change them by submitting a device configuration job.

This section describes how to display device inventory information and also describes submitting a device configuration job using the Configure button on the Inventory window.

To display inventory information for devices:

  1. Display a list of devices.
  2. Select and right-click one or more devices (of the same device class) in the list and select View Inventory from the context menu.

    The Inventory window displays, showing tabs for various database table views. A database table view is a logical table that joins two or more database tables of the Device Manager database. Database table views are specific to the device class of the selected devices. The tabs on this window are defined by database table views established for your Device Manager environment.

  3. Select the Inventory tab that corresponds to the type of inventory information you want to view.
  4. On the selected tab, expand columns as necessary. For a more readable, detailed view of the row, highlight the row you want to view and click View Details. To exit the Inventory Details window and return to the Inventory window, click Close.

  5. Do one of the following:

Modifying Device Properties

Device properties are different from device configuration parameters:

The help information for the Device Manager console provides descriptions of the various device properties you can modify.

To modify the properties of a device:

  1. Display a list of devices.

  2. Right-click a device in the right pane of the Device Manager console and select Properties from the context menu. The Device Properties window is displayed with the values for the selected device.

  3. Modify the fields you want to change. Do not, however, modify the Device name field. If you change the device name, Device Manager no longer recognizes the device as enrolled. Do not modify the Owner and Realm fields. If you need to fill in the Owner or Realm fields, make sure that the owner and realm are valid in accordance with the product or component that manages subscribers or device owners in your Device Manager environment.

    The Device class field cannot be modified. Click Help for information about the properties fields you can modify.

  4. Click OK to save this information and close the window.

Displaying Device Classes

A device class is a collection of devices that have similar characteristics and that can be managed similarly; for example, Palm III and Palm V devices belong to the Palm device class. To display one or more device classes, select Device Classes in the left pane of the Device Manager console. A list of the device classes that are installed and configured for your site are displayed in the right pane.

Modifying Device Class Properties

The properties of a device class are different from its device configuration parameters:

The help information for the Device Manager console provides descriptions of the device class properties.

To display or modify the properties of a device class:

  1. Select Device Classes in the left pane of the console. A list of the device classes that are installed and configured for your site are displayed in the right pane.

  2. In the right pane of the Device Manager console, right-click the device class whose properties you want to modify, and select Properties from the context menu. The Device Class Properties window is displayed.

  3. On the Device Class Properties window, use the tabs to navigate to the fields you want to change. Click Help for a description of these fields.

  4. Click OK to save this information and close the window.

Configuring Devices

You can configure a single device, multiple devices, or all devices of a device class by submitting a device configuration job from the Device Manager console. In addition, you can qualify your target devices as enrolling devices, currently enrolled devices, or both.

Before submitting a device configuration job, make sure you understand the difference between device configuration parameters and device properties. When configuring devices, you are working with device configuration parameters, not device properties.

Submitting a Device Configuration Job

To submit a device configuration job, use any method described in Submitting Jobs. On the Attributes window of the Submit Job wizard, select Device Configuration in the Job type drop-down box.

Displaying Jobs for a Device

A job is any specialized processing initiated through Device Manager and performed on a device. Some jobs like inventory collection or device configuration may be performed automatically on devices during their enrollment. Some jobs can be submitted from the Device Manager Care applications described in Introduction to Device Manager, and targeted to a single device. Most jobs, however, are initiated by an administrator using the Device Manager console. Jobs submitted from Device Manager Customer Care or the Device Manager console can be displayed in the console.

To display jobs for a selected device:

  1. Display a list of devices.

  2. Right-click a device in the right pane of the Device Manager console and select View Applicable Jobs from the context menu. The Job Search window is displayed.

  3. Specify your search criteria and click OK.

    A secondary window is displayed, listing jobs targeted for the selected device that match your search criteria. These jobs could have been submitted in one of the following ways:

    When displaying jobs for a selected device, you can sort the jobs listed in the job table on the secondary window by clicking the arrow in any column header. You can move the job table columns by dragging them. You cannot modify any information or launch other windows from this job table.

  4. Click Close to close the window.

Displaying the Software List for a Device

The software list is a record or audit trail of all software packages distributed to the selected device by Device Manager, using software distribution jobs. When Device Manager initiates a software distribution job and it runs successfully on the device, Device Manager automatically modifies its database by updating the software list for the device with information about the distributed software.

Displaying the software list is different than displaying inventory for the device. Displayed inventory may include more than software alone. It may also include hardware, device parameters, or any other resources known to reside on a device. Inventory information is collected from the device by inventory collection jobs that query the device to determine its inventory and then store the results in the database. Displayed inventory is therefore likely to be more comprehensive and more current than the software list. The software list reflects only software that was distributed by Device Manager at some point in time, and there is no guarantee that the software still resides on the device.

To display the database list of software on a device:

  1. Display a list of devices.

  2. Right-click a device in the right pane of the Device Manager console and select View Software from the context menu. A secondary window is displayed listing the known software on the device.

  3. Click Close to close the window.

Updating the Software List for a Device

The software list is a record or audit trail of all software packages distributed to the selected device by Device Manager, using software distribution jobs. When Device Manager initiates a software distribution job and it runs successfully on the device, Device Manager automatically modifies its database by updating the software list for the device with information about the distributed software.

If software is put on the device by means other than Device Manager running a successful software distribution job, or if someone removes from the device a software package that was distributed by Device Manager, the database is not automatically updated and its software list becomes out of synch with the software actually on the device.

For example, a software package may have been preloaded onto the device, or added later manually, and therefore be omitted from the software list. A device owner may remove software, or install new software on the device without using Device Manager, causing the list of software to become out of synch with the software actually on the device.

In cases where you know that list of software is out of synch with the software actually on the device, you can use the Device Manager console to update the database records. Follow this manual process if you want to keep the database current with the actual software installed on a device.

To manually update the database list of software on a device:

  1. Display a list of devices.

  2. Right-click a device in the right pane of the Device Manager console and select View Software from the context menu. A secondary window is displayed listing the known software on the device.

  3. Use Add and Remove to update the list with software that the owner has added or removed for the device.

    Any changes you make are recorded in the Device Manager database. No software is added or removed from the device itself.

  4. Click Close to close the window.

Deleting Devices

When you use the Device Manager console to delete a device, the following information for the deleted device is removed from the Device Manager database:

To delete one or more devices:

  1. Display a list of devices.

  2. Select one or more devices to delete. To select more than one device, select the first device and then press and hold the Ctrl or Shift key and select additional devices.

  3. Right-click any selected device and select Delete from the context menu.

    A confirmation prompt is displayed.

  4. Click Yes on the confirmation prompt. All selected devices are removed from the Device Manager database.

Managing Device Manager Servers

A Device Manager server is a server whose main role is processing jobs for devices. The Device Manager console displays the host name and port number of each registered Device Manager server. Each time Device Manager starts on a particular server, Device Manager checks its database to determine if that server is registered as a Device Manager server. If it is not registered, Device Manager registers it.

The Device Manager console provides windows for manipulating the Device Manager server information registered in the Device Manager database. You can use the console to display the names and properties of the registered Device Manager servers. You can also use the console to remove the record of a Device Manager server from the database. Changing server information in the database does not affect the physical servers. For example, removing a server record does not stop the server.

Displaying Server Properties

To display the properties of Device Manager servers, select the Servers node in the left pane of the Device Manager console. The host name and port for each Device Manager server is displayed in the right pane.

Deleting Server Records

At times you may want to delete a Device Manager server record, removing the server's registration from the Device Manager database. One such time is when you acquire two entries for the same server. For example, the Domain Name System (DNS) server could go down, leaving the Device Manager server currently registered in the database with its IP address. When the DNS server comes back up, Device Manager re-registers the server. But this time it is registered with its host name. In this case, you would use the Device Manager console to remove the unwanted extra record for the same server.

It is also possible that you could uninstall Device Manager from the server, or the server could be retired, leaving an obsolete Device Manager server record in the database. In these cases too you could use the Device Manager console to remove the unwanted server record.

To delete one or more server records from the Device Manager database:

  1. Select the Servers node in the left pane of the Device Manager console.

  2. In the right pane, select one or more servers to delete. To select more than one server, select the first server and then press and hold the Ctrl or Shift key and select additional servers.

  3. Right-click the selected servers and select Delete from the context menu.

    A confirmation prompt is displayed.

  4. Click Yes on the confirmation prompt. The server is removed from the Device Manager database and console.

Managing Software

Software is a registered software package. Device Manager does not maintain a library of software that you distribute. Instead, Device Manager stores URLs in its database that point to the software that you have prepared to deploy and provides software distribution jobs you can submit to deploy the software.

Device Manager also stores other software-related information in its database, and the Device Manager console provides windows for manipulating that information. Windows are provided for you to register, distribute, redistribute, display, and modify software objects or properties in the Device Manager database, as well as display any devices that received the software by means of a Device Manager software distribution job.

Registering Software

Device Manager stores URLs in its database that point to the software you want to deploy. To register software in the Device Manager database, you will need to prepare a software package and copy it to a location on a Web server where the Device Manager server can access it. Then you can use the Device Manager console to register the software in the database. This entails creating a software definition that contains the URL address for the software. The final step is to distribute the software to devices by submitting a software distribution job, using the software definition with its URL. The itemized steps follow:

  1. Before you add software to the database using the console:

    1. Prepare a software package in accordance with the Device Plug-in Guide for the device class you want to distribute software to. A software package is the collective meta package properties, application properties, and application package files comprising all the software to be sent to a targeted device by means of a software distribution job. The software is packaged or formatted for deployment to a device according to the requirements of the device class and the device operating system.

      For device classes currently supplied with Device Manager, the software package may include the following:

      Application package
      The complete file set for a particular software application. It includes the application's program files, graphics files, database files, and the like.

      Package definition file
      A plain text file that lists each individual file that comprises an application package (program files, graphics files, database files, and the like). The device class determines whether application properties are also included in the package definition file. For Windows CE devices, application properties are included in the package definition file. For Palm OS devices, application properties are included in the meta package definition file.

      Application properties
      A set of keyword-value statements that specify the name, version, and description of an application package, the file name or application URL of the application's package definition file, and any additional distribution options for the application package (for example, disk space required, overwriting permissions, and full or relative path from the current directory on the source host).

      Meta package definition file
      A plain text file that specifies the properties and applications to be sent to a targeted device by means of a software distribution job. This file specifies any applicable meta package properties, and identifies the package definition file for each application being sent to the targeted device. The device class determines whether application properties are also included in the meta package definition file. For Palm OS devices, the application properties are included in the meta package definition file; for Windows CE devices, application properties are included in the package definition file. Device Manager locates the meta package definition file on a Web server by using the file's software URL, which is stored in the Device Manager database.

      Meta package properties
      A set of keyword-value statements included in the meta package definition file that specify the name, version, and description of the software package and provide controls for the overall software distribution job (for example, controls that allow the user to delay or reject the job).

    2. Copy the entire software package to a Web server location accessible using HTTP, HTTPS, or FILE protocol.

    3. Determine the software URL, in accordance with the Device Plug-in Guide for the device class you want to distribute software to.

      For device classes currently supplied with Device Manager, the software package includes a meta package definition file to be used as the software URL. For example:

      http://myserver.yamato.ibm.com/temp/meta_myapp.txt. 
      

    Once you have determined the software URL, you are ready to use the Device Manager console to register the software in the Device Manager database.

  2. To register software in the Device Manager database using the Device Manager console:

    1. Display a list of device classes.

    2. Right-click the device class for the new software and select New Software from the context menu. The New Software Properties window is displayed with the selected device class already filled in.

    3. Complete all the required fields, including URL, which is the URL for the software package. This is typically the URL of the meta package definition file.

      To prevent duplicate software, no two software packages can have all three of their Software name, Version, and Device class fields the same. At least one of these fields must be different for any two software packages. Click Help for a description of the fields.

    4. To register this information in the Device Manager database and close the window, click OK.

      To enter information for new software, click Apply. The current information is saved and the fields are cleared to enter information for the next software package of the same device class.

    Now you are ready to distribute the software.

Distributing Software to Devices

After you install the software in a location on a Web server where your devices can access it, you can submit a software distribution job that deploys the software to one or more target devices. You do this by preparing a software package and registering the software in the Device Manager database, as described in Registering Software.

To distribute software to one or more devices, use any method described in Submitting Jobs. On the Attributes window of the Submit Job wizard, select Software Distribution in the Job type drop-down box. You can only distribute software to devices whose device class supports software distribution.

Redistributing Software to Devices

In the event the software that Device Manager previously distributed becomes corrupted at the device, is deleted from the device, or otherwise requires replacement, you can redistribute that original software to the device. As with the original distribution, the software package must be in a location on a Web server where the device can access it and be registered in the Device Manager database as described in Registering Software.

To redistribute registered software to a device:

  1. Display a list of devices.

  2. Right-click a device in the right pane of the Device Manager console and select View Software from the context menu. A secondary window is displayed listing the known software on the device.

  3. Select one software package for redistribution from the list of known software.

  4. Click Redistribute to redistribute the selected software.

    The New Job Properties window is displayed with the target device class preselected, along with the software you specified for redistribution in the previous window. A job type of software distribution is also preselected. These preselections cannot be modified.

  5. Select a target device and make changes to the other fields as necessary. Click Help for a description of the fields.

  6. Click OK to submit the software distribution job and close the window.

Displaying Jobs That Distribute Selected Software

To display jobs that distribute selected software:

  1. Display a list of software packages.

  2. Right-click a software object in the right pane of the Device Manager console and select View Applicable Jobs from the context menu.

    A secondary window is displayed with a list of software distribution jobs that distribute the selected software. You can sort the display by clicking the arrow in any column header. You can move the table columns by dragging them. You cannot modify any information or launch other windows.

  3. Click Close to close the window.

Displaying Devices That Received Selected Software

To display devices that selected software was distributed to:

  1. Display a list of software packages.

  2. Right-click a software object in the right pane of the Device Manager console and select View Devices from the context menu.

    The Device Search window is displayed. Click Help for a description of the fields.

  3. Specify your search criteria and click OK.

    A secondary window is displayed with a list of devices that meet your search criteria and have received the selected software. You can sort the display by clicking the arrow in any column header. You can move the table columns by dragging them. You cannot modify any information or launch other windows.

  4. Click Close to close the window.

Displaying Software

To display the software packages registered with Device Manager:

  1. Select the Software node in the left pane of the Device Manager console.

    The Software Search window is displayed. Click Help for a description of the fields.

  2. Specify your search criteria and click OK. The software that meets your search criteria is displayed in the right pane of the console.

Alternatives

Modifying Software Properties

Software package properties include items such as software name, version, device class, URL, and description. The help information for the Device Manager console provides descriptions of the various software package properties you can modify.

To prevent duplicate software, at least one of the three values specified in the Software name, Version, and Device class fields for any given software package must be unique. For example, if two packages have the same software name and version, they must belong to different classes of device. If two packages belong to the same class of device, they must have different software names or versions. The following software packages are unique:

        Software name     Version     Device class
Software package 1:     Stock_Quotes     1.0     Wince
Software package 2:     Stock_Quotes     1.0     Palm
Software package 3:     Checkbook     1.0     Palm
Software package 4:     Checkbook     2.0     Palm

To change the properties of a software package:

  1. Display a list of software packages.

  2. Right-click a software object in the right pane of the Device Manager console and select Properties from the context menu.

    The Software Properties window is displayed. Click Help for a description of the fields.

  3. Make changes to the fields as necessary. You cannot modify the Device class field.

  4. Click OK to save this information and close the window.

Deleting Software

Device Manager currently supplies no jobs for removing a software package that Device Manager has distributed to a device or that the owner has installed on the device.

You can, however, remove the record of a software package from the Device Manager database. You might do this if, for example, you no longer want the software to be available for distribution to devices of a particular class. Each software package is applicable to only one device class, and only devices of that class can receive the related software from Device Manager. Removing the record serves, in effect, to unregister the software package that was previously registered in the database for the respective class.

When you remove the software, the software object and its properties are deleted from the Device Manager database and removed from the Device Manager console. This removal includes the URL that points to the location of the software package. No actual software files are removed from any device or server.

In addition, Device Manager removes the software from the software list of any device. Therefore, before removing a software package from the database, you should display all the devices that received the software and ensure that the software is no longer on these devices. Then remove the software object from the database.

To remove a software object from the Device Manager database:

  1. Display a list of software packages.

  2. Select one or more software packages to delete. To select more than one software package, select the first package and then press and hold the Ctrl or Shift key and select additional packages.

  3. Right-click the selected package and select Delete from the context menu.

    A confirmation prompt is displayed.

  4. Click Yes on the confirmation prompt.

    The software package, including the URL that points to its location, is deleted from the Device Manager database and removed from the Device Manager console. No actual software is removed from any device or server.

Managing Queries

A query is a request for information from the Device Manager database. In Device Manager, you use a query from the Device Manager console to find devices in the Device Manager database or to target a job to devices with particular characteristics. From the Device Manager console, you can query the database by selecting a saved query or by creating a new query using search criteria in SQL format. Unlike searches, queries can be named and saved in the Device Manager database for future use.

Each query you create and save is registered in the Device Manager database. All queries are intended to return a list of devices. The management tasks you can perform on a registered query include displaying query properties and deleting a query from the database.

From the list of queries you can also submit a job based on a selected query and display devices associated with a query.

Creating Queries

This section describes several ways to create a query:

To create and save a query for future use:

  1. Do one of the following:

  2. On the New Query Properties window, type a new name in the Query name field.

  3. Complete or modify the Description field. This is an optional field.

  4. Use the Choose button to select a query view. The query view you select determines the search criteria to be made available for creating or modifying your SQL where clause. You can only specify search criteria in your SQL where clause that is applicable to the selected query view.

  5. Use the Search criteria in SQL format field to enter a where clause or modify a prefilled where clause. This is an optional field.

    If you need help with the SQL syntax, select the Assist button and let the SQL Assistant help generate a new where clause. Use the search criteria tabs on the left side of the SQL Assistant window and the associated fields on the right side to set your search criteria. Each tab corresponds to a search criteria defined by the query view specified on the New Query Properties window. The help information for the Device Manager console provides descriptions of the fields and buttons on the SQL Assistant window. The SQL Assistant uses the combination of search criteria and search options you supply to create the SQL where clause that will run against the Device Manager database.

    Click OK to return to the New Query Properties window, where the search criteria you set displays as an SQL where clause in the Search criteria in SQL format field. To select a different query view having a different set of search criteria, choose another view on the New Query Properties window and then select Assist again.

  6. On the New Query Properties window, do one of the following:

    The new query is now registered in the Device Manager database and you can use it to display devices or submit a job.

To create a query as part of searching for devices:

  1. Select the Devices node in the left pane of the Device Manager console to display the Device Search window.

  2. Select the Return devices using a new query radio button. For more information about the fields and buttons on this window, click Help.

  3. In the box associated with the radio button, use the Choose button to select a query view. The query view you select determines the search criteria to be made available for creating or modifying your SQL where clause. You can only specify search criteria in your SQL where clause that is applicable to the selected query view.

  4. Use the Search criteria in SQL format field to enter a where clause. This is an optional field.

    If you need help with the SQL syntax, select the Assist button and let the SQL Assistant help generate your where clause. Use the search criteria tabs on the left side of the SQL Assistant window and the associated fields on the right side to set your search criteria. Each tab corresponds to a search criteria defined by the query view specified on the Device Search window. The help information for the Device Manager console provides descriptions of the fields and buttons on the SQL Assistant window. The SQL Assistant uses the combination of search criteria and search options you supply to create the SQL where clause that will run against the Device Manager database.

    Click OK to return to the Device Search window, where the search criteria you set displays as an SQL where clause in the Search criteria in SQL format field. To select a different query view having a different set of search criteria, choose another view on the Device Search window and then select Assist again.

  5. To test your new query, from the Device Search window click the How Many button. A window will appear showing the number of devices that match your search criteria.

  6. To assign the new query a name and register it in the Device Manager database, select Save. The New Query Properties window appears.

  7. On the New Query Properties window, complete the Query name field, and click OK to register the query and exit the window.

  8. On the Device Search window, click OK to find devices using your new query. A list of any found devices will display in the right pane of the Device Manager console.

To create a query as part of submitting a job:

  1. Ensure that nothing is selected in the right pane of the Device Manager console.

  2. Open the File pull-down menu and select Submit Job. The Target Devices window of the Submit Job wizard appears. The help information for the Device Manager console provides descriptions of the fields and buttons on this window.

  3. On the Target Devices window, select the Devices filtered by query, owner group, or both radio button.

  4. Under the Query option for targets, select the New Query button. The New Query Properties window appears.

  5. On the New Query Properties window, type a new name in the Query name field.

  6. Complete the Description field. This is an optional field.

  7. Use the Choose button to select a query view. The query view you select determines the search criteria to be made available for creating or modifying your SQL where clause. You can only specify search criteria in your SQL where clause that is applicable to the selected query view.

  8. Use the Search criteria in SQL format field to enter a where clause. This is an optional field.

    If you need help with the SQL syntax, select the Assist button and let the SQL Assistant help generate your where clause. Use the search criteria tabs on the left side of the SQL Assistant window and the associated fields on the right side to set your search criteria. Each tab corresponds to a search criteria defined by the query view specified on the New Query Properties window. The help information for the Device Manager console provides descriptions of the fields and buttons on the SQL Assistant window. The SQL Assistant uses the combination of search criteria and search options you supply to create the SQL where clause that will run against the Device Manager database.

    Click OK to return to the New Query Properties window, where the search criteria you set displays as an SQL where clause in the Search criteria in SQL format field.

  9. To test your new query, from the New Query Properties window click the How Many button. A window will appear showing the number of devices that match your search criteria.

  10. On the New Query Properties window, click OK to register the query in the Device Manager database and return to the Target Devices window.

    The new query now appears selected in the Query drop-down box. Device Manager will use the selected query to find the target devices for the job being submitted.

  11. Continue with your job submittal using the new, saved query.

Displaying Queries

To display a list of queries in the Device Manager database, select the Queries node in the left pane of the Device Manager console. A list of the queries registered in the Device Manager database will display in the right pane of the console.

Displaying Query Properties

To display query properties:

  1. Display a list of queries.

  2. Right-click the query for which you want to display properties, and select Properties from the context menu.

  3. The read-only Query Properties window displays the properties for the query.

  4. Click Close to close the window.

Deleting Queries

To delete one or more queries from the Device Manager database:

  1. Display a list of queries.

  2. Select one or more queries to delete (if a query has been used as a target for a job, you must first delete all the jobs associated with the query). To select more than one query, select the first query and then press and hold the Ctrl or Shift key and select additional queries.

  3. Right-click any selected queries, and select Delete from the context menu.

    A confirmation prompt is displayed.

  4. Click Yes on the confirmation prompt. The query is deleted from the Device Manager database.

Part 2: Server Operations

The tasks described in the following sections must be performed from a Device Manager server.

Managing Large Numbers of Jobs or Devices

The DMSUtil command enables you to perform the following tasks on a Device Manager server without having to use the Device Manager console:

When working with large numbers of jobs or devices, it can be easier and more practical to use the DMSUtil command than to perform these tasks from the Device Manager console.

The DMSUtil command provides a set of filters that enable you to focus your task on only the objects that meet the specified job filter criteria or device filter criteria. For example, you can cancel only the inventory jobs that are pending against Palm devices.

To use the DMSUtil command:

  1. Navigate to the bin subdirectory of the Device Manager root directory for your platform on the Device Manager server. The Device Manager root directory is the directory where Device Manager was installed.

    For example, if you are using Device Manager as included with IBM WebSphere Everyplace Access, Device Manager was installed as follows:

    Device Manager installation directories - WebSphere EveryPlace Access
    Server Platform Device Manager
    Root Directory
    bin Subdirectory
    IBM AIX /usr/WebSphere/DMS /usr/WebSphere/DMS/bin
    Microsoft Windows install_drive:\WebSphere\DMS install_drive:\WebSphere\DMS\bin

    Otherwise:

    Device Manager installation directories - default
    Server Platform Default Device Manager
    Root Directory
    bin Subdirectory
    IBM AIX /usr/TivDMS /usr/TivDMS/bin
    Sun Solaris or RedHat Linux /opt/TivDMS /opt/TivDMS/bin
    Microsoft Windows install_drive:\TivDMS install_drive:\TivDMS\bin

  2. From the bin subdirectory, enter the DMSUtil command for your server platform on the command line:

    Server Platform DMSUtil Command
    IBM AIX DMSUtil.sh
    Sun Solaris or RedHat Linux DMSUtil.sh
    Microsoft Windows DMSUtil.bat

    Sample DMSUtil.sh commands (for AIX, Solaris, and Linux users) are given in the following sections. Windows users substitute DMSUtil.bat for the command name and leave the remaining command syntax unchanged.

All command entries are case sensitive.

To display help, from the command line enter the DMSUtil command, followed by -?. For example:

Listing Jobs

To list in the command window all the jobs that meet your specified job filter criteria, use the following command:

DMSUtil.sh -listjobs [ JobFilter ]

In the following sample, all device configuration jobs for devices in the Windows CE (Wince) device class are listed:

DMSUtil.sh -listjobs JOB_TYPE=DEVICE_CFG DEVICE_CLASS_NAME=Wince

Sample output:

There were 3 submitted jobs matching the filter criteria.
JOB_ID = 20418152647781123
    JOB_TYPE = DEVICE_CFG
    QUERY_ID = null
    GROUP_NAME = null
    TARGET_DEVCLASS_ID = 20417181301428904
    DEVICE_CLASS_NAME = Wince
    SUBMITTED_TIME = Thu Apr 18 11:26:48 EDT 2002
    ACTIVATION_TIME = Thu Apr 18 11:26:49 EDT 2002
    EXPIRATION_TIME = Mon Jan 18 22:14:07 EST 2038
    JOB_STATUS = EXECUTABLE
    JOB_PRIORITY = 0
    JOB_DESCRIPTION = null
    INTERVAL = 0
    INTERVAL_UNIT = null
    LAST_MODIFIED = Thu Apr 18 11:26:49 EDT 2002
JOB_ID = 20418152706900451
    JOB_TYPE = DEVICE_CFG
    QUERY_ID = null
    GROUP_NAME = wpsadmins
    TARGET_DEVCLASS_ID = 20417181301428904
    SUBMITTED_TIME = Thu Apr 18 11:27:07 EDT 2002
    ACTIVATION_TIME = Thu Apr 18 11:27:08 EDT 2002
    EXPIRATION_TIME = Mon Jan 18 22:14:07 EST 2038
    JOB_STATUS = EXECUTABLE
    JOB_PRIORITY = 0
    JOB_DESCRIPTION = null
    INTERVAL = 0
    INTERVAL_UNIT = null
    LAST_MODIFIED = Thu Apr 18 11:27:08 EDT 2002
JOB_ID = 20418152729930050
    JOB_TYPE = DEVICE_CFG
    QUERY_ID = null
    GROUP_NAME = wpsadmins
    TARGET_DEVCLASS_ID = 20417181301428904
    SUBMITTED_TIME = Thu Apr 18 11:27:30 EDT 2002
    ACTIVATION_TIME = Thu Apr 18 11:27:31 EDT 2002
    EXPIRATION_TIME = Mon Jan 18 22:14:07 EST 2038
    JOB_STATUS = EXECUTABLE
    JOB_PRIORITY = 0
    JOB_DESCRIPTION = null
    INTERVAL = 0
    INTERVAL_UNIT = null
    LAST_MODIFIED = Thu Apr 18 11:27:31 EDT 2002

Logging Listed Jobs

A list of jobs can be saved in a log file by redirecting the command output (stdout) to the file you specify in OutputFileName.log. To append listed jobs to a specified file, navigate to the appropriate directory for your platform on the Device Manager server and enter:

DMSUtil.sh -listjobs [ JobFilter ] >> OutputFileName.log

Canceling Jobs

To cancel all submitted jobs that meet your specified job filter criteria, use the following command:

DMSUtil.sh -canceljobs [ JobFilter ]

If at least one job is not canceled successfully, the transaction is rolled back and no jobs are canceled.

In the following sample, all device configuration jobs are canceled:

DMSUtil.sh -canceljobs JOB_TYPE=DEVICE_CFG

Sample output:

55 submitted jobs were canceled successfully.

Logging Canceled Jobs

The number of canceled jobs can be saved in a log file by redirecting the command output (stdout) to the file that you specify in OutputFileName.log. Before logging the number of canceled jobs, first log a list of the jobs being canceled (see Logging Listed Jobs), then log the number of canceled jobs by redirecting the command output to the same file:

DMSUtil.sh -canceljobs [ JobFilter ] >> OutputFileName.log

Deleting Jobs

To remove from the database all the jobs that meet your specified job filter criteria, use the following command:

DMSUtil.sh -deletejobs [ JobFilter ]

A submitted job must be canceled, expired, or completed before you can delete it.

If at least one job is not removed successfully, the transaction is rolled back and no jobs are removed.

In the following sample, all device configuration jobs are removed:

DMSUtil.sh -deletejobs JOB_TYPE=DEVICE_CFG

Sample output:

37 submitted jobs were deleted successfully.

In the following sample, all completed jobs are removed:

DMSUtil.sh -deletejobs JOB_STATUS=COMPLETED

Sample output:

110 submitted jobs were deleted successfully.

Logging Deleted Jobs

The number of deleted jobs can be saved in a log file by redirecting command output (stdout) to the file you specify in OutputFileName.log. Before logging the number of deleted jobs, first log a list of the jobs being deleted (see Logging Listed Jobs), then log the number of deleted jobs by redirecting command output to the same file:

DMSUtil.sh -deletejobs [ JobFilter ] >> OutputFileName.log

Cleaning Up Expired Jobs

Jobs with expired status are in the pool of submitted jobs that Device Manager sorts through at device connect time as it looks for work to do for the device. To improve performance each time a device connects, use the following command to periodically (for example, monthly) remove the expired jobs from the pool of submitted jobs:

DMSUtil.sh -cleanupexpiredjobs

In the following sample, all expired jobs are removed from connect-time processing:

DMSUtil.sh -cleanupexpiredjobs 

Sample output:

There were 345 expired jobs removed from the pool of submitted jobs. 

Listing Devices

To list in the command window the database data of all devices that meet your specified device filter criteria, use the following command:

DMSUtil.sh -listdevices [ DeviceFilter ]

In the following sample, the data of all devices in the Palm device class are listed:

DMSUtil.sh -listdevices DEVICE_CLASS_NAME=Palm

Sample output:

There were 5 devices matching the filter criteria.
DEVICE_ID = 1000002
    DEVICE_CLASS_NAME = Palm
    DEVICE_CLASS_ID = 1000000
    DEVICE_NAME = melissa
    FRIENDLY_NAME = null
    USER_NAME = odb
    USER_REALM = ibm
    SERIAL_NUMBER = null
    MODEL = null
    DEV_DESCRIPTION = null
    LAST_MODIFIED = Tue Oct 30 08:53:23 GMT-05:00 2001
DEVICE_ID = 1000003
    DEVICE_CLASS_NAME = Palm
    DEVICE_CLASS_ID = 1000000
    DEVICE_NAME = test
    FRIENDLY_NAME = null
    USER_NAME = null
    USER_REALM = null
    SERIAL_NUMBER = null
    MODEL = null
    DEV_DESCRIPTION = null
    LAST_MODIFIED = Tue Oct 30 08:55:11 GMT-05:00 2001
DEVICE_ID = 1000004
    DEVICE_CLASS_NAME = Palm
    DEVICE_CLASS_ID = 1000000
    DEVICE_NAME = test1
    FRIENDLY_NAME = null
    USER_NAME = null
    USER_REALM = null
    SERIAL_NUMBER = null
    MODEL = null
    DEV_DESCRIPTION = null
    LAST_MODIFIED = Tue Oct 30 08:55:22 GMT-05:00 2001
DEVICE_ID = 1000005
    DEVICE_CLASS_NAME = Palm
    DEVICE_CLASS_ID = 1000000
    DEVICE_NAME = test2
    FRIENDLY_NAME = null
    USER_NAME = null
    USER_REALM = null
    SERIAL_NUMBER = null
    MODEL = null
    DEV_DESCRIPTION = null
    LAST_MODIFIED = Tue Oct 30 08:55:31 GMT-05:00 2001
DEVICE_ID = 1000006
    DEVICE_CLASS_NAME = Palm
    DEVICE_CLASS_ID = 1000000
    DEVICE_NAME = 10FG1CF97CAA
    FRIENDLY_NAME = null
    USER_NAME = mel
    USER_REALM = ibm
    SERIAL_NUMBER = null
    MODEL = null
    DEV_DESCRIPTION = null
    LAST_MODIFIED = Tue Oct 30 10:26:32 GMT-05:00 2001

Logging Listed Devices

Listed devices can be saved in a log file by redirecting command output (stdout) to the file you specify in OutputFileName.log. To append listed devices to the file you specify, navigate to the appropriate directory for your platform on the Device Manager server and enter:

DMSUtil.sh -listdevices [ DeviceFilter ] >> OutputFileName.log

Deleting Devices

To remove from the database the data of all the devices that meet your specified device filter criteria, use the following command:

DMSUtil.sh -deletedevices [ DeviceFilter ]

If at least one device is not removed successfully, the transaction is rolled back and no devices are removed.

In the following sample, all the data of devices whose MODEL attribute is defined as "Palm V" are removed:

DMSUtil.sh -deletedevices MODEL="Palm V"

Sample output:

95 devices were deleted successfully.

Logging Deleted Devices

The number of deleted devices can be saved in a log file by redirecting command output (stdout) to the file you specify in OutputFileName.log. Before logging the number of deleted devices, first log a list of the devices being deleted (see Logging Listed Devices), then log the number of deleted devices by redirecting stdout to the same file:

DMSUtil.sh -deletedevices [ DeviceFilter ] >> OutputFileName.log

Job Filter Criteria

The job filter takes the form:

[ attribute1=value attribute2=value ... attributen=value ]

Attributes

JOB_TYPE
Specifies the type of job you want to filter by. Values for job types supplied with Device Manager are:

Your site may provide additional job types.

DEVICE_CLASS_NAME
Specifies that you want to filter by the name of the device class that the job was submitted to run on.

Valid values for device classes supplied with Device Manager are:

Palm
Specify this device class to list, cancel, or remove jobs for Palm Computing PDA devices.
Wince
Specify this device class to list, cancel, or remove jobs for Microsoft Windows CE devices.

At your site, all of these device classes may not be configured and available, or there may be additional device classes, or both.

JOB_STATUS
Specifies that you want to filter by the current processing status of a job. Status is calculated by comparing the current date and time on the server with the Device Manager database to the activation and expiration dates and times stored in the Device Manager database itself.

Valid status category values, in uppercase only, are:

PENDING
The job has been submitted but has not reached the activation date and time. You can cancel a Pending job.
EXECUTABLE
The job has been submitted and has reached the activation date and time, but has not reached the expiration date and time. You can cancel an Executable job.
COMPLETED
The job has finished. Jobs submitted to enrolling devices never finish. You can either cancel or delete a Completed job.
EXPIRED
The job has passed its expiration date and time. You can either cancel or delete an expired job.
CANCELED
The job has been canceled from the Device Manager console or from DMSUtil.sh. A job can be canceled before or after it runs. The Device Manager database still retains information about a Canceled job. You can delete a Canceled job.

JOB_PRIORITY
Specifies that you want to filter by the numeric level of importance the administrator attached to expediting the submitted job. A valid job priority is a number from 1 to 1000, where 1 is the highest priority and 1000 is the lowest priority.

Device Filter Criteria

The device filter takes the form:

[ attribute1=value attribute2=value ... attributen=value ]

Use quotation marks around attribute values that have embedded blanks. For example, MODEL="Model ABC".

Attributes

MODEL
Specifies that you want to filter by the model number for the device.

DEVICE_CLASS_NAME
Specifies that you want to filter by the name of the device class for the device.

Valid values for device classes supplied with Device Manager are:

Palm
Specify this device class to display or remove Palm Computing PDA devices.
Wince
Specify this device class to display or remove Microsoft Windows CE devices.

At your site, all of these device classes may not be configured and available, or there may be additional device classes, or both.

Monitoring Log Files

Device Manager Log Files

The administrator should monitor the Device Manager log files, which contain important informational, warning, and error messages. The files are self-propagating files, limited in size, and named DMSMsgn.log and DMScareMsgn.log, where n indicates the number of the message log file that wraps between numbers 1, 2, and 3 (the Msg1 log file always contains the newest Device Manager messages and the Msg3 log file contains the oldest). DMSMsgn.log contains messages from the Device Manager servlets. DMScareMsgn.log contains messages from the Device Manager Care applications.

Application Server Log Files

In addition, four stderr.log and stdout.log files are produced for Device Manager by the application server that communicates with Device Manager and WebSphere Application Server. These message logs include the same messages that the Device Manager log files include, plus WebSphere Application Server messages and possibly some Device Manager messages, which are not logged in the Device Manager log files. These message logs can be a valuable diagnostic tool in the event of a problem. Because these application server logs may become very large, review and prune them frequently.

The administrator should monitor the following log files on each Device Manager server:

Operating System Log Filepath Log Files
IBM AIX /usr/WebSphere/AppServer/logs DMSMsgn.log
DMScareMsgn.log
DMS_stderr.log
DMS_stdout.log
DMScare_stderr.log
DMScare_stdout.log
Sun Solaris
RedHat Linux
/opt/WebSphere/AppServer/logs
Microsoft Windows install_drive:\WebSphere\AppServer\logs

Part 3: Appendix

The following appendix describes the accessibility features of Device Manager.

Accessibility

Accessibility features help a user who has a physical disability, such as restricted mobility or limited vision, to use software products successfully. The major accessibility feature in this product enables users to operate specific or equivalent features using only the keyboard.

In addition, the product documentation has been modified to include features to aid accessibility:

Navigating the Interface Using the Keyboard

Many menu actions in the Device Manager console and in the Device Manager Self Care or Customer Care applications can be initiated from the keyboard. In those cases, the shortcut letter is underlined. To select a menu action, press and hold the Alt key and select the underlined shortcut letter of a menu bar topic (for example, Alt+F for the File menu). Then select the underlined shortcut letter of the menu action (for example, R for Refresh). You can perform both actions together (Alt+F, R).

Standard shortcut and accelerator keys are used by the product and are documented by the operating system. Refer to the documentation provided by your operating system for more information.

The following table lists Device Manager keyboard shortcuts that you can use to navigate inside the windows of this product:

Accessing GUI features
Function Performed Shortcut
Access the menu bar F10
Access a menu bar topic Alt+letter
Access a menu bar action Alt+letter, then letter

Navigating
Function Performed Shortcut
Next field in a form Tab
Next frame F6
Next task button Ctrl+Tab
Next menu item down arrow key
Previous field in a form Shift+Tab
Previous frame Shift+F6
Previous task button Ctrl+Shift+Tab

Magnifying What Is Displayed on the Screen

You can enlarge information on the product windows using facilities provided by the operating systems on which the product is run. For example, in a Microsoft Windows environment, you can lower the resolution of the screen to enlarge the font sizes of the text on the screen. Refer to the documentation provided by your operating system for more information.