Skip to main content

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​

  1. From the backoffice menu, select Admin and then Valuesets.
  2. The valuesets list displays:
    • ID
    • Type (SYSTEM or CUSTOM)
    • Name
    • Description
    • Value count
    • Created date
    • Modified date

Step 2: Create a New Valueset​

  1. Click the New Valueset button in the top right corner.
  2. 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​

  1. Click Save to create the valueset.
  2. The popup will close and the new valueset will appear in the list.
  3. Click Cancel to discard changes.

Step 5: Add Valueset Items​

After creating a valueset, you need to add items to it:

  1. Click on the valueset name in the list to open it.
  2. You'll see the valueset items list showing:
    • ID
    • Valueset ID
    • Description
    • Value
    • Extra field

Step 6: Create New Valueset Items​

  1. Click New Valueset Item button in the top right.

  2. The Edit Valueset Item popup appears.

  3. 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

  4. Click Save to add the item.

  5. Repeat for all needed values.

Default System Valuesets​

New tenants automatically receive these system valuesets:

NameDescriptionPurpose
SYSTEM_SUPPLIERSSuppliersProduct supplier field values
SYSTEM_MANUFACTURERSManufacturersProduct manufacturer field values
SYSTEM_TURNOVER_GROUPSTurnover groupsProduct turnover group classifications
SYSTEM_APP_LANGUAGESApplication languagesAvailable languages for backoffice UI
SYSTEM_DATA_LANGUAGESData languagesLanguages for localizable content (products, categories, etc.)
SYSTEM_PAYMENT_STATUSPayment statusesOrder payment status tracking
SYSTEM_SHIPPING_METHODShipping methodsAvailable shipping options
Note: For 'PICKUP' value, set extra field to 'HIDE' to hide at checkout
SYSTEM_SOURCEOrder sourcesTrack how orders/quotes were created
SYSTEM_USER_TAGSUser groups/segmentsCategorize contacts, companies and customers
BOOLEANBoolean Yes/NoStandard yes/no options for forms and logic

Editing Valuesets and Items​

Edit a Valueset​

  1. Click on the valueset row in the list.
  2. The valueset items view opens.
  3. To edit valueset properties, use the API or data import.

Edit Valueset Items​

  1. Click on any item in the valueset items list.
  2. The Edit Valueset Item popup opens.
  3. Modify the description, value, or extra field.
  4. 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)