Share a Dock Area Profile with Other Accounts¶
Goal
Find the .ini file for a locally saved Dock Area profile so you can share it with another e-account or add it to
the beamline plugin repository.
Prerequisites¶
- You have saved and tested the profile locally.
- You can access the e-account or beamline plugin repository where the profile should be copied.
- You can open a Gitea pull request if the profile should become part of the plugin repository.
An e-account is the experiment account assigned to an experiment. It has limited storage access and owns the writable Dock Area profile settings for that experiment.
1. Find the saved profile¶
Open the profile manager from the Dock Area toolbar and select the profile.
Read the Runtime path field in the metadata panel. This is the editable .ini file for the saved profile.
Use this path as the source file when you copy the profile to another e-account or add the profile to the plugin repository.
2. Choose where to share the profile¶
Use this option for durable beamline reuse. The profile becomes available to every e-account that uses the deployed plugin revision.
Copy the profile into the plugin repository¶
Copy the profile INI file into the preferred plugin repository profile directory:
/sls/<xname>/config/bec/<deployment_name>/<beamline_repo>/<beamline_package>/bec_widgets/profiles/
/sls/x01da/config/bec/production/debye_bec/debye_bec/bec_widgets/profiles/
Here, <beamline_repo> is the Git repository directory and <beamline_package> is the Python package directory inside
that repository. In many beamline plugins they have the same name, for example debye_bec/debye_bec.
Note
If the bec_widgets/profiles/ directory does not exist yet, create it before
copying the profile file.
Keep the file name readable and specific. For example:
alignment_scan.ini
The plugin repository path follows the same beamline repository layout described in Add Changes to Your Plugin Repository.
Add the file to the plugin repository¶
Continue with Add Changes to Your Plugin Repository to stage, commit, and push the profile file.
Open a Gitea pull request¶
Open a pull request against the plugin repository's main branch.
After the pull request is approved and merged, the profile is available as a bundled profile when the next deployment uses that commit.
Use this option for ad hoc sharing between two e-accounts. Copy the profile directly only when the profile does not need to be reviewed, versioned, or distributed through the plugin repository.
Copy the profile to another e-account¶
Copy the profile INI file into the target e-account's writable profile directory:
/sls/<xname>/data/<target_e-account>/raw/widget_settings/profiles/runtime/<namespace>/
/sls/x01da/data/e12345/raw/widget_settings/profiles/runtime/bec/
If the profile should also be the restore point in the target e-account, copy it to the matching baseline directory:
/sls/<xname>/data/<target_e-account>/raw/widget_settings/profiles/baseline/<namespace>/
/sls/x01da/data/e12345/raw/widget_settings/profiles/baseline/bec/
Use the same file name in both locations.
3. Check the shared profile¶
After deployment or after copying the profile to another e-account, open BEC with a Dock Area.
Open the profile manager and verify that the profile is listed. Bundled profiles appear as read-only profiles and cannot be overwritten or deleted from the GUI.