diff --git a/docs/00__Overview/2__Apache_Camel_Context_Concept/apache_camel_context_concept.md b/docs/00__Overview/2__Apache_Camel_Context_Concept/apache_camel_context_concept.md index 6b93e4a..19ce6ea 100644 --- a/docs/00__Overview/2__Apache_Camel_Context_Concept/apache_camel_context_concept.md +++ b/docs/00__Overview/2__Apache_Camel_Context_Concept/apache_camel_context_concept.md @@ -46,6 +46,7 @@ There are multiple chain elements, that have very specific ways of processing co ### Split Diagram below shows how context data is being managed by **Split** element: + ![Split element context data flow diagram](img/camel_split.svg) **Steps Description** diff --git a/docs/00__Overview/4__General_Functions/general_functions.md b/docs/00__Overview/4__General_Functions/general_functions.md index c25d97b..8932cc2 100644 --- a/docs/00__Overview/4__General_Functions/general_functions.md +++ b/docs/00__Overview/4__General_Functions/general_functions.md @@ -93,9 +93,24 @@ There is filtering functionality available for most of the column tables, utiliz It is possible to specify multiple filtering conditions via "**Add filter**" button. When filters are applied, button "**Filter**" will have a small counter indicator, showing quantity of active filters. It is also possible to remove particular filter via ![Delete|20](img/delete.svg) button or remove all filters via "**Clear All**" button. +## Table Sorting +For some table columns the following functions can be available: +- ![](img/caret-up.svg) Sort Ascending +- ![](img/caret-down.svg) Sort Descending + ## Table Settings Most of the tables in the system can be adjusted not only by extending/shrinking column size, but also by controlling each column's visibility and sequence. To do so, click gear button ![Gear|20](img/setting.svg) on top of the table and adjust properties accordingly. Some of the columns can't be hidden or moved - this is explained for exact columns in respective design articles. +## View User Details +Click user icon ![](img/user.svg) on top right of the screen to see user and tenant details: +- username +- user email +- tenant name +- tenant id + +Tenant is being defined during the login operation, exactly when user selects the domain. + + ## Go to Home Page **`⛔ Not available via VS Code extension`** diff --git a/docs/00__Overview/4__General_Functions/img/caret-down.svg b/docs/00__Overview/4__General_Functions/img/caret-down.svg new file mode 100644 index 0000000..d0cb0d4 --- /dev/null +++ b/docs/00__Overview/4__General_Functions/img/caret-down.svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/00__Overview/4__General_Functions/img/caret-up.svg b/docs/00__Overview/4__General_Functions/img/caret-up.svg new file mode 100644 index 0000000..f1654c9 --- /dev/null +++ b/docs/00__Overview/4__General_Functions/img/caret-up.svg @@ -0,0 +1,4 @@ + + + + diff --git a/docs/00__Overview/7__Chain_Availability_Setup_Via_Access_Control/access_control.md b/docs/00__Overview/7__Chain_Availability_Setup_Via_Access_Control/access_control.md index c3ef706..dc0e68f 100644 --- a/docs/00__Overview/7__Chain_Availability_Setup_Via_Access_Control/access_control.md +++ b/docs/00__Overview/7__Chain_Availability_Setup_Via_Access_Control/access_control.md @@ -27,9 +27,9 @@ All sequentially added roles for each particular endpoint shall be specified man | -------------------------- | --------------------------- | ---------------------------- | ------------------------ | ------------------------ | ------- | ------- | | Trigger Chain via Endpoint | /qip-routes/chain/checkData | QIP-CHAIN | ALL | - | Allow | Allow | | Trigger Chain via Endpoint | /chain/checkData | QIP-CHAIN | RETRIEVE | - | Deny | Allow | -| Trigger Chain via Endpoint | /order/{orderId}/submit | | | Order | SUBMIT | Deny | +| Trigger Chain via Endpoint | /order/{orderId}/submit | Order | SUBMIT | - | Allow | Deny | -Where Resource, Resource Type, Operation are values, configured on [HTTP Trigger](../../01__Chains/1__Graph/1__Elements_Library/6__Triggers/1__HTTP_Trigger/http_trigger.md) within a chain. +Where **Resource, Resource Type, Operation** are values, configured on [HTTP Trigger](../../01__Chains/1__Graph/1__Elements_Library/6__Triggers/1__HTTP_Trigger/http_trigger.md) within a chain. ## User Interface diff --git a/docs/01__Chains/1__Graph/1__Elements_Library/5__Transformation/2__Mapper/mapper.md b/docs/01__Chains/1__Graph/1__Elements_Library/5__Transformation/2__Mapper/mapper.md index cb0c626..1239ddc 100644 --- a/docs/01__Chains/1__Graph/1__Elements_Library/5__Transformation/2__Mapper/mapper.md +++ b/docs/01__Chains/1__Graph/1__Elements_Library/5__Transformation/2__Mapper/mapper.md @@ -211,15 +211,10 @@ Supported formats and data: >ℹ️ **Note:** >**Schema Change Handling** > -> When the source or target schema is updated, the Mapper does not overwrite existing mappings. -> -> Instead, it reconciles changes: -> - Existing mappings are preserved if fields remain unchanged. +> When the source or target schema is updated, the system is trying to preserve existing mappings (connection arrows) if it is possible: > - New fields are added but not mapped automatically. -> - Removed or incompatible fields may break mappings and require manual fixes. -> - Renamed fields are treated as new and must be re-mapped. -> -> This ensures that schema updates do not unexpectedly reset user configurations. +> - Renamed fields are treated as new and must be re-mapped manually. +> - Changing a field's data type or its 'Required' flag will not break the mapping. #### Edit Body Structure There are control buttons, available under (![20](img/more.svg)) expandable menu in **Graph View**. This menu becomes visible after hovering the mouse on the desirable attribute. For **Table View** access control buttons with similar functionality exist and they are hidden by default. To display the buttons, hover the mouse on desired attribute or attribute value for its modification. @@ -303,38 +298,6 @@ The table below contains description of possible connection pairs, that could be | Array of Primitives | Array's field (Primitives) | Mapper creates as many objects as many values array of primitives contains (including the cases when array of primitive is also part of array) and maps each value of source array to each new object (order of the resulted objects is based on the order of values in the array of primitives). | | Constant | Any type | It is possible to add a constant via left (source) scheme and map it to the specific target parameter with specifying target data type. If constant value is not equal to constant name, they both are displayed on **Graph View**, but only value will be mapped. The value is displayed with grey font color right after the constant name.

In general, conversion is similar for "Primitive to ..." cases.

User is able to fill next constant's details:
ℹ️**Note:** When one "Generated" constant is mapped to many parameters - all parameters will get **identical** generated value. | -**Primitive to Primitive conversion rules:** - -- **String** to **String**: No conversion. -- **String** to **Number**: Converts if source contains only digits, otherwise **null**. -- **String** to **Boolean**: "true" becomes **true**; numeric strings follow Number-to-Boolean rules; otherwise **false**. -- **Number** to **String**: Simple conversion. -- **Number** to **Number**: No conversion. -- **Number** to **Boolean**: 0 becomes "false", else "true". -- **Boolean** to **String**: Simple conversion. -- **Boolean** to **Number**: "true" becomes 1, "false" becomes 0. -- **Boolean** to **Boolean**: No conversion. - -**Object to Object mapping notes:** - -- If scheme is defined for both source and target, only matched fields are mapped. -- If scheme is defined for source but not target, final object has source structure. -- If scheme is undefined for source but defined for target, final object has target structure. -- If scheme is undefined for both, structure is built from the first object in the array received in request. - -**Constant details:** - -- **Value** - value of the constant (or its name when generated). -- **Type** - string, number, boolean. -- **Generated** checkbox - if checked, data is generated based on instance's date. "Name" is renamed to "Value". Marked with "G" label in **Graph** and **Table** views. -- **Generator** options: **Current Date**, **Current Time**, **Current Date and Time**, **UUID** (v4). -- **Unix epoch** checkbox - generates date in unix format. Not available for UUID. -- **Format** - date/datetime format (e.g., dd-mm-yyyy). Not available for UUID. -- **Locale** - e.g., en_US. Not available for UUID. -- **Timezone** - e.g., GMT. Not available for UUID. -- If constant value differs from name, both are displayed on **Graph View** but only value is mapped (shown in grey). -- Conversion is similar to **"Primitive to ..."** cases. -- When one "Generated" constant is mapped to many parameters, all get **identical** generated value. #### Apply Transformation It is possible to apply transformation to mapped attributes on each of Mapper Views: diff --git a/docs/01__Chains/3__Deployments/deployments.md b/docs/01__Chains/3__Deployments/deployments.md index 12b57b0..1ae3a1c 100644 --- a/docs/01__Chains/3__Deployments/deployments.md +++ b/docs/01__Chains/3__Deployments/deployments.md @@ -21,7 +21,7 @@ Under the chain it is possible to navigate on "**Deployments**" tab. The followi - 🔴 **_Failed_** - deployment failed on one or multiple engines. Error details are available by hovering the mouse over engine's status. - **Created By**: The user who initiated the deployment. - **Created At**: The exact date and time of deployment. -- **Actions**: The only available action is **Delete Deployment** marked with ![Delete|20](img/delete.svg), which removes the deployment record (note: this does not affect the deployed chain itself). + ### Create Deployment Click **"Create deployment"** button marked with ![Plus|20](img/plus.svg). The window for setting deployment parameters will appear. Fill in the following deployment parameters and click **"Deploy"**: diff --git a/docs/01__Chains/5__Logging/logging.md b/docs/01__Chains/5__Logging/logging.md index f54043d..e4c4161 100644 --- a/docs/01__Chains/5__Logging/logging.md +++ b/docs/01__Chains/5__Logging/logging.md @@ -34,9 +34,9 @@ Qubership Integration Platform will apply its own default hard-coded option and - **Info** - log only external communications (sending and receiving external messages by any protocol, incoming and outgoing). Used for investigation of production incidents. - **Log Payload** - controls payload parts, which must be logged: Headers, Properties, Body. If nothing is selected - no payload data will be logged. - **Produce DPT Events** - based on selected option, system either sends DPT events or not: - - **true** - deployed chain will be publishing events to DPT (Distributed Process Tracing and Monitoring system). - - **false** _(Default value)_ - no events will be published to DPT. + - **checked** - deployed chain will be publishing events to DPT (Distributed Process Tracing and Monitoring system). + - **unchecked** _(Default value)_ - no events will be published to DPT. - **Enable Logging Masking** - based on selected option, system decides if masking must be applied to configured set of parameters: - - **true** _(Default value)_ - masking settings, configured under "Masked Fields" expand will be applied. - - **false** - no masking applied. + - **checked** _(Default value)_ - masking settings, configured under "Masked Fields" expand will be applied. + - **unchecked** - no masking applied. - **Apply** button - when custom settings are specified, they MUST be applied via this button. As the result of this operation, settings will be published to the Consul. diff --git a/docs/01__Chains/7__Properties/properties.md b/docs/01__Chains/7__Properties/properties.md index def2592..dc0be14 100644 --- a/docs/01__Chains/7__Properties/properties.md +++ b/docs/01__Chains/7__Properties/properties.md @@ -29,4 +29,4 @@ Properties are the following: * Deploy Action - Allows to select the following actions: * None - the chain will be saved as a draft. * Snapshot - the chain will be saved as a draft with created snapshot. - * Deploy Action - the chain will be deployed. + * Deploy - the chain will be deployed. diff --git a/docs/01__Chains/chains.md b/docs/01__Chains/chains.md index 7707f09..f4ea76d 100644 --- a/docs/01__Chains/chains.md +++ b/docs/01__Chains/chains.md @@ -59,11 +59,6 @@ Each **chain** contains the following parameters on table view: - _**Delete**_ - deletes chain. -> ℹ️ **Notes:** For most of the table columns there is special context menu. To open it, **click on the column name**. The following functions can be available here: -> -> - Sort Ascending -> - Sort Descending - **Folder** contains the following parameters on table view: - **Name** - clickable reference to the page with folder content. - **Actions menu** - list of operations, accessed via menu symbol ![20](img/more.svg), contains the list of available operations with the folder: