Custom Attributes

When capturing records, transactions, or tickets you might want to capture information that QuickEasy BOS doesn’t automatically include. You can achieve this by using Attributes. There are pre-created sets of Attributes for specific modules which are listed under System when you add attributes

Unique attributes can also be created (e.g. to add information such as a supplier’s BEE rating). These attributes are named Custom Attributes.

Lookup lists may be created for certain attributes which allow users to select an option instead of typing it. Lookup lists are automatically alphabetised. Lookup lists are created from the attributes interface (e.g. Main Menu > Setup > Attributes or Menu (button) > Edit Attributes).

Custom attributes can be added to:


Custom Attributes Interface

Interface

Buttons Explained

Button

Description

Recent

A dropdown list of recently viewed records for quick access to those records.

The button is supressed if there are no recent items.

Add/Edit

Used to add or edit entries.

Save

Saves any changes.

Actions

Update Attributes on Modules: Applies changes made to lookup lists and attribute items to the attributes already added to modules.

Menu


Filters Explained

Button

Description

Module

A dropdown list of modules for selection.

System (checkbox)

If checked only system entries are displayed.

System entries cannot be edited.

Auto Height

(checkbox)

If checked automatically adjusts the row height to fit all the entries.

Click Save (button) if the row is not being adjusted.


Attribute Sets: Fields Explained

Field

Description

Field Chooser (*)

Used to add or remove columns.

ID

The system-generated number allocated to the entry.

Code

A field to enter a brief description or code.

Description

A field to enter a description.

Multiple

(Add Multiple)

A checkbox.

If checked the attribute can be added more than once (e.g. if a supplier has multiple bank accounts).

Module

The module selected for the custom attribute.

Type

The type of attribute set.

Created

The date on which the attirbute set was created.

Updated

The date on which the attribute set was last updated.

Updated By

The user who last updated the attribute set.


Attribute Items: Fields Explained

Field

Description

Field Chooser (*)

Used to add or remove columns.

ID

The system-generated number allocated to the entry.

Order ID

The sequence number allocated to the item within the attribute set.

Key

The name for the index field.

If the field is not completed, the ID field is used in the format a_number.

Caption

The caption that is displayed

Editor

The editing options for the field. The options are:

  • Text: Any text can be typed.

  • Number (0 Decimals): Only an integer can be typed.

  • Number (2 Decimals): A number with 2 decimals can be typed.

  • Number (4 Decimals): A number with 4 decimals can be typed.

  • Combobox (Fixed): An answer must be selected from a lookup list.

  • Combobox (Edit): An answer may be selected from a lookup list or typed in the block.

  • Checkbox (Y/N): A checkbox. Checked for yes, left unchecked for no.

  • Lookup SQL: An SQL query is run to create a lookup list.

  • Date: Opens a calendar to select a date.

Lookups

If combox was selected under Editor, lookup lists can be created by typing in the entries (press Enter between entries).

Default Value

A field to enter a default value for the attribute.

Created

The date on which the attirbute item was created.

Updated

The date on which the attribute item was last updated.

Updated By

The user who last updated the attribute item.

SQL

Checkbox. If SQL is created, the box is automatically checked.

A context menu with these options:

  • View/Edit Lookup SQL: Allows the SQL query to be created. Only displayed if Lookup SQL is selected as the Editor option.

  • Clear Attribute Values on Modules: Clears all the entries.

  • Move Up Ctrl+U: Moves the entry one line higher. Only applies to attribute sets that have multiple items.

  • Move Down Ctrl+D: Moves the entry one line lower. Only applies to attribute sets that have multiple items.

  • Delete Ctrl+Del: Deletes the entry.


Tutorials

These tutorials explain how to create, edit, and add attributes.

How to Create Custom Attributes 

  1. Navigate to Edit Attributes (e.g. Main Menu > Setup > Attributes).
  2. Click Add/Edit (button).
  3. Module = Select one of these options from the dropdown list:
    • All
    • Contacts
    • Customers
    • Suppliers
    • Items
    • Assets
    • Transactions
    • Services
  4. Create an Attribute Set (top row left) as follows:
    1. Code = Type an abbreviation of the description.
    2. Description = Type a description for the group.
    3. Multiple = Check the checkbox if the attribute set can be added more than once to the same record.
  5. Add Attribute Items to the set. Click the set on the right and complete the fields in the attributes section as follows:
    1. Key = Type a descriptive key (lower case, no spaces). This key makes finding the attribute easier when creating custom actions or reports.
    2. Caption = Type a descriptive heading for the attribute (e.g. BEE Rating).
    3. Editor = Select what type of answer the user must provide from these options:
      • Text: Any text can be typed.
      • Number (0 Decimals): Only an integer can be typed.
      • Number (2 Decimals): A number with 2 decimals can be typed.
      • Number (4 Decimals): A number with 4 decimals can be typed.
      • Combobox (Fixed): An answer must be selected from a lookup list.
      • Combobox (Edit): An answer may be selected from a lookup list or typed in the block.
      • Checkbox (Y/N): A checkbox. Checked for yes, left unchecked for no.
      • Lookup SQL: A fixed lookup list is created using an SQL query (which must be added afterwards).
      • Date: Opens a calendar to select a date.
    4. Lookups = If Combobox (Fixed) or Combobox (Edit) is selected, type the expected answers in the field provided – one entry per line.
      • Note: Check or uncheck the Auto Height checkbox to display or hide the full lookup list.
      • Note: In certain circumstances the system allows you to create lookup lists without first selecting Combobox, but the lookup lists do not work until you select Combobox in the editor column.
  6. Repeat Step 4 to add additional attribute items to the set (optional).
  7. Click Save (button).

How to Edit a Custom Attribute 

  1. Navigate to Edit Attributes (e.g. Main Menu > Setup > Contacts > Menu (button) > Edit Attributes).
  2. Click Add/Edit (button).
  3. Edit the fields as needed.
    • Note: Check or uncheck the Auto Height checkbox to display or hide the full lookup list.
  4. Click Save (button).

How to Delete a Custom Attribute Item

  1. Navigate to Edit Attributes (e.g. Main Menu > Setup > Contacts > Menu (button) > Edit Attributes).
  2. Right click an attribute item on the right-hand section and click Delete on the context menu.
  3. Confirm the deletion.

How to Delete a Custom Attribute Set

  • All the custom attributes on the right must first be removed from the set before it can be deleted (see previous heading).
  • Sets must be removed from the records to which they were added (e.g. contacts, transactions) before they can be deleted.
  1. Navigate to Edit Attributes (e.g. Main Menu > Setup > Contacts > Menu (button) > Edit Attributes).
  2. On the left in Sets section, right click a set and click Delete on the context menu.
  3. Confirm the deletion.

How to Add Attributes to a Contact 

Fixed attribute sets are displayed under System. Custom attributes are displayed under Custom.

  1. Navigate to Contacts (Main Menu > Setup > Contacts).
  2. Right click the contact you want to edit and select Edit Contact from the context menu.
  3. Click Edit (button) on the top row if it is not blue.
  4. Click Attributes (tab). 
  5. On the right side, click Attributes (button) next to Add/Remove.
  6. Move your mouse over Add and click the Attribute Group you want to add.
  7. The set is added and the necessary information can be provided in the Value column.
  8. Repeat Steps 5-7 to add more attribute groups.
  9. Click Save (button) on the top row.

How to Remove Attributes from a Contact 

System attributes cannot currently be removed.

  1. Navigate to Contacts (Main Menu > Setup > Contacts).
  2. Right click the contact you want to edit and select Edit Contact from the context menu.
  3. Click Edit (button) on the top row if it is not blue.
  4. Click Attributes (tab). 
  5. On the right side, click Attributes (button) next to Add/Remove.
  6. Move your mouse over Remove and click the Attribute Group you want to remove.
  7. Confirm the deletion on the popup.
  8. Repeat Steps 5-7 to remove more custom attribute groups.
  9. Click Save (button) on the top row.

How to Update Modules when Attributes are Edited

  1. Navigate to Edit Attributes (e.g. Main Menu > Setup > Contacts > Menu (button) > Edit Attributes).
  2. Click Actions (button) > Update Attributes on Modules.
  3. The attributes are updated and a confirmation message is displayed.

How to Add or Edit an Attribute on a Service Ticket

  1. From editing a ticket: click Menu (button) > View/Edit Attributes.
  2. On the popup:
    1. Click Add (button) and select one of the available attributes.
    2. Enter the required information in the Value column.
    3. Click Save (button).

How to Add an Attribute to a Transaction

If an attribute set is selected using the Transaction Type Setting: General > Default – Attribute Sets, it is automatically displayed.

  1. From editing a transaction: click Menu (button) > View/Edit Attributes.
  2. On the popup:
    1. Click Add (button) and select one of the available attributes.
    2. Enter the required information in the Value column.
    3. Click Save (button).

How to Edit an Attribute on a Transaction

Attributes can be edited if the transaction can be edited.

  1. From editing a transaction: click Menu (button) > View/Edit Attributes.
  2. On the popup:
    1. Enter the required information in the Value column.
    2. Click Save (button).

Learn More

  1. Attribute Sets Entities: An explanation of the attribute sets available to entities.
  2. Attribute Sets Persons: An explanation of the attribute sets available to persons.