Ready-Made Solution Setup Steps

Ready-made solution setup steps

On the setup step page, the ready-made solution author defines an action that the user sees during installation. Give the step a clear title and description so the user understands what will happen after confirmation.

Before you start

steps are available for a Ready-Made Solution app with a source project;
steps can be created, changed, and deleted only in a version draft;
a new draft already contains the latest published version's steps;
you need permission to manage app versions;
for an agent step, first choose Agent in the resource type field, open the resource selector, use search when needed, choose the required agent, and click Add Resource;
removing an agent from version resources makes it unavailable for new steps. If a step already uses the agent, change or delete that step first.

If the version has already been published, create a new draft and make the changes there. An automatic update must keep the complete setup step set identical to the previous published version: steps cannot be added, changed, reordered, or removed. Use After Confirmation when setup steps need to change.

What the user sees during installation

steps follow the Order field, with lower numbers first;
the user sees the title and description in the selected language;
a required step cannot be skipped, and solution setup cannot finish without it;
an optional step can be completed or skipped;
Custom Instruction is always optional.

Step types

Fill Variables. Asks the user for project or lead variable values required by the solution.
Set Default Agent. Creates or replaces an automatic assignment rule for the selected agent slot and dialog scope. Separate channel rules can be specified during setup.
Assign Agent in Dialogs. Asks the user to select a dialog and assigns the specified agent to it as primary or background. If that slot is already occupied, its previous assignment is replaced.
Generate Subscription. Adds a stage for obtaining subscription links to the setup flow and saves the resulting links. This type has no additional author fields.
Custom Instruction. Shows text that the user reads and acknowledges. This step can be skipped, so its Required Step switch is not shown.

Choose an option in the Step Type field.

General step fields

In Order, specify the step's position in the sequence.
Fill in the Russian title and English title.
Add the Russian description and English description. Describe the action's outcome, not the solution's internal implementation.
For every type except Custom Instruction, enable Required Step when the solution cannot work correctly without the action.

Agent steps

For Set Default Agent and Assign Agent in Dialogs, you must specify:

the agent slot: the primary agent answers the user, while the background agent performs supporting work;
an agent from the current version; use search and choose it from the result list.

These steps have no No Agent option. If the list is empty, return to the version and add a source-project agent to this version's resources. Publish a changed agent draft before publishing the solution version.

For Set Default Agent, also choose a dialog scope: all, private, or group dialogs. The scope determines where the automatic assignment rule applies.

Fill Variables step

Click Add Variable. The step must contain at least one variable.

Configure each variable:

Variable Target: Project for one shared value or Lead for a value associated with a lead;
Variable Name: a variable with this name must already exist in this app's source project;
a Russian label and English label shown to the user;
a Russian hint and English hint;
an example value that matches the variable's type and restrictions;
whether the field is required during installation.

The same Variable Target + Variable Name pair cannot be added twice. Remove an unnecessary field with the remove variable button.

Saving and deleting

After configuration, click Save Step. An existing draft step also has a delete step button.

If the step cannot be saved

make sure you are editing a version draft;
if automatic mode is selected, restore the previous published version's steps or switch the version to After Confirmation;
if a source project is required, create it in the ready-made solution settings;
for an agent step, check that the agent is included as a resource in the current version;
for Fill Variables, add at least one field, remove duplicates, and verify the source-project variable names;
if an example value is rejected, enter a value with the selected variable's type and format;
if save actions are missing or fields are unavailable, check your permission to manage app versions.

Dialog access during installation

For a ready-made solution, the developer access switch for related dialogs appears automatically and is enabled by default during installation. The owner of the installing project can turn it off before installation or later on the installed app page; the solution author does not control this choice. This is not full project access: the developer sees only dialogs in which this solution's agents participated.