Set up ordering in LUMA
This page explains how to set up ordering in LUMA, so that assets can be ordered and committed to an account. Each element depends on the ones before it, so you must work through the sections in the following order:
How ordering is configured explains what each element does and how they connect.
Prerequisites
Before you begin, ensure you have:
-
Administrator access to LUMA Admin at System Domain level.
-
The currencies you need for rates and accounts, set up in the console’s Currencies module.
1. Create the types
Ordering needs an order type, a resource type, and an account type. These steps create child types, rather than configuring ordering on the parent Order, Resource, and Account types. Types and inheritance compares the two approaches.
Create an order type
The order type identifies orders, and its states track where each order is in its workflow.
-
Navigate to System Domain > Types and select . The Add Type modal opens.
-
From the Parent dropdown, select Order.
-
In the Name field, enter a name for the order type, and select Add. The order type appears in the type tree in the Types panel.
-
Select the order type, then select the States module.
-
Select and add a state for each point an order can reach in its workflow, setting the Phase for each one. You assign these states to the process stages later, in Add the stages.
-
Select the Info module, set the Initial State, and select Save.
Create a resource type
Assets of this resource type can be ordered.
-
Navigate to your client domain > Types and select .
-
From the Parent dropdown, select Resource.
-
In the Name field, enter a name for the resource type, and select Add.
-
Select the resource type, then select the States module.
-
Select and add the states the resource type needs, setting the Phase for each one.
-
Select the Info module, set the Initial State, and select Save.
2. Create the order process
The process sets the approval workflow an order follows after it has been placed. These steps create a process with manual approval. For auto-approval, leave out the approver role and the approval stage.
Add the process
You create the process against the order type, and it stays disabled until its roles, stages, and transitions are in place.
-
Navigate to your client domain > Processes and select . The Add Process modal opens.
-
From the Type dropdown, select the order type you created.
-
Enter a Name and a Title, and select Add. The process appears in the Processes panel, disabled until you finish configuring it.
Add the initiator role
Only users or groups of users with the initiator role can start an order.
-
Select the process, then navigate to Roles and select .
-
In the Name field, enter a name, for example
creator, and select Add. -
Select the role, then select the Info module.
-
Select the Initiator checkbox, and select Save.
-
Select the Actors module, and select .
-
Select Users and Groups, choose individual users or groups of users that can place orders, and select Add.
Add an approver role
Only users or groups of users with the approver role can accept or reject orders in the approval stage.
-
Select the process, then navigate to Roles and select .
-
In the Name field, enter a name, for example
approver, and select Add. -
Select the role, then select the Actors module, and select .
-
Select Users and Groups, choose individual users or groups of users that can approve orders, and select Add.
Add the stages
These steps use three stages: new, work, and end.
The work stage is the approval stage.
-
Select the process, then navigate to Stages and select .
-
In the Name field, enter
new, and select Add. -
Repeat for the
workandendstages. -
Select the
newstage, then select the Info module. -
Select a State from the order type’s states.
-
In the Description field, describe the purpose of the stage, and select Save.
-
Repeat for the
workstage. -
For the
endstage, set the State and Description, select Complete from the Operation dropdown, and select Save.
Add the transitions
Transitions set which stages an order can move to next, and which roles can move it.
-
Select the
newstage, then select the Transitions module, and select Edit. The Roles and Transitions modal opens. -
Select the initiator role and the
workstage, and select Add. -
Select the
workstage, then select the Transitions module, and select Edit. -
Select the approver role and both the
newandendstages, then select Add. The approver can now accept the order by moving it toend, or reject it by moving it back tonew.
3. Create the supplier group and rates
The supplier group stores the rates that set the price and quantities of an order.
Add the supplier group
The supplier group is a Unit group that holds the rates the route offers.
-
Navigate to your client domain > Groups and select . The Add Group modal opens.
-
From the Type dropdown, select Unit.
-
In the Name field, enter a name for the supplier group, and select Add.
Add a rate
Each rate sets the price in one currency, and decides whether end users choose from set quantities or order any quantity.
-
Select the supplier group, then navigate to Rates and select . The Add Rate modal opens.
-
From the Type dropdown, select Fixed or Variable. Fixed and variable rates describes how each type behaves.
-
From the Currency dropdown, select a currency.
-
In the Name field, enter the name that appears when an order is created, and select Add. The rate appears in the Rates panel, disabled until you add its volumes.
Add the volumes
Volumes set the quantities and unit prices for the rate.
-
Select the rate, then navigate to Volumes and select . The Add Volume modal opens.
-
Enter a Unit Quantity and a Unit Price, and select Add.
-
Repeat for each quantity option or price break you need.
Enable the rate
Enable the rate once it has its volumes.
-
Select the rate, then select the Info module.
-
Optional: in the Unit field, enter a custom name for the unit. If you leave the field empty, the unit appears as unit.
-
Select the Enabled checkbox, and select Save.
Link the rate to resource types
Link the rate to the same resource types that the transform lists, so that the system offers the rate for those assets.
-
Select the rate, then select the Types module.
-
Select Types, choose the resource type you created, and select Add. You can add several resource types to the same rate.
4. Create the route
The route links the process to the supplier group. Its title is the ordering option that can be selected under Add to cart.
-
Navigate to your client domain > Routes and select . The Add Route modal opens.
-
From the Process dropdown, select the process you created. The Type field fills in with the process’s order type.
-
From the Supplier dropdown, select the supplier group you created.
-
Enter a Name and a Title.
-
In the Description field, enter a short description, and select Add.
-
Select the route, then select the Info module.
-
Select the Enabled checkbox, and select Save.
To display the Order Delivery Address dropdown when an order item is added, add location metadata to the route, as described in Add an orders asset list page.
5. Create the transform
The transform links the resource type to the route, which makes the Add to cart button available on assets of that type.
-
Navigate to your client domain > Transforms and select . The Add Transform modal opens.
-
Enter a Name and a Title.
-
Set the following fields, and select Add:
-
Exposure:
System -
Kind:
Derivative -
Engine:
Passthru
-
-
Select the transform, then select the Info module.
-
From the Type dropdown, select the resource type you created.
-
Select the Enabled checkbox, and select Save.
-
Select the Types module, then select Types.
-
Choose the same resource type, and select Add.
-
Select the Routes module, then select Routes.
-
Choose the route you created, and select Add. You can add several routes to the same transform.
| The Type in the Info module must be the asset’s resource type or one of its parents. If it isn’t, the add to order modal is empty and no error appears. |
6. Create an account
Accounts appear in the Payment section of the draft order summary. An order’s cost can be split across several accounts.
-
Navigate to Accounts and select . The Create Account modal opens.
-
From the Type dropdown, select the account type you created.
-
In the Name field, enter the name that appears in the Payment section.
-
From the Currency dropdown, select a currency.
-
In the Audience panel, select , choose the users and groups who can commit orders to this account, and select Add.
-
Select Add to create the account. The account appears in the Accounts panel, disabled.
-
Select the account, then select the Info module.
-
Select the Enabled checkbox, and select Save.
To set a credit limit, configure the account as strict or loose, as described in Configure payment accounts.
Troubleshooting
Each problem in this section is a common cause of a broken ordering journey. Select one to display its fix.
Problem: The Add to cart button is missing from an asset.
Solution: check that the user can start the process, and that the transform lists the asset’s resource type.
-
In the process, select Roles, and note which role has Initiator selected.
-
Select Actors, and note which groups hold that role.
-
In the user’s profile, select Membership. If the user isn’t in one of those groups, add them to a group, or add one of their groups as an actor.
-
Check the asset’s resource type in the asset details, or select the asset’s in LUMA.
-
In the transform, select Types. If the transform doesn’t list the asset’s resource type, add it to the transform, or change the asset’s type to one the transform lists.
Problem: The add to order modal is empty, and Add and view order does nothing.
Solution: check the type in the transform’s Info module.
-
Check the asset’s resource type.
-
In the transform, select Info. If the Type isn’t the asset’s resource type or one of its parents, change it to match, or change the asset’s type.
Problem: No accounts appear in the Payment section.
Solution: check that the user is in the account’s audience.
-
In Accounts, select the account, then select Inspect in the Info module.
-
Select Affiliates, and note which groups are in the audience.
-
If the user isn’t in one of those groups, add them to a group, or add one of their groups to the audience.