The Extensions Management functionality allows you to execute customized actions and processes in the Extensions Management view in your Order Management System (OMS). Configure it in your System Integrator (SI) Portal to see the functionality in your OMS Admin.
System > Extensions Management in the OMS Admin
Find the Available Extensions and Execution Log views in this view.
Extensions Management view in the OMS Admin
Enable Extensions Management
You can find the Extensions Management Definition your SI Portal.
Extensions Management Definition setting in SI Portal
There are two available configuration options:
|Enabled||Enables the functionality in your OMS Admin.|
|List of Extensions||Shows the list of the available extensions.|
To enable this functionality to appear in your OMS Admin:
Ensure you are assigned the correct permissions to access this configuration and functionality. In your OMS Admin navigate to System > Roles.
- Click the applicable role.
- Ensure the Extensions option in the Internal Tools section is selected.
- Navigate to Config > Global Settings > Extensions Management Definition in your SI Portal.
Tick the Enabled option to enable this configuration.
Enable the Extensions Management functionality
- Click Save Rule. A confirmation message appears.
In this configuration rule you can configure two other values as well:
|View History||Show the change history of this configuration rule over time.|
|Unset||Reset the configuration rule to the default value.|
This configuration is available through the System Integrator (SI) Portal, which is not accessible externally yet. Please contact Magento Support or your Technical Account Manager to change this configuration.
Configure available extensions
In the SI Portal, can also see a list of the available extensions that your SI can create for this functionality.
If you want to add other extensions values:
- Deselect the default checkbox for a value.
- Click Add a new value.
- To remove a value, click Trash .
Each item (or extension definition) has several mandatory values to configure:
|Name||Name of the extension Definition|
|Title||Title of the extension definition|
|Integration Name||Name of the integration to be registered in the system|
|Description||Description of the extension definition|
|Instructions||Instructions for the extension|
|List of Parameters||Unlimited number of required inputs|
The fields for these values should be strings, and have a character limitation for their descriptions. For example, the Description value has a limitation of 350 characters.
To use the List of Parameters value, you must configure required fields (such as the key name of the parameter or the type of input):
These values have the same characteristics as the root extensions management definition, for which you can add more items or remove items if necessary. You can enable or disable them for required parameters.
Click Save rule to implement any changes you made to the extensions management definitions.
In the Available Extensions tab view you can see a list of all available extensions for your OMS.
Available Extensions view
To view or modify an extension:
- Click View more to access the details of the extension, see instructions for running the extension, and if applicable, the list of parameters you must add to identify and execute the extension.
- Modify the fields as applicable. Fields annotated with a red asterisk are mandatory.
- Click Execute Extension to save and launch the extension.
In the Execution Log tab view you can find the history and details of every extension definition that you launched.
Execution Log view
In this view you can find several values:
|Extension Name||Name of the extension definition|
|Executed by||User who launched the extension|
|Execution ID||Unique ID for that execution|
|Execution Start Date||Date when the execution was launched|
|Elapsed Time||Time elapsed since the execution started|
|Status||Status in which you can find each extension launched|
|Execution Log||History of that execution. Click View Details to see a detailed log of that execution.|
Click Show filters to filter the results of the view.