Manage valuesets
Goal
To create and manage valuesets in the Propeller backoffice, enabling you to store predefined lists of values used across the platform for fields like payment statuses, suppliers, manufacturers and custom business attributes.
Understanding Valuesets
Valuesets are reusable collections of values that standardize data entry across your commerce platform. They come in two types:
System Valuesets
- Pre-defined valuesets created automatically for new tenants
- Essential for core platform functionality
- Cannot be deleted but can be modified
- Examples: SYSTEM_PAYMENT_STATUS, SYSTEM_SUPPLIERS
Custom Valuesets
- User-created valuesets for specific business needs
- Fully customizable and can be deleted
- Used for industry-specific or company-specific values
- Examples: Product attributes, custom classifications
Step 1: Navigate to Valuesets
- From the backoffice menu, select Admin and then Valuesets.
- The valuesets list displays:
- ID
- Type (SYSTEM or CUSTOM)
- Name
- Description
- Value count
- Created date
- Modified date
Step 2: Create a New Valueset
- Click the New Valueset button in the top right corner.
- A popup window titled New Valueset will appear.
Step 3: Configure Valueset Details
Complete the following fields:
Required Information
- Name: Enter a unique name for the valueset
- Use descriptive names that indicate purpose
- Examples: "Product Colors", "Delivery Regions"
Optional Information
- Description (NL): Add a description explaining the valueset's purpose
- Use the language dropdown to add descriptions in multiple languages
- Helps other users understand when to use this valueset
Step 4: Save the Valueset
- Click Save to create the valueset.
- The popup will close and the new valueset will appear in the list.
- Click Cancel to discard changes.
Step 5: Add Valueset Items
After creating a valueset, you need to add items to it:
- Click on the valueset name in the list to open it.
- You'll see the valueset items list showing:
- ID
- Valueset ID
- Description
- Value
- Extra field
Step 6: Create New Valueset Items
-
Click New Valueset Item button in the top right.
-
The Edit Valueset Item popup appears.
-
Complete the fields:
- Description (NL): Display name for the item
- Use language dropdown for multiple languages
- Value: The actual value stored in the system
- This is what's used in integrations and data storage
- Extra: Optional additional data
- Used for special configurations or metadata
- Description (NL): Display name for the item
-
Click Save to add the item.
-
Repeat for all needed values.
Default System Valuesets
New tenants automatically receive these system valuesets:
Name | Description | Purpose |
---|---|---|
SYSTEM_SUPPLIERS | Suppliers | Product supplier field values |
SYSTEM_MANUFACTURERS | Manufacturers | Product manufacturer field values |
SYSTEM_TURNOVER_GROUPS | Turnover groups | Product turnover group classifications |
SYSTEM_APP_LANGUAGES | Application languages | Available languages for backoffice UI |
SYSTEM_DATA_LANGUAGES | Data languages | Languages for localizable content (products, categories, etc.) |
SYSTEM_PAYMENT_STATUS | Payment statuses | Order payment status tracking |
SYSTEM_SHIPPING_METHOD | Shipping methods | Available shipping options Note: For 'PICKUP' value, set extra field to 'HIDE' to hide at checkout |
SYSTEM_SOURCE | Order sources | Track how orders/quotes were created |
SYSTEM_USER_TAGS | User groups/segments | Categorize contacts, companies and customers |
BOOLEAN | Boolean Yes/No | Standard yes/no options for forms and logic |
Editing Valuesets and Items
Edit a Valueset
- Click on the valueset row in the list.
- The valueset items view opens.
- To edit valueset properties, use the API or data import.
Edit Valueset Items
- Click on any item in the valueset items list.
- The Edit Valueset Item popup opens.
- Modify the description, value, or extra field.
- Click Save to apply changes.
Best Practices
- Naming Conventions: Use clear, uppercase names for system integration (e.g., PROD_ENUM_ATTR_COLOR)
- Value vs Description: Keep values simple and consistent (e.g., "RED"), use descriptions for display ("Red Color")
- Language Support: Always provide descriptions in all supported languages
- Extra Field Usage: Document what the extra field contains when used
- Regular Review: Periodically check for unused valueset items
- Integration Planning: Coordinate with developers when creating valuesets used in integrations
Common Use Cases
Product Attributes
Create valuesets for standardized product properties:
- Colors: RED, BLUE, GREEN
- Sizes: XS, S, M, L, XL
- Materials: COTTON, POLYESTER, WOOL
Business Classifications
Organize data with custom valuesets:
- Customer types: B2B, B2C, DISTRIBUTOR
- Order priorities: LOW, NORMAL, HIGH, URGENT
- Product conditions: NEW, REFURBISHED, USED
Regional Settings
Manage location-specific values:
- Delivery zones: ZONE_A, ZONE_B, ZONE_C
- Tax regions: EU, NON_EU, DOMESTIC
- Warehouse locations: NORTH, SOUTH, CENTRAL
Important Notes
- System valuesets are critical for platform operation - modify with caution
- Deleting valueset items may affect existing data references
- Changes to valuesets don't automatically update existing records
- Some valuesets are used in business rules and shipping calculations
- The extra field has special meaning for certain system valuesets (e.g., SYSTEM_SHIPPING_METHOD)