hasInput

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™ 1.0.

Syntax

hasInput(customfield_id)
or
hasInput(keyword)


Make sure that a transition screen has been attached to the current transition.

Description

Verifies if a field had input in the transition screen. Should only be used in transitions that require a screen.

  

This routine has a very limited working scope. Since it handles transient values, it will work correct 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.

While using in post functions this routine will work 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

boolean (true/false)

A "true" return value means that the specified field had input in the transition screen.

Examples

Example 1 - checking whether a certain custom field has any value

hasInput("customfield_12003");

Returns "true" if the customfield_12003 contains a value and "false" if the customfield_12003 is empty.

Example 2 - checking whether a ticket has comments

hasInput("comment");

Returns "true" if the Comment field contains a value and "false" if the Comment field is empty.

Example 3 - checking whether time was logged against a ticket

The following line will check whether a Time Spent field was filled out for a ticket during the transition (on the transition screen). This is useful for cases when you want to make sure that users log time when they resolve tickets.

hasInput("worklog");

If you want to show a warning under the Time Spent field for cases when the worklog wasn't entered for a ticket, consider using the following lines in the workflow validator.

return false, "worklog_timeLogged", "<error message>"; 

In addition you can use the isNull(timeSpent) routine to check whether the time was logged against the ticket before the transition.

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.

The timetracking fields have different internal naming in this case, so you'll have to use the next mapping:

FieldKey
estimatetimetracking_originalestimate
originalEstimatetimetracking_remainingestimate
worklog start dateworklog_startDate
worklog time logged
worklog_timeLogged

See also