Managing data sources in Publishing Document Builder

As an administrator or report designer, you can add and edit data sources for Document Builder. For example, you can update the password that is required to connect to a data source, set an authentication method, or specify a new location for a data source.

1. On the Assets tab, click the Connections tab.
2. Click Add Connection.
3. Enter a Title for the data source.
4. Enter a Description for the data source.
5. In the URL field, specify the URL for the resource or click Select.
   Note:

   To select artifacts from a specific configuration, first set Global Configuration (GC) URL in the configuration context. Then, select an artifact by using resource picker, else the resource picker displays the contents from a default stream of the selected project area.

   1. In Select Connection URL window, complete the following fields and click GO.
      • Enter the Host IP address, port, and context root in Host Details field.
        Note: If the Publishing Document Builder is registered with a Jazz® Team Server (JTS), then the JTS Server name is pre-populated in the host details field.
      • Select the common providers from the list.
      • Select the service catalog from the list. To select the RM artifact as in the URI property, select the oslc_rm option. To select configuration, as in the Configuration-Context property, select the oslc_config option.
      • Select the service provider from the list.
      • Select the selection dialog from the list.
      • Select the configuration from the list.
   2. In Enter credentials for Connection pop-up window, select the Authentication Method from the following list, enter your credentials, and click OK.
      • Auto
      • Basic
      • Form
      • OAuth
      • OAuth-OSLC
      • SSL Certificate
      An embedded web browser displays the OSLC delegated dialog box for you to select the resource.
   3. Select a resource from the list and click OK.
      The URL is now displayed in URL field. Further URL modification is not needed.

   For more information, see the video Resource picker and Simplified connection association.

6. If you want to generate documents for different configurations, see Setting up a data source to generate documents about configurations.
7. If you specify the URL for the resource in URL field, select the Authentication Method from the list and enter your credentials:
   • Auto
   • Basic
   • Form
   • OAuth
   • OAuth-OSLC
   • SSL Certificate: If you choose SSL Certificate, click the + sign to add a certificate. In the Upload Certificate window, enter the certificate title, select the certificate, and click Upload. These certificates are private and user-specific.

   Note:

   • If you select the URL for the resource using Select Connection URL window, the Authentication Method and your credentials are populated.
   • If you are generating a document using JTS authenticated session, user credentials are not needed, and the Authentication Method must be set to Auto.
8. Enter any cookie properties.
9. If needed, enter an accept type for providing the data in Accept header field.
   Examples:

   • image/jpeg
   • text/html
   • application/xml
   • */*
10. If needed, select the POX profile header from Extra headers field. For more information, see Data source configuration element properties.
    Note: If you select the URL for the resource using Select Connection URL window, the Extra headers field is populated with Pox profile.
11. If you are connecting to IBM Engineering Requirements Management DOORS®(DOORS) , select the DOORS Details checkbox.
    1. Specify the DOORS View.
       Views contain a subset of the objects or attributes that are in the module.
    2. Specify the DOORS Baseline.
       Baselines are read-only versions of a module. A baseline captures and preserves a moment in time.
    3. Specify the DOORS data, for example -data port@doors_db_server.
    The DOORS client must be installed on the same server as the document generation service (dgaas.war). When document generation is triggered, the document generation service starts the DOORS client in batch mode, extracts data from DOORS through DXLs, and then shuts down the DOORS client.
12. Click Save.
13. You can also edit and delete data source connections in the Connections tab.

Results

The data source is shown in the list of data source connections that are used by reports. When you generate a document, you are prompted to specify the data source.