Availability
This routine is available starting with SIL Engine™ 4.8.0.8.
Syntax
admAppendProjectToCustomFieldConfigurationScheme(fieldName, existingProjectKey, projectKeyToAppend, ignoreExistingContextScheme)
Description
Appends a project to an existing Configuration Scheme of a Custom field for a given project.
The given project should already have a configuration.
The project key to be appended should not belong to any config for that field.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| fieldName | string | Yes | Name custom field id that has a field configuration. |
| existingProjectKey | string | Yes | The project that appears in one of the the custom field configurations, for the given custom field. |
| projectKeyToAppend | string | Yes | The project that does not appear in any configuration for the given custom field, and will be appended to the configuration where the existingProjectKey appears. |
| ignoreExistingContextScheme | boolean | Yes | If this flag is set to false, and there is already a configuration for the given custom field/project pair, the project will not be added to the config for the existingProjectKey. If this flag is set to true, and a configuration for the project already exists, the project will be moved from it's current scheme to the existingProjectKey config scheme. |
Return type
boolean (true/false)
Returns 'true' if the project was added to the list of projects in the field configuration that already contains the existingProjectKey.
Examples
Example 1 - Adding a project to a custom field configuration
Example 1: The following line of code will add (append) project "PRJ2" to the custom field configuration for the "CF_CASCADE" field that contains the "PRJ1" project key.
admAppendProjectToCustomFieldConfigurationScheme("CF_CASCADE", "PRJ1", "PRJ2", true);
Result:
See also