Cubu Docs
User Guide
User Guide
  • 👋Welcome to Cubu!
  • Getting Started
  • Understanding the Basics
    • Organizations
    • Process Management
      • 📚Introduction to Cases
      • 📚Service Models and Flow
      • 📚Storing Data with Fields
      • 📚Categorizing Cases with Tags
      • 📚Service Categories and Types
      • 📚Inboxes
      • 📚Routes
      • 📚Working Hours
      • 📚Walk-in Services
      • 📚Appointment-based Services
      • 📚Data Tables
      • 📚The Customers Data Table
      • 📚Automation
        • 📄Automation Triggers
        • 📄Automation Conditions
        • 📄Automation Actions
    • Agent Status Tracking
    • Portals
      • 📚Portal Flow I: Single Unit
      • 📚Portal Flow II: Cross Unit Search
      • 📚Prerequisites & Data Collection
    • Kiosks
      • 📚Kiosk Flow
      • 📚Kiosk Accessibility
    • Virtual Tickets
    • Service Level Alerts
    • Security and Permissions
      • Access Control
        • 📚Unit Access Permissions
        • 📚Inbox Access Permissions
        • 📚Service & Calendar Access Permissions
        • 📚Fields Access Permissions
        • 📚Data Table Access Permissions
      • 📚Built-in Roles
    • Subscriptions & Licensing
    • Chats Overview
  • User Tools
    • About Agents and Managers
    • Agent Console
      • ⚒️Agent Console Basics
      • ⚒️Processing Cases
      • ⚒️The Inbox Tab
      • ⚒️The Case Tab
      • ⚒️Workspace Settings Tab
    • Calendar
      • ⚒️Selecting Calendars
      • ⚒️Booking, Checking-in & Canceling Appointments
    • Appointment Booking
    • Data Manager
      • ⚒️Searching for Records
      • ⚒️Managing Data Records
    • Case Browser
    • General Tasks
      • ⚒️Updating your Profile
      • ⚒️Selecting Your Current Unit
      • ⚒️Change Language
      • ⚒️Switch Organization
    • Report Center
    • Real-time Monitor
      • Widgets Reference
      • Metrics Reference
  • Connected Apps
  • Admin Tools
    • About Administrators
    • Organization Tree
      • ⚒️Managing the Organization Tree
      • ⚒️Configuring Unit Access
      • ⚒️Configuring Time Zones
      • ⚒️Managing Inboxes
      • ⚒️Managing Routes
      • ⚒️Managing Workstations
      • ⚒️Managing Portals
      • ⚒️Managing Kiosks
        • ⚒️Printed Tickets Templates
    • Service & Process Configuration
      • ⚒️Global Service Settings
      • ⚒️Managing Service Categories
      • ⚒️Managing Service Types
      • ⚒️Managing Fields
      • ⚒️Managing Tags
      • ⚒️Managing Working Hours
      • ⚒️Managing Automations
      • ⚒️Managing Data Tables
      • ⚒️Managing Back-office Tasks
      • ⚒️Managing Alert Rules
    • Service Management
      • ⚒️Walk-in Services Settings
      • ⚒️Appointment-based Services Settings
      • ⚒️Managing Service Availability
      • ⚒️Manage Service Daily Plans
      • ⚒️Manage and Scedule Daily Plan Templates
    • Security and Permissions
      • ⚒️Managing Users & Invitations
      • ⚒️Managing Groups
    • Customer Engagement
      • ⚒️SMS Templates
      • ⚒️Email Templates
      • ⚒️ICS Templates
      • ⚒️Managing Themes
      • ⚒️Managing Fonts
      • ⚒️Media Library
      • 🗒️Dynamic Text Parameters (Messaging)
    • Localization and Translation
      • ⚒️Translating Resource Names
      • ⚒️Translating Kiosks, Portals, Tickets, and Chats
      • 📄Dynamic Text Parameters (Public Apps)
    • Organization Settings
      • ⚒️Organization General Settings
      • ⚒️Public Text Languages
      • ⚒️File Storage
      • ⚒️SSO
      • ⚒️BI and Reports
      • ⚒️Certificates
      • ⚒️Webhooks
      • ⚒️Integrations
      • ⚒️Groups
      • ⚒️Registered Applications
    • Chats Admin
      • ⚒️Chat Settings
      • ⚒️Chatbots Configuration
    • Billing
      • ⚒️Subscription Management
      • ⚒️Payments
    • Logs
      • ⚒️Event Log
      • ⚒️SMS Log
      • ⚒️Change Log
  • Digital Signage
    • 📚Digital Signage
    • 📚Digital Sign Appearance
    • ⚒️Managing Digital Signs
    • ⚒️Managing Screen and Frame Layouts
    • ⚒️Managing Playlists
    • ⚒️Managing Public Announcements
  • How To Guides
    • Agent Tasks
      • 🧐How to unlock a case processed by another user
    • Admin Tasks
      • 🧐How To: Compensate For No-shows
      • 🧐How To: Reference Data Records from Cases
      • 🧐How To: Configure a Phone Call Meeting
      • 🧐How To: Set Up a Kiosk Ticket Printer
      • 🧐How To: Configure SendGrid as an Email Provider
      • 🧐How To: Configure Mandrill as an Email Provider
      • 🧐How To: Use Google Fonts in Themes
    • Automations
      • 🧐How To: Use Automation to Send SMS
      • 🧐How To: Use Automation to Move a Case to Another Inbox
    • In-Branch Operations
      • 🧐How To: Use the Kiosk Client App
      • 🧐How To: Connect a Digital Sign
    • Kiosks
      • 🧐How To: Configure Accessible Kiosk with IVR
Powered by GitBook
On this page
  • Creating a New Field
  • Field Settings
  • Settings common to all field types:
  • Settings specific to field types:
  • Archiving and Restoring Fields
  • Archiving a Field
  • Restoring a Field
  • Localization
  • See Also
  1. Admin Tools
  2. Service & Process Configuration

Managing Fields

PreviousManaging Service TypesNextManaging Tags

Last updated 1 year ago

Fields define data items you can add to cases, customers, and other data records.

Admin Tools -> Metadata -> Fields

Editing fields requires the Service Admin role.

Creating a New Field

On the Fields page, click on the New Field button.

In the New field dialog, enter:

  • Field name: Choose a friendly name describing the field. Field names are unique in the organization.

  • Slug: The slug is a code that uniquely identifies the field in the system. The slug is used in SMS and email templates to add the field value to customer messages. You cannot change the slug once the field is created.

  • Data type: The type of data stored by this field. Some field types will require additional settings (see below). You cannot change the data type once the field is created.

Click Create to create the new field.

Field Settings

On the Field Details page, you can edit the field's settings.

Settings common to all field types:

  • Field name: A unique, friendly name identifying the field.

  • Description: (optional) A free-text description of the field.

  • Information text: (optional) Information to show users as a tooltip to help them fill the field correctly.

  • Field color: Choose a color for the field to make it easier to identify on the Agent Console and Data Records.

Settings specific to field types:

Boolean Fields

  • Default value: (True/False) A default value for new Case records and Data records.

Currency Fields

to store a certainThe currency field type is used for storing an amount of money.

  • Min/Max value: The minimum and maximum permitted value.

  • Precision: The allowed number of digits after the decimal point.

  • Default value: A default value for new Case records and Data records.

  • Supported currencies: A list of currencies the user can choose from.

  • Default currency: The default currency to use when the field is presented to users.

Data Record Fields

A "data record" field links a data record in a data table to a case record or another data record.

For more information, see How To: Reference Data Records from Cases

Date and Time Fields

Use this field type to store date and time data.

  • Include time: Check this box to include the time part in the field. If you uncheck this, the field will only store the date information.

  • Default date and time

    • None: No default value

    • Absolute: Set the field to a specified value when creating the record.

    • Relative: Set the field to a date and time relative to the time of the record's creation.

Text Fields

  • Is multiline: Check this box to create a multi-line textbox.

  • Min length/ Max length: The permitted text length.

  • Default value: A default text for creating a new Case or Data record with this field.

Number Fields

  • Min/Max value: The minimum and maximum permitted value.

  • Precision: The allowed number of digits after the decimal point.

  • Default value: A default value for new Case records and Data records.

Phone Number Fields

Use this field to store phone numbers.

  • Supported regions: A list of supported country dialing codes.

  • Default region: The default region to use when rendering this field.

Archiving and Restoring Fields

Archiving a Field

Archiving a field removes it from the system.

To archive a field, click on the context menu button [⋮] adjacent to the field name and click Archive Field.

Built-in fields, e.g., Email, First Name, cannot be deleted.

If the field is used in emails, SMS, or other templates, its data will no longer be included in the message, which may create gaps or incomplete messages. Before archiving a field, make sure it is not used in templates.

Restoring a Field

To restore an archived field, go to the Field List page, click the context menu button [⋮], and Restore Archived Fields.

Click the context menu button [⋮] adjacent to the field you wish to restore, then click Restore. You can rename the field or change the slug before restoring it if another field has already used it.

Localization

The field name, description, and other information may appear on Kiosk, Portals, and other customer-facing applications. You can provide translations for these elements using the Public Texts tools (located in the Customer Engagement toolbelt). For more information, see:

See Also

Free text/List of options: Choose "List of Options" to provide a list of values the user can choose from. When using this option, the field is rendered as a dropdown.

Validation pattern: The advanced option allows you to enter a to validate the user input.

⚒️
RegEx expression
⚒️Translating Resource Names
📚Storing Data with Fields
Field List Page