Creatio IDE

PDF

Easy

The Creatio platform includes an integrated development environment (Creatio IDE). Creatio IDE is located in the Configuration section. The purpose of the Configuration section is to execute operations with structural items that enable functionality development.

Creatio IDE lets you execute operations with the following structural items:

File system.
Packages.
SVN repositories.
Configuration elements.
Source code.
Configuration.

Learn more in a separate article: Operations in Creatio IDE.

Set up permissions to the Configuration section

You can set up permissions to the Configuration section on the system operation level. If a user lacks the permission to access the Configuration section, they receive a standard notification about the lack of permissions to perform an operation when trying to load the section. By default, only Creatio administrators have access to key system operations. Creatio lets you configure access permissions to system operations for users or user groups. Learn more in the user documentation: System operation permissions.

To set up permissions to the Configuration section:

Click to open the System Designer. Go to the Users and administration block → Operation permissions.
Select the Can manage configuration elements (CanManageSolution code) system operation.
Click and specify the user/role in the Operation permission detail.

As a result, the record will appear on the Operation permission detail and have the Access level column set to Yes. Users that have the specified role will receive permission to the Can manage configuration elements (CanManageSolution code) system operation.

Open the Configuration section

You can open the Configuration section in Creatio .NET Framework in the following ways:

Click to open the System Designer. Click Advanced settings in the Admin area block.
Open the [Creatio application URL]/0/ClientApp/#/WorkspaceExplorer URL. For example, http://my.creatio.com/0/ClientApp/#/WorkspaceExplorer.
Use the /we alias. For example, http://my.creatio.com/0/we.
Use the /conf alias. For example, http://my.creatio.com/0/conf.
Use the /dev alias. For example, http://my.creatio.com/0/dev.

You can open the section in Creatio .NET Core or .NET 6 similarly, but without the /0 prefix.

As a result, the Configuration section will open in a new tab.

Configuration section UI

The Configuration section UI includes the following functional areas:

Toolbar (1).
Package workspace (2).
Main workspace (3).

View the Configuration section UI in the figure below.

Toolbar (1)

The toolbar (1) lets you:

Close the Configuration section (Close button).
Compile the entire configuration (Compile button and Compile all item of the Compile button's dropdown list).
Manage the development environment (Actions dropdown list).

The group items of the Actions dropdown list on the toolbar (1) let you manage the development environment.

View the action groups of the Actions dropdown list on the toolbar (1) in the figure below.

The following action groups let you manage the development environment:

File system development mode (4).
Packages (5).
SVN repositories (6).
Configuration (7).
Actualize items (8).
Source code (9).

Package workspace (2)

The package workspace (2) lets you:

Search for a package by its name (Search by package search bar).
Create a package ( button). The button opens the package creation box that lets you specify the package name and description, set up the compilation of the package to an assembly package, add dependencies, as well as specify the SVN repository. To create a package, follow the guide in a separate article: Create a custom package.
View the list of Creatio packages (All packages folder). The packages are displayed in alphabetical order. The modified packages and modifiable packages are displayed at the top. If you select the All packages folder, Creatio displays the configuration elements of all packages in the Configuration section list alphabetically. If you select a different package folder, Creatio displays the configuration elements of that package alphabetically. Creatio displays the modified packages at the top of the All packages folder index and marks them with .

The package menu of the package workspace (2) lets you execute actions with the current package. To open the package menu, click in the package row.

View the package menu in the figure below.

The package menu lets you:

Compile the package to an assembly package (Compile item). The item is inactive for packages that have the Compile into a separate assembly checkbox cleared in the package properties. The checkbox specifies that the package is an assembly package. Learn more about assembly packages in a separate article: Assembly package.
Export a package as a *.zip archive (Export item). You can install an exported package into a different environment. Learn more about exporting packages in a separate article: Transfer packages.
Move the package configuration elements to a different package (Move all elements item). The item opens a box that lets you select the destination package. When you move the configuration elements, Creatio IDE can set dependencies automatically.
Delete a package (Delete item). Not available for pre-installed packages. Creatio IDE lets you delete empty packages and packages that contain non-parent configuration elements. Attempting to delete a package with parent configuration elements will result in Creatio displaying a list of dependent packages and dependent elements that block deletion.
Lock the package from changes in the connected SVN repository (Lock package in SVN item). The item is available only for packages installed from the SVN repository.
Unlock the package for changes in the connected SVN repository (Unlock package in SVN item). The item is active only for locked packages installed from the SVN repository.
Update the package from the repository (Update from repository item). Learn more about updating packages in a separate article: Version control in Creatio IDE.
Commit a package to the repository (Commit to repository option). Learn more about committing packages to the version control system in a separate article: Version control in Creatio IDE.
Review the package properties (Properties option). Set up the package dependencies for modifiable packages in the Properties tab. The tab also contains system information: the package author and editor, the creation and modification dates, the unique ID, and the primary package key in the database table. To open the package properties, double-click the package name.

Main workspace (3)

The main workspace (3) contains the following tools:

Toolbar.
Configuration section list.
Configuration element menu.

View the toolbar of the Configuration section workspace (3) in the figure below.

The workspace (3) toolbar lets you:

Add a configuration element by type (Add dropdown list).
Import a schema (*.md) or a reference assembly (*.dll) into the custom package (Import item of the Add dropdown list).
Execute configuration element actions in bulk (Multi actions dropdown list).
Select the type of configuration elements to display (Type dropdown list).
Select the status of configuration elements to display (Filters dropdown list).
Search for a configuration element by its name (Search search bar).

The Configuration section list of the main workspace (3) contains the index of configuration elements.

The section list includes the following columns:

Name. The name of the configuration element set at its creation.

Custom element name starts with the prefix specified in the Prefix for object name (SchemaNamePrefix code) system setting, Usr by default. When a configuration element schema is created, the prefix specified in the Prefix for object name (SchemaNamePrefix code) system setting is added to the current field automatically. Creatio checks for the prefix and whether it matches the system setting value when saving the schema properties. If the prefix is missing or does not match, the user receives a corresponding notification.

The configuration elements are sorted in alphabetical order. The column lets you view a list of modified configuration elements (marked with next to the name). Creatio places the modified elements at the top of the record list. Learn more: Add a configuration element.
Title. The title of the configuration element.
Status. The status of the configuration element. Use the Filters drop-down list of the section workspace (3) toolbar to filter the configuration elements to display by the current column value. Learn more: Select the status of configuration elements to display.

The Status column can have the following values:
- — the configuration element must be updated.
- — the configuration element contains an error.
- — the configuration element must be updated and contains an error.
Hover over the Status column value to view the following tooltips:
- Needs to be installed in database for the SQL script and Data configuration elements.
- Needs to be updated in database for the Object configuration element.
- Needs generate source code for the Client module, Source code, Case, Marketing campaign, Business-process, User task configuration elements.
Type. The configuration element type. Use the Type dropdown list of the section workspace (3) toolbar to filter the configuration elements to display by the current column value. Learn more: Select the type of configuration elements to display.
Object. The object to which the bound package data is connected. The column value is available only for the configuration element of the Data type.
Modified on. The modification date of the configuration element.
Package. The name of the package that contains the configuration element.

Creatio IDE lets you sort the list column data in ascending or descending order. To sort the data, click the column name.

You can sort the list column data in the following ways:

Sort the data in the current package. Select a package in the package workspace (2) to enable data sorting in the current package.
Sort the data in all packages. Select the All packages folder in the package workspace (2) to enable data sorting in every package.

The configuration element menu of the main workspace (3) lets you execute a single action with a configuration element. To open the configuration element menu, click in the configuration element row of the section list. The item index of the configuration element menu depends on the configuration element type.