diff --git a/modules.json b/modules.json index f992dfc..a335f84 100644 --- a/modules.json +++ b/modules.json @@ -136,6 +136,7 @@ "icon": "assessment", "objects": [ "usage-files/object.json", + "usage-chunks/object.json", "usage-records/object.json" ] } diff --git a/usage-chunks/object.html b/usage-chunks/object.html new file mode 100644 index 0000000..495c05a --- /dev/null +++ b/usage-chunks/object.html @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/usage-chunks/object.json b/usage-chunks/object.json new file mode 100644 index 0000000..f28c658 --- /dev/null +++ b/usage-chunks/object.json @@ -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%" + } + } + ] + } + diff --git a/usage-chunks/object.md b/usage-chunks/object.md new file mode 100644 index 0000000..c7fd6e9 --- /dev/null +++ b/usage-chunks/object.md @@ -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. diff --git a/usage-chunks/object.png b/usage-chunks/object.png new file mode 100644 index 0000000..3bf32f5 Binary files /dev/null and b/usage-chunks/object.png differ diff --git a/usage-chunks/object.pptx b/usage-chunks/object.pptx new file mode 100644 index 0000000..fd04a0e Binary files /dev/null and b/usage-chunks/object.pptx differ diff --git a/usage-chunks/s-a-draft.md b/usage-chunks/s-a-draft.md new file mode 100644 index 0000000..83ce801 --- /dev/null +++ b/usage-chunks/s-a-draft.md @@ -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) diff --git a/usage-chunks/s-a-draft.png b/usage-chunks/s-a-draft.png new file mode 100644 index 0000000..3bed691 Binary files /dev/null and b/usage-chunks/s-a-draft.png differ diff --git a/usage-chunks/s-b-ready.md b/usage-chunks/s-b-ready.md new file mode 100644 index 0000000..17ad089 --- /dev/null +++ b/usage-chunks/s-b-ready.md @@ -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) diff --git a/usage-chunks/s-b-ready.png b/usage-chunks/s-b-ready.png new file mode 100644 index 0000000..891052b Binary files /dev/null and b/usage-chunks/s-b-ready.png differ diff --git a/usage-chunks/s-c-closed.md b/usage-chunks/s-c-closed.md new file mode 100644 index 0000000..3289fa4 --- /dev/null +++ b/usage-chunks/s-c-closed.md @@ -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) diff --git a/usage-chunks/s-c-closed.png b/usage-chunks/s-c-closed.png new file mode 100644 index 0000000..f2b6e55 Binary files /dev/null and b/usage-chunks/s-c-closed.png differ diff --git a/usage-chunks/s-d-failed.md b/usage-chunks/s-d-failed.md new file mode 100644 index 0000000..661059f --- /dev/null +++ b/usage-chunks/s-d-failed.md @@ -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) diff --git a/usage-chunks/s-d-failed.png b/usage-chunks/s-d-failed.png new file mode 100644 index 0000000..deee67b Binary files /dev/null and b/usage-chunks/s-d-failed.png differ diff --git a/usage-chunks/t-1-new-draft.md b/usage-chunks/t-1-new-draft.md new file mode 100644 index 0000000..8536b37 --- /dev/null +++ b/usage-chunks/t-1-new-draft.md @@ -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. diff --git a/usage-chunks/t-1-new-draft.png b/usage-chunks/t-1-new-draft.png new file mode 100644 index 0000000..80bf0d1 Binary files /dev/null and b/usage-chunks/t-1-new-draft.png differ diff --git a/usage-chunks/t-2-draft-ready.md b/usage-chunks/t-2-draft-ready.md new file mode 100644 index 0000000..ae80b00 --- /dev/null +++ b/usage-chunks/t-2-draft-ready.md @@ -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. diff --git a/usage-chunks/t-2-draft-ready.png b/usage-chunks/t-2-draft-ready.png new file mode 100644 index 0000000..d8f921c Binary files /dev/null and b/usage-chunks/t-2-draft-ready.png differ diff --git a/usage-chunks/t-3-ready-closed.md b/usage-chunks/t-3-ready-closed.md new file mode 100644 index 0000000..13c7c01 --- /dev/null +++ b/usage-chunks/t-3-ready-closed.md @@ -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. diff --git a/usage-chunks/t-3-ready-closed.png b/usage-chunks/t-3-ready-closed.png new file mode 100644 index 0000000..891052b Binary files /dev/null and b/usage-chunks/t-3-ready-closed.png differ diff --git a/usage-chunks/t-4-draft-failed.md b/usage-chunks/t-4-draft-failed.md new file mode 100644 index 0000000..0354172 --- /dev/null +++ b/usage-chunks/t-4-draft-failed.md @@ -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. diff --git a/usage-chunks/t-4-draft-failed.png b/usage-chunks/t-4-draft-failed.png new file mode 100644 index 0000000..c8188f2 Binary files /dev/null and b/usage-chunks/t-4-draft-failed.png differ