Skip to content
Other versions

Loading…

Custom actions

The Custom actions feature helps add custom action options in the KCenter user interface.

Users are shown in a table structure.

Filtering options Id Name Label Icon Description Document Folder Record Mail URL View Width Height Show close

User parameters:

Field Description Required
Id The internal Id of the custom action. Set by the application.
Name The name of the custom action. true
Label The label of the custom action.
When you wish to internationalize the label, you can use a language key value.		 true
Icon The MDI icon value. true
URL URL to be requested by the custom action. ***
Description Description of the custom action. false
View Allowed options:
- Popup-wizard (the custom action is shown in a popup)
- Full-screen (the custom action is shown in the whole user interface screen)
- Run-javascript (the script will be executed in the UI without showing any kind of panel)		 true
Width A number or % is allowed.
Samples:
- 300
- 80%		 *
Height A number or % is allowed.
Samples:
- 300
- 80%		 *
Apply to document When enabled, the custom action will be available for documents. true
Apply to folder When enabled, the custom action will be available for documents. true
Apply to record When enabled, the custom action will be available for records. true
Apply to mail When enabled, the custom action will be available for mail. true
Show close button When enabled, a close button is shown. **
Script The JavaScript code that will be executed by the UI.
// Jump to folder with uuid
const uuid = ‘748923a3-f130-48d1-b09e-88b6af8c44cd’;
const kcenterApp = window.kcenterApp; // access to the main kcenter object
kcenterApp.$store.dispatch(‘browser/refreshByUuid’, uuid, { root: true });		 ****
Action Available actions:
-  Edit a custom action.
-  Delete a custom action.
  • * Mandatory when Popup-wizard is selected.
  • ** Option is shown when Popup-wizard is selected.
  • *** Mandatory when Popup-wizard or Full-screen are selected.
  • **** Mandatory when Run-javascript is selected.