lfInstantHook
Availability
This routine is available starting with
- Power Scripts 2.5.6 (for Jira 5.x) and 2.6.1 (for Jira 6.x)
- katl-commons 2.5.8 (for Jira 5.x) and 2.6.1 (for Jira 6.x)
Syntax
lfInstantHook(relatedFields, scriptPath);
Description
Executes the given SIL script passing the screen values for the specified dependent fields (relatedFields) as parameters to the script.This is especially useful in the create issue screen, where you don't have access to the issue standard variables. Using an instant hook, you can access the screen values for the desired fields as argv["field"] in the hook script.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| relatedFields | String Array | Yes | Dependent fields required for the given field (needed only if you get the field's values from the screen like this: argv["field"]) |
| scriptPath | String | Yes | Script source to run when the event is triggered |
Example
lfInstantHook({"summary", "customfield_13706", "components"}, " hook.sil");
For the scriptPath parameter you can either give the relative path (as in the example above) or the absolute path:
C:/Program Files/Atlassian/Application Data/JIRA/silprograms/hook.sil.
// hook.sil :
if (contains(argv["summary"], "important")) {
lfSet("priority", "Highest");
lfShowFieldMessage("priority", "Priority changed", "INFO");
}
Every time when the initial script is triggered, the hook.sil is executed. When the summary field contains the word “important”, the Priority field is set to "Highest" and a message will be displayed for the Priority field.
The first image shows the initial value of the priority for the current issue, the next one shows the value it is changed to, after executing the code from hook.sil.
The values from the relatedFields are accessed as argv[field]. For multiple values fields like components or affectedVersions, the value returned is in the following format: val1|val2|val3.
Info
For more information, see How Live Fields work.
See also