Text configuration

In the “Text configuration” area you can define templates that allow for an automated generating of texts or attribute values. This e. g. accelerates the text production and ensures that texts have a uniform structure.

INFO
Click here to find a use case that explains how a specific text template is created.
INFO
Text templates can either be used generally, or it can be configured the generation of texts resp. attribute values triggered by the job “ProcessQueueGenerateTextJob” is limited to particular categories. Click here to find an example for an appropriate configuration.

Select templates

In order to select an existing template, proceed as follows:

  1. Choose the template from the template directory.
    Possibly use the text search to filter the list of templates by a search term.
  2. Click on the template to select it. Following this, the mappings belonging to this template are listed in the table on the right-hand side.
INFO
Using the column header tools you can filter table entries or adjust their sequence. In order to filter table entries you can also use the free-text search.

Create templates

In order to create a template for generating texts or attribute values, the first step is to create an empty template. In the second step, mappings are set up. When later creating a text resp. attribute value using a template, it comprises of the various mappings respectively their underlying values.

Create templates for texts

In order to create a new template for generating texts, proceed as follows:

  1. Click on the button to call up the corresponding dialog box.
  1. Enter a template name in the input field “ID”.
  2. Select the option “Text” from the “Scope” menu.
  3. Select a text type from the “Text type” menu*.
  4. Select a target language from the “Text language” menu*.
  5. Select a context level from the “Context” menu*.
  6. Via the “Calculate automatically” menu, specify whether text datasets based on the template are updated automatically whenever the underlying attributes resp. texts are changed. To do so, select the corresponding option*/**:
    • YES: Text datasets are updated.
    • NO: Text datasets are not updated.
  • In order to finish the process, click on the SAVE button. chevron to the right A success message is shown. Following this, you can set up mappings for the template.
  • In order to cancel the process, click on the CANCEL button.
Note
Note
  • **The automatic update is triggered by the job “ProcessQueueGenerateTextJob”.
  • **The automatic update requires that the property ipim.core.textsetup.autocalculate.enabled is set to “true”
INFO
Generating texts based on templates is either carried out by the job “ProcessQueueGenerateTextJob” or it can be carried out via the “GENERATE TEXT” button in the “Texts” tab of the “Product details” app.

Create templates for attributes

In order to create a new template for generating attribute values, proceed as follows:

  1. Click on the button to call up the corresponding dialog box.
  1. Enter a template name in the input field “ID”.
  2. Select the option “Attribute” from the “Scope” menu.
  3. Select an attribute from the “Attribute” menu.
  4. Select a target language from the “Target language” menu.
  5. Select a context from the menu “Context” menu.
  6. Via the “Calculate automatically” menu, specify whether attribute values based on the template are updated automatically whenever the underlying attributes resp. texts are changed. To do so, select the corresponding option*:
    • YES: Text datasets are updated.
    • NO: Text datasets are not updated.
  • In order to finish the process, click on the SAVE button. chevron to the right A success message is shown. Following this, you can set up mappings for the template.
  • In order to cancel the process, click on the CANCEL button.
Note
  • *The automatic update is triggered by the job “ProcessQueueGenerateTextJob”.
  • *The automatic update requires that the property ipim.core.textsetup.autocalculate.enabled is set to “true”
INFO
The generating of attribute values is either carried out by the job “ProcessQueueGenerateTextJob” or it can be done using the “Generate attribute” action from the action menu. Click here to learn more.

Edit templates

In order to edit the settings of a template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Move the mouse cursor over the template. Following this appears theAction menubutton.
  3. Click on theAction menubutton to access the action menu.
  4. Click on the button to call up the corresponding dialog box.
  5. Make the desired changes.
  • In order to save your changes, click on the SAVE button.Arrow to the right A success message is shown.
  • In order to cancel the process, click on the CANCEL button.

Duplicate templates

First introduced in version 5.4.2: In order to duplicate a template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Move the mouse cursor over the template. Following this appears theAction menubutton.
  3. Click on theAction menubutton to access the action menu.
  4. Click on the Duplicate button to execute the duplicating of the template. If the process was successful a corresponding message will appear and a copy of the template appears in the list of templates.

Delete templates

In order to delete a template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Move the mouse cursor over the template. Following this appears theAction menubutton.
  3. Click on theAction menubutton to access the action menu.
  4. Click on the button. Following this, the corresponding prompt window appears.
  • In order to finish the deleting of the template, click on the CONFIRM button. If the process was successful, a corresponding message will appear an the template vanishes from the list of templates.
  • In order to cancel the process, click on the CANCEL button.

Create mappings

A template comprises a given number of mappings. When later generating a text respectively an attribute value based on a template, it comprises of all the individual mappings. There are different kinds of mapping types which can be configured as described below.

Note
The base configuration offers the mapping types “Constant”, “Attribute” and “Text”. Apart from that there are also the mapping types “Implementation” and “Parameter”. These two mapping types is configured during the system setup.

Create mappings of the “Constant” type

In order to configurate a “Constant” type mapping for a particular template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Click on the template to select it.
  1. Click on the CREATE button in the footer of the “Mappings” table to call up the corresponding dialog box.
  1. Select the mapping type “Constant” from the menu and click on the SAVE button. Following this, the dialog box closes and a new mapping entry appears in the table.
  1. Possibly select a prefix from the menu in the table cell of the “Prefix” column. When generating a text respectively attribute value, the selected prefix will be put at the beginning of the mapping.
  2. Enter a text in the table cell of the “Value” column.
  3. Select the option “Value” from the menu in the table cell of the “Configuration” row.
  4. From the menu in the table cell of the “End” row, possibly select the corresponding option to determine if the mapping ends with a blank space or a line break.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.
Note
The selection of available prefixes can be specified via the appropriate properties. Via the property textsetup.mapping.prefixes, the selection of prefixes can defined whereby the individual prefixes are separated by delimiters. These delimiters can be specified via the property textsetup.mapping.propertydelimiter. Using the property textsetup.mapping.delimiters it is specified which delimiters can be used as resp. as part of prefixes. And via the property textsetup.mapping.blank it is specified how empty spaces are written in the definition of prefixes.

Create mappings of the “Attribute” type

For a mapping of the type “Attribute” you can determine an attribute that will serve as the basis for the mapping. When generating a text or an attribute value for a product, a variant or an item, it will consist of the attribute value which is stored for the respective product, variant or item. In order to configurate such a mapping for a particular template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Click on the template to select it.
  1. Click on the CREATE button in the footer of the “Mappings” table to call up the corresponding dialog box.
  1. Select the mapping type “Attribute” from the menu and click on the SAVE button. Following this, the dialog box closes and a new mapping entry appears in the table.
  1. Possibly select a prefix from the menu in the table cell of the “Prefix” column. When generating a text respectively attribute value, the selected prefix will be put at the beginning of the mapping.
  2. Select an attribute from the menu in the “Value” column. Possibly enter a search term in the input field “Search” to filter the list of attributes by a search term.
  3. From the menu in the “Configuration” column, select which properties of the selected attribute are used. The options are:
    • Boolean: This option is for boolean attributes. If the respective attribute value is “Yes” the generated text or attribute value based on the mapping will consist of the attribute name and the attribute value. If the respective attribute value is “No”, the mapping is not considered.
    • Name: Only the name of the selected attribute will be used.
    • Name and Value: The name and value of the selected attribute will be used.
    • Value: Only the value of the selected attribute will be used.
  4. Possibly select a delimiter from the menu in the “Delimiter” column. If a text or attribute value based on the respective mapping consists of two elements such as the name and the value of an attribute, the elements will be separated by the selected delimiter.
  5. If you have selected an attribute for which a unit of measurement is established, select the corresponding option from the menu in the “UOM” column to determine wether the mapping includes the unit of measurement.
  6. From the menu in the table cell of the “End” row, possibly select the corresponding option to determine if the mapping ends with a blank space or a line break.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Create mappings of the “Text” type

If a product, variant or item has a text for the selected texttype, this text forms the basis for the mapping. In order to configurate such a mapping for a particular template, proceed as follows:

  1. Choose the template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Click on the template to select it.
  1. Click on the CREATE button in the footer of the “Mappings” table to call up the corresponding dialog box.
  1. Select the mapping type “Text” from the menu and click on the “SAVE” button. Following this, the dialog box closes and a new mapping entry appears in the table.
  1. Possibly select a prefix from the menu in the table cell of the “Prefix” column. When generating a text respectively attribute value, the selected prefix will be put at the beginning of the mapping.
  2. Select a texttype from the menu in the “Value” column. Possibly use the text search to filter the list of texttypes by a search term.
  3. Select the option “Value” from the menu in the table cell of the “Configuration” row.
  4. From the menu in the table cell of the “End” row, possibly select the corresponding option to determine if the mapping ends with a blank space or a line break.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Modify the sequence of mappings

Using the corresponding buttons you can change the sequence of mappings in order to modify the selected template accordingly. To do so, proceed as follows:

  1. Move the mouse cursor over the mapping you want to remove. Then appears a bar containing several buttons.
  2. Click on the appropriate button:
    • In order to move the mapping upwards by one step, click on the Nach oben button.
    • In order to move the mapping downwards by one step, click on the Nach unten button.
    • In order to move the mapping to the top, click on the Ganz nach oben button.
    • In order to move the mapping to the bottom, click on the Ganz nach unten button.
  • In order to save your changes, click on the SAVE button.
    Pfeil nach rechtsA success message is shown.
  • In order to dismiss your changes, click on the RESET button.

Delete mappings

In order to delete a mapping, proceed as follows:

  1. Choose the superordinate template from the template directory. Possibly use the text search to filter the selection of templates by a search term.
  2. Click on the template to select it.
  3. Click on the template to select it. Then all the mappings of the selected template will be listed in the table of the “Mappings” table.
  4. In the table, tick the mapping you want to delete. You can also tick multiple mappings.
  5. Click on the DELETE button in the footer.
    The CLICK TO CONFIRM button is shown.
  6. Click on the CLICK TO CONFIRM button to confirm the deleting.
    A success message is shown.

FAQ

How does the “Calculate automatically” option affect the creation of a template?

Via the “Calculate automatically” menu, you can specify whether text datasets resp. attribute values based on the template are updated automatically whenever the underlying attributes resp. texts contained in the template are changed.

What triggers the automatic update of text datasets resp. attribute values?

The automatic update is triggered by the job “ProcessQueueGenerateTextJob”. For the update to work via this job, the property ipim.core.textsetup.autocalculate.enabled must also be set to “true”.

In which two ways can the generating of texts based on templates be carried out?

Generating texts based on templates is either carried out by the job “ProcessQueueGenerateTextJob” or it can be carried out via the GENERATE TEXT button in the “Texts” tab of the “Product details” app.

In which two ways can the generating of attribute values based on templates be carried out?

The generating of attribute values is either carried out by the job “ProcessQueueGenerateTextJob” or it can be done using the “Generate attribute” action from the action menu.

Can the selection of available prefixes for mappings be specified?

The selection of available prefixes can be specified via the appropriate properties. Via the property textsetup.mapping.prefixes, the selection of prefixes can be defined, whereby the individual prefixes are separated by delimiters. These delimiters can be specified via the property textsetup.mapping.propertydelimiter. Using the property textsetup.mapping.delimiters it is specified which delimiters can be used as resp. as part of prefixes. Via the property textsetup.mapping.blank it is specified how empty spaces are written in the definition of prefixes.