The Studio is a versatile tool used for customizing existing modules, particularly for packages installed from the App Store. Extensions made in the Studio are stored in what are known as Custom Tables. Therefore, only fields created in the Studio can be deleted through the Studio.
The main functions of the Studio include customizing existing modules. These include:
- Creating additional fields
- Adjusting field labels
- Establishing relationships
- Modifying individual layouts (views)
- Personalizing subpanels
This way, the corresponding modules can be tailored to the specific requirements of your company.
To access the Studio, navigate via the top navigation to the Admin area and select Studio under Developer Tools.
Creating additional fields
In this step-by-step guide, you will learn how to create new fields in a module using the Studio. Just follow these steps:
Step 1: Select Module
- Go to the module list in the left sidebar of the Studio.
- Select the appropriate module where you want to add a new field. You can do this by clicking either on the folder itself or on the plus sign.
Step 2: Add Field
- After selecting the module, click on “Fields.”
- Choose the option “Add Field.” This will open a menu for field configuration.
Step 3: Field Configuration
- In the subsequent menu, you need to choose the configuration for the new field.
- You can find some tips for field configuration and useful information in the help bar on the right.
- Check the definition of data types here to make the best choice for your application.
Step 4: Save
- Click “Save” to create the new field.
Note: The fields created in the Studio are immediately available in the system after saving.
Adjusting field labels
Step 1: Select Module
- Go to the module list in the left sidebar of the Studio.
- Select the module whose field labels you want to customize. Click either on the folder itself or on the plus sign.
Step 2: Access Labels
- Click on “Labels” to access the overview of field labels.
- Ensure that the option “All Labels” is selected in the dropdown menu at the top right. Only then will all the module’s fields be displayed to you.
Step 3: Choose Language Version and Adjust Labels
- Choose the desired language from the language versions stored in the system.
- Click on the respective fields and enter the desired new labels.
Step 4: Save and Deploy
- Click on “Save & Deploy” to apply your customizations.
Note: You can also assign field labels directly when creating new fields. The menu here in the Studio is intended for easily editing multiple field labels simultaneously.
Establishing relationships
Step 1: Select Module
- Go to the module list in the left sidebar of the Studio.
- Select the module for which you want to establish a relationship. Click either on the folder itself or on the plus sign.
Step 2: Access Relationships
- Click on “Relationships” to access the overview of existing relationships.
- Click on “Add Relationship” to create a new relationship with another module.
Step 3: Choose Relationship Type
Consider which type of relationship you want to create. In principle, there are three types:
- One-to-One: One record can be linked to exactly one other record.
- One-to-Many: One record can be linked to multiple records, which are, however, only connected to this one record.
- Many-to-Many: Records can be linked to multiple records in both directions.
Step 4: Link Modules
- Select the appropriate module that should be linked to the selected module.
- Assign a suitable label for this relationship.
Step 5: Configure Relationships
- Carefully consider from which module you want to establish a relationship.
- In a One-to-Many relationship, the module under which you want to have a subpanel must be the main module of the relationship.
- For One-to-One relationships, you can drag a new field into the views via the layouts to make the relationship visible.
- For One-to-Many or Many-to-Many relationships, a subpanel will be created under the main module where you will see the linked entries.
Step 6: Save and Deploy
- Click “Save & Deploy” to apply the changes.
Modifying individual layouts (views)
This guide explains how to configure the layouts of individual modules in the Studio. Follow the steps below to customize the views for your modules:
Step 1: Select Module
- Go to the module list in the left sidebar of the Studio.
- Select the module whose layout you want to configure by clicking either on the folder itself or on the plus sign.
Step 2: Access Layouts
- Click on “Layouts” to see the different layout options for the module.
- Select the layout you want to edit. The available layouts are:
- Edit View: View when editing or creating a record.
- Detail View: View when opening a record.
- List View: Overview of all records in the module.
- Quick Create: View when creating a record in a subpanel.
- DataEngine Dashlet: View when adding a dashlet to a module on the dashboard.
- Popup View: View when linking to another record, including list and search view.
- Filter: Definition of filter options in the list view, including Simple and Advanced Search.
Step 3: Customize Layout
- Move Fields: In all views, you can move fields via drag-and-drop.
- All List and Filter Views: Fields can be made visible or hidden by default. In the normal list view, you can drag additional fields into the “Available” area.
- Edit and Detail View: These are modular. Fields can be grouped into sections and arranged in individual rows. To remove fields, drag them into the red area on the left. Choose between tabs and panels (Sections under a tab).
- Configure Individual Rows: For one field per row, you can decide using the plus sign whether the field should take the full width.
- Synchronization: In the Edit View, you can choose whether to synchronize it with the Detail View. Note that you will no longer be able to edit both views separately.
- Initial Setup: In the Detail View, you can choose to copy the view from the Edit View – this is helpful when setting it up for the first time.
- View History: In all views, you can display the history of changes.
Step 4: Save and Deploy
- Click “Save & Deploy” to apply your customizations.
With these steps, you can customize and effectively manage the layouts of the modules according to your preferences.
Personalizing subpanels
This guide explains how to configure the subpanels of individual modules in the Studio. Follow these steps to customize the subpanel views to meet your needs:
Step 1: Select Module
- Go to the module list in the left sidebar of the Studio.
- Select the module whose subpanels you want to configure by clicking either on the folder itself or on the plus sign.
Step 2: Access Subpanels
- Click on “Subpanels” to display an overview of all subpanels that belong to your chosen module. Here you will see all subpanels in a many-to-one relationship with other modules.
Step 3: Customize Subpanel
- Select one of the available subpanels.
- Drag and drop the desired fields into the default view. These fields will then be displayed in the table of the subpanel when it’s embedded in the main module.
Step 4: Save and Deploy
- Confirm your inputs by clicking “Save & Deploy” to apply the changes.