Skip to main content

Version: 21.05

lib-import

The lib-import task imports a Maestro organization or project library to a Maestro server.

Support

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

Task Attributes

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 importing a project library.

libraryNameString

The Maestro library name.

If specified, overrides the value in the library's manifest.

versionNumberString

The Maestro library version.

If specified, overrides the value in the library's manifest.

fileString

The file path to library for import.

Note: Either file or dir must be specified.

dirString

The dir path to library dir for import.

Note: Either dir or file must be specified.

mergeString

If true and the import updates an existing library, the imported library files are merged with the existing library.

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 Add", "SCM Project Library Edit", "SCM Project Library Add" or "SCM Project Library Edit".

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 imports a project library.

<lib-import 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-import:
[lib-import] Http client: created.
[lib-import] Response: HTTP/1.1 200 OK
[lib-import] Response: {
[lib-import] "name": "Exchange Core Lib",
[lib-import] "type": "Project",
[lib-import] "createdAt": "Apr 19, 2018 1:12:58 PM",
[lib-import] "createdBy": "administrator",
[lib-import] "versionNumber": "1.0.0",
[lib-import] "clientId": 1,
[lib-import] "projectId": 1
[lib-import] "id": 5
[lib-import] }
BUILD SUCCESSFUL
Total time: 1 second