Properties describe the characteristics of your Product or Customer.
With Properties you can
- Add features to your Products, that are shown in the Shop and are comparable between Products.
- Add input fields to Product's configuration phase in the checkout process.
- Add input fields for requesting Customer information in the checkout process.
Properties are also used for storing and relaying information between Pilvi and Service Integration providers.
Table of Contents
Properties have
- a unique Property Name, ex.
site-1-my.example.property - a localized Property Label, ex.
My Example Property - a Property Type, which defines where the Property receives its value.
- a Property Value Type, which defines the type of the value. See list of possible Value Types below.
- a Property value.
Property values
Property has a Value type, that cannot be altered after its creation:
- Checkbox. Yes/No toggle. Shown in the UI as a checkbox.
- Text. Text value. Shown in the UI as a text input field.
- Selectbox. Text option. Shown in the UI as a selectbox.
- Number. Numeric value. Shown in the UI as a number input field.
- Number Range. Numeric value from a certain range. Shown in the UI as a slider.
- Textarea. Multiple lines of text. Shown in the UI as a textarea input field.
- Date. Date value with month, day, and year. Shown in the UI as a date picker.
Property validations
Property values may also have an optional validation that restricts the value of the Property.
| Value Type | Validation Type | Validation Name |
|---|---|---|
| STRING | Email. Spec | |
| STRING | URL | URL. Spec |
| STRING | DOMAIN | Domain. Spec |
| STRING | HOSTNAME | Hostname. Spec |
| STRING | PHONE | Phone |
| NUMBER | INTEGER | Integer |
| NUMBER | DECIMAL_2 | Two Decimals 0.00 |
Property categories
Properties are divided into to categories: Product and Profile.
Product Properties
Product Properties define a Product. Product Properties may have their value set on the Product or on the Service.
Names of the Product Properties that are created by a Seller are automatically prefixed with a Seller ID. Ex. seller-1-
Profile Properties
Site Administrator can define and set the values of the Profile Properties in Manager. Profile Property values may be required from the user in Shop Sign Up and Shop Cart. User can also see and change the values in Console.
In addition to the Property value type and validation, Site Administrator may set Profile Property attributes for the visibility, validation, helpers, and localizations.
Names of the Profile Properties are automatically prefixed with the Site ID. Ex. site-1-
Adding New Profile Properties
New Profile Properties can be added in Customers - Profile Properties. The name will be used by default for all the locales.
Required
If Required is set, User has to input a value before proceeding.
Accessibility in Shop/Console/Manager
Profile Property accessibility can be defined separately for Shop (Sign Up, Cart), Console (User Settings), and Manager (Customer Profiles). The accessibility options for each are:
- Hidden. Profile Property is not visible.
- Visible. Profile Property value is shown.
- Editable. Profile Property value is visible and may be edited.
Show for (Profile Type)
Profile Property access can be further limited based on the profile type.
- Person. User with the profile type Person can see/edit the property.
- Business. User with the profile type Business can see/edit the property.
- All. Both Person and Business users can see/edit the property.
Position
Position number can be used to sort Profile Properties on the forms in ascending order. The default is 0. Note that properties with the same position number are not in any specific order within that position.