Sections
Profile

Objects

on 05-08-2024 12:00 AM by SnapApp by BlueVector AI

1144

An Object is a structured collection of data arranged in rows and columns. The rows represent individual records, while the columns denote fields. Each record encapsulates information about a specific entity, such as a customer or an order. Each field holds data pertaining to a particular attribute of the entity, such as the customer’s name and address, or the order’s total price.

There are 3 different types of Objects:

  • System Object - Objects required by the SnapApp to function properly
  • Standard Object - Common Objects required by most users with added features to meet the requirements
  • Custom Object - Created by the user

Table of Contents

How to create an Object?

  1. Navigate to Settings from the User menu of the top bar.
  2. Tap on Objects from the Data menu of the left navigation bar.
  3. Tap on + Add New in the top header of the Objects list view to add a new Object.
Ensure you have the proper permissions to Create objects and Read the newly created object.

go-to-object

Obj-create

Obj-create2

Finally, your Object is ready to store records. You can repeat the steps described above to add multiple tables. You can also Preview the Object that you have created How to preview an object?

How to edit an Object?

**Pre-Conditions** : Object must be created
  1. Navigate to Settings from the User menu of the top bar.
  2. Tap on Object from the Data menu of the left navigation bar, and tap the Edit button to make configuration changes to the Object.
  3. Configure the Object settings → Save
Settings Description
Singular Label This is a noun and a singular label for the Object (e.g. Product). Singular labels are used when referencing a record in an Object.
Plural Label The plural version of the label (e.g. Products). Plural labels are used when referencing a collection of records in an Object or the Object as a whole.
Table Name The name used to store the Object in the underlying database. This is not visible anywhere in the application and can not be changed once set.
Record Label Field This is set to ‘ID’ by default and can be changed once you add fields. The record label field is used to identify a record through out the application. This field will be treated as the primary field on list views and displayed when a record is referenced by another record, either on an Object detail view or the value that is displayed in the drop down when editing a ref field. For example, if you set the record label field to product number, the product number would display instead of a big id throughout the application. This makes your records more recognizable and easier to use.
Track Attachments Setting this to true will create a ref field relationship on the attachments Object which will allow you to add attachments to records in this Object.
Track Notes Setting this to true will create a ref field relationship on the notes Object which will allow you to add notes to records in this Object.
Track Activities Setting this to true will create a ref field relationship on the activities Object which will allow you to add activities (e.g. emails, tasks, sms, events) to records in this Object.
Track Tags Setting this to true will create a ref field relationship on the tags Object which will allow you to add tags to records in this Object.
Track Favorites Enabling this setting will allow users to favorite records in this Object. Favorited records can be retrieved using the favorites filter.
Enable Feed Setting this setting to true, will enable Feeds on records in this Object. A feed allows users to post messages related to the record to be shared with other users who have access to the record. Feeds facilitate real time collaboration and simplify communications.
Feed Tracking Enabling feed tracking will allow you to automatically post changes to individual fields in the feed. If you enable feed tracking on the Object, you will want to do the same for each field where you want to track changes on. This is done in the field settings.
Permission Sets You must assign permission set access to the Object to allow user roles to Create, Read, Update, Delete, and Clone records in the Object. NOTE: If you do not assign any permissions sets to an Object, no one (including yourself) will be able to access this Object.
Object Access This defines the default level of record access for this Object for all users, i.e. private Objects only provide record access to the owner/creator of each record while public Objects grant record access to all users by default. Record access can be extended for private Objects by leveraging Sharing Rules or Data Access Hierarchies.

configure-Object

permission-set

How to preview an Object?

  1. Navigate to Settings from the User menu of the top bar.
  2. Tap on Objects from the Data menu of the left navigation bar.
  3. Tap on the object in the list that you want to preview → Preview

preview

object-view

How to delete an Object?

**Pre-Conditions** : Object must be created
  1. Navigate to Settings from the User menu of the top bar.
  2. Tap on Objects from the Data menu of the left navigation bar.
  3. Tap on the Object in the list that you want to delete.

  4. Tap on the Delete button. To see the Delete button, you must have the Delete permission on the Objects object in one of the permission sets assigned to your user role.

  5. Naming Convention

    • Objects should be nouns describing the Object. Avoid abbreviations and short and cryptic names.
    • Descriptive names make it easier for others to understand the schema, which is vital to maintaining efficiency as the team grows.
    • And whenever possible, use a single word instead of many. Or use underscore to separate multiple words
    • Object Labels should be capitalized in Title Case and words should be separated with spaces.
    • Table names are automatically created. They should be lowercase, and plural and should have underscores to separate words.

  6. ID’s and Object Record Label

    • The system automatically creates internal UUIDs for each record. These are universally unique but very long and not ideal for humans to reference. For this reason, SnapApp allows you to create your own id and use it as the record label.
    • The record label is the field on an Object used as the primary label. This will appear on any link to the record.
    • Record Label should be a unique field that describes the record.
    • It is often a good idea to use a formula generating a prefix that helps identify the Object + an id. For example, you may elect to create a formula field called Permit Number to be the record label for the Permits Object.
    • The following formula would generate a permit number like ON-00020 could be =CONCATENATE("ON-",FORMAT_NUMBER("[[_index]]", "{:05.0f}"))

  7. Configuration Best Practices

    • Selecting the Track Notes, Attachments, Tasks will automatically create these related lists, saving time later.
    • Selecting the Track Tags and Favorites works a little differently. This enables the ability to add tags to a record or mark a record as a favorite (Tags is not yet available).

Thank you for following these steps to configure your SnapApp components effectively If you have any questions or need further assistance, please don’t hesitate to reach out to our support team. We’re here to help you make the most out of your SnapApp experience.

For support, email us at snapapp@bluevector.ai

Generate Text