Components are the 'services' that your package is comprised of. For example, if "Dining for Two" is your package, then your components are the menu selections: "Entrées", "Main Course, "Dessert" and "Drinks".
A component can be saved as a draft and updated as many times as required. Once saved, draft components can then be associated with one or more packages. Once its associated package is published, the component is marked as 'In Use'. Some details cannot be changed after this point.
A component is comprised of the following:
- Marketing Definition - specify the way the component is displayed in the Store. Includes component name, description, image and category.
- Variations - specify variations/options to provide choices to your customers.
- Quantities - allow quantities of the component to be ordered.
- Customer Supplied Information - use this to request information from your customers about the component they are selecting.
- Supplier Information - use this to specify information for the supplier responsible for provisioning the component.
NB. Variations, quantities, customer supplied information and supplier information are all optional. At a minimum, you must specify a Component Name and Category.
These are explained in detail below.
Marketing Definition
The following information can be specified for a component:
| Field Name | Description | Type |
|---|---|---|
| Component Name | Name of the component. | Mandatory |
| Description | Description of the component. | Optional |
| Component Code (under the "Advanced..." link) | A system code used to identify the component for supplier use | Optional |
| Image | Image that will be displayed for this component when it is shown in the Store. | Optional |
| Category | Categories are used to manage the Requests list. They assist you to find components within a specific category. | Mandatory |
| Supplier | If applicable, select the supplier responsible for provisioning this component. Associating a supplier enables you to report on suppliers per component. | Optional |
| Associated Property | If applicable, the component can require a property to be associated with it when it is purchased as part of a package. | Optional |
- Navigate to the Catalog zone.
- Click on the Components tab.
- On the Components List screen, click the "+ New Component" box.
The Add Component screen is displayed. - Where it says "Component Name", enter the name of the component.
- Optionally, where it says "Description" enter a description for the component.
- Optionally, upload a suitable image for the component. Recommended size is 140 x 79 pixels. Click 'Choose File', browse to the image and upload it.
- In the Category dropdown, select a suitable category for the component.
- Optionally, select a supplier for the component.
- If the component requires a property to be associated with it, tick the 'Property Required' box.
- Optionally select a supplier for the component.
- Click Save (scroll to bottom of page).
Your component is saved as a Draft.
The following is an example of adding a component:
The following is an example of the component (specified above) as it appears to the customer in the Store. As 'Property Required' was ticked, the customer is required to select a property/location in order to purchase the package.
Variations
Adding variations to a component enables your customers to select from one or more options. Variation pricing is specified at the package level. When the component is purchased (as part of a package), an order is created that will contain the Variation Options selected by the customer.
One or more variations can be specified for a component. A variation is specified as follows:
- Variation Name - the name of the variation as it will appear to the customer.
- Variation Code (under the "Advanced..." link) - the code for the variation. Information in this field is provided to the supplier.
- Description of this variation - this description is shown to the customer at configuration time just under the variation name. Max length is 256 characters.
A variation has two or more Variation Options. A Variation Option is specified as follows:
- Variation Option Name - the name of the variation option as it will appear to the customer.
- Variation Option Code (under the "Advanced..." link) - the code for the variation option. Information in this field is provided to the supplier.
Base Variation Option
When you add a variation option, you must select which will be the 'base' option. The 'base' option is the default for the variation. No charge can be specified for a 'base' variation option. NB. There can only be one variation option selected as the base per variation.
- Click Edit Component.
- Under 'Component Variations', click the Add variation link.
- Where it says "Variation name", enter the name of the variation.
- Optionally, you can add a variation description. Use this to describe the variation to the customer.
- Add a variation option. You need at least two to present a choice to the customer.
- Where is says "Variation option name", enter the first variation option name.
- In the second row where is says "Variation option name", enter the second variation option name.
- Optionally, click the Add Option link to add more Variation Options.
- Add additional variation options as required.
- Click Save.
The following is an example of adding a variation:
The following is an example of the variation (specified above) as it appears to the customer in the Store:
Component Quantities
Specifying a quantity enables the customer to select the number of components they require as part of package purchase. The quantity allocation, limits and optional descriptions are specified at the component-level; the pricing for the component is specified at the package-level.
If quantities have been specified, the quantity is created as an attribute of the component order when the orders are generated upon purchase.
When you select a quantity for a component, the min/max and per unit description is required. 'Per unit' is a description of the unit of measurement, for example 'per person', 'per box', 'per carton', etc. Min/Max are quantity limits. 'Description of this quantity' is optional and can be used to provide additional information about the quantity being selected. This text is displayed to the customer on Purchase wizard page.
- Click Edit Component.
- To enable quantities, tick the 'Quantities' box under the Quantities heading.
- Optionally, you can add a quantity description. Use this to describe the quantity to the customer. For example, 'How many boxes would you like?'
- Enter the min and max quantity limits. For example, specifying '1' for the min and '10' for the max would mean the customer can select between 1 and 10 for the component. You can specify a minimum of 0 for a quantity based component.
- Enter the 'per unit' description. Use this to describe the unit of measurement. For example 'per person', 'per box', 'per carton', etc.
- Click Save.
The following is an example of adding a quantity:
The following is an example of the quantity (specified above) as it appears to the customer in the Store:
Customer Supplied Information (aka Customer Questions)
In some cases, the supplier responsible for provisioning the component may require customer specific information to be associated with a component to assist with processing the order.
Adding Customer Supplied Information to a component creates a form field that can be completed by the customer at the time of purchase. When the component is purchased (as part of a package), an order is created for the supplier that will contain the completed Customer Supplied Information.
Customer Supplier Information is specified as follows:
- Field name - Specify the name of the field as it will appear to the customer. (mandatory)
- Code - Information in this field is provided to the supplier. It is not visible to the customer. (optional)
- Description - Contextual help displayed to the customer to assist them complete the field. (optional)
component - Answer is mandatory - Tick this if the customer must complete the question to purchase the package.
- Customer enters - This lets you specify how the customer will enter the information. There are two options, either:
- Any text - this is a free-text field. If selected, the customer enters free text into the field.
- From a list - if selected, you can enter one or more values to build up a dropdown list. Separate each value with a line break. The customer will select a value from this dropdown list. Tick "Allow other" to enable the customer to select "Other" in the dropdown. In such a case, if the customer selects "Other" they can enter free text.
One or more Customer Questions can be specified for a component.
NB. Specifying Customer Supplied Information for a component is optional. However, if it is defined then by default a customer must complete the customer question in the store wizard. Unticking 'Answer is mandatory' makes the Customer Supplied Information optional for the customer.
With 'Any text' selected
The following is an example of adding Customer Supplied Information (with "Any text" selected):
The following is an example of Customer Supplied Information (with "Any text" selected) as they appear to the customer in the Store:
With 'From a list' selected
The following is an example of adding Customer Supplied Information (with "From a list" selected):
The following is an example of Customer Supplied Information (when "From a list" is selected) as they appear to the customer in the Store:
The following is an example of the customer selecting "Other" (when "From a list" is selected) as they appear to the customer in the Store:
Supplier Information
In some cases, the supplier may require specific information to be associated with a component to assist with processing the order.
Adding Supplier Information to a component creates a form field that can be completed by the catalog manager. When the component is purchased (as part of a package), an order is created that will contain the specified Supplier Information.
Supplier Information is specified as follows:
- Field name - Specify the name of the field as it will appear to the catalog manager. (mandatory)
- Field Value - Specify the value for the field (entered by the catalog manager). Information in this field is provided to the supplier. (mandatory)
One or more Supplier Information fields can be specified for a component.
NB. Specifying Supplier Information for a component is optional. However, please note that if Supplier Information is defined then all the fields for it are required to be filled, as indicated above.
The following is an example of adding Supplier Information:
The following is an example of the Supplier Information (specified above) displayed on the Order Details screen:
