Service Design Specification - Object Design for company

workforceos-auth-service documentation

Document Overview

This document outlines the object design for the company model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.

company Data Object

Object Overview

Description: A data object that stores the information for company

This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.

Core Configuration

Redis Entity Caching

This data object is configured for Redis entity caching, which improves data retrieval performance by storing frequently accessed data in Redis. Each time a new instance is created, updated or deleted, the cache is updated accordingly. Any get requests by id will first check the cache before querying the database. If you want to use the cache by other select criteria, you can configure any data property as a Redis cluster.

Properties Schema

Property Type Required Description
name String Yes A string value to represent one word name of the company
codename String Yes A string value to represent a unique code name for the company which is generated automatically using name
fullname String Yes A string value to represent the fullname of the company
avatar String No A string value represent the url of the company avatar. Keep null for random avatar.
ownerId ID Yes An ID value to represent the user id of company owner who created the tenant
industry String No The industry the company operates in (e.g., Technology, Healthcare, Finance, etc.)
companySize String No The size of the company (e.g., 1-10, 11-50, 51-200, etc.)

Default Values

Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.

Constant Properties

ownerId

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

name fullname avatar industry companySize

An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false. These properties will be added to the update API’s body parameters and can be updated by the user if any value is provided in the request body.

Elastic Search Indexing

name codename fullname ownerId industry companySize

Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.

Database Indexing

ownerId

Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.

Unique Properties

codename

Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.

Secondary Key Properties

ownerId

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Session-sourced Properties

ownerId

These properties have source: 'session' — their values are read from the authenticated session at create/update time and cannot be supplied in the request body.

This property is the data object’s ownership field, used by ownership-based access control.

Filter Properties

name codename fullname avatar ownerId

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.