This is the documentation for Clover Club 12.0.
Documentation for the upcoming version Rampur 13.0 can be found here.

Workflow States of Approvable Objects

This section lists all states of approvable objects as they go through a workflow.

Quotes

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/Quote.java

Workflow Action

quoteStatus

Notes

Workflow Action

quoteStatus

Notes

onSubmit

DRAFT



onWithdraw

DRAFT



onDeny

DRAFT



onQuoteApproved



OFFER

For an explanation see Workflow Life Cycle.

DEAL

onSuperseded



SUPERSEDED

INVALIDATED

Additional quoteStatus values:

  • REVOKED

  • LOST

  • PARTIALDEAL

Agreements/Promotions

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/Contract.java

Workflow Action

contractStatus

Notes

Workflow Action

contractStatus

Notes

onSubmit

DRAFT



onWithdraw

DRAFT



onDeny

DRAFT



onApproved

APPROVED



onSuperseded



SUPERSEDED

For an explanation see Workflow Life Cycle.

INVALIDATED

Additional contractStatus values:

  • REVOKED – After an Agreement/Promotion is revoked (action on the Agreement/Promotion level; not workflow related). 

Rebate Agreements

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/RebateAgreement.java

Workflow Action

rebateAgreementStatus

Notes

Workflow Action

rebateAgreementStatus

Notes

onSubmit

DRAFT



onWithdraw

DRAFT



onDeny

DRAFT



onApproved

APPROVED



onSuperseded



SUPERSEDED

For an explanation see Workflow Life Cycle.

INVALIDATED

Additional rebateAgreementStatus values:

  • OPEN

  • CLOSED

  • REVOKED – After a Rebate Agreement is revoked (action on the Rebate Agreement level; not workflow related).

Rebate Records

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/RebateRecord.java

Workflow Action

Rebate Record Status

Workflow Action

Rebate Record Status

onSubmit

SUBMITTED

onWithdraw

DRAFT

onDeny

DRAFT

onApproved

APPROVED

onNoApprovalRequired

APPROVED

Additional Rebate Record Status values:

  • REVOKED – After a Rebate Record is revoked (action on the RR level; not workflow related).

  • INVALIDATED – When the system automatically invalidates (withdraws) the workflow.

Price Grid Items

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/AbstractPriceGridItem.java

Workflow Action

Approval State

Corresponding Workflow Status

Workflow Action

Approval State

Corresponding Workflow Status

onSubmit

NOT_APPROVED

Submitted

onWithdraw

NOT_APPROVED

Withdrawn

onDeny

DENIED

Denied

onApproved

APPROVED

Approved

onNoApprovalRequired

APPROVED

No approval required

Details on Approval States:

  • NOT_APPROVED – Price Grid is in this state if all its items are not approved. Price Grid Item can be non approved also individually, so it can be in this state too.

  • PARTIALLY_APPROVED – Price Grid is in this state if some of its Price Grid Items are approved and some are not. An individual Price Grid Item cannot be in this state.

  • APPROVED – Price Grid is in this state if all its items are approved. Price Grid Item can be approved also individually, so it can be in this state too.

 See also these states shown in a diagram.

Price Lists

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/Pricelist.java

Workflow Action

Approval State

Corresponding Workflow Status

Workflow Action

Approval State

Corresponding Workflow Status

onSubmit

NOT_APPROVED

Submitted

onWithdraw

NOT_APPROVED

Withdrawn

onDeny

NOT_APPROVED

Denied 

onApproved

APPROVED

Approved

onNoApprovalRequired

APPROVED

No approval required

Additional Approval States: 

  • PARTIALLY_APPROVED – Not used in the context of price lists. 

  • AUTO_APPROVED – Sent from the backend, in the UI it shows as "Approved".

  • DENIED –  Sent from the backend, in the UI it shows as "Not approved".

 See also these states shown in a diagram. 

Data Change Requests

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/DataChangeRequest.java

Workflow Action

approvalState

Workflow Action

approvalState

onSubmit

NOT_APPROVED

onWithdraw

NOT_APPROVED

onDeny

DENIED

onApproved

APPROVED

onNoApprovalRequired

APPROVED

Claims

Based on UI, the file https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/Claim.java does not specify the states.

Workflow Action

Claim Status

Corresponding Workflow Status

Workflow Action

Claim Status

Corresponding Workflow Status

onSubmit

Draft

Submitted

onWithdraw

Draft

Withdrawn

onDeny

Draft

Denied

onApproved

Approved

Approved

onNoApprovalRequired

Approved

No approval required



Revoked



Deal Plans

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/DealPlan.java

Workflow Action

Plan Status

Corresponding Workflow Status

Workflow Action

Plan Status

Corresponding Workflow Status

onWithdraw

Draft

Withdrawn

onSubmit

Draft

Submitted

onDeny

Draft

Denied

onApproved

Offer

Approved

onNoApprovalRequired

Offer

Approved



Deal

Draft, Approved



Revoked

Draft, Approved



Lost

Draft, Approved

Compensation Plan

Based on https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/Compensation.java

Workflow Action

CompensationStatus

Workflow Action

CompensationStatus

onSubmit

Draft

onWithdraw

Draft

onDeny

Draft

onApproved

Approved

onSuperseded

Superseded

Invalidated

Custom Forms

Based on the UI, the file https://gitlab.pricefx.eu/engineering/pricefx-core/-/blob/develop/pricefx-server/src/main/java/net/pricefx/domain/CustomForm.java mentions only some states.

Workflow Action

Custom Form Status

Corresponding Workflow Status

Workflow Action

Custom Form Status

Corresponding Workflow Status

onSubmit

Draft

Submitted

onWithdraw

Draft

Withdrawn

onDeny

Draft

Denied

onApproved

Approved

Approved

onNoApprovalRequired

Approved

No approval required



Revoked



Optimization Models

Based on the UI.

Workflow Action

Model Status

Corresponding Workflow Status

Workflow Action

Model Status

Corresponding Workflow Status

onSubmit

Draft

Submitted

onWithdraw

Draft

Withdrawn

onDeny

Draft

Denied

onApproved

Approved

Approved

Â