Products
Objectives of the Product page
The `Products ' feature allow the administrator to manage the product that appear on the website.
It is the decoration layer to publish the product.
This page present how we can create and edit a product and associate Valuein Product & Product Rate Plan to Zuora Product & Product Rate Plan
Note:
And many other features to specify how the product behave with other product (included, excluded, upgrade/downgrade path, ...)
Section Description
There is two main level for configuring a product :
- Define how the product look like, it is the Product ;
- Define how the product can be sold, is the Rate plan ;
- Prerequisites**
- Got to Content ->> Homepage . Then tick on
- Recently Added Product
- Enable Recommended Product
- Enable Shop
- Create Subscription strategy ( Go to Billing ->> Subscription strategy)
- Create Tax class ( Go to Billing ->> Product Tax class)
- Create Product rate plan (Go to Products and groups ->>Product rate plan)
- Create a shop (Go to shop ->> Shop)
- Create a shipping strategy ( Go to Shipping ->> Shipping strategy)
This will be separate into several part :
- Actions
- Main information
- Shopping
- Rate plans
- Attributes - to give more information about product in the shop page
- Medias
- Relations
- Shops
- Shipping Strategies
- Upgrade / downgrade
- Included / excluded
Actions
Standard menu that permit to create or duplicate the product, clear product cache and download configurations
Section description
The Action List enable the capacity to synchronize the Product Catalog from Zuora to Valuein. This menu can be found on this page on the upper-left conner of the page, here :
By clicking on this menu you have access to several options :
- Add : By clicking on this link, it will load a new page, that enable for you the creation of a brand new product
- Clear product cache : By clicking on this link, this will trigger a synchronization between Valuein & Zuora. Valuein retrieve asynchronously the Product Catalog from Zuorain order for you to select the correct Rate plan & charges you want to associate with the Product you are creating in Valuein.
- Download configurations: download product catalog list
By clicking on 'Duplicate' button, you can create a duplicate of the current product.
Tips
Please note that the Clear Product Cache option should be trigger manually each time the Zuora Product Catalog is modified in order to reflect the correct ID from Zuora to Valuein.
Main information
This part contains the main information of the product, such as the Name, the Description, the SKU, the Product Type.
Section description
Here are describe the standard fields :
| Name of the field | Type | Mandatory | Description |
| Title | Text field | Yes | Name of the product |
| SKU | Text field | Yes | Reference code of the product |
| Product Type | Picklist | Yes | Picklist with one of the following options : Primary(Which is display in the shop page and can have options) / Standalone(Cannot have options)/ Option(will be diaply once you select the respective primary product) |
| Short Description | Text Area (WYSIWYG) | Yes | Short description of the Product. |
| Commentaires | Text Area (WYSIWYG) | Yes | Long description of the Product. |
| Rating | Picklist | Yes | a rating system gives a grade to the product. This notation is displayed on the first page Values are : * 0/5 * 1/5 * 2/5 * 3/5 * 4/5 * 5/5 |
| Position | Number | Yes | The position as the product appears on the website |
Shopping
This define the defaults Tax Class and Subscription Strategy used by this product, as well as Commission Rate.
Section description
Here are describe the standard fields :
| Name of the field | Type | Mandatory | Description |
| Tax class | Picklist | Yes | This fields determine the standard Tax Rate applied for this product. The values here are the values created in the Billing>Product Tax classes . You can create a new Tax Rate by clicking on the button "Add a Tax rate" below this field |
| Subscription Strategy | Picklist | Yes | This fields determine the standard Subscription Strategy applied for this product. The values here are the values created in the menu Billing >> Subscription Strategies. If you select the value "Use default strategy", the default Subscription Strategy defined for the environment, that you can also define in the menu Billing >> Subscription Strategy, will be applied for this product |
You can also create here a Commission Rate. A Commission Rate determine the commission percentage applied on the amount of the product, used for calculating providers rate commissions and amount, that are applied to partners defined in the Providers menu. The Commission Rate Section is Out of scope.
Here are the description of the fields :
| Name of the field | Type | Mandatory | Description |
| Supprimer | Checkbox | Yes (default : False) | This field is either False or True. By clicking on this checkbox, and set it to true, and updating the product on this page, it will delete the Commission Rate. |
| Platform Rate | Integer | Yes | This field value should be between 0 and 100. The field in this value is translated into a percentage. It represent the value in percetage that will be given to the Partner |
| Starting Date | Date | Yes | This field represent the including Start Date on when the Commission will be applied. |
| Ending Date | Date | Yes | This field represent the including End Date on when the Commission will be applied. |
You can add several Platform Rate one after another by clicking on the button "Add a commission rate".
Rate plans
This section enable the configuration of the Rate plan, charges, prices, and specific rules that needs to be applied to them.
Section description
In this section, you are able to add several Rate Plan and specify prices depending on the Zuora Catalog.
First, you will need to click on the "Add a rate plan" button. You will see a new section appear with the following look :
Here is a description of the fields :
| Name of the field | Type | Mandatory | Description |
| Title | String | Yes | Contains the name of the Rate plan that will be printed on the Shop. Can be the same or a different one from the Zuora Rate Plan name |
| Attributes | String | Yes | Options display under rate plan |
| External ID | Picklist | Yes | This fields should contains the Zuora Product Rate Plan associated that you wished for. You can attach several Valuein Product Rate Plan to the same Zuora Product Rate Plan and specify dedicated rules, depending on how you want to sell this rate plan. Once selected, the part will refresh showing you standard price and charges associated to the Zuora Charge Selected, that you can edit based on your preference. List of Products and Rate plan available in this picklist depend on the Clear Product Cache. |
| Position | Integer | Yes | Position of the Rate Plan within the Product in the Shop, when searching. |
| Charges | Section | Yes | This section appears once you select a valid External ID. |
| Subscription Strategy | Picklist | Yes | By selecting a strategy here, you configure a Subscription Strategy for this Rate Plan. If it is not the same as the one define on the Product Level, this one will be used. By default, the one selected for the Product will be used. If you choose here "Use default strategy", it will use the one configure on the Product Level. |
| Add commission rate(Out of scope) | Section | No | This button as the same functionnality as the one in the Shopping section. If you do not configure Commission Rate here, the one configured in the Shopping Section will be used. If you do not configure any Commission Rate for the Rate Plan or the Poduct, no Commission will be applied. |
| Delete | Checkbox | Yes (default : False) | This field is either False or True. By clicking on this checkbox, and set it to true, and updating the product on this page, it will delete the Rate Plan selected. |
Tips
- Add a rate plan : click on this button in order to create a Rate Plan and add it in the section.
- Add a filter : click on this button if you want to show products dynamically. The products shown will be the one that correspond to the filter.
You can add several filters by clicking on the button "Add a filter" that is below the array.
- Create product options and filters separately in the corresponding section, as you will be more flexible in the configuration screen. Elements printed in the related section by clicking on the buttons are made simple in order to display only minimal information, and do not contains all configurable elements.
Attributes
The objective of this page is to define the product attribute group. This feature is closely linked with catalog.
This will be displayed on catalog page under the product description.
| Name of the field | Type | Mandatory | Description |
| Attribute name | String | Yes | Name of the attribute |
| Attribute value | String | Yes | Value of the attribute |
Management attributes:
If you have configured some Custom Fields via the menu Config >> Custom Field, and attached the fields on the Entity "Products", fields will be displayed here for you to fill.
Medias
On this page, you can associate a picture to the product, that will be printed on the Shop.
Section description
You can either import a new picture or select an existing pictures already imported.
Tips
- Supported format : jpg, png.
Relations
On this page, you can configure options and products related to the current product selected. You can also associate a Provider (used to determine which Provider sell this Product,Basically It defines relation between provider and the product).
| Name of the field | Type | Mandatory | Description |
| Relation | |||
| Provider | String | Yes | Select a provider |
| Related Product | |||
| Products Rate Plans | String | Yes | You can select any/all 'Primary' or 'standalone' products rate plans which is registered in Valuein in order to add them in the Related Product section of the Product on the Shop |
| Filters | String | Yes | click on this button if you want to show products dynamical. The products shown will be the one that correspond to the filter. |
| Product Options | |||
| Products Rate Plans | String | Yes | You can select only product created as 'option' type |
| Filters | String | Yes | click on this button if you want to show products dynamical. The products shown will be the one that correspond to the filter. |
Shops
Specify on which Shop the Product should be shown.
Section description
Click on the button "Add a Shop" in order to add the product on a shop.
You can click again on "Add a Shop" to enable this product for several Shop.
Here are a description of the standard fields :
| Name of the field | Type | Mandatory | Description |
| shop | Pick list | Yes | This field contain the Shop on which the Product is available. |
Tips
- You need to create the Shop in the related menu before adding it in this section.
Shipping Strategies
Objectives of the Shipping Strategy page
It defines how the shipping will happen
Section description
| Name of the field | Type | Mandatory | Description |
| Chosen Shipping Strategy | String | Yes | Select shipping strategy |
| Display Shipping Strategy In Quote | check box | no | When you tick it your selected shipping strategy will display in the Quote |
Add a shipping strategy
When you click on 'Add a shipping strategy' button you will see below tabs
Main information-tab
| Name of the field | Type | Mandatory | Description |
| Main Information | |||
| Title | String | Yes | Shipping strategy title |
| Is the default strategy | check box | Yes | Set this shipping strategy as default one |
| Trigger | |||
| Trigger | String | Yes | -Invoice : The shipping will start when a new invoice is generated.-Payment : The shipping will start when a payment is accepted.Subscription contract effective date : The shipping will start when the subscription starts.-Subscription service activation date : The shipping will start when the subscription is activated.-Subscription customer acceptance date : The shipping will start when the customer accepts the service.-Other : The shipping will be triggered by an api call. |
Schedule-tab
| Name of the field | Type | Mandatory | Description |
| The trigger send only one package | Check box | Yes | |
| Start date | Date | Yes | Start date of the schedule |
| End date | Date | Yes | End date of the schedule |
| Next shipping date | Date | Yes | Next shipping date |
| The trigger will generate row in the past (catchup) | chackbox | no | Once this schedule is triggered, it will generate row in the past |
payment failure-tab
| Name of the field | Type | Mandatory | Description |
| Payment Failure Action | String | Yes | Pause : The shipping will wait for the payment success before being shipped.Cancel shipping : The shipping will be cancelled.Send anyway : The shipping will be send even without the payment. |
| The shipping may expire | Check box | Yes | It allows to expire the shipping |
| Shipping Expiration Delay | Date | Yes | When the shipping expiration delay starts |
Logistic-tab
| Name of the field | Type | Mandatory | Description |
| The same logistic sku may be used by multiple product at once | Check box | Yes | It allows to use same logistic sku by multiple product at once |
| Send shipping order as soon as the trigger is received | Check box | Yes | It allows to send shipping order as soon as the trigger is received |
| Create the shipping log with the status « Waiting validation » | Check box | Yes | Create the shipping log with the status |
| The product can only be shipped if a association have been found | Check box | Yes | The product can only be shipped if a association have been found |
Tips
- It is recommended to create the Shipping Strategy before associated it with the Product, as you will be more flexible in the configuration screen.
Upgrade / downgrade
Products Rate Plans associated here will be available for Upgrade or Downgrade (depending the configuration), which will enable the possibility for the User to upgrade and downgrade from this product to another one on the Shop, using the Self Care part of the Shop.
The Products available can either be groups or Specific Product Rate Plans.
Section description
Upgrade products
- Products Rate Plans : Specify here the Products Rate Plans available for Upgrade.
- Add a rate plan : click on this button in order to create a Rate Plan and add it in the section.
- Add a filter : click on this button if you want to show upgrade products dynamically. The products shown will be the one that correspond to the filter.
Products Rate Plans will be displayed by priority order, from top to bottom. Here are describe the standard fields :
You can add several filters by clicking on the button "Add a filter" that is below the array.
Downgrade products
- Products Rate Plans : Specify here the Products Rate Plans available for Downgrade.
- Add a rate plan : click on this button in order to create a Rate Plan and add it in the section.
- Add a filter : click on this button if you want to show downgrade products dynamically. The products shown will be the one that correspond to the filter.
Products Rate Plans will be displayed by priority order, from top to bottom. Here are describe the standard fields :
You can add several filters by clicking on the button "Add a filter" that is below the array.
Tips
- Create products and filters separately in the corresponding section, as you will be more flexible in the configuration screen. Elements printed in the related section by clicking on the buttons are made simple in order to display only minimal information, and do not contains all configurable elements.
Included / excluded
Products Rate Plans associated here will be automatically included or excluded from the cart when the main product is added (depending the configuration).
The Products available can either be groups or Specific Product Rate Plans.
Section description
Included products
- Products Rate Plans : Specify here the Products Rate Plans that will be included.
- Add a rate plan : click on this button in order to create a Rate Plan and add it in the section.
- Add a filter : click on this button if you want to show upgrade products dynamically. The products shown will be the one that correspond to the filter.
Products Rate Plans will be displayed by priority order, from top to bottom. Here are describe the standard fields :
You can add several filters by clicking on the button "Add a filter" that is below the array.
Excluded products
- Products Rate Plans : Specify here the Products Rate Plans that needs to be excluded.
- Add a rate plan : click on this button in order to create a Rate Plan and add it in the section.
- Add a filter : click on this button if you want to show downgrade products dynamically. The products shown will be the one that correspond to the filter.
Products Rate Plans will be displayed by priority order, from top to bottom. Here are describe the standard fields :
You can add several filters by clicking on the button "Add a filter" that is below the array.
Tips
- Create products and filters separately in the corresponding section, as you will be more flexible in the configuration screen. Elements printed in the related section by clicking on the buttons are made simple in order to display only minimal information, and do not contains all configurable elements.
"Edit Rate plan"
User should be able to edit rate plan if they want to change existing rate plan.