Invocation

The syntax for calling the List Objects API client program is as follows:

listobjects /project=<project name> 

            /file=<output xml file> 

            /path=<path in project> 

            /server.host=<server host name> 

            /server.port=<server port>

            /cfg=<configuration file>

            /level=<required revision level>	      

            /user=<required user for development revision>

The parameters can be given in any order and have the following meaning:

• project; this mandatory parameter specifies the name of the project in the ITP/MDK Repository for which the objects must be listed.
• file; this mandatory parameter describes the (mandatory) name of the output file. Into this file the XML listing of the objects is written.
• path; this parameter is optional. If given, it restricts the objects listed to those that reside under the given folder path in the project. To restrict the output to Text Blocks, specify "Text Blocks" as path; to restrict the output to a specific Text Block folder, make sure the path starts with "Text Blocks". Likewise, output can be restricted to Content Wizards by specifying a path beginning with "Content Wizards".
• server.host and server.port point out which server to connect to. These parameters are optional, if not specified the API will try to connect to the server on localhost:2586.
• cfg; this parameter optionally specifies a configuration file to read. If omitted, the program will try to read listobjects.ini, if it exists. To be found, the file listobjects.ini should reside in the same directory as the listobjects.exe program, or its path should be included in the name.
• level; this parameter specifies a minimal level of revisions, each object that has got such a revision or a revision in a higher level will be listed. The parameter is optional, if not specified the compatibility option is set to "Handle accepted revisions as published", just the accepted revisions will be listed, otherwise just the published revisions.
• user; this parameter is only necessary, if you want to list the development revision. For this the user is needed that locked the required objects.

You can also specify these parameters, all or in part, in a configuration file, by default in the file listobjects.ini. If the parameter cfg is not present on the command line, the program will automatically read the file listobjects.ini if it exists in the same directory as the listobjects.exe. Parameters on the command line will always have priority over parameters specified in a configuration file. This file should look like:

[Configuration]

project=<project name>

path=<path in project>

file=<output xml file>

level=<required revision level>

user=<required user for development revision>

[Server]

host=<server host name>

port=<server port>

Invocation examples:

listmodels /project="my project" /file=output.xml

listmodels /project="another project" /path="text blocks" /file=textblocks.xml

listmodels /project="my project" /path="model docs\invoices" /file=models.xml

listmodels /project="my project" /file=output.xml /cfg=itprep.ini

listmodels /project="my project" /file=output.xml /server.host=server01

listmodels /project="my project" /file=output.xml /level=accepted

listmodels /project="my project" /file=output.xml /level=development /user=jane