getInput
- Alexandra Topoloaga (Unlicensed)
- Jonathan Muse
- Elena Kolesnik
- Admin Adminovich (Deactivated)
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 !
Availability
This routine is available starting with SIL Engine™ 4.0.16
Syntax
getInput(customfield_id)
or
getInput(keyword)
Make sure that a transition screen has been attached to the current transition.
Description
Gets the value of a field in the transition screen. Should only be used in transitions that require a screen.
The routine handles transient values, therefore it will work correctly only if an interval is called starting from the moment the user clicks the Submit button on the transition screen up to the point when the issue is saved in the database. Therefore we can define the valid scope for the routine to be validators and certain post-functions. It means that you will not be able to use it in conditions, SIL services, SIL listeners nor from the SIL Gadget.
When used in post-functions this routine works in SIL post functions that run before the routines that save the issue in the database. The latter are default Jira post-functions that can be easily recognized by their name, for instance "Update change history for an issue and store the issue in the database", for a regular transition "Creates the issue originally", for the "Create Issue" transition, and so on.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
customfield_id/keyword | string | Yes | Id of the custom field (customfield_id) or the specific keyword for the standard fields. |
Return type
string
The value of the field in the transition screen.
Examples
Example 1 - checking whether a certain custom field has a given value
return getInput("customfield_12003") == "abc";
Checks if the value set in the transition screen for customfield_12003 is "abc".
Example 2 - getting the comment a ticket has on a transition screen
getInput("comment");
Returns the value the Comment field has set.
Notes
Custom fields must be referenced by id (customfield_id), while standard fields can be specified by one of the following keywords: summary, timetracking, security, attachment, reporter, environment, description, duedate. You can also check the Comment field, using the keyword comment.
See also