diff --git a/modules.json b/modules.json index f992dfc..ee79f00 100644 --- a/modules.json +++ b/modules.json @@ -112,6 +112,7 @@ "objects": [ "report-repositories/object.json", "report-schedules/object.json", + "report-templates/object.json", "reports/object.json" ] }, diff --git a/report-templates/object.html b/report-templates/object.html new file mode 100644 index 0000000..35072f2 --- /dev/null +++ b/report-templates/object.html @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/report-templates/object.json b/report-templates/object.json new file mode 100644 index 0000000..9701688 --- /dev/null +++ b/report-templates/object.json @@ -0,0 +1,123 @@ +{ + "name": "Report Templates", + "image": "object.png", + "readme": "object.md", + "statuses": [ + { + "id": "s-a-enabled", + "name": "Enabled", + "mapping": { + "left": "26.63%", + "top": "61.17%", + "width": "16.4%", + "height": "20.57%" + } + }, + { + "id": "s-b-disabled", + "name": "Disabled", + "mapping": { + "left": "59.74%", + "top": "61.53%", + "width": "16.4%", + "height": "20.57%" + } + }, + { + "id": "s-c-blocked", + "name": "Blocked", + "mapping": { + "left": "56.69%", + "top": "1%", + "width": "16.31%", + "height": "19.66%" + } + } + ], + "transitions": [ + { + "id": "t-1-new-enabled", + "from": "New", + "to": "Enabled", + "name": "1. New Template Addition", + "mapping": { + "left": "12.6%", + "top": "63.89%", + "width": "11.04%", + "height": "6.71%" + } + }, + { + "id": "t-2-enabled-disabled", + "from": "Enabled", + "to": "Disabled", + "name": "2. Template Deactivation", + "mapping": { + "left": "46.8%", + "top": "63.71%", + "width": "8.36%", + "height": "6.71%" + } + }, + { + "id": "t-3-disabled-enabled", + "from": "Disabled", + "to": "Enabled", + "name": "3. Template Reactivation", + "mapping": { + "left": "46.71%", + "top": "92.71%", + "width": "8.98%", + "height": "6.71%" + } + }, + { + "id": "t-4-enabled-blocked", + "from": "Enabled", + "to": "Blocked", + "name": "4. Template is Blocked", + "mapping": { + "left": "46.46%", + "top": "39.96%", + "width": "8.98%", + "height": "6.71%" + } + }, + { + "id": "t-5-disabled-blocked", + "from": "Disabled", + "to": "Blocked", + "name": "5. Disabled Template is Blocked", + "mapping": { + "left": "60.9%", + "top": "39.92%", + "width": "13.53%", + "height": "6.71%" + } + }, + { + "id": "t-6-blocked-enabled", + "from": "Blocked", + "to": "Enabled", + "name": "6. Template is Unblocked", + "mapping": { + "left": "27.88%", + "top": "40.14%", + "width": "9.11%", + "height": "6.71%" + } + }, + { + "id": "t-7-blocked-deleted", + "from": "Blocked", + "to": "Deleted", + "name": "7. Template Removal", + "mapping": { + "left": "76.3%", + "top": "2.45%", + "width": "9.11%", + "height": "6.71%" + } + } + ] + } diff --git a/report-templates/object.md b/report-templates/object.md new file mode 100644 index 0000000..36930b9 --- /dev/null +++ b/report-templates/object.md @@ -0,0 +1,9 @@ +# Report Template +## Overview +Report templates define the structure and the content of your generated report files on the CloudBlue Connect platform. The system provides default templates that cannot be disabled or removed. However, Connect allows adding repositories that include custom report templates. Therefore, uploaded report templates can be disabled, blocked, and removed. + +Once a new template is added, the system assigns the *Enabled* status to it. Enabled report templates can be assigned to the *Disabled* status and consequently can be hidden from users. Disabled report templates can be enabled again if necessary. + +If your repository object is updated and the system cannot locate added templates, your repository will be assigned to the *Failed* status. Thus, the system transfers enabled and disabled templates to the *Blocked* state. Furthermore, in case failed repository is removed, the Connect platform removes all report templates that are associated with this repository. +## Learn more +Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/account/reports/) for more information on report management. diff --git a/report-templates/object.png b/report-templates/object.png new file mode 100644 index 0000000..9cb8855 Binary files /dev/null and b/report-templates/object.png differ diff --git a/report-templates/object.pptx b/report-templates/object.pptx new file mode 100644 index 0000000..ff043f0 Binary files /dev/null and b/report-templates/object.pptx differ diff --git a/report-templates/s-a-enabled.md b/report-templates/s-a-enabled.md new file mode 100644 index 0000000..2e12613 --- /dev/null +++ b/report-templates/s-a-enabled.md @@ -0,0 +1,17 @@ +# Enabled Status +## Description +The *Enabled* report template state indicates that your template is available for your account users. Therefore, the system can generate a report file by using your enabled report template. The system prompts your account users to select enabled templates from the provided list while creating a new report or report schedule. + +Enabled report templates can be disabled and consequently be hidden from users. In addition, note that the system blocks enabled report templates in case their associated report repository is assigned to the *Failed* status. +## Prerequisites +An added report repository that includes your report template is required to assign this template to the *Enabled* state. +Moreover, the system transfers your reactivated templates to this state from the [Disabled](s-b-disabled.html) and [Blocked](s-c-blocked.html) statuses. +## Transferable statuses +Enabled report templates can be assigned to the [Disabled](s-b-disabled.html) status. +Furthermore, the system transfers enabled templates to the [Blocked](s-c-blocked.html) state in case it is no longer available within its corresponding repository. +## Associated transitions +* [New Template Addition](t-1-new-enabled.html) +* [Template Deactivation](t-2-enabled-disabled.html) +* [Template Reactivation](t-3-disabled-enabled.html) +* [Template is Blocked](t-4-enabled-disabled-blocked.html) +* [Template is Unblocked](t-6-blocked-enabled.html) diff --git a/report-templates/s-a-enabled.png b/report-templates/s-a-enabled.png new file mode 100644 index 0000000..15b7ea6 Binary files /dev/null and b/report-templates/s-a-enabled.png differ diff --git a/report-templates/s-b-disabled.md b/report-templates/s-b-disabled.md new file mode 100644 index 0000000..c55b19d --- /dev/null +++ b/report-templates/s-b-disabled.md @@ -0,0 +1,15 @@ +# Disabled Status +## Description +The system allows disabling report templates that should be hidden from your account users. Therefore, in case your report template is assigned to the *Disabled* status, this template cannot be selected to generate a report file on the Connect platform. The system also prompts you to provide a note before disabling your report template. + +Note that the system blocks disabled report templates in case its associated report repository is assigned to the *Failed* status. +## Prerequisites +Report template in the [Enabled](s-a-enabled.html) state. +## Transferable statuses +Once your report template is reactivated, the system assigns the [Enabled](s-a-enabled.html) status to this template. +In case your report repository with your disabled report template is transferred to the *Failed* state, the system assigns the [Blocked](s-c-blocked.html) status to this template. +## Associated transitions +* [Template Deactivation](t-2-enabled-disabled.html) +* [Template Reactivation](t-3-disabled-enabled.html) +* [Template is Blocked](t-4-enabled-disabled-blocked.html) +* [Template is Unblocked](t-5-blocked-enabled.html) diff --git a/report-templates/s-b-disabled.png b/report-templates/s-b-disabled.png new file mode 100644 index 0000000..2e460b1 Binary files /dev/null and b/report-templates/s-b-disabled.png differ diff --git a/report-templates/s-c-blocked.md b/report-templates/s-c-blocked.md new file mode 100644 index 0000000..d963eff --- /dev/null +++ b/report-templates/s-c-blocked.md @@ -0,0 +1,15 @@ +# Blocked Status +## Description +In case your repository with your custom report templates is assigned to the *Failed* status, the system transfers your added templates to the *Blocked* state. Such report templates cannot be used to generate reports on Connect. + +Blocked report templates can be enabled again once their associated report repository is assigned to the *Ready* status, and this repository includes required templates. +In addition, the system automatically deletes blocked report templates in case their corresponding repository is removed from the Connect platform. +## Prerequisites +The system blocks your report templates with [Disabled](s-b-disabled.html) and [Enabled](s-a-enabled.html) statuses in case their repository is transfered to the *Failed* state. +## Transferable statuses +Once your report repository is assigned to the *Ready* status, the system transfers your blocked report template back to the [Enabled](s-a-enabled.html) state. +If your *failed* repository is deleted, the system removes your blocked templates. +## Associated transitions +* [Template is Blocked](t-4-enabled-disabled-blocked.html) +* [Template is Unblocked](t-5-blocked-enabled.html) +* [Template Removal](t-6-blocked-deleted.html) diff --git a/report-templates/s-c-blocked.png b/report-templates/s-c-blocked.png new file mode 100644 index 0000000..ff43bdb Binary files /dev/null and b/report-templates/s-c-blocked.png differ diff --git a/report-templates/t-1-new-enabled.md b/report-templates/t-1-new-enabled.md new file mode 100644 index 0000000..4d5507c --- /dev/null +++ b/report-templates/t-1-new-enabled.md @@ -0,0 +1,7 @@ +# New Template Addition +## Description +This transition indicates that a new report template is added to the CloudBlue Connect platform. Therefore, the system assigns the *Enabled* status to this report template. Your account users can also create report and report schedule objects based on this uploaded template. +## Prerequisites +Your added repository that includes your report template. +## Operation results +New template with the [Enabled](s-a-enabled.html) status. diff --git a/report-templates/t-1-new-enabled.png b/report-templates/t-1-new-enabled.png new file mode 100644 index 0000000..88ddb00 Binary files /dev/null and b/report-templates/t-1-new-enabled.png differ diff --git a/report-templates/t-2-enabled-disabled.md b/report-templates/t-2-enabled-disabled.md new file mode 100644 index 0000000..c11e10e --- /dev/null +++ b/report-templates/t-2-enabled-disabled.md @@ -0,0 +1,8 @@ +# Template Deactivation +## Description +This transition implies that your report template is disabled and hidden from your account users. Thus, this template cannot be used to generate reports on the CloudBlue Connect platform. The system also transfers this template to the *Disabled* state. +Note that Connect prompts you to provide a note before disabling your report template. +## Prerequisites +Report template in the [Enabled](s-a-enabled.html) state. +## Operation results +Report template with the [Disabled](s-b-disabled.html) status. diff --git a/report-templates/t-2-enabled-disabled.png b/report-templates/t-2-enabled-disabled.png new file mode 100644 index 0000000..4e3e22e Binary files /dev/null and b/report-templates/t-2-enabled-disabled.png differ diff --git a/report-templates/t-3-disabled-enabled.md b/report-templates/t-3-disabled-enabled.md new file mode 100644 index 0000000..c309a79 --- /dev/null +++ b/report-templates/t-3-disabled-enabled.md @@ -0,0 +1,7 @@ +# Template Reactivation +## Description +This transition indicates that your report template is reactivated and transferred back to the *Enabled* state. You account users will be able to use this template generate their reports on Connect once again. +## Prerequisites +Report template with the [Disabled](s-b-disabled.html) status. +## Operation results +Report template in the [Enabled](s-a-enabled.html) state. diff --git a/report-templates/t-3-disabled-enabled.png b/report-templates/t-3-disabled-enabled.png new file mode 100644 index 0000000..ddd8078 Binary files /dev/null and b/report-templates/t-3-disabled-enabled.png differ diff --git a/report-templates/t-4-enabled-blocked.md b/report-templates/t-4-enabled-blocked.md new file mode 100644 index 0000000..14abe0c --- /dev/null +++ b/report-templates/t-4-enabled-blocked.md @@ -0,0 +1,8 @@ +# Template is Blocked +## Description +This transition implies that your repository with your uploaded templates is assigned to the *Failed* status. Therefore, the system blocks your enabled report templates that are associated with this repository. +## Prerequisites +Report template in the [Enabled](s-a-enabled.html) state. +Report repository that is assigned to the *Failed* status. +## Operation results +Report template that is transferred to the [Blocked](s-c-blocked.html) state. diff --git a/report-templates/t-4-enabled-blocked.png b/report-templates/t-4-enabled-blocked.png new file mode 100644 index 0000000..c9f5e06 Binary files /dev/null and b/report-templates/t-4-enabled-blocked.png differ diff --git a/report-templates/t-5-disabled-blocked.md b/report-templates/t-5-disabled-blocked.md new file mode 100644 index 0000000..132b864 --- /dev/null +++ b/report-templates/t-5-disabled-blocked.md @@ -0,0 +1,8 @@ +# Disabled Template is Blocked +## Description +This transition implies that your repository with your uploaded templates is assigned to the *Failed* status. Therefore, the system blocks your disabled report templates that are associated with this repository. +## Prerequisites +Report template with the [Disabled](s-b-disabled.html) status. +Report repository that is assigned to the *Failed* status. +## Operation results +Report template that is transferred to the [Blocked](s-c-blocked.html) state. diff --git a/report-templates/t-5-disabled-blocked.png b/report-templates/t-5-disabled-blocked.png new file mode 100644 index 0000000..eb107ae Binary files /dev/null and b/report-templates/t-5-disabled-blocked.png differ diff --git a/report-templates/t-6-blocked-enabled.md b/report-templates/t-6-blocked-enabled.md new file mode 100644 index 0000000..c9b96e6 --- /dev/null +++ b/report-templates/t-6-blocked-enabled.md @@ -0,0 +1,7 @@ +# Template is Unblocked +## Description +In case your report repository object is assigned back to the *Ready* state, the system restores the *Enabled* status to your blocked report template. Therefore, this template can be usesd to generate reports and create report schedules on the CloudBlue Connect platform. +## Prerequisites +Report template in the [Blocked](s-c-blocked.html) state. +## Operation results +Report template in the [Enabled](s-a-enabled.html) state. diff --git a/report-templates/t-6-blocked-enabled.png b/report-templates/t-6-blocked-enabled.png new file mode 100644 index 0000000..9218ce7 Binary files /dev/null and b/report-templates/t-6-blocked-enabled.png differ diff --git a/report-templates/t-7-blocked-deleted.md b/report-templates/t-7-blocked-deleted.md new file mode 100644 index 0000000..65ea021 --- /dev/null +++ b/report-templates/t-7-blocked-deleted.md @@ -0,0 +1,7 @@ +# Template Removal +## Description +This transition implies that your failed report repository is removed from the the CloudBlue Connect platform. Thus, the system deletes your report templates that are associated with this removed repository. +## Prerequisites +Report template in the [Blocked](s-c-blocked.html) state. +## Operation results +Removed report template. diff --git a/report-templates/t-7-blocked-deleted.png b/report-templates/t-7-blocked-deleted.png new file mode 100644 index 0000000..a9fa0b7 Binary files /dev/null and b/report-templates/t-7-blocked-deleted.png differ