Create and configure a custom artifact

  • Release version: Yokohama
  • Updated February 11, 2025
  • 1 minute to read

    • Create and configure custom artifacts of your choice to use the Localization Framework functionality.

    Before you begin

    Ensure that you have activated the Localization Framework Installer plugin (com.glide.localization_framework.installer) before configuring a custom artifact.

    Role required: localization_admin and script_include_admin.

    Procedure

    1. Navigate to All > Localization Framework > Artifact Configurations.
    2. Select New.
    3. In the Artifact Configuration form, fill in the fields.
      Table 1. Artifact Configuration form fields
      Field Description
      Name Identifier of the artifact record.
      Internal name An internal name for the artifact.
      Table name Identifier of the table where information of the artifact is stored.

      For example, Catalog Items [sc_cat_item] table.
      Processor script Extracts the translatable content associated with the translation request and saves the translations into the database.You can select a script include using the search magnifying glass icon icon, or you can create a new script include.
      The processor script contains the following functions:
      • getTranslatableContent: Extracts the translatable content.
      • saveTranslatedContent: Saves the translated content back to the system.
      For more information, see Processor script functions.To create a new processor script for the artifact, see Create a processor script.
      Note:
      Under Related Links on an existing artifact record, you can switch to Legacy View for script editing.
      Application Application scope. The value is the current application selected for the logged-in user session. For more information, see Select an application from the application picker.
      Active Option to activate the configuration record.
      Generate insights Option to turn on or turn off the localization insights for the artifact. For more information, see Localization Insights dashboard.
    4. Select Submit.

    What to do next

    For examples of Localization Framework artifacts that you can set up, see the LF Artifact blog posts list on https://www.servicenow.com/community/international-localization/need-to-translate-a-par-dashboard-check-this/ta-p/2839751 in the ServiceNow Community. These examples include Processor scripts.