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

Usage chunks #73

Open
wants to merge 6 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 @@ -136,6 +136,7 @@
"icon": "assessment",
"objects": [
"usage-files/object.json",
"usage-chunks/object.json",
"usage-records/object.json"
]
}
Expand Down
35 changes: 35 additions & 0 deletions usage-chunks/object.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<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="3175, 10, 3693, 468" href="s-c-closed" />
<area shape="rect" coords="2661, 36, 3049, 239" href="t-3-ready-closed" />
<area shape="rect" coords="2074, 6, 2514, 477" href="s-b-ready" />
<area shape="rect" coords="1543, 41, 1940, 243" href="t-2-draft-ready" />
<area shape="rect" coords="934, 983, 1419, 1431" href="s-d-failed" />
<area shape="rect" coords="962, 637, 1400, 799" href="t-4-draft-failed" />
<area shape="rect" coords="951, 3, 1386, 471" href="s-a-draft" />
<area shape="rect" coords="461, 65, 781, 249" href="t-1-new-draft" />
</map>

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

</body>
</html>
98 changes: 98 additions & 0 deletions usage-chunks/object.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
{
"name": "Usage File Chunks",
"image": "object.png",
"readme": "object.md",
"statuses": [
{
"id": "s-a-draft",
"name": "Draft",
"mapping": {
"left": "26.16%",
"top": "2.51%",
"width": "10.08%",
"height": "27.59%"
}
},
{
"id": "s-b-ready",
"name": "Ready",
"mapping": {
"left": "56.26%",
"top": "1.52%",
"width": "10.81%",
"height": "30.43%"
}
},
{
"id": "s-c-closed",
"name": "Closed",
"mapping": {
"left": "86.56%",
"top": "1.38%",
"width": "11.51%",
"height": "28.51%"
}
},
{
"id": "s-d-failed",
"name": "Failed",
"mapping": {
"left": "26.37%",
"top": "66.2%",
"width": "10.4%",
"height": "27.59%"
}
}
],
"transitions": [
{
"id": "t-1-new-draft",
"from": "New",
"to": "Draft",
"name": "1. Draft Creation",
"mapping": {
"left": "12.93%",
"top": "4.29%",
"width": "7.63%",
"height": "9.83%"
}
},
{
"id": "t-2-draft-ready",
"from": "Draft",
"to": "Ready",
"name": "2. Successful Chunk Processing",
"mapping": {
"left": "41.4%",
"top": "4.75%",
"width": "10.4%",
"height": "7.72%"
}
},
{
"id": "t-3-ready-closed",
"from": "Ready",
"to": "Closed",
"name": "3. Usage File Chunk Closure",
"mapping": {
"left": "71.4%",
"top": "4.15%",
"width": "10.81%",
"height": "10.5%"
}
},
{
"id": "t-4-draft-failed",
"from": "Draft",
"to": "Failed",
"name": "4. Chunk Creation Failure",
"mapping": {
"left": "26.4%",
"top": "44.09%",
"width": "10.4%",
"height": "7.72%"
}
}
]
}

9 changes: 9 additions & 0 deletions usage-chunks/object.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Usage File Chunks
## Overview
Usage file chunks are generated when your usage files are succussfully uploaded and accepted within the system. Usage file chunks represent objects that include your actual usage record data. Such objects also allow downloading required information by using the API or graphical user interface. In order to get this information, the usage file chunk object should be assigned to the *Ready* status.

Once usage records are applied for the subsequent billing operations, it is required to assign an external identifier for your usage file chunk object. When your external billing identifer and billing note are specified successfully, the usage file chunk objects will be automatically *closed* by the system.

In case the system fails to generate a new usage file chunk due a technical problem, it is assigned to the *Failed* state. Such objects do not allow accessing usage record data and cannot be used for the following billing operations.
## Additional Information
Please refer to the [Usage module](https://connect.cloudblue.com/community/modules/usage_module/) documentation for more information on the usage file management.
Binary file added usage-chunks/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 usage-chunks/object.pptx
Binary file not shown.
12 changes: 12 additions & 0 deletions usage-chunks/s-a-draft.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Draft Status
## Description
Once your usage file is accepted, the system generates a new usage file chunk object and assigns the *Draft* status to this object. In general, this status indicates that the system processes your usage file chunk and it is not yet available for the following billing operations. Draft usage file chunks also cannot be used to acquire usage record information.
## Prerequisites
An accepted usage file on the CloudBlue Connect platform.
## Transferable statuses
When your usage file chunk is processed successfully, the system transfers assigns the [Ready](s-b-ready.html) status to this object.
In case your usage file chunk processing is failed due to a technical problem, the system transfers the object to the [Failed](s-d-failed.html) state.
## Associated transitions
* [Draft Creation](t-1-new-draft.html)
* [Successful Chunk Processing](t-2-draft-ready.html)
* [Chunk Creation Failure](t-4-draft-failed.html)
Binary file added usage-chunks/s-a-draft.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions usage-chunks/s-b-ready.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Ready Status
## Description
The *Ready* status indicates that your usage file chunk is processed successfully. Therefore, the system allows downloading usage record data by using the provided API or user interface. Usage record data should be used for the following billing operations and reconciliation.

This status also implies that the system requires to assign an external identifier and external note for your usage file chunk. Once this information is provided, the system closes your usage file chunk object and consequently closes your usage file.
## Prerequisites
A usage file chunk object in the [Draft](s-a-draft.html) state.
## Transferable statuses
Once an external identifier and an external note are assigned to your usage file chunk, it is transferred to the [Closed](s-c-closed.html) state by the system.
## Associated transitions
* [Successful Chunk Processing](t-2-draft-ready.html)
* [Usage File Chunk Closure](t-3-ready-closed.html)
Binary file added usage-chunks/s-b-ready.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions usage-chunks/s-c-closed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Closed Status
## Description
The system assigns the *Closed* status to your usage file chunk object once an external identifier and external note are provided for this object. Therefore, this status generally indicates that all billing operations that are associated with the usage file chunk are finalized.

Note that the system allows downloading usage record information if your usage file chunk object is assigned to this state. Moreover, the system allows changing external identifiers for your closed usage file chunks.
## Prerequisites
A usage file chunk object in the [Ready](s-b-ready.html) state.
## Associated transition
[Usage File Chunk Closure](t-3-ready-closed.html)
Binary file added usage-chunks/s-c-closed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions usage-chunks/s-d-failed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Failed Status
## Description
This status is displayed in case your usage file chunk processing is failed due technical issues. Consequently, failed usage file chunks do not allow accessing usage record data and cannot be used for the following billing operations. It is recommended to submit and accept a usage file once again in case of this error.
## Associated transition
[Chunk Creation Failure](t-4-draft-failed.html)
Binary file added usage-chunks/s-d-failed.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 usage-chunks/t-1-new-draft.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Draft Chunk Creation
## Description
This transition indicates that a submitted usage file has been approved. Therefore, the system generates a new usage file chunk object and assigns the *Draft* status to this object.
## Prerequisites
An accepted usage file on the CloudBlue Connect platform.
## Operation results
A usage file chunk object in the [Draft](s-a-draft.html) state.
Binary file added usage-chunks/t-1-new-draft.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 usage-chunks/t-2-draft-ready.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Successful Chunk Processing
## Description
This transition implies that the system successfully processed your usage file chunk object. Thus, it allows downloading usage record information. Thereafter, this information can be used for the subsequent billing operations.
## Prerequisites
A usage file chunk object in the [Draft](s-a-draft.html) state.
## Operation results
A chunk object with the [Ready](s-b-ready.html) status.
Binary file added usage-chunks/t-2-draft-ready.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 usage-chunks/t-3-ready-closed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Usage File Chunk Closure
## Description
This transition indicates that external identifier and external note are assigned to your usage file chunk. This transition also indicates that reconciliation and all required billing operations are finalized. Consequently, the system transfers the usage file chuk object to the *Closed* state.
## Prerequisites
A usage file chunk object in the [Ready](s-b-ready.html) state.
## Operation results
A chunk object with the [Closed](s-c-closed.html) status.
Binary file added usage-chunks/t-3-ready-closed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions usage-chunks/t-4-draft-failed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Chunk Creation Failure
## Description
This transition implies that your usage file chunk processing is failed due to technical issues. Therefore, the system fails to generate a usage file chunk and assigns the corresponding status to the chunk object.
## Operation results
A usage file chunk object in the [Failed](s-d-failed.html) state.
Binary file added usage-chunks/t-4-draft-failed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.