PfxDeploy Toolbar

PfxDeploy toolbar is used to write/deploy the configuration stored in your local project folders and files to the remote partition. It is commonly used to deploy logics or table fields definitions.

To learn what configurations can be written to a partition, see Supported Object Types.

The structure of the folders and files expected in your project/module is described in Configuration Package.

Available Actions

The list of actions in the order of appearance on the PfxDeploy toolbar screenshot.

Select module – Decides which connection config file (config.json) should be used. Each module/project can have its own connection config file. The toolbar will either use the connection config file found in the selected module, or (if not found) from the project.
Environment – Select an environment from the list defined in the connection config file.
Partition – Selects partitions (from the list of partitions available in the selected environment) to which the tool will write the configuration. This allows you to deploy the same configuration to more partitions at the same time.
Select All Partitions – Selects all partitions in the list of partitions.
Select All Objects – Selects all objects in the list of objects.
Select Objects in the Actual Commit – Selects objects which were committed in the last Git commit.
Select Objects from Selected Commit – Allows you to select objects which have changed between a particular selected commit and the last one.
Select Objects Modified on the Disk – Selects objects which were modified on the local disk since the last Git commit.
Refresh – Reloads the list of objects from your local project.
Show also Inactive and Simulation Only statuses (only for logics and Company Parameters) – By default, only objects with status Active are shown. This button allows you to show also objects with status Inactive or Simulation Only.
List of Object Types
List of Objects
Deploy – Performs the Deploy operation. If there are Groovy code syntax errors detected in the code and the code cannot be compiled, you get a notification popup in Studio and cannot proceed with the deployment. In the error notification you will find a link which navigates you directly to the source code of the incorrect element (potentially to the related line and column).
Syntax Check (only for logics) – When selected, the logic will be executed in syntax check mode on the partition before it is stored. If the execution in syntax check fails, the logic will not be deployed to the partition and the error will be reported in Studio. We recommend to select this checkbox when adding/modifying input fields in the logics to ensure that the logic will be able to generate parameters safely in the real run without a crash. This setting is disabled by default.
Keep user groups (only for logics and some other object types) – When set, the user groups of the logic will NOT be overridden during deploy. This setting is typically used once the customer becomes responsible for the security setup (typically during UAT or GO LIVE).
Intact labels (only for logics) – Deprecated. Determines that the element labels should NOT be overwritten during deploy. You should use label translations instead. This was used to be used for projects where the customer maintained the labels.
With Preferences (only for some object types) – When set, the default associated Preference configuration will also be deployed. It is a shortcut for deploying a Preference which could be also deployed under Preferences.
Include Data (only for Company Parameters and users) – When set, the tool will also deploy the associated data stored in a related CSV file fetched previously. The data cannot be deployed separately without the structure.
Important: This is meant only for small, typically static or initial, control data. It should never be used for ordinary pricing data.