Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

Info
titleAvailability

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

Syntax

admAddFieldToScreen(scrName, fieldAsStr)

...

Excerpt

Adds a field(custom field or system field) to a screen.

Parameters

Parameter name

Type

Required

Description

scrNamestringyes
The screen
Screen name.
fieldAsStrstringyes
The field
Field as a string(the field id for system fields, the field id as string, the field name or alias for custom fields).
scrTabNamestringno
The tab
Tab name(if not provided, the first tab will be used to add the field).
indexInTabnumberno
The position
Position in tab(if not provided, or -1, the field will be the last in the tab).

Return type

string

Returns 'true' if the field is successfully added to the screen , and 'false' otherwise.

Info

The method throws an exception if the screen name or field parameters are empty or don't refer to a valid screen/field. Also an exception is thrown if the field is already present presented in the screen.

If the tab name is provided and a tab with this name does't exist in the screen, it will be created and added as the last tab in the screen.

...