logPublisher

The logPublisher task adds a log as a contribution to a build result. Log contributions are displayed on the Logs page of the build result editor.

The following table contains logPublisher task attributes.

Attribute Description Required

buildResultUUID

The UUID of the build result to update. The value of this attribute is typically ${buildResultUUID} because the property is built-in when using the Jazz™ Build Engine.

Yes

filePath

For tasks that need an input file, specifies the path to a file. It can be an absolute path or a path relative to the base directory of the build file.

Yes

label

The label for the build result contribution.

Yes

repositoryAddress

Address of the team repository to use. The value of this attribute is typically ${repositoryAddress} because that property is built-in when using the Jazz Build Engine.

Yes

userId

User ID for authentication to the repository. Requires password or passwordFile to be set.

Yes

certificateFile

The path to the file that contains the user's login certificate for authentication. Requires password or passwordFile to be set. You can specify certificateFile or repositoriesFile, but not both.

No

characterEncoding

The character encoding used in the artifact file. It must be an IANA-compliant name. Defaults to the default encoding of the current platform. For more information, see IANA List of Character Set Names.

No

componentName

The name of the component to which this contribution applies. Used for grouping in the user interface.

No

contentType

For the logPublisher task, the MIME content type of the artifact. If not specified, it is derived from the file extension. For an unknown file extension, text/plain is used.

No

failOnError

If true (the default), the task fails if it encounters an error. If false, some errors are ignored and the task is completed.

No

integratedWindows

Whether to use Integrated Windows Authentication

No

kerberos

Whether to use Windows user credentials using Kerberos/SPNeGO.

No

password

Password for the user ID for authentication to the repository. Either password or passwordFile can be provided, but not both.

No

passwordFile

The password file to use for authentication to the connection. You can create a suitable password file by invoking the Jazz Build Engine with the -createPasswordFile argument. You can only specify one password file. Either password or passwordFile can be provided, but not both.

No

repositoriesFile

The repositories registry file containing a listing of repositories and their login credentials. You can specify repositoriesFile or certificateFile, but not both. If you specify repositoriesFile, do not specify either password or passwordFile. The repositories file is created and updated through the use of scm login and logout commands.

No

reuseLoginOption

The first time an Ant task logs in to a repository, a connection is not terminated at the end of this task. All subsequent tasks reuse this connection as long as they connect to same repository with same user ID. When a task logs in to a different repository or with a different user ID, the previous connection is terminated and a new connection is created and reused.

No

smartCard

Whether to use the connected smart card for authentication (true or false). Requires userId to be set. For more information about smart card authentication, see Connecting to repositories and project areas.

No

status

The status of the contribution. Must be one of the following: OK, ERROR, WARNING, or INFO.

No

verbose

Specifies more message output. The default is false.

No

Example

<logPublisher repositoryAddress="${repositoryAddress}"
		              userId="${userId}"
		              password="${password}"
		              buildResultUUID="${buildResultUUID}"
		              filePath="log.txt"
		              label="a log" />

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki