Show Scripted Field on Transition Screen

[DerekWilliamsGenscape]

I have a scripted field for which I need to display on a transition screen. The code will generate a <select> drop down based on another custom field value in the ticket. I am having trouble getting this field to appear on the transition screen.

I have followed this article with no success: https://scriptrunner.adaptavist.com/5.0.4/jira/scripted-fields.html#_displaying_script_fields_in_transition_screens

I know my code is working because the preview of the code is working just fine and displaying how I expect.

...

/*Redacted classes for brevity*/

def CreateOption(String OptionVersion, String OptionId) {
    return "<option value=\"${OptionId}\">${OptionVersion}</option>"
}

def CreateSelect(ops) {
    def temp = []
    ops.each {o -> temp.push(CreateOption(o.Version.toString()))}
    return "<select>${temp}</select>"
}

def issueManager = ComponentAccessor.getIssueManager()
def customFieldManager = ComponentAccessor.getCustomFieldManager()
def cField = customFieldManager.getCustomFieldObject("customfield_13154")
def cFieldValue = issue.getCustomFieldValue(cField)

OctopusAction o = new OctopusAction(OctopusServer);
def projName =  o.getProjectByName(cFieldValue.toString()).Id;
def releases = o.getAllReleases(projName).Items

def options = []
releases.each{r->
    options.push(CreateOption(r.Version.toString(), r.Id.toString()))
}
return "<select>${options}</select>"

[Scott Boisvert]

I know this is two years old, but is there a solution to this. My scripted field works fine on the view screen, but adding the javascript recommended by Adapatvist/ScriptRunner Scripted Fields just displays the script on the screen under the field I place it in.

[Joanna Choules]

Hi Scott,

Can you describe exactly where you're adding the JS?

[Scott Boisvert]

@Joanna Choules The script goes in the description of another field on the screen. The issue I was having though is that you have to have Allow HTML In Custom Field Descriptions enabled, it was disabled in our environment.

[Joanna Choules]

Hi Scott,

Thanks for letting me know. Did enabling that option resolve the issue for you?

[Scott Boisvert]

@Joanna Choules Yep it did.

[Ashraful Hasan [Adaptavist]]

Hi,

Please add the javascript code and also please confirm the JIRA and SR version? From the ticket I can see the version of JIRA is 7.6.1 and SR 5.2.2.

[DerekWilliamsGenscape]

yes that is correct. Here is the JS

<script type="text/javascript">
(function ($) {

    // ---------------------------------- MANDATORY CONFIG ----------------------------------
    var fieldName = "Octopus Release" // display name - does not have to match the name of the field
    var fieldId = "customfield_13154" // field Id
    // ---------------------------------- END MANDATORY CONFIG ------------------------------

    function addCalculatedField(e, context) {
        var $context = $(context);

        // if you want you can limit this to certain actions by checking to see if this value is in a list of action IDs
        if (!$("input[name='action']").val()) {
            return;
        }

        // multiple handlers can be added if you do an action, then cancel repeatedly
        if ($context.find("#scriptedfield_" + fieldId).length > 0) {
            return;
        }

        var issueKey = $("meta[name='ajs-issue-key']").attr("content");
        if (!issueKey) {
            issueKey = $("#key-val").attr("rel"); // transition screens in full page mode
        }

        var paddingTop = AJS.$("meta[name='ajs-build-number']").attr("content") < 6000 ? "1" : "5";

        var fieldGroupHtml = '<div class="field-group">' +
            '<label for="' + fieldId + '">' + fieldName + '</label>' +
            '<div style="padding-top: ' + paddingTop + 'px" id="scriptedfield_' + fieldId + '"> ' +
            '<span class="aui-icon aui-icon-wait">Loading, please wait</span></div>' +
            '</div> ';

        // Modify this select if you want to change the positioning of the displayed field
        $context.find("div.field-group:first").before(fieldGroupHtml);

        $.ajax({
            type: "GET",
            "contentType": "application/json",
            url: AJS.params.baseURL + "/rest/api/2/issue/" + issueKey + "?expand=renderedFields&fields=" + fieldId,
            success: function (data) {
                if ("fields" in data && fieldId in data.fields) {
                    var fieldValue = data.fields[fieldId];
                    $context.find("#scriptedfield_" + fieldId).empty().append(fieldValue);
                }
                else {
                    $context.find("#scriptedfield_" + fieldId).empty().append("ERROR - bad field ID");
                }
            },
            error: function () {
                $context.find("#scriptedfield_" + fieldId).empty().append("ERROR");
            }
        });
    }

    JIRA.bind(JIRA.Events.NEW_CONTENT_ADDED, function (e, context) {
        addCalculatedField(e, context);
    });

})(AJS.$);
</script> 

[DerekWilliamsGenscape]

So my comment disappeared....Those versions are correct. Here is the JS

<script type="text/javascript">
(function ($) {

    // ---------------------------------- MANDATORY CONFIG ----------------------------------
    var fieldName = "Octopus Release" // display name - does not have to match the name of the field
    var fieldId = "customfield_13154" // field Id
    // ---------------------------------- END MANDATORY CONFIG ------------------------------

    function addCalculatedField(e, context) {
        var $context = $(context);

        // if you want you can limit this to certain actions by checking to see if this value is in a list of action IDs
        if (!$("input[name='action']").val()) {
            return;
        }

        // multiple handlers can be added if you do an action, then cancel repeatedly
        if ($context.find("#scriptedfield_" + fieldId).length > 0) {
            return;
        }

        var issueKey = $("meta[name='ajs-issue-key']").attr("content");
        if (!issueKey) {
            issueKey = $("#key-val").attr("rel"); // transition screens in full page mode
        }

        var paddingTop = AJS.$("meta[name='ajs-build-number']").attr("content") < 6000 ? "1" : "5";

        var fieldGroupHtml = '<div class="field-group">' +
            '<label for="' + fieldId + '">' + fieldName + '</label>' +
            '<div style="padding-top: ' + paddingTop + 'px" id="scriptedfield_' + fieldId + '"> ' +
            '<span class="aui-icon aui-icon-wait">Loading, please wait</span></div>' +
            '</div> ';

        // Modify this select if you want to change the positioning of the displayed field
        $context.find("div.field-group:first").before(fieldGroupHtml);

        $.ajax({
            type: "GET",
            "contentType": "application/json",
            url: AJS.params.baseURL + "/rest/api/2/issue/" + issueKey + "?expand=renderedFields&fields=" + fieldId,
            success: function (data) {
                if ("fields" in data && fieldId in data.fields) {
                    var fieldValue = data.fields[fieldId];
                    $context.find("#scriptedfield_" + fieldId).empty().append(fieldValue);
                }
                else {
                    $context.find("#scriptedfield_" + fieldId).empty().append("ERROR - bad field ID");
                }
            },
            error: function () {
                $context.find("#scriptedfield_" + fieldId).empty().append("ERROR");
            }
        });
    }

    JIRA.bind(JIRA.Events.NEW_CONTENT_ADDED, function (e, context) {
        addCalculatedField(e, context);
    });

})(AJS.$);
</script>

[Joanna Choules]

Hi Derek,

What previewing functionality did you use to check that the code was working? I believe you should only need to add the code to the description of one of the fields that appears on the appropriate screen.

[DerekWilliamsGenscape]

I would just preview by returning a select option. However, if I add the javascript to the description field of the context, nothing shows up. Note there is not a description field of the scripted field. If one exists it is not called description.

[DerekWilliamsGenscape]

Any thoughts here? I am frustrated with this platform.

[Sandor Mathe]

Hello,

Is there a resolution for this problem? I encountered the same issue...

[DerekWilliamsGenscape]

For more detail, it does not appear that I can even get the blank custom field to show on transition screens. I have pasted the Javascript code in every single 'description' field (citation the article) that I can find as it related to field configurations.

[Natalie Al-Delemi]

I know this is a few years old question, but you will need:

1- Make sure HTML is enabled on custom fields in system general configuration

2- paste the script in description of the other field that controls the value of the scripted field. 

3- Make sure the field ID is correct in the script.

you will then see that it works.. It worked for me