Skip to content

Commit

Permalink
Merge pull request #58 from maxkuzkin/main
Browse files Browse the repository at this point in the history
removing redundant sections from the object description files
  • Loading branch information
maxkuzkin authored Mar 18, 2022
2 parents 13434a7 + ff3b0d1 commit 284e4dd
Show file tree
Hide file tree
Showing 25 changed files with 50 additions and 516 deletions.
20 changes: 2 additions & 18 deletions agreement-versions/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,5 @@
Agreements represent versioned templates that are created by Distributors to sign corresponding Contracts with other accounts (Vendors or Resellers). Therefore, Distributors are required to generate an agreement before creating contracts on the CloudBlue Connect platform. There are several types of agreements on the CloudBlue Connect platform. This includes program agreements, distribution agreements, service agreements, referral agreements, and syndication agreements. Consequently, each agreement is used to collaborate with Vendors, invited Distributors, or Resellers and serves as a template for corresponding contract type.
Agreement objects also feature agreement versions. Agreement versions, as the name implies, represent various versions (i.e., different document versions) of your agreement. Note that agreement objects don't include statuses or transitions. However, the system provides a specific workflow for agreement versions. Thus, for example, the Connect platform enables Distributors to create agreement versions in the *Active* or *Inactive* state. In case certain criteria are met, your agreement version can be activated, deactivated or deleted. Access required statuses and transitions for further description details.

## Available Statuses
The following list displays available statuses of the agreement version objects on the CloudBlue Connect platform. Select a status from the provided diagram or click on any of the following contextual links to access detailed status information:

* A. [Active](s-a-active.html)
* B. [Inactive](s-b-inactive.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [New Active Agreement Version Creation](t-1-new-active.html)
2. [New Inactive Agreement Version Creation](t-2-new-inactive.html)
3. [Agreement Version Deactivation](t-3-act-inactive.html)
4. [Agreement Version Reactivation](t-4-inact-active.html)
5. [Active Agreement Version Removal](t-5-act-deleted.html)
6. [Inactive Agreement Version Removal](t-6-inact-deleted.html)

## Learn more
In case more information on agreement objects or agreement types is required, refer to the [Partners module documentation](https://connect.cloudblue.com/community/modules/partners/agreements/) from the Connect Community page.
## Additional Information
Please refer to the [Partners module documentation](https://connect.cloudblue.com/community/modules/partners/agreements/) for more information.
21 changes: 2 additions & 19 deletions cases/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,6 @@ Once a new Case is created, the system assigns the *Pending* status to this Case
Therefore, the system assigns the *Inquiring* status to this Case. Partners can also transfer the case back to the *Pending* state if all required information is presented.
Partners can also assign the *Resolved* status to their pending Case if necessary. Thus, this Case will be resolved and the system automatically assigns the *Closed* status to it (depending on your specified [Autoclose Timeout](https://connect.cloudblue.com/community/modules/account/single-sign-on/azure-active-directory/) setting within the **Account** module).
Note that the system also allows closing resolved Cases manually or reopen resolved Cased and transfer them back to the *Pending* state.
## Available statuses
The following provides a list of all available case states on the CloudBlue Connect platform. Select a status from the provided diagram or click on any of the following contextual links to access detailed status information:

* A. [Pending](s-a-pending.html)
* B. [Inquiring](s-b-inquiring.html)
* C. [Resolved](s-c-resolved.html)
* D. [Closed](s-d-closed.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [New Case Creation](t-1-new-pending.html)
2. [Data Inquiry](t-2-pend-inquiring.html)
3. [Inquired Data is Submitted](t-3-inq-pending.html)
4. [Case Resolution](t-4-pend-resolved.html)
5. [Case Closure](t-5-res-closed.html)
6. [Case Reopening](t-6-res-pending.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/helpdesk/) for more information.
## Additional Information
Please refer to the [Helpdesk module](https://connect.cloudblue.com/community/modules/helpdesk/) documenation for more information.
23 changes: 2 additions & 21 deletions distribution-contracts/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,5 @@ Vendors should enroll a distribution agreement to create and enroll a distributi
Furthermore, Distributors can refine provided data and transfer the pending contract back to the *Enrolling* state. Distributors can also terminate activated contracts.
In case the **Auto Accept** option from the **distribution agreement details screen** is enabled, the state flow of distribution contracts is different. Namely, Vendors don't need to enroll automatically generated distribution contracts and Distributors are not required to approve or reject these contracts. However, Distributors can still terminate the active contracts.

## Contract Statuses
The following list displays available distribution contract statuses on the CloudBlue Connect platform. Select a status from the provided diagram or click on a contextual link below to display detailed status information:

* A. [Enrolling](s-a-enrolling.html)
* B. [Pending](s-b-pending.html)
* C. [Active](s-c-active.html)
* D. [Rejected](s-d-rejected.html)
* E. [Terminated](s-e-terminated.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Contract Enrollment](t-1-new-enrolling.html)
2. [Enrolling to Pending Contract Conversion](t-2-enr-pending.html)
3. [Contract Activation](t-3-pen-active.html)
4. [Contract Rejection](t-4-pen-rejected.html)
5. [Contract Termination](t-5-act-terminated.html)
6. [Data Refinement](t-6-pen-enrolling.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/partners/contracts/distribution-contracts/) for more information.
## Additional Information
Please refer to the [Partners Management module](https://connect.cloudblue.com/community/modules/partners/contracts/distribution-contracts/) documentation for more information.
20 changes: 2 additions & 18 deletions items/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,5 @@ Items are individual resources or units (such as a license or any other SKU) tha
Pay-As-You-Go items are used by Vendors to implement a system that based on the consumption or usage of a specified product rather than on a flat rate for Reservation items. Note that defining Pay-As-You-Go item requires to enable the corresponding capability first.
Reservation and Pay-As-You-Go items share same states and transitions on the Connect platform. Once a new item is created, the system assigns the *Draft* status to it. In case a new product version with this item is created, the system transfers the item to the *Published* state. Thereafter, Vendors can assign the *End of Sale* status to their item. Note, however, that system enables Vendors to restore the *Published* status to such items.

## Available Statuses
The list below displays available item states on the CloudBlue Connect platform. Select a status from the provided diagram or click on any of the following contextual links to access detailed status information:

* A. [Draft](s-a-draft.html)
* B. [Published](s-b-published.html)
* C. [End of Sale](s-c-endsale.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Item Creation](t-1-new-draft.html)
2. [Item Publication](t-2-draft-published.html)
3. [Draft Removal](t-3-draft-deleted.html)
4. [End of Sale Assignment](t-4-published-endsale.html)
5. [Item Restoration](t-5-endsale-published.html)

## Learn more
Refer to the [Connect community page](https://staging.connect.cloudblue.com/community/modules/products/items/) for more details.
## Additional Information
Please refer to the [Products Management module](https://connect.cloudblue.com/community/modules/products/items/) documentation for more details.
23 changes: 2 additions & 21 deletions listings-request/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,6 @@ A *listing request* object represents a formal request to list a product on a sp
The system allows Vendors to generate listing requests of the following types: *create* (requests to list a new product), *update* (requests to update listing data), or delete (requests to delist a product from the marketplace). Consequently, all listing requests should be processed by Distributors/ Resellers.

Once a new listing request object is generated, the system assigns the *Draft* status to this object. Once Vendors submit their request to Distributor or Reseller systems, the request object is automatically assigned to the *Reviewing* state. Distributors or Resellers can start processing the request and transfer it to the *Deploying* state. In case the request processing is successful, Distributors/Resellers assign the *Completed* status to this request. Alternatively, Distributors/Resellers can reject request in case of an error and transfer it to the *Cancelled* state.
## Listing request statuses
The following list displays available statuses for listing requests on the CloudBlue Connect platform. Select a status from the provided diagram or click on a contextual link below to display detailed status information:

* A. [Draft](s-a-draft.html)
* B. [Reviewing](s-b-reviewing.html)
* C. [Deploying](s-c-deploying.html)
* D. [Completed](s-d-completed.html)
* E. [Cancelled](s-e-cancelled.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Draft Request Creation](t-1-new-draft.html)
2. [Draft Request Removal](t-2-draft-deleted.html)
3. [Draft to Reviewing Request Convertion](t-3-draft-reviewing.html)
4. [Reviewing Request Approval](t-4-reviewing-deploying.html)
5. [Deployment Completion](t-5-deploying-completed.html)
6. [Deployment Cancellation](t-6-deploying-cancelled.html)
7. [Reviewing Request Rejection](t-7-reviewing-cancelled.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/listings/) for more information.
## Additional Information
Please refer to the [Listings Management Module](https://connect.cloudblue.com/community/modules/listings/) documentation for more information.
20 changes: 2 additions & 18 deletions listings/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,6 @@ Once Vendors decide to list their product to their selected marketplace, the sys

Listing objects are managed via *Listing Requests*. Namely, these requests are used to list the specified product to the required marketplace, update the listing information, or remove the product from this marketplace. Therefore, Vendors generate a listing request in case it is required to create, update or delete listings.
Distributors or Resellers can approve or reject listing request and consequently manage listing objects on the Connect platform.
## Listing Statuses
The following list displays available statuses for listing on the CloudBlue Connect platform. Select a status from the provided diagram or click on a contextual link below to display detailed status information:

* A. [Not Listed](s-a-notlisted.html)
* B. [Listed](s-b-listed.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Listing Creation](t-1-new-notlisted.html)
2. [Listing Approval](t-2-notlisted-listed.html)
3. [Listing Rejection](t-3-notlisted.html)
4. [Termination Request](t-4-termination-request.html)
5. [Termination Apporoval](t-5-listing-termination.html)
6. [Update Request](t-6-update-request.html)
7. [Update Approval](t-7-listing-update.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/listings/) for more information.
## Additional Information
Please refer to the [Listings Management moduke](https://connect.cloudblue.com/community/modules/listings/) documentation for more information.
22 changes: 2 additions & 20 deletions offers/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,5 @@ Offers represents logical grouping of one or multiple product plans. Plans are s
Once Vendors generate a new offer instance, the system assigns the *Private* status to this offer. Vendors are required to define their offer and save its public version to transfer it to the *Ready* state. In case Vendors add their offer to their listing request, the system assigns *Listed* state to this offer.
The following provides more information on available offer statuses and transitions on the CloudBlue Connect platform.

## Available Statuses
The list below displays available offer statuses on the CloudBlue Connect platform. Select a status from the provided diagram or click on any of the following contextual links to access detailed status information:

* A. [Private](s-a-private.html)
* B. [Ready](s-b-ready.html)
* C. [Listed](s-c-listed.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Offer Instance Creation](t-1-new-private.html)
2. [Public Version Creation](t-2-priv-ready.html)
3. [Adding an Offer to Product Listing](t-3-ready-listed.html)
4. [Offer Delisting](t-4-listed-ready.html)
5. [Private Offer Removal](t-5-priv-deleted.html)
6. ["Ready" Offer Instance Removal](t-6-ready-deleted.html)
7. [Ready to Private Version Assignment](t-7-ready-private.html)

## Learn more
Refer to the [Connect community page](https://staging.connect.cloudblue.com/community/modules/offers/) for more information.
## Additional Information
Please refer to the [Offers Management Module](https://connect.cloudblue.com/community/modules/offers/) documentation for more information.
18 changes: 2 additions & 16 deletions partners/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,5 @@ In case an invitation link is generated, the system creates a new partner object
Alternatively, you can instantly create and activate your partner account on the Connect platform.
Note that the system also allows terminating contracts with your partners. In this case, your partner account will be *removed* from your partner list.

## Available Statuses
The following introduces available statuses for partner objects on the CloudBlue Connect platform. Select a status from the provided diagram or click on any of the following contextual links to access detailed status information:

* A. [Invited](s-a-invited.html)
* B. [Active](s-b-active.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Partner Invitation](t-1-new-invited.html)
2. [Partner Account Creation](t-2-new-active.html)
3. [Invitation Link Activation](t-3-inv-active.html)
4. [Contract Termination](t-4-act-removed.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/partners/) for more information.
## Additional Information
Please refer to the [Partners Management Module](https://connect.cloudblue.com/community/modules/partners/) documentation for more information.
24 changes: 2 additions & 22 deletions price-lists/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,5 @@ Vendors can generate price list drafts by using the Connect platform. Thereafter
Furthermore, the system enables Vendors to schedule price list activation. Thus, created draft list can be activated on specified time. Vendors are also able to unschedule price lists and transfer them back to *Draft* state.
Note that in case the activated price list is no longer relevant, Vendors can terminate these lists.

## Price List Statuses
The following list displays available price lists statuses on the CloudBlue Connect platform. Select a status from the provided diagram or click on a contextual link below to display detailed status information:

* A. [Draft](s-a-draft.html)
* B. [Scheduled](s-b-scheduled.html)
* C. [Active](s-c-active.html)
* D. [Terminated](s-d-teminated.html)


## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Draft Creation](t-1-new-draft.html)
2. [Price List Schedule](t-2-draft-scheduled.html)
3. [Schedule Cancellation](t-3-schedule-draft.html)
4. [Scheduled Pricing Activation](t-4-schedule-active.html)
5. [Draft Activation](t-5-draft-active.html)
6. [Price List Termination](t-6-active-terminated.html)
7. [Draft Removal](t-7-draft-deleted.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/pricing/) for more details.
## Additional Information
Please refer to the [Price Management Module](https://connect.cloudblue.com/community/modules/pricing/) documentation for more details.
19 changes: 2 additions & 17 deletions products/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,6 @@
Products represent substances, software or services that are provisioned, fulfilled, or
manufactured by Vendors. Thus, Vendors configure their products and define all required product data via the **Products** module on the Connect platform. Product data include items (SKUs), product overview, provided media, and so on. Furthermore, Vendors can provide different versions of a product and send requests to list or delist these product versions on specified marketplaces.
Once Vendors assign a version to a *Draft* product, it transfers to the *Published* state. Vendors can also delete a product or assign it with the *End of sale* status. The following provide detailed information about each product status and product transition on the CloudBlue Connect platform.
## Product Statuses
The list below displays all product statuses on the Connect platform. Select a status from the provided diagram or click on a contextual link below to display detailed status information:

* A. [Draft](s-a-draft.html)
* B. [Published](s-b-published.html)
* C. [End of Sale](s-c-endsale.html)

## Transitions
Choose a transition from the provided diagram or click on any of the following contextual links to access transition information:

1. [Draft Creation](t-1-new-draft.html)
2. [Product Version Assignment](t-2-draft-pub.html)
3. [Draft Removal](t-3-draft-del.html)
4. [End of Sale Confirmation](t-4-pub-end.html)
5. [Product Restoration](t-5-end-pub.html)

## Learn more
Refer to the [Connect community page](https://connect.cloudblue.com/community/modules/products/) for more information.
## Additional Information
Please refer to the [Products Management Module](https://connect.cloudblue.com/community/modules/products/) documentation for more information.
Loading

0 comments on commit 284e4dd

Please sign in to comment.