Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report Templates #72

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
"objects": [
"report-repositories/object.json",
"report-schedules/object.json",
"report-templates/object.json",
"reports/object.json"
]
},
Expand Down
37 changes: 37 additions & 0 deletions report-templates/object.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<html>
<head>
<style>
</style>
<meta charset="utf-8">
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
<script type='text/javascript' src='http://davidlynch.org/projects/maphilight/jquery.maphilight.js'></script>
<script type="text/javascript">
$(document).ready(function () {
$('.map').maphilight({ alwaysOn: true });
// uncomment this line for normal hover highlighting
// $('.map').maphilight();
});
</script>
</head>
<body>

<!-- Edit with https://summerstyle.github.io/summer/ below -->

<img class="map" src="object.png" alt="" usemap="#map" />
<map name="map">
<area shape="rect" coords="2433, 61, 2774, 246" href="t-7-blocked-deleted" />
<area shape="rect" coords="1779, 8, 2340, 499" href="s-c-blocked" />
<area shape="rect" coords="1924, 885, 2434, 1056" href="t-5-disabled-blocked" />
<area shape="rect" coords="1454, 869, 1772, 1080" href="t-4-enabled-blocked" />
<area shape="rect" coords="870, 856, 1180, 1094" href="t-6-blocked-enabled" />
<area shape="rect" coords="1401, 2014, 1828, 2193" href="t-3-disabled-enabled" />
<area shape="rect" coords="1883, 1344, 2485, 1813" href="s-b-disabled" />
<area shape="rect" coords="1500, 1392, 1785, 1581" href="t-2-enabled-disabled" />
<area shape="rect" coords="836, 1328, 1363, 1814" href="s-a-enabled" />
<area shape="rect" coords="407, 1391, 760, 1577" href="t-1-new-enabled" />
</map>

<!-- Edit with https://summerstyle.github.io/summer/ above -->

</body>
</html>
123 changes: 123 additions & 0 deletions report-templates/object.json
Original file line number Diff line number Diff line change
@@ -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%"
}
}
]
}
9 changes: 9 additions & 0 deletions report-templates/object.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/object.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added report-templates/object.pptx
Binary file not shown.
17 changes: 17 additions & 0 deletions report-templates/s-a-enabled.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added report-templates/s-a-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions report-templates/s-b-disabled.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added report-templates/s-b-disabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions report-templates/s-c-blocked.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added report-templates/s-c-blocked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions report-templates/t-1-new-enabled.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-1-new-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions report-templates/t-2-enabled-disabled.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-2-enabled-disabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions report-templates/t-3-disabled-enabled.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-3-disabled-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions report-templates/t-4-enabled-blocked.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-4-enabled-blocked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions report-templates/t-5-disabled-blocked.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-5-disabled-blocked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions report-templates/t-6-blocked-enabled.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-6-blocked-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions report-templates/t-7-blocked-deleted.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added report-templates/t-7-blocked-deleted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.