This reference contains summary information about various tools, commands, and utilities that are deployed on the administration system after a successful installation of IBM® Maximo® Asset Management. Where applicable, links to additional information are provided.

While many of the commands are used exclusively for Maximo® Asset Management, you can incorporate some of the commands into solutions that you build.


1. buildmaximo-xwar

1.1. Overview

The Work Center WAR file, maximo-x.war, is automatically built and deployed during the installation and configuration process. However, you can manually build the Work Center WAR file by using the buildmaximo-xwar command. After you build the maximo-x.war file, you can deploy it on the Maximo® Asset Management application server or UI cluster.

The buildmaximo-xwar command does not accept any parameters when the command is started from the command line.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmaximo-xwar.cmd

1.2. More information

Manually deploying Work Center WAR files in IBM Knowledge Center.


2. buildmaximoear

2.1. Overview

The Maximo application EAR file, maximo.ear, is automatically built and deployed during the installation and configuration process. However, you can manually build the Maximo EAR file by using the buildmaximoear command so that you can deploy the Maximo® Asset Management application on IBM WebSphere® Application Server V7.x or earlier. If you intend to deploy the Maximo application on a later version of WebSphere Application Server, use the buildmaximoearwas8 command.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmaximoear.cmd

2.2. Usage

The buildmaximoear command accepts the following parameters when the parameters are started from the command line.

  -help, -h              print this message
  -projecthelp, -p       print the project help information
  -version               print the version information and exit
  -diagnostics           print information that might be helpful to
                         diagnose or report problems.
  -quiet, -q             be extra quiet
  -verbose, -v           be extra verbose
  -debug, -d             print debugging information
  -emacs, -e             produce logging information without adornments
  -lib <path>            specifies a path to search for JAR files and classes
  -logfile <file>        use the provided file for the log
    -l     <file>                ''
  -logger <classname>    the class that completes logging
  -listener <classname>  add an instance of class as a project listener
  -noinput               do not allow interactive input
  -buildfile <file>      use the provided build file
    -file    <file>              ''
    -f       <file>              ''
  -D<property>=<value>   use the value for the provided property
  -keep-going, -k        execute all targets that do not depend
                         on failed target(s)
  -propertyfile <name>   load all properties from file with -D
                         properties taking precedence
  -inputhandler <class>  the class that handles input requests
  -find <file>           (s)earch for build file towards the root of
    -s  <file>           the file system and use the build file
  -nice  number          A niceness value for the main thread:
                         1 (lowest) to 10 (highest), and 5 is the default
  -nouserlib             Run ant without using the JAR files from the
                         ${user.home}/.ant/lib directory
  -noclasspath           Run ant without using the CLASSPATH
  -autoproxy             Java1.5+: use the OS proxy settings
  -main <class>          override the normal entry point for ant

2.3. More information


3. buildmaximoearwas8

3.1. Overview

The Maximo application EAR file, maximo.ear, is automatically built and deployed during the installation and configuration process. However, you can manually build the Maximo EAR file by using the buildmaximoearwas8 command to deploy the Maximo application on IBM WebSphere® Application Server V8.0 or later. If you intend to deploy the Maximo application on an earlier version of WebSphere Application Server, or you intend to deploy on Oracle WebLogic Server, use the buildmaximoear command.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmaximoearwas8.cmd

3.2. Usage

The buildmaximoearwas8 command accepts the following parameters when the parameters are started from the command line.

  -help, -h              print this message
  -projecthelp, -p       print the project help information
  -version               print the version information and exit
  -diagnostics           print information that might be helpful to
                         diagnose or report problems.
  -quiet, -q             be extra quiet
  -verbose, -v           be extra verbose
  -debug, -d             print debugging information
  -emacs, -e             produce logging information without adornments
  -lib <path>            specifies a path to search for JAR files and classes
  -logfile <file>        use the provided file for log
    -l     <file>                ''
  -logger <classname>    the class that completes logging
  -listener <classname>  add an instance of class as a project listener
  -noinput               do not allow interactive input
  -buildfile <file>      use the provided build file
    -file    <file>              ''
    -f       <file>              ''
  -D<property>=<value>   use the value for the provided property
  -keep-going, -k        execute all targets that do not depend
                         on failed target(s)
  -propertyfile <name>   load all properties from file with -D
                         properties taking precedence
  -inputhandler <class>  the class that handles input requests
  -find <file>           (s)earch for build file towards the root of
    -s  <file>           the file system and use the build file
  -nice  number          A niceness value for the main thread:
                         1 (lowest) to 10 (highest), and 5 is the default
  -nouserlib             Run ant without using the JAR files from the
                         ${user.home}/.ant/lib directory
  -noclasspath           Run ant without using the CLASSPATH
  -autoproxy             Java1.5+: use the OS proxy settings
  -main <class>          override the normal entry point for ant

3.3. More information


4. buildmxiehsear

4.1. Overview

The buildmxiehsear command is deprecated. It was used to build the EAR file for the local help system.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmxiehsear.cmd

5. buildmxiehsear12c

5.1. Overview

The buildmxiehsear12c command is deprecated. It was used to build the EAR file for the local help system.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmxiehsear12c.cmd

6. buildrmiregwar

6.1. Overview

You can use this command to prepare and build the RMI registry file, rmireg.war. The buildrmiregwar command uses the settings that are specified in the /applications/maximo/properties/maximo.properties file to build a WAR file that includes the necessary parameters to run in the Maximo® Asset Management environment.

The buildrmiregwar command does not accept any parameters when the parameters are started from the command line.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildrmiregwar.cmd

6.2. More information

Building the RMI registry file in IBM Knowledge Center.


7. commonenv

7.1. Overview

You can use the commonenv command to set the environment parameters that are used by Maximo® Asset Management tools.

The commonenv command does not accept any parameters when the parameters are started from the command line.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\commonenv.bat

7.2. More information


8. commonenvCustom

8.1. Overview

You can use the commonenvCustom command to set custom environment parameters for Maximo® Asset Management tools.

The commonenvCustom command does not accept any parameters when the parameters are started from the command line.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\commonenvCustom.bat

8.2. More information


9. configdb

9.1. Overview

You can use the configdb command to configure the database by creating the structure that is required for IBM® Maximo® Asset Management tools.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\configdb.bat

9.2. Usage

-f<properties filename>
-d<output directory>
-o<output filename>
-a<db alias>
-u<username>
-p<password>
-l
-e
-r
-z
-h<help>

10. copytenantdata

10.1. Overview

The Maximo® Asset Management template data tables contain data that is copied from a template but is unique for each tenant, and the data can be modified by each tenant. Template data tables have the tenant ID column. When a tenant is created, table rows that include the tenant ID of the new tenant are created. A tenant can view and modify only the information that is associated with the tenant ID of that tenant.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\copytenantdata.bat

10.2. Usage

-d<output directory>
-o<output filename>
-l
-e
-h<help>
-i<input filename>

10.3. More information


11. encryptproperties

11.1. Overview

In the Maximo® Asset Management tools, the maximo.properties file has an encrypted password for the database user. If modifications need to be made to any of the properties that are in the maximo.properties file, the modifications must not be made to this encrypted file; the file that has the non-encrypted password must be used. Run the encryptproperties command to encrypt the database user password in the maximo.properties file and also to copy the maximo.properties`file before the encryption to the `maximo.properties_orig file. This action also ensures that the new modifications are in the _orig file.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\encryptproperties.bat

11.2. Usage

encryptproperties [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
* -e          : Encrypt Properties. (value: )
  -kFILE      : The Maximo properties file home (value: C:\IBM\SMP\maximo
                applications/maximo/properties)

  -pARG_VALUE : The password for the database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -uARG_VALUE : Username for database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -?, --help  : Help.

12. integrityui

12.1. Overview

This command launches the Integrity Checker tool. You can use the Integrity Checker tool to confirm that your data can be upgraded to the next version of Maximo® Asset Management and to confirm that your data is not corrupted during the upgrade process. You can also use it for non-upgrade purposes. For example, if you suspect that your Maximo data is corrupted, you can use the tool to identify and fix data integrity issues.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\integrityui.bat

12.2. More information


13. maxinst

13.1. Overview

You can use the maxinst command to populate the Maximo® Asset Management database with schema and data. You can run this command any time that the product is installed for the first time. Do not run this command if you already have a Maximo database. The maxinst command drops and rebuilds all of the tables that are in your database.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\maxinst.bat

13.2. Usage

maxinst [OPTIONS...] ARG1 ARG2 ARGn...

OPTIONS: (* is required)
  -aARG_VALUE : The database alias. If not specified, the mxe.db.url property is used.
                (value: )

  -cFILE      : The subdirectory for input file. The assumed root is the
                location of this bat file, which is in the tools\maximo directory. For example, if the input file
                is in the tools\maximo\FR directory, this parameter equals FR. If
                not specified, then the input directory is the tools\maximo\EN directory.
                 (value: )

  -dFILE      : If you use the -l parameter, this parameter outputs the log file to the
                specified directory. If not specified, this parameter outputs to the MXServer log
                directory, which normally is the tools\maximo\log directory. (value: )

* -e          : Causes Sql to be executed. (value: )
  -fARG_VALUE : The file name for properties file. If not specified, the
                maximo.properties file is used. See the -k parameter for the propfile directory. (value:
                )

  -gARG_VALUE : The property file with or without a full path where all
                installation-collected parameters are stored. (value: installation
                properties)

  -iARG_VALUE : The file name of the input file without a path or extension. The
                default file name is Unlcvt if the -i param is not provided. (value:
                maxdemo)

  -kFILE      : The directory for the properties file. See the -f parameter for
                the propfile file name. (value: C:\IBM\SMP\maximo\applications\maximo
                properties)

* -l          : Outputs a detailed log file. (value: )
  -mARG_VALUE : Varchar multiple. If a value is not equal to 1, native
                varchar/varchar2 column lengths are a multiple of the length in
                the maxattribute. Use this parameter only in
                special multi-language situations. (value: )

  -mt         : All regular and multi-tenancy
                scripts for core and add-on products are executed. (value: )

  -oARG_VALUE : If you are using the -l parameter, this parameter is the file name for the log file. If
                not specified, the log file is the Maxinst + timestamp + .log file. See the -d
                parameter for the log file directory. (value: )

  -pARG_VALUE : The password for the database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -q          : Enable DB2 text search. (value: )
  -rARG_VALUE : If the value is 1, notify DBManage that Install Mode is true.
                (value: 1)

  -sARG_VALUE : Table space for index storage. (value: )
  -tARG_VALUE : Table space for table storage. (value: )
  -uARG_VALUE : Username for the database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -xARG_VALUE : If Maximo® Asset Management is ultimately deployed on a UNIX platform,
                then the -x parameter must be supplied. If the ultimate deployment is on a
                Windows platform, omit this parameter. (value: )

  -y          : Use this parameter only for DB2. When -y is specified, all columns that
                normally have native datatype of varchar instead are created as
                vargraphic. (value: )

  -?, --help  : Help.

The default database is defined in the maximo.properties file.

IMPORTANT NOTE RE: -S and -T PARAMETERS: The maxinst command does not provide a default value for table space. For the maxinst command to specify the table space tables or indexes are created, you must specify the table space by using the -t and/or -s parameters. For example, for the SqlServer primary filegroup, you specify: -tPRIMARY -sPRIMARY


14. mxapply

14.1. Overview

You can use the mxapply command to preserve and reapply existing customizations when you update Maximo Asset Management. You use the mxapply command to apply the different transactions that are identified by the mxdiff command to the presentation XML files.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\screen-upgrade\mxapply.bat

You must run the mxdiff command before you run the mxapply command.

14.2. Usage

-t: Transaction file (transactions.xml)
-p: Property file (located in the applications\maximo\properties\maximo.properties directory)
and it looks in the properties directory for the file that you specify
-l: Update the MAXLABELS table in the database, true by default
-s: Specify the name of the source application for product extensions
-a: Specify the name of the target application for product extensions

15. mxdiff

15.1. Overview

You can use the mxdiff command to preserve and reapply existing customizations when you update Maximo Asset Management. You use the mxapply command to apply the different transactions that are identified by the mxdiff command to the presentation XML files.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\screen-upgrade\mxdiff.bat

You must run the mxdiff command before you run the mxapply command.

15.2. Usage

-b: Baseline 6.x extract file (baseline.xml)
-f: Folder name containing 6.x extract files (baseline.xml)
-m: Modified 6.x extract file (mxversion.xml)
-t : Transaction file (transactions.xml)

16. PIIVersionUpdater

16.1. Overview

This command ensures that updated language files are updated before the TDToolkit tool is run to update languages.

This command is not intended to be used as a stand-alone command from the command line.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\PIIVersionUpdater.bat

16.2. Usage

PIIVersionUpdater [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
  -pFILE          : The previous XLIFF version directory. (value:
                    C:\IBM\SMP\maximo/tools/maximo/PIIVersionUpdater/previous)

  -rFILE          : The returned XLIFF from translators directory. (value:
                    C:\IBM\SMP\maximo/tools/maximo/PIIVersionUpdater/returned)

  -uFILE          : THe updated XLIFF directory. (value: C:\IBM\SMP\maximo/tools
                    maximo/PIIVersionUpdater/updated)

  -vXLIFF_VERSION : The version number to use for changed records. Use XLIFF to
                    get the highest version from the files. (value: XLIFF)

  -?, --help      : Help.

17. pkginstall

17.1. Overview

This command is used to install Maximo® Asset Management product license packages.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\pkginstall.bat

17.2. Usage

-d<directory>
-f<filename>

18. TDTDynamicTranslationExpander

18.1. Overview

You can use the TDTDynamicTranslationExpander command to ensure that database table fields are large enough to hold translated values. You use the command to examine a translated value in an XLIFF file and determine whether it fits in the current column width of the relevant table. If the value does not fit, the TDTDynamicTranslationExpander command automatically resizes the table column. This command is run when the addlanguage command is started in the configuration tool or when the TDToolKit command is called. The TDTDynamicTranslationExpander command is part of the TDToolKit command processing that loads the translated XLIFFS files into the database.

This command is not intended to be run manually.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\TDTDynamicTranslationExpander.bat

18.2. Usage

TDTDynamicTranslationExpander.bat -addlang -version

18.3. More information


19. TDToolkit

19.1. Overview

You can use the TDToolkit command to designate the base language and one or more languages as additional languages for Maximo® Asset Management.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\TDToolkit.bat

19.2. Usage

Commands
----------------------------------+----------------------------------------------
-EXPORT                           |Export the database to XLIFF files.
                                  |The following options are valid:
                                  |-DE
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SL
                                  |-TL
                                  |-USEMAXROWSTAMP
                                  |-USEMRS
                                  |-PRODUCT
                                  |-SUBYTE
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-USEEXCLUDE
                                  |-OVERRIDEVERSION
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-IMPORT                           |Import a set of XLIFF files.
                                  |The following options are valid:
                                  |-DI
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-TL
                                  |-USEMAXROWSTAMP
                                  |-USEMRS
                                  |-VERSION
                                  |-SYSTEMEXIT
                                  |-OVERRIDEEN
                                  |-NOMAXMESSFIX
                                  |-LOCALE
                                  |-DONTEXITONDOMAINERROR
----------------------------------+----------------------------------------------
-UPDATE                           |Update a set of XLIFF files.
                                  |The following options are valid:
                                  |-DE
                                  |-DR
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SL
                                  |-TL
                                  |-USEMAXROWSTAMP
                                  |-USEMRS
                                  |-PRODUCT
                                  |-SUBYTE
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-USEEXCLUDE
                                  |-OVERRIDEVERSION
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-ADDLANG<language>                |Add a secondary language to the database.
                                  |The following options are valid:
                                  |-DI
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-NOMAXMESSFIX
                                  |-VERSION
----------------------------------+----------------------------------------------
-PMPUPDATE<pmp_name>              |Update translation(s) for a PMP.
                                  |The following options are valid:
                                  |-DI
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-VERSION
                                  |-SYSTEMEXIT
                                  |-NOMAXMESSFIX
                                  |-LANG
                                  |-LOCALE
                                  |-DONTEXITONDOMAINERROR
----------------------------------+----------------------------------------------
-COMPARE                          |Compare a Maximo database and Maxdemo database.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-CHECKDUP                         |Check XLIFF files for duplicates.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
----------------------------------+----------------------------------------------
-FIXREPORTLABEL                   |Add missing resource names to the ReportLabel
                                  |xliff files if necessary.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-ADDMAXIMODATA                    |Add Maximo data to Maxdemo XLIFF files.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SUBYTE
                                  |-SYSTEMEXIT
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-EXCLUDEEXPORT                    |Export exclude files.
                                  |VThe following options are valid:
                                  |-DE
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-USEMAXROWSTAMP
                                  |-USEMRS
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-MAXDEMODNTL                      |Compare a Maxdemo and Maximo database.
                                  |Generates the TDTDoNotTranslate_Maxdemo.xml file
                                  |to identify Maxdemo records.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-DONTESCAPEVARIABLES
----------------------------------+----------------------------------------------
-CHECKTRANSLATION                 |Check database translation against XLIFF files.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
                                  |-VERBOSE
----------------------------------+----------------------------------------------
-CHECKDOMAINS                     |Check the domain integrity.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
                                  |-MAXRECORDS
----------------------------------+----------------------------------------------
-RESETSTARTCENTERS                |Reset the start centers to refresh the labels
                                  |from the database.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
----------------------------------+----------------------------------------------
-FIXTDTVERSION                    |Update the TDTVERSION table.
                                  |The following options are valid:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-SYSTEMEXIT
----------------------------------+----------------------------------------------
-USEEXPANDER                      |Run the TDTDynamicTranslationExpander command.
                                  |The command is run to ensure the
                                  |translation fits in the database.
                                  |The following flags are passed along:
                                  |-MXE.DB.DRIVER
                                  |-MXE.DB.URL
                                  |-MXE.DB.USER
                                  |-MXE.DB.PASSWORD
                                  |-MXE.DB.SCHEMAOWNER
                                  |-MXE.MT.ENABLED
                                  |-MXE.MT.DB.ADMINUSER
                                  |-MXE.DB.DB2SSLCONNECTION
                                  |-MXE.DB.DB2SSLTRUSTSTORELOCATION
                                  |-MXE.DB.DB2SSLTRUSTSTOREPASSWORD
                                  |-LMP
                                  |-IMPORT
                                  |-TL
                                  |-ADDLANG
                                  |-PMPUPDATE
                                  |-LANG
                                  |-VERSION
                                  |-NOUPDATE, not used by TDToolkit
                                  |-NOCONFIGURATION, not used by TDToolkit
                                  |-NOCONFIG, not used by TDToolkit
----------------------------------+----------------------------------------------



Parameters
----------------------------------+----------------------------------------------
-DR<reference_dir>                |The reference directory that is used for updates.
----------------------------------+----------------------------------------------
-DE<export_dir>                   |The export directory.
----------------------------------+----------------------------------------------
-DI<import_dir>                   |The import directory.
----------------------------------+----------------------------------------------
-MXE.DB.DRIVER<driver>            |Override the driver in the maximo.properties file.
----------------------------------+----------------------------------------------
-MXE.DB.URL<url>                  |Override the url in the maximo.properties file.
----------------------------------+----------------------------------------------
-MXE.DB.USER<user>                |Override the user in the maximo.properties file.
----------------------------------+----------------------------------------------
-MXE.DB.PASSWORD<password>        |Override the password in the maximo.properties file.
----------------------------------+----------------------------------------------
-MXE.DB.SCHEMAOWNER<schema>       |Override the schema owner in the maximo.properties file.
----------------------------------+----------------------------------------------
-MXE.MT.ENABLED<1|0>              |Override the Multi-Tenancy flag.
----------------------------------+----------------------------------------------
-MXE.MT.DB.ADMINUSER<user>        |Override the multi-tenancy admin user.
----------------------------------+----------------------------------------------
-MXE.DB.DB2SSLCONNECTION<t/f>     |Override the SSL Connection and use true or false.
----------------------------------+----------------------------------------------
-MXE.DB.DB2SSLTRUSTSTORELOCATION<loc>  |Override the SSL truststore location.
---------------------------------------+-----------------------------------------
-MXE.DB.DB2SSLTRUSTSTOREPASSWORD<pass> |Override the SSL truststore password.
----------------------------------+----------------------------------------------
-SL<source_languange>             |The source language for the XLIFF files.
----------------------------------+----------------------------------------------
-TL<target_languange>             |The target language for the XLIFF files.
----------------------------------+----------------------------------------------
-USEMAXROWSTAMP                   |Use the MAXROWSTAMP table.
----------------------------------+----------------------------------------------
-USEMRS                           |Use the MAXROWSTAMP table.
----------------------------------+----------------------------------------------
-PRODUCT<pmp_name>                |Specify the product to get the correct version.
                                  |Use this option with PMPs.
----------------------------------+----------------------------------------------
-SUBYTE                           |Use byte for the size-unit in XLIFF files.
----------------------------------+----------------------------------------------
-SYSTEMEXIT                       |Exit with the System.exit(n) command if an error occurs.
----------------------------------+----------------------------------------------
-MAXRECORDS                       |Maximum records per XLIFF files.
                                  |Defaults to 1000.
----------------------------------+----------------------------------------------
-USEEXCLUDE                       |Use exclude files for updates or exports.
----------------------------------+----------------------------------------------
-OVERRIDEEN                       |Force import of English XLIFF files.
----------------------------------+----------------------------------------------
-OVERRIDEVERSION<version>         |Use the specified version in XLIFF files.
----------------------------------+----------------------------------------------
-NOMAXMESSFIX                     |Do not add double apostrophes (') in the MAXMESSAGES table.
----------------------------------+----------------------------------------------
-LANG                             |Only process the specified languages.
                                  |Separate languages with commas.
----------------------------------+----------------------------------------------
-LOCALE<locale>                   |Normally, the locale is set by -TL.
                                  |Use this parameter to override the locale.
----------------------------------+----------------------------------------------
-EXITONDOMAINERROR                |Stop import if duplicates exist
                                  |in the domains.
----------------------------------+----------------------------------------------
-VERBOSE                          |List record details during a check of the database.
----------------------------------+----------------------------------------------
-DONTESCAPEVARIABLES              |Do not escape the :Variables.
----------------------------------+----------------------------------------------

19.3. More information


20. updatedb

20.1. Overview

You can use the updatedb command to write updates and changes to the database. Run this command any time the product is upgraded or a fix pack is installed. The application server must be stopped before you run this command. If you customize your Maximo® Asset Management deployment, you must run the updatedb command to write the changes to the database.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\updatedb.bat

20.2. Usage

updatedb [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
  -aARG_VALUE : The database alias. If not specified, the mxe.db.url property is used.
                (value: )

  -dFILE      : If not specified, outputs to the MXServer log directory,
                which normally is the tools\maximo\log directory. (value: )

  -fARG_VALUE : The file name for the properties file. If not specified, the
                maximo.properties file is used. See the -k parameter for the propfile directory. (value:
                )

  -gARG_VALUE : The property file with or without a full path where all
                installation-collected parameters are stored. (value: installation
                properties)

  -j          : Run in internal build mode without a rest class. (value: )
  -kFILE      : The Maximo properties file home. (value: C:\IBM\SMP\maximo
                applications/maximo/properties)

  -lite       : Run in lite mode. (value: )
  -mARG_VALUE : Varchar multiple. If a value is not equal to 1, native
                varchar/varchar2 column lengths are a multiple of the length in
                maxattribute. Use this parameter only in
                special multi-language situations. (value: )

  -mt         : All regular and multi-tenancy
                scripts for core and add-on products are executed. (value: )

  -mtonly     : Only multi-tenancy scripts for
                core and add-on products are executed. (value: )

  -nFILE      : The subdirectory for the input file. The assumed root is the
                location of this bat file, which is the tools\maximo directory. For example, if the input file
                is in the tools\maximo\fr\script directory, this parameter equals
                fr (lowercase). If not specified, then the input directory
                is the tools\maximo\en\script directory. (value: )

  -oARG_VALUE : If not specified, the log file is the Maxinst + timestamp + .log file.
                See the -d parameter for the log file directory. (value: )

  -pARG_VALUE : The password for the database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -rARG_VALUE : If the value is 1, notify DBManage that Install Mode is true.
                (value: )

  -sARG_VALUE : Table space for index storage. (value: )
  -tARG_VALUE : Table space for table storage. (value: )
  -uARG_VALUE : The username for the database connection. If not specified, the
                mxe.db.password property or the running Maximo server instance is used. (value: )

  -vARG_VALUE : If the value is 1, a_customer.xml file check is not printed
                to the console. The default value is 0. (value: )

  -wFILE      : The directory for the extension class file. The updated class file is
                written to the specified directory. (value: C:\IBM\SMP\maximo
                applications/maximo/businessobjects/classes)

  -y          : Use this parameter only for DB2. When the parameter is specified, all columns that
                normally have a native datatype of varchar are instead created as
                vargraphic. (value: )

  -?, --help  : Help.

The default database is defined in the maximo.properties file.


21. updatedblite

21.1. Overview

You can use the updatedblite command to complete updates to the database. The updatedb and updatedblite commands use the same parameters. This command works in conjunction with the updatedblitepreprocessor command.

The updatedb command builds and prepares class files and then writes data to the database. During this time, the application server must be shut down. The updatedblitepreprocessor command and the updatedblite command split the tasks of preparing class files and updating the database, which minimizes downtime. The updatedblitepreprocessor command builds and prepares class files, during which time the application server can remain active. The updatedblite can then be run to write data to the database, during which time the application server must be stopped.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\updatedblite.bat

21.2. Usage

  updatedblite [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
  -aARG_VALUE : The database alias. If not specified, the mxe.db.url property is used.
                (value: )

  -dFILE      : If not specified, outputs to the MXServer log directory,
                which normally is the tools\maximo\log directory. (value: )

  -fARG_VALUE : The file name for the properties file. If not specified, the
                maximo.properties file is used. See the -k parameter for the propfile directory. (value:
                )

  -gARG_VALUE : The property file with or without a full path where all
                installation-collected parameters are stored. (value: installation
                properties)

  -j          : Run in internal build mode without a reset class. (value: )
  -kFILE      : The Maximo properties file home. (value: C:\IBM\SMP\maximo
                applications/maximo/properties)

* -lite       : Run in lite mode. (value: )
  -mARG_VALUE : Varchar multiple. If a value is not equal to 1, native
                varchar/varchar2 column lengths are a multiple of the length in
                maxattribute. Use this parameter only in
                special multi-language situations. (value: )

  -mt         : All regular and multi-tenancy
                scripts for core and add-on products are executed. (value: )

  -mtonly     : Only multi-tenancy scripts for
                core and add-on products are executed. (value: )

  -nFILE      : The subdirectory for the input file. The assumed root is the
                location of this bat file, which is the tools\maximo directory. For example, if the input file
                is in the tools\maximo\fr\script directory, this parameter equals
                fr (lowercase). If not specified, then the input directory
                is the tools\maximo\en\script directory. (value: )

  -oARG_VALUE : If not specified, the log file is the Maxinst + timestamp + .log file.
                See the -d parameter for the log file directory. (value: )

  -pARG_VALUE : The password for the database connection. If not specified,
                the mxe.db.password property or the running Maximo server instance is used. (value: )

  -rARG_VALUE : If value is 1, notify DBManage that Install Mode is true.
                (value: )

  -sARG_VALUE : Table space for index storage. (value: )
  -tARG_VALUE : Table space for table storage. (value: )
  -uARG_VALUE : Username for database connection. If not specified,
                the mxe.db.password property or the running Maximo server instance is used. (value: )

  -vARG_VALUE : If the value is 1, a_customer.xml file check is not printed
                to the console. The default value is 0. (value: )

  -wFILE      : The directory for the extension class file. The updated class file is
                written to the specified directory. (value: C:\IBM\SMP\maximo
                applications/maximo/businessobjects/classes)

  -y          : Used this parameter only for DB2. When this parameter is specified, all columns that
                normally have a native datatype of varchar instead are created as
                vargraphic. (value: )

  -?, --help  : Help.

22. updatedblitepreprocessor

22.1. Overview

You can use the updatedblitepreprocessor command to prepare class files before they are built into the application EAR files. The updatedb command can also perform this work, but it requires that you stop the application server. If you use the updatedblitepreprocessor command, you are not required to stop the application server while the class files are prepared.

This command works in conjunction with the updatedblite command.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\updatedblitepreprocessor.bat

22.2. Usage

  updatedblitepreprocessor [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
  -dFILE      : If not specified, outputs to the MXServer log directory,
                which normally is the tools\maximo\log directory. (value: )

  -fARG_VALUE : The file name for the properties file.  If not specified, the
                maximo.properties file is used. See the -k parameter for the propfile directory. (value:
                )

  -gARG_VALUE : THe property file with or without a full path where all
                installation-collected parameters are stored. (value: installation
                properties)

  -j          : Run in internal build mode without a rest class. (value: )
  -kFILE      : The Maximo properties file home. (value: C:\IBM\SMP\maximo
                applications/maximo/properties)

  -nFILE      : The subdirectory for the input file. The assumed root is the
                location of this bat file, which is the tools\maximo directory. For example, if the input file
                is in the tools\maximo\fr\script directory, this parameter equals
                fr (lowercase). If not specified, then the input directory
                is the tools\maximo\en\script directory. (value: )

  -oARG_VALUE : If not specified, the log file is the Maxinst + timestamp + .log log file.
                See the -d parameter for the log file directory. (value: )

  -vARG_VALUE : If the value is 1, a_customer.xml file check is not printed
                to the console. The default value is 0. (value: )

  -wFILE      : The directory for the extension class file. The updated class file
                is written to the specified directory. (value: C:\IBM\SMP\maximo
                applications/maximo/businessobjects/classes)

  -?, --help  : Help.

23. updateXML

23.1. Overview

You can use this command to update XML files that are built into product WAR and EAR files. For example, you can update the web.xml file to change security options.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\updateXML.bat

23.2. Usage

UpdateXML <options>

The possible options include the following parameters:

  -o<oldDir>	The old Maximo home directory
  -f<filePath>	The file path relative to the Maximo home directory.
  -d<directory> The directory relative to the tools\maximo> directory

 To search for and run all difference files, use the `-o<oldDir>` parameter with the `-d<directory` parameter relative to the `tools\maximo>` directory.

24. writereportprop

24.1. Overview

You can use this comment to export all non-English property files that you have in your system. A log file that details the results is located in the \tools\maximo\log directory, and the properties files are located in the export file location that you defined in your reporttools.properties file.

The command is located in the following directory:

c:\IBM\SMP\maximo\tools\maximo\writereportprop.bat

24.2. Usage

  writereportprop [OPTIONS...] XMLFILE1 XMLFILE2 XMLFILEn...

OPTIONS: (* is required)
  -aARG_VALUE : The database alias. If not specified, the mxe.db.url property is used.
                (value: )

  -fARG_VALUE : The file name for the properties file. If not specified, the
                maximo.properties file is used. See the -k parameter for the propfile directory. (value:
                )

  -kFILE      : The Maximo properties file home. (value: C:\IBM\SMP\maximo
                applications/maximo/properties)

  -pARG_VALUE : The password for the database connection. If not specified,
                the mxe.db.password property or the running Maximo server instance is used. (value: )

  -rARG_VALUE : The Maximo home directory. (value: C:\IBM\SMP\maximo)
  -uARG_VALUE : The username for the database connection. If not specified,
                the mxe.db.password property or the running Maximo server instance is used. (value: )

  -?, --help  : Help.

24.3. More information


25. xliff2tms

25.1. Overview

The xliff2tms command is deprecated. It was used to transform XLIFF formatted information into the Tivoli Message Standard format.

The command is located in the following directory:

c:\IBM\SMP\maximo\deployment\buildmxiehsear12c.cmd