1. Create a Taxonomy with Search Facets.
2. Enable Search Facet Taxonomy as Metadata.
3. Add Search Facet Metadata to Files.
4. Optional: Send Portal Search Facets for Localization.

   This step is only required if you publish localized content to the portal. If so, ensure your search facets are localized to the same target languages (locale codes) you use to localize your content.

5. Optional: Add Localized Portal Search Facets to Portal Configuration.

   This step is only required if you publish localized content to the portal.

6. Enable Metadata as Portal Search Facets.
7. Optional: Change the Order of Search Facets.

1. In the Main Menu in the top-left corner, click Taxonomy.
2. Click New Taxonomy.
3. Enter a label for the taxonomy.

   The Label field is the name of the taxonomy and is not visible to users outside of this interface. The Name field is used by the CCMS as a unique identifier and is populated automatically. At this point, you can still modify the value in the Name field. Once you save, you can still modify the label but not the name.

4. Click Save to create the new taxonomy.
5. Click the taxonomy to add taxonomy terms.
6. Click the existing term Unnamed 1 and, in the Label field, give it a meaningful name.

   Once configured, the name you give a taxonomy term in the Label field is visible to other users. The Name field is not editable for existing taxonomy terms.

7. Click Save.
8. Right-click the renamed term and do any of the following:

   • To create a new, top-level term, select Create Term Below.

   • To create a child term under the existing term, select Create Narrower Term.

9. Give the new term a meaningful name. Click Save.
10. Keep adding new terms as needed.
11. Once you are satisfied, click Save all changes.

You added a taxonomy in the CCMS and populated it with terms. It is not visible anywhere outside of the Taxonomy interface. You are ready to enable the taxonomy as metadata.

1. In the Main Menu in the top-left corner, click Metadata.
2. In the Category Name field, enter a name for the metadata category.

   If you have a number of metadata categories already present, scroll down to see the Category Name field.

   The metadata category is a grouping for your taxonomies and metadata. You can add one or more taxonomies and metadata within a metadata category. The way you set up your metadata categories in the Metadata interface is also how other users see it in the CCMS.

   

3. Click Add Category.

   A metadata category section is added.

   

4. Complete the following fields:
   1. In the Label field, enter a label.

      The value you add in the Label field is visible in the Content Library. The Name field is used as a unique identifier by the CCMS and is populated automatically. At this point, you can still modify the name. Once you save, you can still modify the label but not the name.

   2. In the Type drop-down menu, select Taxonomy.
   3. In the Values field, select a taxonomy structure.

      These are the taxonomy terms you want to associate with your metadata category.

5. Optional: To enable users to select multiple values, check Allow Multiple Selection.
6. To use the metadata for search filtering in the Content Library, check Search facet.
7. To enable the metadata so you can use it for search filtering and add it to files, check Enabled.
8. To prevent this metadata from being added to selected content types, in the Exclude from Content Type field, choose those content types.
9. Click Add Field, then Save Changes.

Your metadata category should look similar to this. Note the empty third field (expected).

1. In the Content Library, ensure that you are working in the master branch.

2. In the Content Library, click a file.
3. In the right pane, scroll down and select the metadata tag from the available options.

   

4. Close the Resource Drawer to save the changes.

   

5. Repeat these steps for any other file you want to add metadata to.

6. In the Content Library, select the files, folders, or maps you want to modify.

   To select a range of files and folders, select the first file or folder, press and hold Shift, and select the last file or folder in the range.

7. Right-click the selection and select Bulk Change > Metadata.
8. If you don't want to include the dependencies of a given map, like its child topics and submaps, clear the Include dependencies check box.
   Important:

   The Include dependencies option only includes the direct dependencies of the map. It does not include binary files (non-text files like images) present in the map.

9. If you don't want to change the resource-only files in a map, clear the Include resource-only files check box.
   Tip:

   For example, the resource-only files are your warehouse topics that have the @processing-role="resource-only" attribute assigned to their <topicref> elements. They are appended in a map but are not included in the output.

10. If you want to include all map dependencies, including its indirect dependencies and binary files (non-text files like images), select the Include all dependencies check box.
11. Select the check box next to the metadata category you want to modify.
12. In the Action drop-down menu, select one of the following options:

    Option	Description
    Add to existing	Metadata tags are added to the selected files. Existing metadata values remain applied.
    Clear field	All metadata tags in the selected files are cleared.
    Replace all with	All metadata tags in the selected files are cleared and replaced with the new tags.
    Find and remove these	Specified metadata tags are removed from the selected files.

13. In the Metadata drop-down menu, select the metadata to apply the selected action to.
14. Click Save.

1. Gather all your search facets in the source language in a document that your Localization Services Provider (LSP) accepts.

   For example, your LSP might want to work with a .docx, .xlsx, .txt or a specialized document type.

   You only need to localize the values in the Label field that both the Taxonomy and Metadata interfaces use for your search facets. Ideally, that document reflects the parent-child hierarchy of your search facets present in Heretto CCMS, which might help translators with context.

   1. In the CCMS, go to the Main Menu in the top-left corner and select Metadata.
   2. Scroll down to a metadata category with your search facet configuration.
   3. Copy the relevant value in the Label column and add it to the document you will be sending to your LSP.

   4. Click the field for the corresponding Values column and add the selected value along with its children to the document you will be sending to your LSP.

2. Repeat these steps for any other search facets that need to be localized.
3. Once you add all search facets to the document, send it to your LSP.

1. In the Content Library, ensure that you are working in the master branch and go to your main portal sitemap.
2. Open the main portal sitemap.
3. In the map tree pane, click the Gear button and set your options like this:
   1. Set Icons to On.
   2. Set Show Elements to All.
   3. Set Element Names to Full.

   The map tree now shows color-coded elements with full element names. This view enables you to easily identify and modify all elements in your sitemap.

4. Expand the sitemeta element, right-click the config.json element, and select Show file in Content Library.

5. In the Content Library, right-click the config.json file and select Edit Source.
6. In the Source Editor, press Ctrl/Cmd > F and search for i18n (internationalization).

   The i18n parameter you are looking for contains the en language code with default portal labels in English.

   "i18n": {
           "en": {
   	    "label.tenant": "[REPLACE]",
               "label.section": "Subject",
               "label.home": "Home",
               "label.sections": "Sections"
           }
       },

7. Scroll to the end of the en object and paste this code right after the closing bracket of the en object:

   "locale_code": {
   		"metadata_name_value": "localized_label_value",
   		"metadata_name_value_2": "localized_label_value"
   	}
   }
   

   where:

   • locale_code is the code of the target language you translated your content and search facets to. For example, de and de-de are two different codes. The locale code that you configure for search facets needs to match the codes used in your main sitemap and localized content.

   • metadata_name_value is the value present in the Name column of the Metadata interface

   • localized_label_value is the localized search facet that corresponds to the metadata_name_value

   At this point, your i18n parameter should look like this:

   "i18n": {
           "en": {
   	    "label.tenant": "[REPLACE]",
               "label.section": "Subject",
               "label.home": "Home",
               "label.sections": "Sections"
           },
   
   	"locale_code": {
   	    "metadata_name_value": "localized_label_value",
   	    "metadata_name_value_2": "localized_label_value"
   	}
       },
   

   Note:

   The Source Editor automatically validates the .json file. Errors are indicated by a red wavy line. When you hover over it, you get error details. The most common errors in .json files are missing or extra commas at the end of lines. The last line added inside curly brackets ({}) should have no comma at the end.

8. In the config.json file, replace locale_code with the locale code your search facets are translated to.

   The locale code needs to correspond to the locale code you use to localize your content in the CCMS and should be added inside quotation marks (""): "de-de".

   At this point, your i18n parameter should look like this:

   "i18n": {
           "en": {
   	    "label.tenant": "[REPLACE]",
               "label.section": "Subject",
               "label.home": "Home",
               "label.sections": "Sections"
           },
   	"de-de": {
   	    "metadata_name_value": "localized_label_value",
   	    "metadata_name_value_2": "localized_label_value"
   	}
       },

9. Open the CCMS in a new tab or window, and from the Main Menu in the top-left corner select Metadata.
10. Scroll to a localized metadata and copy the value in the Name column.

11. Go back to the config.json file, and paste the copied value in place of metadata_name_value.

    The pasted value should be added inside quotation marks (""): "Category".

    At this point, your i18n parameter should look like this:

    "i18n": {
            "en": {
    	    "label.tenant": "[REPLACE]",
                "label.section": "Subject",
                "label.home": "Home",
                "label.sections": "Sections"
            },
    	"de-de": {
    	    "Category": "localized_label_value",
    	    "metadata_name_value_2": "localized_label_value"
    	}
        },

12. In the config.json file, replace localized_label_value with a translation of the label associated with the metadata name value.

    At this point, your i18n parameter should look like this:

    "i18n": {
            "en": {
    	    "label.tenant": "[REPLACE]",
                "label.section": "Subject",
                "label.home": "Home",
                "label.sections": "Sections"
            },
    	"de-de": {
    	    "Category": "Kategorie",
    	    "metadata_name_value_2": "localized_label_value"
    	}
        },

13. Repeat 9 through 12 for any metadata for this locale (target language). Add more locales as needed. Click Save.

14. In the config.json file, go to the locale (target language) for which you want to add search facet localizations and add this string to it: "facet.taxonomy_name_value": "localized_label_value".

    "i18n": {
            "en": {
    	    "label.tenant": "[REPLACE]",
                "label.section": "Subject",
                "label.home": "Home",
                "label.sections": "Sections"
            },
    
    	"de-de": {
    	    "Category": "Kategorie",
    	    "metadata_name_value_2": "localized_label_value",
    	    "facet.taxonomy_name_value": "localized_label_value"
    	}
        },

15. Open the CCMS in a new tab or window, and from the Main Menu in the top-left corner select Taxonomy.
16. Go to a taxonomy and select the taxonomy term that you want to localize.
17. Copy the value in the Name field.

18. In the config.json file, replace taxonomy_name_value with the copied value.

    In our example, replace taxonomy_name_value with user_guide.

    At this point, your i18n parameter should look like this:

    "i18n": {
            "en": {
    	    "label.tenant": "[REPLACE]",
                "label.section": "Subject",
                "label.home": "Home",
                "label.sections": "Sections"
            },
    
    	"de-de": {
    	    "Category": "Kategorie",
    	    "metadata_name_value_2": "localized_label_value",
    	    "facet.user_guide": "localized_label_value"
    	 }
        },

19. In the config.json file, replace localized_label_value with the translation of the taxonomy term.

    In our example, replace localized_label_value with Benutzerhandbuch.

    At this point, your i18n parameter should look like this:

    "i18n": {
            "en": {
    	    "label.tenant": "[REPLACE]",
                "label.section": "Subject",
                "label.home": "Home",
                "label.sections": "Sections"
            },
    
    	"de-de": {
    	    "Category": "Kategorie",
    	    "facet.user_guide": "Benutzerhandbuch"
    	}
        },

20. Repeat these actions for any other taxonomy terms. Click Save.

You enable metadata as portal search facets by modifying the config.json file that your main portal sitemap uses. Portions of this procedure can be completed only by users assigned the Administrator role in Heretto CCMS. We recommend that Administrators complete the entire procedure as it involves working in the Source Editor and requires access to the Administration interface.

1. In the Content Library, ensure that you are working in the master branch and go to your main portal sitemap.
2. Open the main portal sitemap.
3. In the map tree pane, click the Gear button and set your options like this:
   1. Set Icons to On.
   2. Set Show Elements to All.
   3. Set Element Names to Full.

   The map tree now shows color-coded elements with full element names. This view enables you to easily identify and modify all elements in your sitemap.

4. Expand the sitemeta element, right-click the config.json element, and select Show file in Content Library.

5. In the Content Library, right-click the config.json file and select Edit Source.
6. In the Source Editor, press Ctrl/Cmd > F and search for facets.

   The facets parameter you are looking for is included in the search parameter.

   "search": {
           "ref": "href",
           "fields": [
               "href",
               "shortDescription",
               "title"
           ],
           "sections": [
               "sitesection"
           ],
           "facets": [
               "Information_Type",
               "Area"
           ]
       },

7. Open the CCMS in a new tab or window, and from the Main Menu in the top-left corner select Metadata.
8. Scroll to a metadata you want to enable as search facets and copy the value in the Name column.

9. Go to the config.json file and paste the copied value under the facets parameter.

   By default, the order in which you add the metadata name values to the config.json file defines their order in portal. Child facets grouped under a metadata name value are ordered alphabetically in portal. If name values start with numbers, they are listed first.

   Tip:

   If you want to override the default order of facets, or child facets, see Change the Order of Search Facets

   Important:

   If you need to add multiple name values to the facets parameter, ensure they are separated with a comma like shown in the example. Note that there is no comma after the last parameter value.

   The value Category copied from the Name column is pasted inside quotation marks ("") under the facets parameter.

   "facets": [
               "Category",
               "Area"
           ]

10. Populate the facets parameter with name values for each metadata you want to enable as a search facet.
11. Click Save.

You can rearrange the order of search facets by overriding the default sorting order. This is especially useful if your search facets are based on taxonomies and metadata.

1. Open the main portal sitemap.
2. In the Content Library, ensure that you are working in the master branch and go to your main portal sitemap.
3. In the map tree pane, click the Gear button and set your options like this:
   1. Set Icons to On.
   2. Set Show Elements to All.
   3. Set Element Names to Full.

   The map tree now shows color-coded elements with full element names. This view enables you to easily identify and modify all elements in your sitemap.

4. Expand the sitemeta element, right-click the config.json element, and select Show file in Content Library.

5. In the Content Library, right-click the config.json file and select Edit Source.
6. In the Source Editor, press Ctrl/Cmd > F and search for facets.

   The facets parameter you are looking for is included in the search parameter.

   "search": {
           "ref": "href",
           "fields": [
               "href",
               "shortDescription",
               "title"
           ],
           "sections": [
               "sitesection"
           ],
           "facets": [
               "Information_Type",
               "Area"
           ]
       },

7. If you already have the facets parameter in the search parameter, insert the facetsAdvancedSettings parameter immediately following the facets parameter.

   The facetsAdvancedSettings parameter requires the order parameter. You define the actual order of your facets and child facets there.

   Important:

   Be sure to insert a comma on the square brace that is right before the new facetsAdvancedSettings parameter, as illustrated in the example.

   The facetsAdvancedSettings parameter requires the order parameter. You define the actual order of your facets and child facets there.

   "search": {
           "ref": "href",
           "fields": [
               "href",
               "shortDescription",
               "title"
           ],
           "sections": [
               "sitesection"
           ],
           "facets": [
               "Information_Type",
               "Area"
           ],
   	"facetsAdvancedSettings": {
                "order":{
                     "Area": [],
                     "Information_Type": [],
                     "Grade_Level": {
                         "grade_1": [],
                         "grade_2": [],
                         "grade_3": [],
                         "grade_4": [],
                         "grade_5": [],
                         "grade_6": [],
                         "grade_7": [],
                         "grade_8": [],
                         "grade_9": [],
                         "grade_10": [],	
                         "grade_11": [],
                         "grade_12": []
                  	  }            
                }
           }

   In this example, we have changed the order of Area and Information_Type. We have also added a new metadata facet for grade levels. The default sort order for a list such as this would be grade_1, grade_10, grade_11, grade_12, grade_2, and so on. The facetsAdvancedSettings parameter enables sorting the grades by their logical order instead of their name in the CCMS.

8. Add as many metadata facets to the order parameter as needed.
   Important:

   The facetsAdvancedSettings parameter overrides the facets parameter. If you're using the facetsAdvancedSettings parameter, be sure to also include the configuration that you previously added to the facets parameter.

9. Be sure to save your changes to the config.json file.