Description:

The Set Admin Password workflow step belongs to the Tenants category in FlowWright. Its internal name is clssetadminpassword, its label is Sets the admin password for the tenant, and its display name is Set Admin Password. The step uses the FlowWright.Workflow.ClsSetAdminPassword namespace and FlowWright.Workflow.dll. It is defined as a Process step with two input connections and two output connections.

The Set Admin Password step uses a configured Tenant Manager connection, a tenant name or ID, an administrative user, and a new password to set the administrator password for the specified tenant. All four properties are required.

The step supports:

• Selecting a Tenant Manager connection
• Identifying a tenant by name or ID
• Specifying the administrative user
• Providing the new password
• True/False workflow branching 

This step can be used for:

• Tenant administration
• Tenant provisioning workflows
• Administrator account setup
• Tenant onboarding
• Controlled administrator password changes
• Tenant lifecycle management
• Automated tenant configuration

Usage:

The Set Admin Password step is typically placed in workflows where an administrative account must be configured, or its password changed for a particular tenant. The workflow can provide the tenant name or ID, administrative user, and new password as inputs.

The workflow can dynamically supply the tenant and administrative-user information using: 

• Workflow Variables
• Global variables
• Form values
• Previous workflow outputs
• Tenant-management information
• Data retrieved from other systems

Typical Workflow Suggestions:

Set an Administrative Password During Tenant Setup

Use the step as part of a tenant provisioning workflow.

Example:

Create / Prepare Tenant
        ↓
Set Admin Password
        ↓
Initialize Tenant
        ↓
Continue Processing

Reset a Tenant Administrative Password

Use Set Admin Password as part of a controlled password-reset workflow.

Example:

Password Reset Request
          ↓
Validate Request
          ↓
Set Admin Password
       ↙          ↘
     True         False
      ↓              ↓
Confirm Reset    Handle Failure

Set a Password for a Specific Tenant

Use the step when a workflow processes a particular tenant.

Example:

Identify Tenant
      ↓
Set Admin Password
      ↓
Continue Tenant Processing

Tenant name or id:
CustomerTenant01

Administrative user:
admin

Use a Tenant Manager Connection

Select the appropriate Tenant Manager connection before performing the password operation.

Example:

Determine Environment
        ↓
Select Tenant Manager Connection
        ↓
Set Admin Password

This can be useful when workflows are deployed across environments with different Tenant Manager configurations.

Set an Administrative Password After Tenant Creation

Use the step after a tenant has been created or initialized.

Example:

Create Tenant
     ↓
Set Admin Password
     ↓
Configure Tenant
     ↓
Complete Provisioning

Set an Administrative Password After Validation

Use a validation step before changing the password.

Example:

Validate Request
      ↓
Validate Tenant
      ↓
Set Admin Password
      ↓
Continue

Example:

Let’s build and execute the “clsSetAdminPasswordDef” example.  

• Create a new definition named “clsSetAdminPasswordDef” and open it in designer mode. 
• Drag a "clsSetAdminPassword" step to the canvas.
• Connect the dots between the “Start” step and the "clsSetAdminPassword" steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Click the "clsSetAdminPassword" step to configure its “Required” properties. Provide a name for the step. Select the connection string. Enter the Tenant Name or GUID. Enter the admin username. Enter the new password, which is encrypted and stored in the database after execution. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance and click the process step to inspect its properties and execution result. When the workflow reaches the Set Admin Password step, verify that:
  • The correct Tenant Manager connection is selected.
  • The intended tenant name or ID is supplied.
  • The correct administrative user is supplied.
  • The new password is supplied through the intended configuration mechanism.
  • The operation follows the expected True or False path.
  • Subsequent workflow processing executes as expected.
  • The password itself is not exposed through workflow logging or other diagnostic output.

Tips:

• Select the correct Tenant Manager connection.
• Provide the intended Tenant name or ID.
• Provide the correct Administrative user.
• Provide the required New password to set.
• Verify that the selected Tenant Manager connection corresponds to the intended environment.
• Test the step with a controlled test tenant before using it in production.
• Test both the True and False workflow paths.
• Verify the administrative account after a controlled test execution.
• Never expose the actual password in workflow logs, notifications, error messages, screenshots, or documentation examples.
• Avoid hard-coding passwords directly into process definitions.
• Use an appropriate secure mechanism for supplying credentials when the FlowWright environment provides one.
• Avoid passing passwords through unnecessary workflow Variables or Globals.
• Limit access to workflow definitions containing password-related configuration.
• Use appropriate administrative authorization before allowing a workflow to execute this step.
• Test the workflow after changing the Tenant Manager connection.
• Test the workflow after changing the tenant name or ID.
• Test the workflow with an invalid tenant identifier.
• Test the workflow with an invalid administrative user.
• Test the workflow's False path and associated error handling.
• Verify that downstream notifications do not inadvertently include the password.
• Ensure diagnostic logging does not record the password.
• Consider separating password-reset authorization from password-setting execution.
• Document the operational purpose of workflows that can change tenant administrative passwords.
• Do not assume the password is masked in the FlowWright designer; the XML defines the field only as a string property.
• Do not assume specific password complexity rules from the XML.
• Do not assume password expiration, history, reuse, or lockout behavior from the XML.
• Do not assume how an invalid tenant, invalid user, or failed password operation is represented beyond the defined True/False result.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into the FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

• Tenant Manager connection
• Tenant name or ID
• Administrative user
• New password
• Variable mappings, if applicable
• Environment-specific settings
• Workflow connections

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.