Lab Info

Lesson: Product Discount Data Management (Standalone Custom Form)

Target Audience: Certified Configuration Engineer

Estimated Time to complete: TBD

Requirements & Solution Author: Petr Rys

Solution Developer: Marcin Łuczakuczak

User Story / Requirements

Create a standalone Custom Form to help pricing managers manage discounts per Product Groups and Families.
Product Group is part of Product Master, Product Family is assigned per Product Group.

Each Product group belongs to 1 Product Family as per table Product Family Mapping.
Based on cumulative yearly revenue on the whole Product Family the customer has assigned Discount Level in Discount Level Definition Table.
Based on Product Group and Discount Level achieved by the Customer the sales agent has a "recommended discount" and a "maximum allowed discount" (Target Discount % and Max Discount %)

Anchor
Details Details isMissingRequiredParameters true

Details

Product Discount Data Management Custom Form allows user to perform these tasks:

Change Data - Pick a table, Change values in the table, without adding any rows

Add new Product Group - Add a group, Assign it to the product family, Assign to it all the required discounts for all the required levels

Discount for each additional level has to be >= to the previous level, otherwise validation fails

Add a product family - Re assign product groups to reflect new Product Family,

Add new discount level to existing product family - Create new discount levels. Levels must be continuous.

...

Assign new discounts for new levels. Discount for each additional level has to be >= to the previous level, otherwise validation fails

Learning Outcomes

At the end of the Lab, you should be able to:

• Create Standalone Custom Form, Custom Form Type

• Utilize Input Matrix as Custom Form input

• Understand Custom Forms Workflow

Provided resources

Logics:

sCFO_ProductDiscountLib

...

ProductFamilyMapping, DiscountLevelDefinition, Discount

Acceptance Criteria

• User can access a standalone Custom Form within the Analytics section to complete tasks listed in the Details section.

...

• After the user submits the form, changes should be saved in the corresponding company parameter tables. If a workflow has been added to the form, the changes should be saved after approval.

• Sample solution

...

Step-by-step solution

Develop the logic and test in Studio

1. Go to the Pricefx Studio and create the following logics.

...

• Assign Product Family: list of unique values from ProductFamilyMapping lookup table

• New Discount: user can add and delete rows

...

Calculations

The results will be displayed as tables in the right panel. Only tables with changes will be shown as copies of parameter tables with updated values.

...

ResultMatrix newTable = api.newMatrix('Column_1', 'Column_2',)
newTable.setColumnFormat('Column_1', FieldFormatType.TEXT)
newTable.setColumnFormat('Column_2', FieldFormatType.NUMERIC)

def getDiscount() {
    def id = api.findLookupTable("Discount").id
    def filters = [ Filter.equal('lookupTable.id', id) ]
    def discountTable = api.find('MLTV2', 0, 0, null, *filters)

    def rows = discountTable.collect {
        [
                productGroup  : it.key1,
                discountLevel : it.key2,
                targetDiscount: it.attribute1,
                maxDiscount   : it.attribute2,
                typedId       : it.typedId]
    }
    return rows
}

def cell_1 = newTable.styledCell(example_value, "black", "yellow", "bold")
def cell_2 = newTable.styledCell(example_value, "black", "yellow", "bold")
newTable.addRow(cell_1, cell_2)

customFormProcessor.addOrUpdateOutput(
        [
                "resultName" : "new_name",
                "resultLabel": "new_label",
                "resultType" : "MATRIX",
                "result"     : newTable,
        ]
)

...

Saving changes to the tables.

We need to ensure that changes in the target tables are displayed accurately. Once the user approves the changes, they should be saved. The customform_WorkflowPosStep logic is responsible for this process.

...

api.currentItem()?.inputs?.get(0)?.value

inputs?.get("managementOptionsInput")

def discountID = api.findLookupTable("Discount").id

def discountFilters = [
        Filter.equal("ProductGroup", oldName),
        Filter.equal('lookupTable.id', discountID)
]

api.find('LTV', 0, *discountFilters).collect {
    def entry = [
            lookupTableName: "ProductFamilyMapping",
            id             : it.id,
            valueType      : it.valueType,
            typedId        : it.typedId,
            name           : newName,
            value          : it.value
    ]
    api.addOrUpdate("LTV", entry)
}

discountEntries.each {
    api.addOrUpdate("MLTV2", [
            lookupTableName: "Discount",
            key1           : it["Product Group"].value,
            key2           : it["Discount Level"].value,
            attribute1     : it["Target Discount %"].value,
            attribute2     : it["Max Discount %"].value
    ])
}

api.currentItem()?.outputs?.find { it.resultName == "DiscountLevelDefinitionMatrix" }

discountLevelDefinitionTable = discountLevelDefinitionTable ? discountLevelDefinitionTable : []

def discountLevelDefinitionEntries = discountLevelDefinitionTable.result.entries.findAll { it['Product Family'] instanceof Map }

Example of a Solution

TODO: embedd solution Zip file.

References

Custom Forms (Reference)

Custom Forms Configuration How-To(s)

Unity Documentation

Custom Forms

Custom Forms General Settings

Custom Forms Header Logics

Company Parameters

Groovy API

setConfigParameter

Other

Pricefx chatbot AI

TODO: review and update articles, we have some Clover Club changes

TODO: add Model Object vs Custom Form vs Configuration Wizard into KB (now just in Product Mngt - non public)

TODO: Petr Rys

Please provide feedback for solution and Lab, partition credentials sent by teams chat