diff --git a/modules.json b/modules.json index f992dfc..eb0d465 100644 --- a/modules.json +++ b/modules.json @@ -69,6 +69,13 @@ "listings-request/object.json" ] }, + "Localization": { + "description": "Create and manage your translations and translation attributes within the CloudBlue Connect system.", + "icon": "translate", + "objects": [ + "translations/object.json" + ] + }, "Marketplaces": { "description": "Define and control assignment of Hubs and Accounts to the Marketplaces with the Marketplaces Management module.", "icon": "shopping_cart" diff --git a/translations/object.html b/translations/object.html new file mode 100644 index 0000000..88193c9 --- /dev/null +++ b/translations/object.html @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/translations/object.json b/translations/object.json new file mode 100644 index 0000000..a4162cc --- /dev/null +++ b/translations/object.json @@ -0,0 +1,77 @@ +{ + "name": "Translations", + "image": "object.png", + "readme": "object.md", + "statuses": [ + { + "id": "s-a-inactive", + "name": "Inactive", + "mapping": { + "left": "32.69%", + "top": "25.17%", + "width": "22.05%", + "height": "28.18%" + } + }, + { + "id": "s-b-active", + "name": "Active", + "mapping": { + "left": "78.08%", + "top": "26.21%", + "width": "19.21%", + "height": "26.46%" + } + } + ], + "transitions": [ + { + "id": "t-1-new-inactive", + "from": "New", + "to": "Inactive", + "name": "1. Translation Creation", + "mapping": { + "left": "16.37%", + "top": "27.5%", + "width": "13.49%", + "height": "11.05%" + } + }, + { + "id": "t-2-in-active", + "from": "Inactive", + "to": "Active", + "name": "2. Translation Activation", + "mapping": { + "left": "59.42%", + "top": "27.69%", + "width": "13.49%", + "height": "11.05%" + } + }, + { + "id": "t-3-act-inactive", + "from": "Active", + "to": "Inactive", + "name": "3. Translation Deactivation", + "mapping": { + "left": "58.96%", + "top": "0.43%", + "width": "13.49%", + "height": "11.05%" + } + }, + { + "id": "t-4-in-deleted", + "from": "Inactive", + "to": "Deleted", + "name": "4. Translation Removal", + "mapping": { + "left": "36.62%", + "top": "63.47%", + "width": "13.49%", + "height": "11.05%" + } + } + ] + } diff --git a/translations/object.md b/translations/object.md new file mode 100644 index 0000000..e2906e8 --- /dev/null +++ b/translations/object.md @@ -0,0 +1,13 @@ +# Translations +## Overview +Translation objects are used to localize your specified context keys to your selected language. Such objects are created and managed via the Localization module on the CloudBlue Connect platform. To understand the workflow of translation objects, it is necessary to understand the difference between contexts and translations. + +*Context* refers to a defined list of common keys that can be translated by using the Connect platform. Context keys can represent product description, various notifications, fields, messages and titles. +Therefore, *translation* refers to a list of localized (or translated) key values for your selected language. The system can provide translations automatically and allows editing such values manually. Generated translations are also available for your business partners in case such objects are activated successfully. + +Translation objects that are generated by the system and include original context keys are called *primary* translations on the Connect platform. Such translations cannot be edited via the Localization module. However, the system enables to assign your created translation as your primary translation for the selected context. + +Note that it is also possible to clone your translation objects and compare translations if necessary. Furthermore, the system allows creating as many translation objects as it is required for your business. + +## Learn more +Refer to the [Localization module documentation](https://connect.cloudblue.com/community/modules/localization/) to learn more about this module and your translations management. diff --git a/translations/object.png b/translations/object.png new file mode 100644 index 0000000..4658ad2 Binary files /dev/null and b/translations/object.png differ diff --git a/translations/object.pptx b/translations/object.pptx new file mode 100644 index 0000000..414c230 Binary files /dev/null and b/translations/object.pptx differ diff --git a/translations/s-a-inactive.md b/translations/s-a-inactive.md new file mode 100644 index 0000000..33064b0 --- /dev/null +++ b/translations/s-a-inactive.md @@ -0,0 +1,16 @@ +# Inactive Status +## Description +The *Inactive* status indicates that your translation is deactivated and cannot be applied to your selected context. Specifically, inactive translations will not be available for your business partners or customers. + +Note, however, that inactive translations can be previewed within the system and can be selected as your primary translations for your context. +The system allows editing your inactive translations, cloning such objects, and comparing them with active or inactive translations. Inactive translations can also be removed if necessary. +## Prerequisites +A new created translation on the Connect platform. +Alternatively, a translation object in the [Active](s-b-active.html) state that should be deactivated. +## Transferable statuses +Once your translation is successfully activated, it is assigned to the [Active](s-b-active.html) state. +## Associated transitions +* [Translation Creation](t-1-new-inactive.html) +* [Translation Activation](t-2-in-active.html) +* [Translation Deactivation](t-3-act-inactive.html) +* [Translation Removal](t-4-in-deleted.html) diff --git a/translations/s-a-inactive.png b/translations/s-a-inactive.png new file mode 100644 index 0000000..d658073 Binary files /dev/null and b/translations/s-a-inactive.png differ diff --git a/translations/s-b-active.md b/translations/s-b-active.md new file mode 100644 index 0000000..d351b0d --- /dev/null +++ b/translations/s-b-active.md @@ -0,0 +1,13 @@ +# Active Status +## Description +The *Active* status implies that your translation is activated successfully. Therefore, your translation will be available for your business partners or customers. Your business partners will also be able to generate additional translation objects based on your translation within the system. +Your active translation can be assigned as the primary translation for your context. +The system also enables to edit your active translations, to clone active translation objects, and to compare them with other active or inactive translations. +Note that active translations cannot be removed. +## Prerequisites +A translation object in the [Inactive](s-a-inactive.html) state that should be activated. +## Transferable statuses +In case your translation is deactivated, the system assigns it to the [Inactive](s-a-inactive.html) state. +## Associated transitions +* [Translation Activation](t-2-in-active.html) +* [Translation Deactivation](t-3-act-inactive.html) diff --git a/translations/s-b-active.png b/translations/s-b-active.png new file mode 100644 index 0000000..f6c4883 Binary files /dev/null and b/translations/s-b-active.png differ diff --git a/translations/t-1-new-inactive.md b/translations/t-1-new-inactive.md new file mode 100644 index 0000000..f030465 --- /dev/null +++ b/translations/t-1-new-inactive.md @@ -0,0 +1,7 @@ +# Translation Creation +## Description +This transition indicates that a translation object is being generated on the CloudBlue Connect platform. Note that your created translation will not be applied to your selected context and will not be available for your business partners until it is activated within the system. +## Prerequisites +Your selected context and specified translation language. +## Operation results +A new translation object in the [Inactive](s-a-inactive.html) state. diff --git a/translations/t-1-new-inactive.png b/translations/t-1-new-inactive.png new file mode 100644 index 0000000..d119c6a Binary files /dev/null and b/translations/t-1-new-inactive.png differ diff --git a/translations/t-2-in-active.md b/translations/t-2-in-active.md new file mode 100644 index 0000000..0b49faf --- /dev/null +++ b/translations/t-2-in-active.md @@ -0,0 +1,7 @@ +# Translation Activation +## Description +This transition indicates that your translation object is being activated on the Connect platform. Therefore, the system will assign the *Active* status to this object and your translation will be successfully applied to your selected context. +## Prerequisites +A translation object with the [Inactive](s-a-inactive.html) status. +## Operation results +A translation object in the [Active](s-b-active.html) state. diff --git a/translations/t-2-in-active.png b/translations/t-2-in-active.png new file mode 100644 index 0000000..6a766d0 Binary files /dev/null and b/translations/t-2-in-active.png differ diff --git a/translations/t-3-act-inactive.md b/translations/t-3-act-inactive.md new file mode 100644 index 0000000..7b52ba1 --- /dev/null +++ b/translations/t-3-act-inactive.md @@ -0,0 +1,7 @@ +# Translation Deactivation +## Description +The transition implies that your translation object is being deactivated within the system. Thus, this translation will be automatically assigned to the *Inactive* state and it will not be applied to the selected context once again. Note that the system also allows reactivating disabled translations. +## Prerequisites +A translation object in the [Active](s-b-active.html) state. +## Operation results +A translation object with the [Inactive](s-a-inactive.html) status. diff --git a/translations/t-3-act-inactive.png b/translations/t-3-act-inactive.png new file mode 100644 index 0000000..f6c4883 Binary files /dev/null and b/translations/t-3-act-inactive.png differ diff --git a/translations/t-4-in-deleted.md b/translations/t-4-in-deleted.md new file mode 100644 index 0000000..c9b5a47 --- /dev/null +++ b/translations/t-4-in-deleted.md @@ -0,0 +1,8 @@ +# Translation Removal +## Description +This transition implies that your translation is being removed. Removed translation objects or your provided translation values for associated context keys cannot be restored. +Note that the system does not allow removing your primary translations. Thus, it is required to assign another translation as your primary translation for your selected context. +## Prerequisites +A translation object in the [Inactive](s-a-inactive.html) state. +## Operation results +A deleted translation object. diff --git a/translations/t-4-in-deleted.png b/translations/t-4-in-deleted.png new file mode 100644 index 0000000..97cfbdd Binary files /dev/null and b/translations/t-4-in-deleted.png differ