Add XDS Source to a Pipeline

You can configure an Extensible Data Source (XDS) for "Custom" steps in your pipeline.

1. Click the project name in the breadcrumb navigation.
2. Click Edit for your pipeline. If your pipeline has:
   • No steps — You see the "Manage Pipeline" page. Add one or more custom steps for your pipeline, then click on Save and Add Sources to navigate to the "Manage Sources" page.
   • One or more steps — You see the "Manage Sources" page. If you have one or more custom steps in your pipeline, you can now add or edit sources for your custom steps. If you have no custom steps, click Manage Pipeline. On the "Manage Pipeline" page, add one or more custom steps for your pipeline and then click on Save and Add Sources to navigate to the "Manage Sources" page.
3. Select the "Custom" step that you want to configure. TeamForge Orchestrate displays all the defined sources for a step, in the order in which they were defined.

You can choose to edit an existing source, or create a new source for this pipeline step.

4. 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.
5. To create a new XDS Source, click Add a new source.
   1. 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.
   2. Select an icon and set the icon background color to differentiate your source visually.
   3. Select an Associated Source:

      Select a source from the list of existing sources for your pipeline. 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.

   4. 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.
   5. Make note of 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 proper source/step/pipeline in TeamForge Orchestrate. You can copy the key by clicking on the small clipboard icon.
6. Click Done to save.

   TeamForge Orchestrate saves the new custom source, and activates it. At this point if the Schema has been registered for this type of integration (see Extending TeamForge Orchestrate for more details), Orchestrate will start processing activity messages.