REST v1 data source properties reference

Open the Properties view in the Launcher application and select a REST v1 data source. The Properties view displays these available properties for REST v1 data sources.
Type Value Description
Name String Required. The title of the schema as entered in Document Studio. You cannot edit this field in this view.
Description String Required. The explanation of how the schema is used as entered in Document Studio. You cannot edit this field in this view.
Type REST Required. The schema type. You cannot edit this field in this view.
Configuration required none, uri, credentials, full, hidden Optional. Default value: uri

You cannot edit this value in this view. Property set in the template which specifies which configurations are necessary when launching the document 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 required to be configured to generate the document.
  • credentials: Only the credentials to authenticate with the data provider are required to generate the document.
  • full: The data source must be configured and credentials must be given to generate the document.
  • hidden: The data source does not display in the Launcher so that the template settings cannot be overridden.
Important: When only user names are required for authentication and passwords are not required, do not use full or credentials

For more information about how user names and passwords are stored, see Security considerations for IBM® Rational® Publishing Engine.

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, documents 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 Required. The path to the data source resource. Example: http://server:port/DataServices/path
Username String Optional. User name to login into the data source application. If there are authentication errors and the Ignore data source configuration errors property is set to true, the document generation continues. If there are authentication errors and the Ignore data source configuration errors property is set to false, the document generation cancels. See Run time metadata properties reference for more information about the Ignore data source configuration errors property.

For more information about how user names and passwords are stored, see Security considerations for IBM Rational Publishing Engine.

Password String Optional. Password to login into the data source application. If there are authentication errors and the Ignore data source configuration errors property is set to true, the document generation continues. If there are authentication errors and the Ignore data source configuration errors property is set to false, the document generation cancels. See Run time metadata properties reference for more information about the Ignore data source configuration errors property.

For more information about how user names and passwords are stored, see Security considerations for IBM Rational Publishing Engine.

Authentication auto, basic, form, oauth, oauth-oslc Optional. 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 and then cached as the authentication type setting for future connections within a current document generation. For subsequent document generation, even when running in the same Launcher or Document Studio instance, the initial auto connection repeats the process by once again testing each type to find and cache the correct type.

If there are authentication errors and the Ignore data source configuration errors property is set to true, the document generation continues. If there are authentication errors and the Ignore data source configuration errors property is set to false, the document generation cancels. See Run time metadata properties reference for more information about the Ignore data source configuration errors property.

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

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


Feedback