/
Custom Strings/Languages

Custom Strings/Languages

Owned by Robin Rodrigue
Last updated: Jul 23, 2020 by Nora Kinal
9 min read





Overview

Overview

The custom strings feature allows you to customize every aspect of the online application. This feature also allows you to define multiple language support and customize each language as necessary to fit your District's needs. Click Ctrl + F to open up your browser's search function and enter text to easily locate the custom string in which you wish to review/modify.

From the MySchoolApps homepage, click on Manage Custom Strings/Languages or click Setup at the top of the site window and select Custom Strings/Languages. You may also activate a new language and edit strings from the District link at the top of the webpage.

Activating and Customizing New Languages

By default, we provide content for English and Spanish.  You may add additional languages by activating a new language and making customizations as needed to the new language.

Take Care When Activating New Languages

When you enable a new language, ALL of the default strings are in English.  It is the District's responsibility to translate all strings in this language appropriately before activating your application for a new school year.  Also, please take note that when you activate a new language it is live immediately.  Due to this behavior, HSS recommends only activating new languages at the start of the new year and while still in Test Mode.

Language Activation Warning

Remember, activating a new language is immediate! The new language is immediately live on the website with only the English defaults until your District translates the language strings. 

  1. From Setup, select Custom String/Languages.

  2. A list of our default languages appears in the list; however, it is the District's responsibility to activate and customize the ones needed.

    1. For existing stock languages you wish to utilize, click Activate. Then, confirm you wish to activate the language by clicking ACTIVATE <LANGUAGE>.

    2. For non-stock languages, click Add New. Then, select the language you wish to appear and click Activate.

  3. The language will now appear in your list of active languages for your District. Click Edit enter translated text to the application settings/custom strings.

  4. Select the string information you wish to modify and click Edit.
    Red string header - Denotes a change from the default has occurred.
    Red text - Previews the custom text entered for the English language and indicates additional translation may be necessary.
    The custom text can be compared to the English default text.
    Note: "HeaderEditMember" has not been modified from the English default; however, translation may still be required from your District.

  5. Click on Custom Text to modify the default text. If custom text already exists, you may simply modify the custom text. When you are done, click Update.

    1. You may use the drop-down menu to enter data fields in the text field.

    2. You may left-click and drag to highlight the selected text you wish to call attention to by clicking Bold or Highlight.

    3. You can add hyperlinks to your custom text.
      Adding Hyperlinks
      Hyperlinks should be added as Custom Text. Once a hyperlink is clicked during the application process, the following message appears to the end-user:
      ”You are leaving MySchoolApps and going to a third party site. The owner of that website is solely responsible for the products, services, and content on its site. Do you want to continue?”

      You may switch back to the default text at any time by clicking the Edit button. Then, select Use Default Text and click Update.

  6. Once you have saved changes, note that the string that contains custom strings is now highlighted red to indicate a change has occurred and the text appears in blue.
    Red string header - Denotes a change from the default has occurred.
    Blue text - Previews the custom text and can be compared to the default text.

  7. Repeat the process for any additional languages you wish to activate for your District. 

Editing Strings in Currently Active Languages

You may edit strings of active languages to suit the needs of your District.

String Navigation

In order to navigate the strings and associate them with the page they modify you can follow a few simple guidelines. 

  • Most strings are organized exactly as they appear in the online application.  For example, to modify the string for the page 'Instructions' in the online application navigate to the string at the location 'Application | Instruction' in the custom strings tree.

  • Some strings are shared across pages.  Examples of these strings are the text on buttons (such as the 'Continue'/'Go Back'), Labels on form input screens (such as the 'name', 'gender' labels on the 'Add Student' page).  The location of these shared strings is the 'Misc' top level custom string node. 

Reserved or Read-Only Custom Strings

Almost any part of the website can be customized by the District except for a very small handful of strings.  These read-only strings cannot be modified because they contain information that should never be changed by the District.  An example of this is the 'Terms of Use' string.  This string defines the user agreement between HSS and the end-user.

Use 2 Different Web Browsers When Setting Up Strings

A recommendation that can assist in setting up strings involves using 2 web browsers on the same computer.  Use 1 browser to modify the string in the admin interface and use the other browser to see the results of the string on the online application itself.  In order to use this technique you must use 2 different browsers - you cannot use the same browser with multiple tabs/windows.

In many situations, you can use the URL that appears in the browser during the application process as a guide in locating the string in the custom string tree view.  For instance, strings related to the pages for Student (URL: /StudentInfo/) are located in the 'StudentInfo' node in the custom string tree.

  1. Select a Language to modify. Then, click Edit.

  2. Custom Strings are broken down into hierarchical categories - Application, Household Member Info, Milestone, Misc, Privacy Act, Student Info, and Warning Check Message. Click on the correct category to review/edit.

  3. Select the string information you wish to modify and click Edit.

  4. Click on Custom Text and modify the default text. You may wish to use the drop-down menu to enter data fields in the text field. You can also left-click and drag to highlight text and select to call attention to the selected item by clicking Bold or Highlight. When you are done, click Update.

    You may use the following HTML tags to modify custom text. All tags, except line breaks, must be closed

    Available data fields closely follow the custom string being edited and will, therefore, vary in available options. (e.g. Application > Decline Terms > Instructions contain various District Contact fields; whereas, Student Info > Case Number > Instructions contains specific information in regards to public assistance, income, and other information directly related to the student and /or household.)
    You may switch back to the default text at any time by clicking the Edit button. Then, select Use Default Text and click Update

  5. Once you have saved changes, note that the string that contains custom strings is now highlighted red to indicate a change has occurred and the text appears in blue.

    Red string header - Denotes a change from the default has occurred.
    Blue text - Previews the custom text and can be compared to the default text.

Deactivating Languages

You can remove additional languages by activating a new language and making customizations as needed to the new language.

  1. From Setup, select Custom Strings/Languages.

  2. Select the language and click DEACTIVATE.

  3. Read the confirmation statement and click DEACTIVATE <LANGUAGE>.

Exporting and Importing Custom Strings

You have the ability to export custom strings for modification and import them for the chosen language.

Knowledge of .xml is necessary to complete this task.

  1. From the Manage Custom Strings/Languages window, select the language and click Export.

  2. Click Export for <Langauage>.

    1. Export all custom strings - Creates an export for all custom strings for the selected language.

    2. Export only untranslated custom strings - Creates an export only for custom strings which have not yet had a value translated.

  3. Once the file downloads, open the file, make necessary changes, and save the changes. Be sure to note the locate where you save the file on your local or network drive.

    Custom Strings Export Sample

    <?xml version="1.0" encoding="utf-8"?> <LanguageStrings xmlversion="1" application="applyforlunch" applicationversion="1.0.0.13766" date="3/28/2016 4:16:58 PM" user="rrod1" district="MCS Academy School District" site="demo" language="Spanish" languageid="2"> <Resource id="Application.DeclineTerms.Help.Header">Declinación de los Términos del Uso</Resource> <Resource id="Application.DeclineTerms.Header">Declinación de los Términos del Uso2</Resource> <Resource id="Application.DeclineTerms.Instructions">Gracias por su interés en MySchoolApps.com. Lamentamos que no está dispuestos a aceptar las condiciones de uso de nuestro sitio. Usted puede presentar una solicitud en papel a su distrito escolar en su lugar. Por favor &lt;field name="ContactDistrictLink"/&gt; para obtener información sobre cómo proceder.</Resource> <Resource id="Application.DeclineTerms.ChangeYourMind">Si usted cambia su mente, usted puede revistar &lt;field name="Button"/&gt; de nuevo</Resource> <Resource id="Application.Finished.Help.Header">Solicitud Presentado</Resource> 1. ¿QUIÉN PUEDE OBTENER COMIDA GRATUITA O DE PRECIO REDUCIDO? ------------------------------------------------------- • Todos los niños en los hogares que reciben beneficios de &lt;field name="InsteadOfFoodstamp"/&gt;, el Programa de Distribución de Alimentos en Reservaciones Indígenas (FDPIR), o &lt;field name="InsteadOfFITAP"/&gt;. • Niños adoptivos temporales (foster) que están bajo la responsabilidad legal de una agencia de cuidado temporal (foster) o de una corte. • Niños que participan en el Programa Head Start de su escuela. • Niños que cumplen con la definición de "sin casa", "fugitivo", o "migrante". • Los niños de hogares donde el ingreso encaja en o debajo de los límites de las Normas Federales de Elegibilidad por Ingresos.



    Custom Strings Only Untranslated Export Sample

    <?xml version="1.0" encoding="utf-8"?> <LanguageStrings xmlversion="2" application="myschoolapps" applicationversion="3.0.0.35036" date="4/14/2018 1:16:37 AM" user="robintest" district="Robin Test" site="QA" language="Spanish" languageid="2"> <Resource id="Misc.HelpContactInfoLine1"><field name="ContactName"/></Resource> <Resource id="Misc.HelpContactInfoLine2"><field name="DistrictName"/></Resource> <Resource id="Misc.HelpContactInfoLine3"><field name="ContactPhone"/></Resource> <Resource id="Misc.HelpContactInfoLine4"><field name="ContactPhone2"/></Resource> <Resource id="Misc.HelpContactInfoLine5" /> <Resource id="Misc.HelpContactAdditionalTextArea" /> </LanguageStrings>



  4. From the Manage Custom Strings/Languages window, select the language and click Import.

  5. Click Choose File and locate the file on your local or network drive. Then, click Open.

  6. Click Import for <Language>.

Reset to Default/Clear Custom Strings

You have the ability to reset custom strings to the original default text provided by Heartland.

There is no undo. If you would like to save the existing text, you should first export the custom strings before resetting to default.

  1. From Setup, select Custom Strings/Languages.

  2. Select the language and click Reset.

  3. Read the confirmation statement and click Reset Language.

Related content