Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Looking for the Supplemental QuestionsXML Schema template? Find the latest version on theUser Guidespage.

...

Most of the contents of your XML file will depend on the questions you want to ask and the responses you expect to receive. For details on creating questions and guiding the student through the application process see Supplemental Questions: Layout And User Experience and Supplemental Questions: Response Elements.

Setting up Your XML File

  1. Copy and paste the example starter XML file structure below into your XML editor before you begin creating questions. This text will serve as your XML base and you can use it over and over again for each new supplemental question XML file set.

...

tip
Note

Important: It is very important that your uploaded XML file be error-free. If there are errors in your supplemental questions XML file, you will likely see an error message in the Administrator when you attempt to upload it.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

It is strongly recommended that before uploading, you validate your XML with a free, online validator tool such as Free Formatter. This site allows you to copy and paste your XML or XSD for syntax checking. *The maximum size limit for file upload is 2 megabytes.

After you paste your XML and click validate, the site will ask you to copy and paste a second file. In industry jargon, the file it is requesting is called a schema. You can copy the schema from here and paste it into the validator. The validator then tells you if there are problems with your XML. Although the error messages may still be somewhat intimidating, this particular validator will at least show you in a friendly way where the error is in your XML.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Looking for the Supplemental QuestionsXML Schema template? Find the latest version on theUser Guidespage.

Supplemental Questions: Layout And User Experience

...

Both <Label> and <HoverHelp> are used only as child elements of the response elements. The <Label> element can be thought of as the question being asked for a response element, while the <HoverHelp> element can be used to provide further explanatory text when the applicant clicks the Help icon next to the related input field. Multiple <HoverHelp> children are allowed, one for each language your student application supports. The optional <Translations> element allows you to specify English or Spanish language (internationalize) for your questions. You must include at least two <Locale> elements, one with a <lang> attribute of "es" and one without, as well as a message block.

...

The <Translations> Element

In 2018, CCCApply applications/pages were internationalized to support multiple languages; currently only English and Spanish are supported. English is the default language. Users have the ability to change the onscreen language between English and Spanish at any time by clicking the Cambiar A Espanol button which appears in the header of each application page. One exception to the internationalization of the application pages is the Supplemental Questions page(s), which requires additional XML configuration to ensure the questions on this page are translated appropriately.

To ensure that all supplemental questions will display in Spanish The <Translations> element allows you to specify English or Spanish language (internationalize) for your questions. You must include at least two <Locale> elements, one with a <lang> attribute of "es" and one without, as well as a message block.

To ensure your page(s) display in Spanish correctly when the Cambiar A Espanol button is selected, or when even if the end-user’s browser language is set to Spanish, the college must implement configure the <translations> <Translations> element within their XML code for all text that displays within the question(s) and response(s)and provide the translated text for each question, label, hover help, and response option.

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFFAE6

IMPORTANT: If your college chooses not to internationalize your supplemental questions, they will display in the default language (English) even if the user has implemented the Cambiar a Espanol button in the application OR if the user’s browser’s language setting is configured for Spanish or another language.

...


To internationalize your custom supplemental questions:

  • Add the optional <Translations> element.

  • Within the <Translations> element, add at least two <Locale> elements, one without any "lang" attribute and one with a lang attribute of "es".

  • Add <Message> element blocks for each code into both of the <Locale> elements.

    • Each <Message> element must have a <code> and <message> attribute with values.

    • The <code> attribute value must match the question's <Label> value.

...

...each has a corresponding <Message code="" message=""/> in the <Translations> element's <Locale> element; the first in English and the second in Spanish:

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Reminder: Do not include formatting in the <Translations> element.

<Translations>

 <Locale>

 <Message code="main.header" message="Here are some questions"/>

...

 </Locale>

 </Translations>


Response Element: The

...

default Attribute

Depending on your specific circumstances, you can allow the applicant to ignore a given question, or you can require the applicant to provide a response. If you allow a question to be ignored, the system will store a system-default value for the question. The legal default values depend on the response element you specified. When you add a default attribute to a response element, the system auto-answers the question with the default value you specify. When the page appears, the question displays as already answered:

...

Change Date

Application Version

Change Description

Additional Notes

October 2022

CCCApply 6.11.1

Update and notes added to the <translate> attribute Updated the <Translations> element section for displaying and implementing language translation to question the XML code.

See: Configuring Spanish-Language Translation Text to Supplemental Questions