Wiki source code of Dictionaries
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="lead" %) | ||
| 2 | **Dictionaries** are used to store and manage various reference data in Loymax Smart Communications. They allow users to quickly find the required information and ensure consistent representation and data relevance. | ||
| 3 | |||
| 4 | (% class="box" %) | ||
| 5 | ((( | ||
| 6 | **Contents:** | ||
| 7 | |||
| 8 | {{toc depth="3" start="3"/}} | ||
| 9 | ))) | ||
| 10 | |||
| 11 | === List of dictionaries === | ||
| 12 | |||
| 13 | Information about dictionaries in Loymax Smart Communications is located in the section **[[Settings>>doc:Main.Smart_Communications.SMC_Use.Settings_SC.WebHome]] > Dictionaries**. Dictionaries are divided into two types: | ||
| 14 | |||
| 15 | 1. **System** — dictionaries that are pre-defined in the System. Only limited editing functionality is available for system dictionaries, and they cannot be deleted. | ||
| 16 | 1. **Custom** — dictionaries created by users. | ||
| 17 | |||
| 18 | |(% style="border-color:#ffffff; text-align:center" %){{lightbox image="Dictionaries.png" width="1000"/}} | ||
| 19 | |||
| 20 | |(% style="border-color:white; width:958px" %)((( | ||
| 21 | To create a new dictionary, click the **Add dictionary** button. The **Dictionary properties** window will open. You need to specify the **Name** and **Code** of the dictionary. The code is used to access the dictionary via API. | ||
| 22 | |||
| 23 | The following actions can be performed with a dictionary: | ||
| 24 | |||
| 25 | * **Edit** — allows changing the name and code of the dictionary; | ||
| 26 | * **Configure** — by clicking there opens the **Field list** window, where you can add or remove [[fields>>doc:Main.Smart_Communications.SMC_Use.Settings_SC.Data_field.WebHome]] as needed; | ||
| 27 | * **Delete**. | ||
| 28 | |||
| 29 | There is also a **search bar that** allows to search dictionaries by their name and code. | ||
| 30 | |||
| 31 | |||
| 32 | |||
| 33 | )))|(% style="border-color:white; width:480px" %){{lightbox image="Add_dictionary.png"/}} | ||
| 34 | |||
| 35 | Clicking on the **Name** of a dictionary there opens a window containing the list of items in that dictionary. | ||
| 36 | |||
| 37 | |(% style="border-color:#ffffff; text-align:center" %){{lightbox image="Dictionary_name.png" width="1000"/}} | ||
| 38 | |||
| 39 | === Dictionary item list === | ||
| 40 | |||
| 41 | |(% style="border-color:white; width:963px" %)The page displays a list of all items in the dictionary.|(% style="border-color:white; text-align:left; width:684px" %){{lightbox image="Dictionary_item.png"/}} | ||
| 42 | |(% style="border-color:white; width:963px" %)((( | ||
| 43 | To add a new item to the dictionary, click the **Add item** button in the top-right corner. The **Dictionary item property** window will open. You need to specify: | ||
| 44 | |||
| 45 | * **Identifier** of the item; | ||
| 46 | * **Value** of the item. | ||
| 47 | |||
| 48 | You also have the option to **edit** or **delete** an item from the dictionary. To do this, click the corresponding buttons at the end of the row for the desired item. | ||
| 49 | |||
| 50 | A **search** function by name and identifier is also available in this section. | ||
| 51 | )))|(% style="border-color:white; text-align:left; width:684px" %){{lightbox image="Item_property.png"/}} | ||
| 52 | |||
| 53 | === System dictionary "Unsubscribe reasons" === | ||
| 54 | |||
| 55 | (% class="box infomessage" %) | ||
| 56 | ((( | ||
| 57 | * This functionality is available only if you have access to the section **Loymax Smart Communications > [[Settings>>doc:Main.Smart_Communications.SMC_Use.Settings_SC.WebHome]]**. If you don't have access to this section, please contact Loymax Technical Support ([[support@loymax.ru>>mailto:support@loymax.ru]]). | ||
| 58 | * We do not recommend editing the **Unsubscribe reasons** dictionary using the edit button — i.e. changing its name or code. | ||
| 59 | ))) | ||
| 60 | |||
| 61 | |(% style="border-color:white; width:953px" %)((( | ||
| 62 | Click on the **Unsubscribe Reasons** dictionary name to open the **Dictionary items** page. By default, two unsubscribe reasons are already set up: | ||
| 63 | |||
| 64 | * The content of the mailing is not interesting to me; | ||
| 65 | * Mailing messages arrive too frequently. | ||
| 66 | |||
| 67 | You can add new unsubscribe reasons by clicking the **Add item** button in the top-right corner of the page. | ||
| 68 | )))|(% style="border-color:white; text-align:center; width:693px" %){{lightbox image="Unsubscribe_items.png"/}} | ||
| 69 | |(% style="border-color:white; width:953px" %)((( | ||
| 70 | The **Dictionary item property** modal window will open, where you need to specify: | ||
| 71 | |||
| 72 | * **Identifier** — a string value. Latin letters, as well as underscores, are allowed. | ||
| 73 | * **Value** — a description of the reason for unsubscribing from mailings. | ||
| 74 | |||
| 75 | (% class="box" %) | ||
| 76 | ((( | ||
| 77 | For example: | ||
| 78 | |||
| 79 | * **Identifier** — not_relevant | ||
| 80 | * **Value** — These offers are not relevant to me | ||
| 81 | ))) | ||
| 82 | |||
| 83 | The selected reason will become available in the unsubscribe options on the [[Unsubscribe page>>doc:Main.Smart_Communications.SMC_Use.Mass_messaging.Subscription_synchronization.WebHome||anchor="01"]]. If a customer selects this reason and unsubscribes from mailings, it will be listed in the [[analytical report>>doc:Main.Smart_Communications.SMC_Use.Mass_messaging.Mailing_report.WebHome]]. | ||
| 84 | )))|(% style="border-color:white; text-align:left; width:693px" %){{lightbox image="Unsubscribe_item_prop.png"/}} | ||
| 85 | |||
| 86 | (% class="box infomessage" %) | ||
| 87 | ((( | ||
| 88 | **Note**: If the previously used **identifier** and/or **value** have been renamed, the unsubscribe reasons already present in the database will remain with the old identifier. | ||
| 89 | ))) |