This documentation supports the 18.02 version of BMC Digital Workplace. To view the latest version, select the version from the Product version menu.

Localizing services and bundles by using export and import

Catalog administrators who have installed the BMC Digital Workplace Catalog 18.02 March hotfix or a later version can export a service or a bundle for translation, and then import the translated service or bundle back to the catalog. This option provides the ability to easily localize a service or a bundle, and reduce time and expenses by avoiding manual editing of the required fields.


Using the export and import option for localization

The export and import option enables the execution of the following business scenario:

export-import


  1. The catalog administrator exports a service or a bundle for translation. All necessary data is exported to a file.
  2. The catalog administrator sends the file to the translation service.
  3. The translation service works with the exported file (replaces the translatable strings with the new languages values), and returns the file to the catalog administrator.
  4. The catalog administrator imports the translated file to the catalog. The localized service or bundle is available in the catalog, and is ready for publishing to the appropriate locales of BMC Digital Workplace.

Components that can be exported for translation

You can export the following components of a service or a bundle for translation:

The following table shows the translatable strings of the exported components:

Translatable strings of the service or bundle profileTranslatable strings of the service or bundle questionnaire
  • Service or bundle name
  • Version name
  • Catalog profile (description, excerpt, tags, Youtube video links, custom fields)

The profile file assets (such as logos, solution images, and file resources) are also exported to the file. You can replace them with the localized variants, and publish these variants to the required locales.

Note: You can export only one service or bundle revision at a time.

  • Question label
  • Page name 
  • Question label text
  • Question description text
  • Default value set for the custom value
  • Display value (but not stored value) for selection field
  • Regex hint

Note: You can export only one service or bundle questionnaire at a time.


To export a service or bundle profile for translation

  1. Go to Services > Services, and open a service or a bundle.
  2. Select the appropriate revision.

  3. Select Export for translation .


    The zip file is downloaded to your computer automatically.

To export a service or bundle questionnaire for translation

  1. Go to Services > Services, and open a service or a bundle.
  2. Next to Workflow, click Edit .
  3. Next to Questions, click Add.
  4. From the Questionnaire Library, select a questionnaire.
  5. Select Actions > Export for translation.


    The zip file is downloaded to your computer automatically.

About the exported files

After you export a service or bundle profile, or a service or bundle questionnaire, the zip file is downloaded to your computer. The zip file contains:

 About the exported CSV files 

The quantity of the CSV files in the downloaded archive is equal to the quantity of supported languages and locales in BMC Digital Workplace Catalog. One CSV file represents one locale. For example, you can see the following file names:

  • French.csv
  • Italian.csv
  • German.csv

Each CSV file contains all translatable strings of the exported service or bundle component (the profile or the questionnaire).

Note

The CSV file with the exported service or bundle profile contains only data from the revision that was selected during the export.

About the exported attachments folder 

The attachments folder consists of subfolders. The quantity of subfolders is equal to the quantity of supported languages and locales in BMC Digital Workplace Catalog. One subfolder represents one locale. For example, you can see the following subfolder names in the downloaded archive:

  • EsThis folder name indicates a Spanish locale.
  • EnThis folder name indicates an English locale.
  • PlThis folder name indicates a Polish locale.

Each subfolder contains additional folders with the original file assets (such as logos, file resources, solution images) of the exported service or bundle revision. These file assets can be replaced with the localized variants.

Forbidden actions

While working with the exported files or folders, do not perform any of the following actions, or you will not be able to import your localized file back to BMC Digital Workplace Catalog.

  • Do not rename or delete the DoNotModify file in the attachments subfolder.
  • Do not rename the zip file.
  • Do not rename or delete CSV files.
  • Do not rename or delete subfolders in the parent attachments folder.
  • Do not modify the official language name in the first row of the CSV file.
  • Do not modify the System Key in the first column of the CSV file.
  • Do not modify Default Locale Value in the second column of the CSV file.

To translate the required components of the service or the bundle

  1. Open the exported zip file.
  2. Open the CSV file for the appropriate locale.
  3. In the Translated Values column, next to the Default Locale Value column, type the required translated values.

  4. Save the changes.

Note

You can translate only files for the locales that have the highest business priority. Other files can remain unchanged. Because the original values are saved to all CSV files, you do not need to edit every CSV file in the zip archive to execute the appropriate import back to BMC Digital Workplace Catalog.

To localize the required file assets of the service or bundle

  1. Open the exported zip file.
  2. Open the attachments folder, and then open the subfolder for the appropriate locale.
  3. In the appropriate additional folder, replace the file asset with the localized variant of this asset.
    For example, in the logo folder, delete the existing (default variant) logo, and add a localized variant of this logo.

Note

If you want to import the localized variant of a logo, ensure that you have only one logo in the logo folder. If multiple logos are added to the folder, only the most recent one is imported back to the catalog.

Preparing the content for import 

Ensure that the file you want to import matches the following requirements:

  • The file is in zip format.
  • The zip file is not empty, and contains all original folders, subfolders, and CSV files.
  • The names of the zip file, CSV files, folders, and subfolders are not modified.
  • The DoNotModify file in the attachments subfolder is not renamed or deleted.
  • The official language names are not modified (see the first row in the CSV files).
  • The system key is not modified (see the first column in the CSV files).
  • The default locale values in the CSV files are not modified.

To import the translated service or bundle profile

  1. Go to Services > Services, and open a service or a bundle.
  2. Select the appropriate revision.

  3. Select >  Import translations.

  4. Select the appropriate zip file with the translated service or bundle profile from your computer.

To import the translated service or bundle questionnaire

  1. Go to Services > Services, and open a service.
  2. Next to Workflow, click Edit.
  3. Next to Questions, click Add
  4. From the Questionnaire Library, select a questionnaire.
  5. Select Actions > Import translations.

  6. Select the appropriate zip file with the translated service or bundle questionnaire from your computer.
Was this page helpful? Yes No Submitting... Thank you

Comments