Localizing Forms

Alloy Navigator Express supports localization of forms used in the Self Service Portal for creating, updating, and viewing Tickets.

Alloy Navigator Express includes localization dictionaries for all workflow items that are involved in SSP operations. The following languages are provided: English (United States), German, Spanish, French, Italian, Portuguese, Russian, Chinese. If you have customized a Form by adding new fields or other elements you may need to localize your changes, i.e. update localization dictionaries for desired languages.

For example, to update or add those entries of the localization dictionary that relates to the Forms involved in viewing, creating and updating Tickets in the SSP:

  1. Navigate to the localization folder under the Self Service Portal installation directory:

    [PhysicalPathToSSP]\localization\

    The [PhysicalPathToSSP] is the placeholder for the physical path to Self Service Portal files.

    NOTE: For instruction on viewing the physical path of Self Service Portal installation folder, see Physical Path to Self Service Portal Files.

  2. Open the localization dictionary that you want to update with a unicode-aware text editor (for example, using Microsoft Notepad)

    NOTE: For details on localization dictionary structure, see Preparing a Localization Dictionary.

  3. For the Ticket View Form , add a new object to the Terms array or update the existing one. The object looks like this:

    
    {
    
      "key": "TICKETS.FORMS.VIEW_FORM.ViewFormElement",
    
      "text": "LocalizedElement"
    
    },
    
    

    Where

    • TICKETS.FORMS.VIEW_FORM — the part of the key responsible for the Ticket View Form in the SSP.

    • ViewFormElement — the name of the element (field, text, or section) added to the View Form or updated on it.

    NOTE: The field name is the original database name of a field that can be seen under the Binding section of the Field Properties dialog box. For details, see Customizing System Fields.

    • LocalizedElement — the localized version of the element added to the View Form or updated on it.

  4. For the caption of the Action used for creating or updating Tickets, find and update the following object in the Terms array:
    
    {
    
      "key": "TICKETS.ACTION.ActionID",
    
      "text": "LocalizedActionCaption"
    
    },
    
    

    Where

    • TICKETS.ACTION— the part of the key responsible for the captions of the Actions for creating or updating Tickets.
    • ActionID — the identifier (ID) of the Action (797 for creating a Ticket, 798 for updating a Ticket).
    • LocalizedActionCaption — the localized caption of the Action.
  5. To localize the caption and instruction on the Form used in the Action, do one of the following:
    • For the Forms used for creating and updating Tickets, find and update the following objects in the Terms array:
      
        {
      
          "key": "TICKETS.FORMS.CUSTOM_ActionID.FORM.CAPTION",
      
          "text": "LocalizedFormCaption"
      
        },
      
        {
      
          "key": "TICKETS.FORMS.CUSTOM_ActionID.FORM.INSTRUCTION",
      
          "text": "LocalizedFormInstruction"
      
        },
      
      

      Where

      • TICKETS.FORMS.CUSTOM_ — the part of the key responsible for the Forms used for creating and updating Tickets in the SSP.
      • ActionID — the identifier (ID) of the Action (797 for creating a Ticket, 798 for updating a Ticket). (see below).
      • LocalizedFormCaption — the localized Form caption.
      • LocalizedFormInstruction — the localized Form instruction.

      For example, in the Spanish localization file es_ES.json, the localized caption and instruction of the Form used for updating Tickets looks like this:

      {

      "key": "TICKETS.FORMS.CUSTOM_798.FORM.CAPTION",

      "text": "Agregar una nota"

      },

      {

      "key": "TICKETS.FORMS.CUSTOM_798.FORM.INSTRUCTION",

      "text": "Por favor, escriba una nota."

      },

  6. For every element (field, text, or section) that you add to the Form used to create a Ticket (Action #797), add the corresponding object to the Terms array. For every element existing on the Forms used to create or update Tickets (Action #797, 798), find and update the corresponding object in the Terms array. The object looks like this:
    
      {
    
        "key": "TICKETS.FORMS.CUSTOM_ActionID.FormElement",
    
        "text": "LocalizedElement"
    
      },
    
    
    
    

    Where:

    • ActionID — the identifier (ID) of the Action using the Form (#797 for creating and #798 for updating a Ticket).
    • FormElement — the name of the element (field, text, or section) added to the Form or updated on it.
    • LocalizedElement — the localized version of the element (field, text, or section) added to the Form or updated on it.

      NOTE: For fields added to the Form used in creating Tickets, FormElement is the name of the field in the database.

      NOTE: The original database name of a field can be seen under Binding section of the Field Properties dialog box when managing system field labels. For details, see Customizing System Fields.

    Figure below shows the Spanish localization file es_ES.json with the localized field added to the Ticket Create Action #797.

    The Terms array in any of localization files includes keys beginning with "FIELDS.COMMON. The localized fields defined by these keys are used by default if you do not have the corresponding fields localized for a particular Form.

    For details on localization dictionary structure, see Preparing a Localization Dictionary.

  7. Save the localization dictionary.