Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 2.5.19 / 2.6.11.

This routine is available for Jira server and cloud deployment options.

Syntax

admAddCustomFieldAlias(customField, alias)

Description

Adds a custom field alias in the sil.aliases file.

Parameters

Parameter name

Type

Required

Description

customFieldstringyesCustom field string id, name or existing alias.
aliasstringyesNew custom field alias to set.

Return type

boolean

Returns 'true' if the custom field alias was added successfully in the sil.aliases file or already exists and 'false' otherwise.

Example

Example 1

Setting a custom field alias using custom field id:

admAddCustomFieldAlias("customfield_10000", "TestAlias");

Example 2

Setting a custom field alias using custom field name:

admAddCustomFieldAlias("Text Field", "TestAlias");

See also