When developing and integrating applications within the bookingtime system, two essential configuration entities, appConfig and moduleConfig play a crucial role in managing settings, access, and customization. These entities ensure that applications and modules function correctly within an organization and provide the necessary flexibility to meet different use cases.
The corresponding config can be accessed via the developer account.
Additionally settings can also be adjusted in the store of an organization.
What is an appConfig?
The appConfig entity is responsible for managing the installation and configuration of applications within an organization. When an app is installed, an appConfig object is created, which allows the app to interact with the organization and apply its settings across all sub-organizations.
Key Characteristics of appConfig
- Every installed app within an organization has a corresponding appConfig.
- The app inherits permissions, enabling employees to access and use the app based on their assigned employeeGroup.
- If an app is installed in an organization, it will automatically have the same permissions in all sub-organizations.
- Employees need explicit permission through employeeGroups to access and interact with the app.
- Apps can define custom settings, which are stored within the appConfig.
Example Use Case for appConfig
A calendar synchronization app needs access to manage appointments within an organization. When installed, an appConfig is created, allowing the app to retrieve and sync appointment data across all sub-organizations. Employees who have the required permissions via employeeGroups can configure the sync settings directly within the app.
What is moduleConfig?
The moduleConfig entity defines how modules operate within an organization. Modules differ from apps in that they are customer-facing components, typically embedded in booking processes. A moduleConfig allows developers to define module-specific settings, such as how the module interacts with the system.
Key Characteristics of moduleConfig
- Modules can be individually configured per organization, per module, enabling different configurations for different business locations.
- Multiples of the same module are possible by installing additonal moduleConfigs.
- The module’s behavior and options can be adjusted dynamically by modifying its moduleConfig.
Example Use Case for moduleConfig
A business operates two booking modules: one for consultations and another for technical support. By configuring each moduleConfig, settings can be made specific for each group. This setup ensures a clear separation of services and provides users with the correct booking options.
Differences Between appConfig and moduleConfig
Feature | appConfig | moduleConfig |
---|---|---|
Purpose | Manages the installation and configuration of apps within an organization | Defines settings and availability of booking modules. |
Scope | Applies to internal apps used by employees. | Applies to modules used by customers in the booking process. |
Permissions | Employees must have specific permissions to access an app. | Defines which booking options are available to customers. |
Inheritance | Apps installed in an organization are automatically available in sub-organizations. | Modules must be configured individually per organization. |
Conclusion
Both appConfig and moduleConfig play a role in managing applications and modules within the bookingtime system. While appConfig ensures internal applications function correctly with proper permissions and inheritance, moduleConfig controls the availability and behavior of customer-facing modules.
Comments
0 comments
Please sign in to leave a comment.