I am trying to find the setup for a preferences entry in the manifest. I notice that the manifest is shown as valid with the “preferences” array of objects. but those objects dont show anywhere by default. I am attempting to make as simple toggle in the securty role to allow for a certain action to be allowed. but without knowing the reference documentation to use for the preferences array of objects. I doubt i’ll be able to lock down the properties. Can we get an update on the properties allowed for hte preferences object in the manifest please?
Hi Hayden,
Short version: based on the current public docs we can cite, manifest preferences aren’t documented as a security-role permission mechanism for add-on actions.
The Add-on SDK docs list the current UI extension points as Job Actions, Client Actions and Menu Items, and the Manifest Reference documents actions, menuItems and webhooks as manifest sections for add-on capabilities.
The Add-on Style guide does say manifest preferences are used to add preferences to the account’s Preferences page, so that’s where they’re intended to surface rather than as a custom menu item.
For security roles, the documented relevant settings are built-in settings such as Show Addons/Integrations, Show Security Roles and Show Preferences, and the Security Roles Reference describes those as showing or hiding those settings areas.
So for now, we wouldn’t rely on manifest preferences for locking down an add-on action by security role.
Email support@servicem8.com with the manifest snippet and the behaviour you’re trying to control, and we’ll get the developer docs team to confirm the supported preferences schema.
Thanks,
Cody
the manifest is very simple
it is currently menu item. which is just fine.
but i cannot find a way to add my addon to the security roles. the idea is tht i would like to have an option in the addons tab of the security roles, to enable or disable my addon for a given role. this would also help by way of hopefully having a setting to dictate admin privileges. my addon has a calendar and simplified setup to update job time and it would be nice to be able to lock down the ability to make those changes for some and allow for others while still allowing both to see the calendar.
if there is a way to add an option to the security roles that i can use in my manifest that would be idea. otherwise i will just have to state in the description that it is meant to be available to anyone with addon privileges and that it is on the user company to manage the access manually instead of with a security role option.
Hi Hayden,
At the moment, it’s not currently possible to add your add-on as its own toggle in Security Roles through the manifest.
That’s good feedback, and it’s well timed as the Add-on SDK is an area we’re looking at improving.
Thanks,
Cody
Awesome! Glad to hear it. I’ve had a readlly nice experience building out my addon and am excited to hear the toolbox will possibly expand in the future.