Add Extensible Data Sources (XDS) to bring a wide variety of tools into the
TeamForge project and traceability context.
XDS sources represent custom integrations built to interact with Orchestrate. XDS sources
may be configured to represent a wide range of tools and product domains, and provide a means
to integrate tools that do not fall under the stock activity classes (commit, build, review, and
work item). See Extending TeamForge Orchestrate for more on how XDS works.
-
From the activity stream, click Manage Sources.
-
Select the Custom toggle.
TeamForge Orchestrate displays all existing XDS (also known as "custom") sources.
You can choose to edit an existing source, or create a new custom source.
-
To edit an existing custom source, click Edit. You can edit the
display name, look and feel and tags. If you save an XDS source without defining the Associated
Source, you may edit the XDS source later and add an Associated Source. Once the Associated
Source has been defined it may not be altered.
-
To create a new XDS Source, click Add a new source.
-
Provide a display name for the XDS source that is depicted on all screens in
the TeamForge Orchestrate user interface. The display name can be up to 100
alphanumeric characters in length.
-
Select an icon and set the icon background color to differentiate your source
visually.
-
Select an Associated Source:
Select a source from the list of existing
sources.
TeamForge Orchestrate will associate activities from the XDS source
to the selected source. For instance, if you want the XDS source in
question to associate to builds from job XYZ, select the source
corresponding to job XYZ in the Associated Source drop down.
If you do not select an associated source, no associations will be drawn to the
activities coming from this XDS source.
-
Add tags to the Source as a means to organize and categorize XDS Sources. Tags
are particularly useful as filters for reporting via the Reporting API. Note that
tags are shared across the entire site; be careful not create superfluous tags
which may make reporting more difficult.
-
Copy the values for each of the four fields under "Adapter configuration". These values
will be used to configure any XDS adapter. For most source types,
TeamForge Orchestrate generates a unique "source association key". The
source association key uniquely identifies and helps route data from
sources to the
TeamForge
Orchestrate. You can copy the key by clicking on the small clipboard
icon.
-
Click Done to save.
TeamForge Orchestrate saves the new custom source, and activates it.