Fields and graphic elements supported by Live Fields

Looking for the documentation on the newest versions of Power Scripts for Jira 8 for Server/Data Center? Click here !

Contents

Standard Jira fields supported by live fields

You use the following fields in Live Fields routines with the key indicated in the Usage column of the table.

FieldExplanationUsage
ProjectThe project name for the issue. Available for v. 2.6.1 (for Jira 6.x) and aboveproject
SummaryThe summary field of the issuesummary
TypeThe issue type fieldissueType
PriorityThe priority field of the issuepriority
StatusThe status field of the issuestatus
ResolutionThe resolution field of the issueresolution
Affects Version/sThe affected versions field of the issueaffectedVersions
Fix Version/sThe fix versions field of the issuefixVersions
Security Level
The security level field of the issuesecurity
Component/sThe component field of the issuecomponents
LabelsThe labels field of the issuelabels
EnvironmentThe environment field of the issueenvironment
DescriptionThe description field of the issuedescription
AssigneeThe assignee field of the issueassignee
ReporterThe reporter field of the issuereporter
DueThe due date field of the issuedueDate
CreatedThe created field of the issuecreated
UpdatedThe updated field of the issueupdated
ResolvedThe resolved field of the issueresolved
EstimatedThe issue original estimateoriginalEstimate
RemainingThe issue remaining estimateestimate
LoggedThe issue time spenttimeSpent
VotesThe vote field of the issuevotes
WatchersThe watchers field of the issuewatchers
Edit SubmitSubmit button from the Edit screeneditSubmit
Transition SubmitSubmit buttons on the Transition screenstransitionSubmit
CancelCancel link from the Edit, Transition, or Create screencancel
Create Issue Submit

Submit button from Create Issue screen (pop-up screen/ JSD Customer Portal)1

createIssueSubmit
Issue Create Submit

Submit button from the Create Issue screen (with the Transition screen)1

issueCreateSubmit
Attach Files
  • Attach Files drop-down item from the More button on the View screen of an issue2
  • Drag and drop from all screens of an issue2
attachFiles
Attach Screenshot

The Attach Screenshot drop-down item from button More from the view screen of an issue2

attachScreenshot
Delete attachments

The Delete icon from the View screen of an issue and from the Manage Attachments screen2

deleteAttachment
Attachments

The Attachments module from the view screen of an issue2

attachments
Add Attachments

The Add Attachments icon from the view screen of an issue2

addAttachments
Manage Attachments

The Manage Attachments drop-down item from Attachments module2

manageAttachments
Viewable by

The Viewable By option of the Comment field from View, Edit, Transition screens.

Available since v. 3.0.8 (for Jira 6.x).

viewable_by
Configure Fields

The Configure Fields button from the Edit Issue screen.

configureFields

1Available for v. 3.0.3 (for Jira 6.x) and above

2Available for v. 3.0.5 (for Jira 6.x) and above

Some Live Fields routines can interact with other elements of the issue as well. Check out each routine's page to see any additional elements it can interact with.

Note

Create Issue Submit and Issue Create Submit - both fields are used for the Create button from the create screen.

  • If the button is accessed from an issue then it will appear in the Create Issue pop-up, and you have to use Create Issue Submit.
  • If the button is accessed from the Manage Add-ons screen for instance, it will first appear on a transition screen, so you have to access the Next button if you want to create a new issue. For such cases you need to use Issue Create Submit.

To control all Create Issue screens using live fields, you need to use both of these fields.

Note

The project field is supported only on the screens where the actual graphical field exists.

When it's value is accessed (with argv["project"]) on a screen where the field is not visible, the behavior is not defined. For example, the value can either be the project key, project name or empty.

Fields supported in the Customer Portal, since v 4.6

Starting with version 4.6 of Power Scripts for Jira, we support Live Fields in the Customer Portal also.

All the standard fields that exist in Jira but are also supported in the Customer Portal. These are: summary, description, environment, duedate, priority, components, labels.

We support Jira Service Desk Customer Portal specific fields. These are: Root cause, Workaround, Approvers, CAB, Change managers, Change risk, Change type, Impact, Investigation reason, Pending reason, Source, Urgency, Due date, Change completion date, Change start date, Time to die, Operational categorization, Product categorization. NOTE: These are basically custom fields defined by Jira Service Desk, so you can use their ids directly, like with any other custom field.

Additionally, we support all the custom fields like: CF Single Line Text, CF Multi Line Text, CF URL field etc. In order to apply a Live Fields routine to a custom field, you can choose to use either its id (eg: customfield_12345) or its name (as defined in the Jira Custom Fields admin page). This is to ensure a consistency in behavior for the same custom field can be included in multiple Customer Portal request types having different display names. This note applies also to standard fields (summary, description, etc).

Note that the "Raise a request" dialog/popup/iframe screen (accessible from the project's page in Jira) is not supported by Live Fields.



Example 1

For this example we will show you how you can use the lfHide function to hide the Estimated field. 

lfHide("originalEstimate"); //this will hide the estimated field

The image shows time tracking information before and after hiding the Estimated field.

Example 2

The following example shows how you can set the issue type using the lfSet function with Live Fields.

lfSet("issueType", "Task"); //this will set the issue type with the Task value

Jira custom fields supported by Live Fields

Live Fields also supports the following custom fields: 

  • Cascading Select
  • Date Picker
  • Date Time
  • Free Text Field
  • Group Picker
  • Labels
  • Multi Checkboxes
  • Multi Group Picker
  • Multi Select
  • Multi User Picker
  • Number Field
  • Project Picker
  • Radio Buttons
  • Select List
  • Single Version Picker
  • Text Field
  • URL Field
  • User Picker
  • Version Picker


Warning

When using a custom field name make sure you don't have more than one custom field with the same name. The action will apply only on the first created custom field.

Example

In the following example we show how you can hide a custom field using the lfHide function. Let's say you have a number field custom field named count. The custom field id is 10100. 

lfHide("customfield_10100") //hide the custom field by its id
lfHide("count") //hide the custom field by its name

Info

You can also use aliases to apply actions to custom fields.

Events

Watching events seems simple (check lfWatch routine). But what exactly are the events? The answer to that is actually very simple: all of them are JavaScript events. We decided to use them directly because of the following reasons:

  1. People already know these events
  2. We offer a broad range of events to watch on
  3. People might want to add additional JS to the page. Mixing them would mean that the programmer would have to mentally map events from Power Scripts to JS and the other way around. Try to avoid that.

What's next

Live Fields routines

See also

Live Fields support for Jira Software fields