Install a package

As a Maxedy partner you can install packages in other environments.

Please take the following steps to install/update a package:

  1. Go to Settings.
  2. Go to Marketplace.
  3. Click on the package you want to install.
  4. Click Install or Update. The package will be installed/updated in the environment.


The install button when it's possible to install a package


The update button when it's possible to update a package


The install button when a package cannot be installed. Either the package source environment is the same as the target environment, or a required package needs to be installed first.

Locked entities

In this environment, the entities that are part of a packages are locked. Meaning that you cannot change properties, but you can add certain properties. This way you can safely update packages without breaking processes.


The notification that the entity is part of a package

Document System

When a document system is part of a package new Document Definitions may be created.

Property Locked if part of a package?
Label Yes
Name Yes

Document Definition

When a document definition is part of a package users, permissions and some properties of the workflow can be changed. Since these are company specific properties. In addition you can

Element Property Locked if part of a package?
General All Yes
Fields All Yes, but you can add/edit/remove new fields
Lines All Yes, but you can add/edit/remove new lines
Statuses All Yes, but you can add/edit/remove new statuses
Access Groups Members No, will be merged with access groups of target environment
Permissions No, will be merged with field/line permissions of target environment
Workflows Actions Yes, but you can add/edit/remove new actions
Statuses Yes, but you can add/edit/remove new statuses
Connections No
Set Access Groups No

Workflow actions & rules When a workflow action is part of a package, the rules that are part of the action cannot be deleted and their position in the list cannot be changed. All their properties are locked. The connections between statuses and the Set Access Groups can be changed, since this can be company specific.

Element Property Locked if part of a package?
All Name Yes
Label Yes
Translation key Yes
User action Do not show success message No
Display only if Yes
Scheduled action Active No
Scheduled action Schedule Yes
Scheduled action Filter Yes
Bulk action Groups No
REST action REST Call Yes

Setting

Settings that are part of a packages can not be changed.

Property Locked if part of a package?
Key Yes, but you can add new keys
Value No, this is company specific

Layout

Element Property Locked if part of a package?
All Layouts Name Yes
Label Yes
Edit field, line and line field properties Yes, cannot add new fields to a layout
Position of field, line and line field Yes
Overview Layout Filter Yes, only field position can be changed
Sort Yes

Template

Property Locked if part of a package?
All Yes, you can only use the preview action
Property Locked if part of a package?
Label Yes
Name Yes
Users No, this is company specific
Menu Structure Yes
Menu Properties Yes

Script

Property Locked if part of a package?
All Yes

Translations

Property Locked if part of a package?
All Yes, but new keys can be created