IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsicreatemsgdefs command

Use the mqsicreatemsgdefs command to create message definition files in a message set.

Supported platforms

  • Windows
  • Linux on x86

Purpose

The mqsicreatemsgdefs command generates message definition files (*.mxsd), according to a set of import options that are specified in an option file. The generated files are placed in the specified message set folder.

The command takes as a parameter a directory where source files of various types, for example, C and COBOL source files, are located (in addition to various other parameters), and starts the appropriate operation based on the extensions to the files.

  1. Ensure that only the files that are required for the command to run exist in the directory and subdirectory structure that you specify. One of the actions that the mqsicreatemsgdefs command performs is to copy all the files in the directory and subdirectories into the workspace, before creating the message definition. The mqsicreatemsgdefs command copies the source files into the import files folder of the messageSet project. Therefore the source directory should not be, or contain the message set project folder. Files that are not related to the message definitions that you are trying to create might also be copied.
  2. You must specify the -data WorkspacePath parameter to specify the target workspace.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-mqsicreatemsgdefs-- -p --MessageSetProjectName--------------->

>-- -d --Pathname of source files folder------------------------>

>-- -data --WorkspacePath--------------------------------------->

>--+-------------------------------------------------------+---->
   '- -base --baseMessageSetProjectName\baseMessageSetName-'   

>--+--------+--+--------+--+-------+--+--------+---------------->
   '- -rmp -'  '- -rmd -'  '- -ns -'  '- -msg -'   

>--+-----------------+--+------+-------------------------------->
   '- -opt --xxx.xml-'  '- -v -'   

>--+----------------------------+------------------------------><
   '- -log --ReportFilePathName-'   

Parameters

-p MessageSetProjectName
(Required) The name of the message set project. If the project does not exist, a new message set project is created.
-d Pathname of source files folder
(Required) The absolute or relative path name of the directory of definition files (source files).

All relevant files that are located in any sub-folders under the source files folder are scanned and imported.

-data WorkspacePath
(Required) The path of the workspace in which your projects are created.

The workspace location is also the default location for projects. Relative paths are interpreted as being relative to the directory from which the command was started.

-base baseMessageSetProjectName\baseMessageSetName
(Optional) If a new message set is to be created, specifies the existing message set project and message set, on which it is based.
-rmp
(Optional) Replaces the existing project of the same name.
-rmd
(Optional) Replaces an existing message definition file of the same name.
  1. If you omit this flag, and a message definition file of the same name exists, a warning is returned.
  2. The location of the generated message definition file in the message set is determined by the target namespace.
-ns
(Optional) If a new message set is to be created, the message set is enabled for namespace support.
-msg
(Optional) Creates messages from complex imported structures.
-opt xxx.xml
(Optional) The absolute or relative path name of the options file. The options file can be one of the following types: If you do not specify an option, the default options file (mqsicreatemsgdefs.xml) is used; see Message sets: Default options file for the mqsicreatemsgdefs command.

You can copy the default options file, and customize it, to create an options file for your environment.

-v
(Optional) Verbose report.
-log ReportFilePathname
(Optional) Absolute or relative path name of the report file. If you omit this option, the report is written to the default log file (mqsicreatemsgdefs.report.txt ) in the Eclipse current directory.

If you specify -log without the report file path name, or with a path name that is not valid, the command issues an error message and stops.

Authorization

On Windows systems, the user ID used to run this command must be running with elevated privileges on the local system:
  • The user ID must be a member of the group Administrators.
  • The command must be started from an environment that has Run as Administrator authority.

If you do not run the command from a privileged environment, you are asked to confirm that you want to continue. When you click OK, a new privileged command console is created and the command completed, but all responses are written to the privileged environment and are lost when that console closes when the command completes.

On other platforms, no specific authority is required to run this command.

Examples

The following example creates or uses the message set project newproject in the source file c:\myproject\source and replaces the existing message project and message definition files of the same name.

mqsicreatemsgdefs -p newproject -d c:\myproject\source -rmp -rmd

an07350_.htm | Last updated Friday, 21 July 2017