Table of Contents

Search

  1. Preface
  2. Introduction to Data Transformation
  3. Data Processor Transformation
  4. Wizard Input and Output Formats
  5. Relational Input and Output
  6. Using the IntelliScript Editor
  7. XMap
  8. Libraries
  9. Schema Object
  10. Command Line Interface
  11. Scripts
  12. Parsers
  13. Script Ports
  14. Document Processors
  15. Formats
  16. Data Holders
  17. Anchors
  18. Transformers
  19. Actions
  20. Serializers
  21. Mappers
  22. Locators, Keys, and Indexing
  23. Streamers
  24. Validators, Notifications, and Failure Handling
  25. Validation Rules
  26. Custom Script Components

CM_console

CM_console

Runs a Data Transformation service.
The CM_console command uses the following syntax:
CM_console <ServiceName> [< -f | -u | -t >InputDocument] [ -aServiceParameter=InitialValue] [ -o<[Path]FileName | FileName>] [ -r<curr | res | spec=OutputDirectory | guid>] [ -lUserName -pPassword] [ -v] [ -S] [ -x<f | u | t>InputPortName=InputDocument] [ -xoOutputPortName=OutputDocument] [ -e]
Do not include a space between an option and its argument.
The following table describes CM_console options and arguments:
Option
Argument
Description
-
ServiceName
Required. Specifies the name of the service.
-f
InputDocument
Optional. Specifies a path and file name on the local file system. By default, the service uses the document defined in the
example_source
property of the startup component.
-t
InputDocument
Optional. Specifies a string surrounded by double quotes.
-u
InputDocument
Optional. Specifies a URL.
-a
ServiceParameter=InitialValue
Optional. Specifies an input parameter for the service. ServiceParameter is the name of a variable as defined in the service. InitialValue must be of a data type that is valid for the defined variable. You can enter multiple input parameters, separated by spaces.
-o
FileName
[Path]FileName
Optional. Directs output to Path/FileName. If you enter only FileName, you must define the Path with the -r option. By default, the CM_console command directs output to the screen.
-r
curr
Optional. Specifies the directory from which you ran the CM_console command.
-r
res
Optional. Specifies the
results
subdirectory under the directory that holds the service in the filesystem repository.
-r
spec=OutputDirectory
Optional. Specifies a directory on the local file system.
-r
guid
Optional. Specifies a directory with a unique name under the
CMReports/tmp
directory. You can use the configuration editor to change the location of this directory.
-l
UserName
Required when you use HTTP authentication. Specifies the user name for HTTP authentication.
This option is a lower-case L.
-p
Password
Required when you use HTTP authentication. Specifies the password for HTTP authentication.
-v
-
Optional. Displays verbose information about the Data Transformation version, the version of the Data Transformation syntax, the setup package identifier, the license, and other information.
-S
-
Required if the startup component of the service is a streamer. You must also use the -f option to define the input file.
-xf
InputPortName=InputDocument
Optional. InputPortName specifies the name of an
AdditionalInputPort
defined in the service. InputDocument specifies a path and file name on the local file system. You can enter multiple input ports, separated by spaces.
-xt
InputPortName=InputDocument
Optional. InputPortName specifies the name of an
AdditionalInputPort
defined in the service. InputDocument specifies a string surrounded by double quotes. You can enter multiple input ports, separated by spaces.
-xu
InputPortName=InputDocument
Optional. InputPortName specifies the name of an
AdditionalInputPort
defined in the service. InputDocument specifies a URL. You can enter multiple input ports, separated by spaces.
-xo
OutputPortName=OutputDocument
Optional. OutputPortName specifies the name of an
AdditionalOutputPort
defined in the service. OutputDocument specifies a path and file name on the local file system. You can enter multiple output ports, separated by spaces.
-e
-
Optional. By default, the CM_console command terminates with an exit code of 1 for success and greater than 1 for error. When you include the -e option, the CM_console command terminates with an exit code of 0 for success and greater than 1 for error.
For example:
CM_console XYZparser -fInputFile.txt -aMaxLines=1000 -oResults.xml -rcurr
This example calls the XYZparser service, using
InputFile.txt
as the main input document. It gives the value of 1000 to the
MaxLines
parameter, and writes the output to the
Results.xml
file in the directory from which you ran the CM_console command.


Updated March 18, 2021