- Created by Robert Reiner, last modified on 02. Oct 2016
projectdoc Toolbox
Render links to jobs and services on a Hudson server.
- Categories
- Tags
- Iteration
- Deprecated
- Extension
- Since
- 1.0
Description
Deprecated since 1.0
Replace the macro with the System Link Macro and the use of placeholders with space properties.
Due to the use of placeholders the URL is no longer required to be divided into reusable parts by the macro.
In version 1.0 the macro is still part of the add-on, but already disabled.
The macro renders a link to a job on a Hudson server.
Its purpose is to specify the reference to the Hudson server at one place (as a Confluence shortcut or space property) and reuse this URL throughout the usage of this macro.
Since projectdoc Toolbox version 1.11 this macro is part of the Information Systems Extension. Prior to that version the macro has been part of the projectdoc Toolbox.
The Since attribute above refers to the version of the extension, not to the version of the projectdoc Toolbox.
Properties
System Identifier
Identifies the connection information via Confluence shortcuts or space properties.
Defaults to hudson
.
The system identifier is checked at three locations
Typically do not change the system identifier provided by the macro (if one is specified). Keep the default value of 'hudson
' as long as you do not need to reference multiple server of the same type in one space. Then set the space property to reference the specific server accordingly. This makes it easier to create new links to artifacts since the system identifier need not to be changed.
The search for the system connection information is conducted as follows. Use the URI discovered first to connect to the server.
- Check for a space property
url-hudson
- Check for a space property
hudson
Only available with projectdoc Toolbox version 1.11 and up! - Check for a space property
shortcut-id-
.hudson
Lookup the connection information from the shortcut links with the value retrieved from the space property. - Check the shortcut links for a value
hudson
. - Check application navigator for a value
hudson
.
If no value is specified at any of the locations above, the macro renders an error message like this:
In this example for a system macro the referenced, but undefined system, is called test-repo
.
Job
The name of the Hudson job as rendered in the URL to the job.
Defaults to the space property 'Project Artifact ID'.
If your server is at
https://www.example.com/hudson
and the job to reference is my-project
, the following URL will be constructed:
https://www.example.com/hudson/job/my-project
Subordinate Service
The subordinate service within the job. Appended to the URL containing the base URI, the job and the subservice.
Hudson provides services for jobs. One is the dependency graph that renders the project dependencies graphically. The subservice is that part of the URL that is appended to the URL to the job on the Hudson server. In the example of the dependency graph the URL fragment is depgraph-view
. The complete URL with Subordinate Service property set to the URL fragment depgraph-view
is therefore:
https://www.example.com/hudson/job/my-project/depgraph-view
Label
The label for the link. Defaults to the name of the job, if not explicitly specified.
Related macros
The following macros help with referencing resources on other information servers:
- Enterprise Architect Image Link Macro
- Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
- HTML Snippet Macro
- Transclude HTML content from a remote server.
- Javadoc Link Macro
- Links API documentation pages for Java elements.
- Nexus Link Macro
- Renders a link to an artifact stored on a Nexus server.
- Site Link Macro
- Links to a resource on a versioned site.
- Sonar Link Macro
- Renders a link to a project on a Sonar service.
- Subversion Link Macro
- Renders a link to a resource on a Subversion (SVN) repository.
- Subversion Transclusion Macro
- Transcludes a snippet from a project on a Subversion (SVN) server.
- System Image Link Macro
- Renders an image transcluded from a remote server.
- System Link Macro
- Links to a resource on a server.
- System Transclusion Macro
- Transclude content from a resource from a remote system.
- Text Snippet Macro
- Transclude text content from a remote server.