Text Management¶
Within the Navertica Product Platform Management module, extended product text management is available, which allows defining various types of descriptive texts for products with different validity periods and in different languages.
Product Text Classification¶
In PIM, different types of product texts can be maintained — some can be short (various variants of product descriptions related to a specific channel), while other texts can be extensive including rich-text formatting (short and long product descriptions). For further work with these texts, it is necessary to handle their classification for external and internal use.
This classification is performed using the "Product Text Classification" setup, which is available from the BC menu, or from the Product Platform Management setup.
Within this setup, the user can define any set of different text types that they may want to enter in PIM. For each text, the user can define how the text will be entered into BC, i.e., whether it is a simple descriptive text or whether it is a text considering advanced HTML formatting.
| Field | Meaning |
|---|---|
| Code | serves as a user-definable identifier of the text (the user later enters this code when assigning the text to various entities in PIM) |
| Description | serves as a short description of the purpose of the given text for better user clarity |
| Text Type | is used to distinguish how to further work with the text from the perspective of its generation and composition, i.e., whether the text may contain advanced formatting. The user can choose one of the values:
|
| Maximum Length | the user can define the number of characters that should be checked for the entered text and must not be exceeded when entering the text (e.g., due to a limitation on the receiving system side) |
| Text Input Option | is used to determine whether formatting can be used in the final text, and thus also determines how the text will be stored in the database. Currently it can have the values:
|
Product Text Placeholders¶
To simplify entry and mass management of product texts, our PIM solution allows defining custom placeholders that can represent selected data in BC and, by using a placeholder in a product text, generate these data into selected places in the texts. This therefore allows, for example, automatically generating into product description texts a section with an attribute listing based on the attributes assigned to a specific item card, or extending a product text with a short text dedicated to the product supplier or brand.
Placeholder setup is a somewhat more complex topic, mainly because the use of placeholders offers the possibility to define custom placeholders as needed.
PIM Text Placeholder Setup¶
This setup is used to define placeholders that you want to use in entered product texts. Placeholder setup is accessible from the BC menu, and is also accessible from the Product Information Management Setup.
After running this action, the user will see an overview of placeholders that are currently usable for PIM texts.
| Field | Meaning |
|---|---|
| Code | specifies the placeholder identifier defined by the user and later used to apply the placeholder in individual PIM texts (maximum 20 characters). The placeholder code is entered without the auxiliary characters that indicate the start and end of the placeholder (these are then added when inserting the placeholder into the text). |
| Product Platform Code | specifies the product platform code for which the placeholder is defined (e.g., I may want to apply different filters for placeholders for different platforms) |
| Description | user-defined explanation for the placeholder (maximum 100 characters) |
| Placeholder Assignment Type | this field specifies which entity the placeholder is assigned to; this information is especially important if nested information needs to be listed so that the use of the assigned placeholder can be identified and thus the starting point for individual relations. The field will offer selection from the following options (the offer corresponds to the list of entities to which PIM texts can be assigned):
|
| Placeholder Type | placeholders can be of two types: entry or list; based on this, the display of information will be ensured:
|
| Translate Value | if this checkbox is selected, translation will be handled for the given field; if it is not selected, it will be a value that is not desirable to translate |
| Transform Value Formatting | specifies whether, when working with the placeholder, the value format will be updated to the local format |
Each placeholder can have one or more steps defined — steps are used to define a chain of steps through which the desired placeholder value can be found. Individual steps are numbered sequentially. In the first step, the system always starts from the entity to which the placeholder is subsequently offered. The other steps are then defined by the user. First, the user defines a chain of steps of type Relation, by which they define through which tables the system must pass when finding a specific placeholder.
The user can access placeholder step setup using the "Steps" action available in PIM Text Placeholder Setup.
| Field | Meaning |
|---|---|
| Placeholder Code | specifies the placeholder code to which the setup relates |
| Product Platform Code | specifies the product platform code to which the placeholder belongs |
| Placeholder Assignment Type | together with the placeholder code uniquely specifies the placeholder for which the setup is created, and also serves for validation of the table that must be used for the first step of the lookup |
| Step No. | specifies the number of the newly created record; numbering will be similar to line numbers on BC documents, i.e., 10000, 20000, etc. |
| Step Type | specifies the step type; currently it is possible to define steps of two types:
|
| Source Table ID | is defined automatically based on the placeholder assignment type or based on the previous step; the user does not enter it |
| Related Table ID | specifies the related table ID if Step Type = Relation |
| Field | is used to fill in the field ID from the last step if Step Type = Value and Placeholder Type = Entry |
| List Content | will be used to define values if Step Type = Value and Placeholder Type = List |
| Repeat | specifies whether for the given line the value should be searched repeatedly, or whether only the first occurrence should be output |
In the step list, the individual tables through which the placeholder value lookup chain passes are defined. However, for correct placeholder identification it is also necessary to define the relations between the individual tables and any filters that must be considered when looking up the record.
| Field | Meaning |
|---|---|
| Placeholder Code | specifies the placeholder code to which the given relation relates |
| Product Platform Code | specifies the product platform code to which the placeholder is assigned |
| Placeholder Assignment Type | specifies the placeholder assignment type, i.e., the source entity for which the text in which the placeholder can be used will be defined |
| Step No. | specifies the placeholder lookup step number for which this relation is applied |
| Line No. | specifies the line number for relation definition; similar numbering will be used as is currently used on sales documents, i.e., 10000, 20000, etc. |
| Related Field | will contain the field number in the related table against which either a relation is specified or which will be filtered to the entered value/string |
| Relation Type | specifies the relation type represented by the values in the Filter Value field; the field can have the values:
|
| Filter Value | the field is used to specify:
|
When entering filters, it is possible to work with two types of placeholders that work with dates (e.g., when searching for texts valid on a certain date):
- work date
- system date
PIM Text Placeholder Testing¶
Because placeholder setup is relatively complicated, it is desirable for the user to have the option to verify whether the placeholder is set up correctly and whether it returns the expected result for the selected entity (e.g., a selected item card).
If the user runs this action on a selected placeholder, a dialog will be shown prompting them to select the card for which they want to perform the placeholder test. The user can also select the desired language for the check, so that also the translation of the selected text will be generated correctly.
In the Plain Text and Formatted Text fields, a preview of the resulting values for the given placeholder is then displayed.
PIM Text Translation Tables Setup¶
Within the PIM module, it is possible to work with translations for selected parts of texts. Because translations for different tables/fields can be handled in different ways in BC, it is necessary to define the individual base and translation tables and the relations between them. For this purpose, "PIM Translation Table Setup" exists in BC, which is accessible under this name from the BC menu, or from the Product Information Management Setup.
In this setup, the user defines the relations between the base and translation tables, i.e., which field of which table has a translation, in which corresponding table, and identification of which translation table field corresponds to the language code (in different translation tables this may be a different field).
| Field | Meaning |
|---|---|
| Source Table ID | specifies the table ID set within the placeholder for which the translation will be defined |
| Field No. | defines the field number from the source table to which the translation field relates |
| Translation Table ID | specifies the table ID in which translations for the source table are maintained |
| Translation Field No. | specifies the field number of the table in which the required translation is stored |
| Language Code Field No. | specifies the field number in the translation table in which the language code is stored |
For each table pair, it is also necessary to define filters by which these tables are linked and which must be applied when looking up the translation.
| Field | Meaning |
|---|---|
| Source Table ID | is filled in in the background according to the record from which the action is started |
| Source Table Field No. | the user fills in according to the required source table field |
| Line No. | serves to allow entering multiple filter parameters for one table pair (generated automatically in the background; the user does not have to enter it) |
| Related Table ID | specifies the field number of the translation table for which the relation is valid (taken from the PIM Translation Table Setup line) |
| Related Field | specifies the field ID that is related to the given value |
| Relation Type | specifies the relation type represented by the values in the Filter Value field; the field can have the values:
|
| Filter Value | the field is used to specify:
|
When entering filters, it is possible to work with two types of placeholders that work with dates (e.g., when searching for texts valid on a certain date):
- work date
- system date
To generate a standard set of base and translation tables, it is possible to use the "Create Defaults" action, which is available in PIM Translation Table Setup.
PIM Text Templates¶
To simplify entering texts that are of the same type, it is possible to use PIM text templates. The user sets up templates using the "PIM Text Templates" action available in the Product Information Management Setup.
| Field | Meaning |
|---|---|
| No. | a unique identifier assigned to the given template (it can be entered manually or generated from the number series set in the Product Information Management Setup) |
| Product Platform Code | the product platform code to which the given template is assigned |
| Language Code | the language code for which the given template is valid |
| Text Type | is used to identify whether the given text is usable as a template or not; it is filled automatically when a new template is created |
| Assignment Type | specifies to which entity within PIM the text is assigned; currently it can be the following entities:
|
| Assignment No. | specifies to which entity number the text is assigned; depending on the type, this is:
|
| Assignment Variant Code | specifies a more detailed identification of the assigned entity:
|
| Text Classification Code | specifies what type of text it is with a link to the Product Text Classification table (the type affects subsequent text storage, therefore the type must not be empty before the user starts entering data for the text) |
| Short Text | a text field with a maximum length of 250 characters that does not allow saving formatted text (it will be used to store standard common descriptions) |
| Long Text | a BLOB field into which a long descriptive text including rich-text formatting can be stored |
| Status | specifies the current status of the text and is decisive for external systems that process data from PIM; currently the statuses can be:
|
| Starting Date | used to indicate the starting date of validity of the given text |
| Ending Date | used to indicate the ending date of validity of the given text |
Edits of individual texts used for templates can be performed using the "Edit" action. The difference in the case of a template text compared to preparing a text for the product itself is that, in the case of a template, there is no preview of the final output (i.e., placeholder replacement with real content).
Within text templates, it is possible to use product text placeholders. For filling placeholders, two windows are available in the product text editing interface. In the first one (the "Choose Field" window), the user has placeholders available for individual fields available on the card to which the template is being assigned (e.g., an item card or category card). In the second one (the "Choose Placeholder" window), the user has placeholders available that are defined for the given card in PIM Text Placeholder Setup, i.e., placeholder selection as needed.
To insert a placeholder into the text, it is possible to select the chosen placeholder and, using the "Copy" action, copy it including the selected starting and ending characters for opening/closing the placeholder. You can then insert the copied placeholder to the appropriate place in the text using the Ctrl + V keyboard shortcut or by right-clicking and using the Paste action.
Note
PIM texts support the creation of versions of individual texts, e.g., for cases when the text changes and the texts need to be generated again. For templates, versioning is currently not possible — if the template needs to be updated, it is necessary to end the validity of the original template and create a new template that will replace the original. An alternative to this procedure is updating the content of the original template. In both cases, however, it may be necessary to handle updates of the product texts themselves — the system itself does not perform changes to previously published texts when templates are changed.
Entering PIM Texts¶
In the following chapter, the methods by which it is possible to enter PIM texts will be described. PIM texts can be entered for:
- items
- item variants
- item categories
- attributes
- attribute values
- PIM labels
Creating a New Text¶
The process of creating product texts is identical for all entities to which product texts can be assigned. Above each such list, the following actions are available:
- Long PIM Texts (displays only texts with Text Type = Long Description)
- Short PIM Texts (displays only texts with Text Type = Short Description)
- PIM Description (displays only texts with Text Type = Description)
- PIM Texts (displays all texts assigned to the given card regardless of text type)
After running these actions, the user will see an overview of texts that are currently maintained for the given card.
Using the "Edit" action, the user switches to editing the created text. When creating a new text, the user needs to enter:
- product platform (if the text should be linked to it)
- text classification code (so it is clear in BC how the texts should be processed)
- language code
- text validity (starting/ending date according to the required limitation)
After running the Edit action, the user will enter the window for editing the product text. This overview in the header contains details about the currently edited text or its version. In the section below the header, an editable section is displayed for entering plain or formatted text (depending on the selected text type). In the Preview section, a preview of the already entered product text is then displayed, and during preview generation the placeholders are replaced by their values. The primary purpose of the preview is therefore to verify that the data meet the requirements.
Refresh Preview Action¶
The purpose of this action is to allow the user to trigger regeneration of the text preview if needed (e.g., after making manual changes in the text). When this action is run, the Preview section is updated according to the current values entered in the Rich Text field (and also the Plain Text field if it contains placeholders).
Copy from Template Action¶
The purpose of this action is to enable the user to generate the text using a template. The template would in that case contain static parts of product texts and may also contain placeholders for values that should be filled depending on the parameters of the specific record.
After running this action, the user will be shown a selection of templates that can be used to enter the text.
After confirming the template selection, the content according to the selected template is filled into the Plain Text/Formatted Text field. At this step, placeholders are not yet automatically replaced in the text. The user can make any changes in the copied text.
Note
The template can be applied only to a text that has not previously had content assigned. If the text already has some content, the system will offer the template selection, but will not write the template text into the given text. If the user truly wants to replace the text with the template text, they must first delete the content of the Plain Text/Formatted Text field and then they can use the template again.
Copy Text Action¶
The Copy Text action is used for simple transfer of texts between a base card and a new version, or between similar cards where there is only a very small difference and it is therefore more efficient to copy the text from another similar card than to create the entire PIM text again.
After running the Copy Text action, the user is prompted to select the text, or the text version, from which they want to copy the text.
The selection of texts from which it is possible to copy is relatively wide; the main limitation of the selection is the Text Classification Code, i.e., only texts with the same classification and assigned to the same type are offered for copying (for items, only texts assigned to the item and its variants are interchangeable).
After confirmation, the selected text is transferred into the Plain Text/Formatted Text field for the given text, or text version.
Resolve Placeholders Action¶
The principle of working with placeholders in PIM is such that placeholders are intended to simplify and speed up entering the text in the required structure. Placeholders therefore play a role especially in PIM text templates. For the target presentation of the text, however, placeholders are no longer desirable because the target system would not be able to interpret them. Unpacking placeholders occurs in PIM in the following cases:
- the user certifies the selected text
- the user manually selects the Resolve Placeholders action
Manual resolving of placeholders may be desirable, for example, if the user needs to modify a selected part of the product text (for example, write the value of a selected attribute differently), and therefore needs to work with the final version of the text.
Note
After resolving placeholders, there is no possibility to "pack" them back; the system then no longer retains the information about the text in the form it had before the placeholders were unpacked. We therefore expect the use of this manual action rather in exceptional cases.
Translate Action¶
In the next version of the PIM module, support for translation automation with connection to machine translators will be implemented. In the current version of PIM, translations must be created manually.
Certify / Reopen Action¶
Product texts can have various statuses — when created, a product text has the New status, which is the default status for newly created texts. When the user is fully satisfied with the text and has made all required edits, the user switches the text or its version to Certified using the "Certify" action.
Certifying the text will:
- lock the text for further user editing
- mark the date and time of the last certification and the user who performed the last certification
- resolve placeholders contained in the product text (i.e., convert the Plain Text/Rich Text field into the final form for the target system)
If the user subsequently decides to make additional changes in the text, it is necessary to reopen the text. The "Reopen" action on the PIM text is used for this purpose. This action changes the text status to In Development and the user can make the required changes/edits in the text.
Note
When reopening the text, there is no reversal of used placeholders; i.e., the user works with a text in which the placeholders are unpacked. If the product has undergone more significant changes, the recommended procedure is to create a new text version, which should have smaller impacts on external display systems.
Note
The ability to reopen a certified text depends on the setup of the "Allow Product Text Reopening" field performed in the Product Information Management Setup. If this field is not selected, reopening the text is not possible (this may be influenced by the requirements of the external target system).
Text Version Management¶
For each text that is not a template, it is possible to maintain one or more versions of the text. The purpose of a version is to be able to change the content of the same text over time and have a history of published text versions available.
The user enters versions from PIM texts using the "Versions" action; the list of currently created versions is also available using an information pane on the PIM texts overview.
After running the "Versions" action, the user will see the list of available product text versions. The user can edit the selected text using the "Edit" action, or create a new text version using the "New" action. When creating a new version, the user enters the version code (numbered manually as needed) and optionally the version validity (starting and/or ending date).
Entering the text for a text version is performed in a similar manner as in the case of the standard "base" text. The user also has the same set of supporting functions available for creating the text; they can therefore use the current template to generate the text or copy the text from the previous version/base product text.