Profile Picture of the author

Objects

on 10-19-2024 12:00 AM by SnapApp by BlueVector AI

34

An Object in SnapApp is a structured collection of data arranged in rows (records) and columns (fields). Each Object helps organize information about entities like customers, orders, or tasks. Fields store specific attributes such as customer names or order totals.

Table of Contents

Object Types

  • System Object: Essential for SnapApp’s core functions (e.g., User Object for managing users).
  • Standard Object: Common Objects with additional features to suit typical use cases (e.g., Inventory Object for tracking products).
  • Custom Object: User-created Objects tailored to unique requirements (e.g., Event Object for managing company events).
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.
Object Access and Permission Sets Object Access 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. Get more details on Object Access here You must assign permission set to different Object access 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, by default that will be only set for Elevated Admin Access.

Key Guidelines for Creating Objects

  • 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.
  • 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}"))

Best Practices for Object Configuration

  • 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).

For advanced configurations or detailed step-by-step instructions, users can refer to the advanced section

Advance Details

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

configure-Object

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?

Some more features with examples

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

Example: Order Management

Object: Order

Label: “Order Attachments”

Use Case: In an order management system, teams often need to attach invoices, shipping labels, and product images to an Order record. Enabling Track Attachments allows the team to store and access all relevant documents in one place, improving order tracking and enabling smoother handoffs between departments.

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

Example: Order Management

Object: Order

Label: “Order Notes”

Use Case: In an order management system, team members may need to add notes for special handling instructions, issues reported by customers, or delivery preferences. Enabling Track Notes allows users to document these details directly on each Order record, ensuring all relevant information is readily accessible and can be reviewed throughout the order lifecycle.

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

Example: Order Management:

Object: Event

Label: “Event Name”

Use Case: Organize company events and track attendee registrations. Enable Feed Tracking to allow team members to post updates and changes regarding event details.

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

Example: Order Management

Object: Order

Label: “Order Status”

Use Case: In an order management system, tagging each Order with status labels such as “Pending,” “Shipped,” “Delivered,” or “Cancelled” helps the operations team quickly identify the current state of orders. This makes it easy to track order progress and manage workflow efficiently.

  • Track Favorites: Enabling this setting will allow users to favorite records in this Object. Favorited records can be retrieved using the favorites filter.

Example: Order Management

Object: Order

Label: “Order ID”

Use Case: In an order management system, sales and support teams may want to mark certain high-value or priority orders as favorites. By enabling Track Favorites, users can quickly retrieve these marked orders using the favorites filter. This feature helps prioritize important orders, making it easy for teams to monitor their status, update information, and provide expedited support when needed.

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

Example: Order Management

Object: Order

Label: “Order Updates Feed”

Use Case: In an order management system, multiple departments (e.g., sales, shipping, customer support) often need to collaborate on individual orders. Enabling Feed on the Order object allows team members to post updates on order status, communicate any issues, and notify others of customer requests or changes in real time. This centralized communication ensures that everyone involved in fulfilling the order is informed, helping to reduce delays and improve customer satisfaction.

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

Example: Order Management

Object: Order

Label: “Expected Delivery Date”

Use Case: When an order’s Expected Delivery Date is updated, perhaps due to changes in shipping or stock, Feed Tracking posts this change in the order feed. This ensures that customer service agents can proactively inform customers about revised delivery timelines, enhancing transparency and customer satisfaction.

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

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

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.


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