Update Set
The Update Set DocType in TechMaju allows developers to track and manage changes to applications and system platform features. This ensures that new functionality can be developed in a non-production environment and then promoted to a production instance seamlessly.
Understanding the Update Set DocType
Purpose: The Update Set DocType is designed to capture and manage changes made to applications within the TechMaju platform. This includes tracking updates to various custom application features and ensuring that these changes can be migrated between instances.
Function: The Update Set DocType enables developers to:
Track changes made to custom applications in the form of Update Items.
Manage the selective promotion of these changes from development to higher environments.
Ensure that all changes can be modularly committed with respective messages and can be packaged into a versioned deployment.
Role Required
TM Core Developer: Can create, write, and delete update sets.
Update Set Fields
Field | Description |
|---|---|
Application | The application for which the update set is created. |
Status | The current status of the update set:
|
Update Items | A table of individual changes (update items) included in the update set. |
Update Item Fields
Field | Description |
|---|---|
Target DocType | The DocType that is being modified. |
Target Record | The specific record within the DocType that is being changed. |
Target Record Title | The title of the record being changed. |
Action | The type of action being performed:
|
Updated By | The user who made the change. |
Updated On | The date and time when the change was made. |
Payload | The details of the change in JSON format. |
Procedure
Automatic management of Update Sets:
An Update Set is created automatically when customizations are made for the related My Application.
Although some Roles may provide ways to change Update Set and Update Items, avoid making any direct changes since it could conflict with automated system changes.
Automatic management of Update Items:
Navigate to the specific Update Set.
Review the list of Update Items, which detail the individual changes made.
Reviewing and Committing Changes:
Ensure all changes are correct and complete.
Select the checkbox next to the changes that will be committed together.
Click on 'Commit' to commit the Update Set.
The current Update Set's status will change to "Committed". Also, a new Update Set will be created with the leftover Update Items that were not committed.
Deploying My Application Changes:
After committing, the Update Set's items can be deployed to a higher environment using the Deploy feature on My Application form.
Follow the deployment process to promote the changes to the production instance.
Only Update Sets with status "Committed" are included in the deployment.
Best Practices
Avoid making any direct changes to Update Sets and Update Items since the platform will automatically manage the relevant records.
Commit changes often and in manageable sized chunks with descriptive commit messages.
Once the committed changes are ready to be deployed, navigate to the My Application to properly version and deploy the Update Set changes for promotion to higher environments.