Service Design Specification - Object Design for employeeDocument

workforceos-employeeprofile-service documentation

Document Overview

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

employeeDocument Data Object

Object Overview

Description: Document or certification attached to an employee profile. E.g., work permit, certification, or contract files.

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

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: throwError

An error will be thrown, preventing the insertion of conflicting data.

Properties Schema

Display Label Property: documentType — This property is the default display label for records of this data object. Relation dropdowns and record references in the frontend will show the value of this property as the human-readable label.

Property Type Required Description
employeeProfileId ID Yes Reference to the related employeeProfile record.
documentType String Yes Type of document (e.g., ID, contract, certification).
documentUrl String Yes URL to the file storage location or bucket for this document.
validUntil Date No Expiration date of document, if applicable. Used for tracking compliance/renewal.
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

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

Auto Update Properties

employeeProfileId documentType documentUrl validUntil

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.

Secret Properties

documentUrl

Secret properties hold sensitive values (e.g., API keys, QR codes, tokens) that must be protected from exposure to AI models. In MCP tool responses, these fields are masked with *** and a __proxyCode is included in the record. The AI cannot read the actual values of secret fields. To reveal a secret to the user, the AI uses the showSecretFieldInFrontEnd tool with the __proxyCode from the GET response. The frontend renders the value securely as text, barcode, or QR code through a dedicated action card. Unlike hashed properties, secret values are stored in cleartext and can be retrieved by authorized users through the proper reveal flow.

Elastic Search Indexing

employeeProfileId documentType validUntil 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

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

Secondary Key Properties

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

Filter Properties

employeeProfileId documentType validUntil 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.