Service Design Specification - Object Design for userGroupMember

workforceos-auth-service documentation

Document Overview

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

userGroupMember Data Object

Object Overview

Description: A data object that stores the members of the user group.

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.

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: doUpdate

The existing record will be updated with the new data.No error will be thrown.

Properties Schema

Property Type Required Description
groupId ID Yes An ID value to represent the group that the user is asssigned as a memeber to.
userId ID Yes An ID value to represent the user that is assgined as a member to the group.
ownerId ID Yes An ID value to represent the admin user who assgined the member.
companyId ID Yes An ID value to represent the tenant id of the company

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

groupId userId ownerId companyId

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.

Elastic Search Indexing

groupId userId ownerId companyId

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

groupId userId ownerId companyId

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.

Cache Select Properties

groupId userId ownerId

Cache select properties are used to collect data from Redis entity cache with a different key than the data object id. This allows you to cache data that is not directly related to the data object id, but a frequently used filter.

Secondary Key Properties

companyId

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.

Filter Properties

groupId userId ownerId companyId

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.