Boolean values (true/false) in multiplechoice survey fields cause 'n.trim is not a function' error and prevent template launch

[kakashiiMF]

Summary

When configuring job templates with surveys using the multiplechoice type for boolean fields (choices: [false, true]), editing or selecting the "false" option fails. This results in a JavaScript error in the Ansible Automation Platform (AAP) UI, auto-deselecting the option, and preventing the template from launching since the field is required. Selecting "true" works fine.

This issue occurs when using the infra.controller_configuration collection to manage AAP 2.4 configurations, likely during survey import or update via the roles.

Steps to Reproduce

1. Use the collection to create or update a job template with a survey spec like the one below (e.g., via the configure_controller role or similar).
2. In the AAP UI, navigate to the job template and attempt to launch it or edit the survey values.
3. Try to select "false" in the boolean multiplechoice field.
4. Observe the error in the browser console and the failure to launch.

Survey Spec (from API)

The problematic survey spec from /api/v2/job_templates/1669/survey_spec/:

{
    "name": "Inputs",
    "spec": [
        {
            "max": 0,
            "min": 0,
            "type": "multiplechoice",
            "choices": [
                "MSPF.IPS.CARDFALLBACK"
            ],
            "default": "",
            "required": true,
            "variable": "sos_property_name",
            "new_question": true,
            "question_name": "Select the desired property",
            "question_description": "The given property will be the property to be changed"
        },
        {
            "max": 0,
            "min": 0,
            "type": "multiplechoice",
            "choices": [
                "LX",
                "VS"
            ],
            "default": "",
            "required": false,
            "variable": "sos_site",
            "new_question": true,
            "question_name": "Select the destination site: (if none is selected both sites will run)",
            "question_description": "Select the site where the property will be changed"
        },
        {
            "max": 0,
            "min": 0,
            "type": "multiplechoice",
            "choices": [
                false,
                true
            ],
            "default": "",
            "required": true,
            "variable": "sos_value",
            "new_question": true,
            "question_name": "Select the value:",
            "question_description": "Select the value for the property"
        }
    ],
    "description": "Inputs for switching properties on the desired site"
}

Error Message

When trying to edit/select "false":

• UI shows: "Something went wrong... There was an error loading this content. Please reload the page. Back to Dashboard."
• Browser console error:

TypeError: n.trim is not a function
    at https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:3051600
    at Array.map (<anonymous>)
    at Yle (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:3050871)
    at ao (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:832922)
    at Ks (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:885266)
    at Al (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:872512)
    at Tl (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:872440)
    at El (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:872303)
    at yl (https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:869269)
    at https://aap-controller-qly.svc.sibs.pt/static/js/main.4aab3535.js:2:818714

• Behavior: Selecting "false" auto-selects no option. The template cannot be launched due to the required field. "true" selects and works.

Environment

• AAP Version: 4.5.24
• AWX/Controller Collection: ansible.controller >=4.5.0,<4.6.0
• Template Creation: Created via ansible-playbook with infra.controller_configuration.configure_controller.yml

Expected Behavior

Boolean choices in multiplechoice surveys should render and select properly without JavaScript errors. "false" should be selectable like "true", allowing the template to launch.

Please let me know if you need more details or help investigating!

Why is the documentation for surveys in this collection (and AAP in general) almost non-existent? There is little to no guidance on how to properly configure survey specs, especially for edge cases like boolean values in multiplechoice fields, which makes debugging issues like this significantly harder.

[djdanielsson]

did you create the template with filetree or by hand? have you tried applying this directly with the module vs the roles, I wonder if this is a role issue or a module issue.

[kakashiiMF]

did you create the template with filetree or by hand? have you tried applying this directly with the module vs the roles, I wonder if this is a role issue or a module issue.

I applied using the role, not directly with the module. Do you want me to try applying through the module instead?

[djdanielsson]

yes please, that will point if this is a module issue or a role issue

[kakashiiMF]

So i tried to execute this:

---
- name: Create / Update MBWAY QLY job template
  hosts: localhost
  connection: local
  gather_facts: false

  vars:
    controller_host: "https://lxcontroller.qly.aap.sys.sibs.pt/"
    controller_username: "aap.qly.org.sos"
    controller_password: "{{ lookup('env', 'TOWER_PASSWORD') }}"
    validate_certs: true

    job_template_data:
      name: "qly-mbway_update_msp_bd_property_teste"
      description: "Switch for properties in MSP DB MBWAY QLY"
      job_type: run
      inventory: "global-inv-main"
      organization: "af.sup.aplic.sos"
      project: "qly-mbway"
      playbook: "mbway_update_msp_bd_property.yml"
      credentials:
        - "machine"
        - "ldap_user"
        - "vault"
      forks: 0
      limit: ""
      verbosity: 0
      extra_vars:
        ansible_ssh_retries: 3
        ansible_python_interpreter: "/usr/bin/python3"
        env: "qly"
      ask_variables_on_launch: true
      survey_enabled: true
      survey_spec:
        name: "Inputs"
        description: "Inputs for switching properties on the desired site"
        spec:
          - question_name: "Select the desired property"
            question_description: "The given property will be the property to be changed"
            variable: "sos_property_name"
            type: multiplechoice
            default: ""
            required: true
            choices:
              - "IS_TO_FORCE_MAINFRAME_EXECUTION"
          - question_name: "Select the destination site: (if none is selected both sites will run)"
            question_description: "Select the site where the property will be changed"
            variable: "sos_site"
            type: multiplechoice
            default: ""
            required: false
            choices:
              - "VS"
          - question_name: "Select the operation type:"
            question_description: "Select the operatin type for the property"
            variable: "sos_value"
            type: multiplechoice
            default: ""
            required: true
            choices:
              - false
              - true
      timeout: 900
      scm_branch: "qly"
      state: present

  tasks:
    - name: Create or update the job template
      awx.awx.job_template:
        name: "{{ job_template_data.name }}"
        description: "{{ job_template_data.description }}"
        job_type: "{{ job_template_data.job_type }}"
        inventory: "{{ job_template_data.inventory }}"
        organization: "{{ job_template_data.organization }}"
        project: "{{ job_template_data.project }}"
        playbook: "{{ job_template_data.playbook }}"
        credentials: "{{ job_template_data.credentials }}"
        forks: "{{ job_template_data.forks }}"
        limit: "{{ job_template_data.limit }}"
        verbosity: "{{ job_template_data.verbosity }}"
        extra_vars: "{{ job_template_data.extra_vars }}"
        ask_variables_on_launch: "{{ job_template_data.ask_variables_on_launch }}"
        survey_enabled: "{{ job_template_data.survey_enabled }}"
        survey_spec: "{{ job_template_data.survey_spec }}"
        timeout: "{{ job_template_data.timeout }}"
        scm_branch: "{{ job_template_data.scm_branch }}"
        state: "{{ job_template_data.state }}"

        controller_host: "{{ controller_host }}"
        controller_username: "{{ controller_username }}"
        controller_password: "{{ controller_password }}"
        validate_certs: "{{ validate_certs }}"
      register: jt_result

    - name: Show result
      debug:
        msg: "{{ jt_result }}"

And the result is this:

GET /api/v2/job_templates/1768/survey_spec/
HTTP 200 OK
Allow: GET, POST, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: lxaapctrq3.qly.aap.sys.sibs.pt
X-API-Product-Name: Red Hat Ansible Automation Platform
X-API-Product-Version: 4.5.24
X-API-Time: 0.028s

{
    "name": "Inputs",
    "spec": [
        {
            "type": "multiplechoice",
            "choices": [
                "IS_TO_FORCE_MAINFRAME_EXECUTION"
            ],
            "default": "",
            "required": true,
            "variable": "sos_property_name",
            "question_name": "Select the desired property",
            "question_description": "The given property will be the property to be changed"
        },
        {
            "type": "multiplechoice",
            "choices": [
                "VS"
            ],
            "default": "",
            "required": false,
            "variable": "sos_site",
            "question_name": "Select the destination site: (if none is selected both sites will run)",
            "question_description": "Select the site where the property will be changed"
        },
        {
            "type": "multiplechoice",
            "choices": [
                false,
                true
            ],
            "default": "",
            "required": true,
            "variable": "sos_value",
            "question_name": "Select the operation type:",
            "question_description": "Select the operatin type for the property"
        }
    ],
    "description": "Inputs for switching properties on the desired site"
}

It's still exhibiting the same issue, so I'm not sure if the root cause is in the role, the module, or the AAP JavaScript itself :)

Important note: Pay special attention to any survey spec parameter that needs a default value.
You must explicitly include** "default": "" (an empty string).

If the default key is omitted or set to null, editing the job template survey through the AAP/AWX web GUI will fail with the following known error:

#6

[djdanielsson]

you probably want to re-test with ansible.controller module (because that is supported) and once you prove that has the same issue, I would open a support ticket and have them investigate it some more and see what they say. It sounds like either an issue with your input or the module and the role isn't affecting/causing the issue.

[kakashiiMF]

Oh sorry, the same test with ansible.controller:

---
- name: Create / Update MBWAY QLY job template
  hosts: localhost
  connection: local
  gather_facts: false

  vars:
    controller_host: "https://lxcontroller.qly.aap.sys.sibs.pt/"
    controller_username: "aap.qly.org.sos"
    controller_password: "{{ lookup('env', 'TOWER_PASSWORD') }}"
    validate_certs: true

    job_template_data:
      name: "qly-mbway_update_msp_bd_property_teste"
      description: "Switch for properties in MSP DB MBWAY QLY"
      job_type: run
      inventory: "global-inv-main"
      organization: "af.sup.aplic.sos"
      project: "qly-mbway"
      playbook: "mbway_update_msp_bd_property.yml"
      credentials:
        - "machine"
        - "ldap_user"
        - "vault"
      forks: 0
      limit: ""
      verbosity: 0
      extra_vars:
        ansible_ssh_retries: 3
        ansible_python_interpreter: "/usr/bin/python3"
        env: "qly"
      ask_variables_on_launch: true
      survey_enabled: true
      survey_spec:
        name: "Inputs"
        description: "Inputs for switching properties on the desired site"
        spec:
          - question_name: "Select the desired property"
            question_description: "The given property will be the property to be changed"
            variable: "sos_property_name"
            type: multiplechoice
            default: ""
            required: true
            choices:
              - "IS_TO_FORCE_MAINFRAME_EXECUTION"
          - question_name: "Select the destination site: (if none is selected both sites will run)"
            question_description: "Select the site where the property will be changed"
            variable: "sos_site"
            type: multiplechoice
            default: ""
            required: false
            choices:
              - "VS"
          - question_name: "Select the operation type:"
            question_description: "Select the operatin type for the property"
            variable: "sos_value"
            type: multiplechoice
            default: ""
            required: true
            choices:
              - false
              - true
      timeout: 900
      scm_branch: "qly"
      state: present

  tasks:
    - name: Create or update the job template
      ansible.controller.job_template:
        name: "{{ job_template_data.name }}"
        description: "{{ job_template_data.description }}"
        job_type: "{{ job_template_data.job_type }}"
        inventory: "{{ job_template_data.inventory }}"
        organization: "{{ job_template_data.organization }}"
        project: "{{ job_template_data.project }}"
        playbook: "{{ job_template_data.playbook }}"
        credentials: "{{ job_template_data.credentials }}"
        forks: "{{ job_template_data.forks }}"
        limit: "{{ job_template_data.limit }}"
        verbosity: "{{ job_template_data.verbosity }}"
        extra_vars: "{{ job_template_data.extra_vars }}"
        ask_variables_on_launch: "{{ job_template_data.ask_variables_on_launch }}"
        survey_enabled: "{{ job_template_data.survey_enabled }}"
        survey_spec: "{{ job_template_data.survey_spec }}"
        timeout: "{{ job_template_data.timeout }}"
        scm_branch: "{{ job_template_data.scm_branch }}"
        state: "{{ job_template_data.state }}"

        controller_host: "{{ controller_host }}"
        controller_username: "{{ controller_username }}"
        controller_password: "{{ controller_password }}"
        validate_certs: "{{ validate_certs }}"
      register: jt_result

    - name: Show result
      debug:
        msg: "{{ jt_result }}"

And the result is this:

GET /api/v2/job_templates/1769/survey_spec/
HTTP 200 OK
Allow: GET, POST, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
X-API-Node: lxaapctrq1.qly.aap.sys.sibs.pt
X-API-Product-Name: Red Hat Ansible Automation Platform
X-API-Product-Version: 4.5.24
X-API-Time: 0.032s

{
    "name": "Inputs",
    "spec": [
        {
            "type": "multiplechoice",
            "choices": [
                "IS_TO_FORCE_MAINFRAME_EXECUTION"
            ],
            "default": "",
            "required": true,
            "variable": "sos_property_name",
            "question_name": "Select the desired property",
            "question_description": "The given property will be the property to be changed"
        },
        {
            "type": "multiplechoice",
            "choices": [
                "VS"
            ],
            "default": "",
            "required": false,
            "variable": "sos_site",
            "question_name": "Select the destination site: (if none is selected both sites will run)",
            "question_description": "Select the site where the property will be changed"
        },
        {
            "type": "multiplechoice",
            "choices": [
                false,
                true
            ],
            "default": "",
            "required": true,
            "variable": "sos_value",
            "question_name": "Select the operation type:",
            "question_description": "Select the operatin type for the property"
        }
    ],
    "description": "Inputs for switching properties on the desired site"
}

It's still exhibiting the same issue with ansible.controller :)

[djdanielsson]

yea I figured it would, it was more you wouldn't be able to submit that stuff to support in a ticket and get it seriously reviewed. so if you can open up a case on it and see what support figures out, if it's an issue with the inputs you are providing or if it's a bug in the module.

[kakashiiMF]

I’ll have to check if I can ask the team managing the AAP to open this ticket for us. If they can’t, would it be possible for someone (from Red Hat/xAI side) to open it on my behalf and follow it up? Thank you :)