Skip to main content

Version: 21.11

lib-export

The lib-export task exports a Maestro organization or project library from a Maestro server.

Support

lib-export was introduced in Transact Maestro 18.05, and continues to be available in later Journey Maestro releases.

Task Attrbutes

All attributes are optional unless otherwise indicated.

AttributeDescription
urlString

Required. The Maestro server URL.

usernameString

Required. The Maestro server username.

passwordString

Required. The Maestro server user's password.

clientCodeString

Required. The client code.

projectNameString

The Maestro project name.

Required if exporting a project library.

libraryNameString

Required. The Maestro library name.

versionNumberString

Required. The Maestro library version.

For general information about version numbers, see Version Attributes.

fileString

The file path to export the library to.

Note: Either file or dir must be specified.

dirString

The directory path to export the library into.

Note: Either dir or file must be specified.

TM Security

To use this task, the user specified by username needs an active user account on the TM server with access to the Management Console module.

To be authorized to call the service, the user account also needs the Management Console permission "SCM Org Library View" or "SCM Project Library View".

If the user is not a global administrator, only services belonging to the organizations assigned to the user will be accessible.

Example

The example Ant task below exports a project library.

<lib-export url="https://form.mycorp.com/maestro/"
username="[email protected]"
password="password"
clientCode="maguire"
projectName="Credit Card"
libraryName="Exchange Core Lib"
versionNumber="1.0.0"
file="target/exhange-core-lib-v1.0.0.zip" />

Example Ant log output:

lib-export:
[lib-export] Http client: created.
[lib-export] Library is successfully exported: target/exhange-core-lib-v1.0.0.zip
BUILD SUCCESSFUL
Total time: 1 second