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 v2 | 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:
![]()
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. 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. |
OSLC.propertiesSupported | true, false | When set to false, the REST v2 data provider does not honor native properties used in a template. |
OSLC.selectSupported | true, false | When set to false, the REST v2 data provider does not honor native selections used in a template. |
OSLC.whereSupported | true, false | When set to false, the REST v2 data provider does not honor native filters used in a template. |
OSLC.orderBySupported | true, false | When set to false, the REST v2 data provider does not honor native sorts used in a template. |
OSLC.pageSize | When set to false, the REST v2 data provider does not honor the native page size used in a template. | |
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. |