Managing Data Service Parameters
A controls whether each of the data service is visible to and configurable by Designers, and a controls which parameters are visible to a . For example, a Data Service Administrator can include a query when configuring a JDBC data service and conceal the query from Designers. Alternatively, a Data Service Administrator can allow Designers to configure the query when they create Database data sources that use the JDBC data service.
Depending on how it is configured, a built-in parameter can be managed by a Data Service Administrator as part of the data service, or by a Designer when configuring data sources. Similarly, a custom parameter can be created and managed by a Data Service Administrator, created by a Data Service Administrator but managed by Designers, or created and managed by a Designer.
Note: Custom parameters are available only for JDBC data services and Database data sources. Built-in parameters are available for all types of data services.
Note: Parameters in Link data services can only be managed by a Data Service Administrator and are not displayed to Designers.
A parameter managed by a Data Service Administrator
If a built-in parameter or a custom parameter is configured to be managed by the Data Service Administrator, the following are the consequences for Data Service Administrators and Designers.
Tip: This approach is suggested for any parameter that should not be customized by Designers or incorporated into a form for use by Data Providers. This approach is not recommended for any parameter for which Data Providers are expected to enter data because Designers will not be able to see the parameter to incorporate it into a form.
Note: This approach is required for parameters in Link data services.
The Data Service Administrator must perform the following tasks in the data service that contains the parameter:
- Create the parameter if it is a custom parameter.
- Clear the Is Parameter check box for the parameter so that the parameter is not configurable in data sources. This step is unnecessary for a parameter in a Link data service.
- Configure a value for the parameter or connect it to a data source.
Designers experience the following behavior when using data sources containing a parameter managed by a Data Service Administrator:
- The parameter is not displayed to Designers when configuring a data source associated with the data service containing the parameter.
- If the parameter was added to the data service after a data source was created, the parameter is automatically added to the existing data source even though the parameter is not displayed.
- If the parameter is changed by the Data Service Administrator, the parameter is automatically updated in existing data sources even though the parameter is not displayed. If a parameter in a Link data service is changed, JDBC data services associated with the Link data service and Database data sources associated with those JDBC data services automatically reflect that change.
- If a custom parameter is deleted by the Data Service Administrator, the parameter is automatically removed from associated data sources. If the deleted parameter was incorporated into the input of another parameter, this may cause associated data sources to fail until that dependency is eliminated. If the parameter with the dependency is managed by the Designer, then a Designer must remove the dependency from each associated data source to prevent problems in existing data sources, and the Data Service Administrator must remove the dependency from the data service to prevent problems in new data sources.
A parameter managed, but not created, by a Designer
If a built-in parameter or a custom parameter created by the Data Service Administrator is configured to be managed by the Designer, the following are the consequences for Data Service Administrators and Designers.
The Data Service Administrator must perform the following tasks in the data service that contains the parameter:
- Create the parameter if it is a custom parameter.
- Select the Is Parameter check box for the parameter so that it is configurable in data sources.
- May configure an initial value for the parameter or connect it to a data source.
Designers experience the following behavior when using data sources containing a parameter managed, but not created by, a Designer:
- The parameter is displayed to Designers when configuring a data source associated with this data service.
- If the parameter was added to the data service after a data source was created, the parameter is not added to the existing data source.
- If the Data Service Administrator makes changes to the value of the parameter in the data service, the value of the parameter is not changed in existing data sources.
- If the Data Service Administrator deletes a custom parameter in the data service, that parameter is automatically removed from associated data sources.
- If the parameter includes in its input any parameters that are managed only in the data service, changes to those other parameters will affect it.
A parameter created and managed by a Designer
If a custom parameter is created and configured to be managed by the Designer, the following are the consequences for Data Service Administrators and Designers.
Note: This approach is available only for parameters in a Database data source.
When the Data Service Administrator configures the data service, the parameter is not displayed in the data service.
The Designer must perform the following tasks when configuring a data source if the Designer intends to create a custom parameter:
- Create the custom parameter.
- Configure a value for the parameter or connect it to a data source.
Designers experience the following behavior when using a parameter created in a Database data source by a Designer:
- The parameter is displayed to Designers when configuring a data source.
- If a Designer creates another data source associated with the same data service, the parameter is not included in the second data source. If a Designer creates an identical parameter in the second data source, that parameter must be managed independently of the parameter in the first data source. Changing one of these parameters has no effect on the other.
- If the parameter includes in its input any parameters that are managed only in the data service, changes to those other parameters will affect it.