Generic XML data source properties reference

Open the Properties view in the Launcher application and select a Generic XML data source. The Properties view displays these available properties for Generic XML data sources.

Type Value Description
Name String The title of the schema as entered in Document Studio. You cannot edit this field in this view.
Description String The explanation of how the schema is used as entered in Document Studio. You cannot edit this field in this view.
Type Generic XML The schema type. You cannot edit this field in this view.
Configuration required none, uri, credentials, full, hidden Default value: uri

You cannot edit this value in this view. Property set in the template, which specifies which configurations are necessary for starting the document-style report generation.

Restriction: New feature icon The Configuration required property is available only in version 2 templates.
  • none: No configuration is required from the report generator. If a data source is not configured, no warnings display at run time.
  • uri: Only the data source is needed to be configured to generate the document-style report.
  • credentials: Only the credentials to authenticate with the data provider are required to generate the document-style report.
  • full: The data source must be configured and credentials must be given to generate the document-style report.
  • hidden: The data source does not display in the Launcher so that the template settings cannot be overridden.
Important: When only usernames are required for authentication and passwords are not required, do not use full or credentials

For more information about how usernames and passwords are stored, see Security considerations for IBM Engineering Lifecycle Optimization - Publishing.

Driver eval Required. You cannot edit this field.
Default URI File path The path to the data source to use if a value for the URI property is not configured or accessible. If a value is provided for the Default URI, the data source displays as configured.
Allow read ahead true, false When set to true, document-style reports are permitted to be generated as configured by the Data read ahead run time metadata property, which determines the order that data sources are processed.
Note: Do not set Allow read ahead to true if a template includes native filters that have variable calculations for a data source.
URI File path The path to the data source resource. For Generic XML, the path is an absolute path to an XML file. Example: http://server:port/path/to/dataSource.xml
Username String Username to log in into the data source application. If authentication errors are there and the Ignore data source configuration errors property is set to true, the document-style report generation continues. If authentication errors are there and the Ignore data source configuration errors property is set to false, the document-style report generation cancels. For more information about the Ignore data source configuration errors property, see .

For more information about how usernames and passwords are stored, see Security considerations for IBM Engineering Lifecycle Optimization - Publishing.

Password String Password to log in into the data source application. If authentication errors are there and the Ignore data source configuration errors property is set to true, the document-style report generation continues. If authentication errors are there and the Ignore data source configuration errors property is set to false, the document-style report generation cancels. For more information about the Ignore data source configuration errors property, see .

For more information about how usernames and passwords are stored, see Security considerations for IBM Engineering Lifecycle Optimization - Publishing.

Authentication Method auto, basic, form, oauth, oauth-oslc,smart-card, ssl-certificate, Kerberos-SPNEGO Default value: auto

The authentication type for connecting to the data source. If no authentication type is specified, each type is tested until the correct type is found. This type is cached as the authentication type setting for future connections within a current document-style report generation. For subsequent document-style report generation, even when running in the same Launcher or Document Studio instance, the initial auto connection repeats the process by testing each type to find and cache the correct type.

If authentication errors are there and the Ignore data source configuration errors property is set to true, the document-style report generation continues. If authentication errors are there and the Ignore data source configuration errors property is set to false, the document-style report generation cancels. For more information about the Ignore data source configuration errors property, see Runtime metadata properties reference.

Accept header image/jpeg, text/html, application/xml, */* A specific type of resource that is retrieved from the data source.
Command String A script to run when the output is generated.
Ignored true, false Default value: false

Set to true to exclude a template from generating when you are running multiple templates from one document specification.