You can begin building your onboarding workflow after creating it. Refer to Adding an Onboarding Workflow. Alternatively, open the workflow from the Onboarding Workflows page to access the configuration page. On the Workflow Designer page, you can configure workflow actions, customize the onboarding portal, and publish the workflow to complete the setup.

1. From the navigation bar, select Network Control > My Services.
   The My Services page is displayed.
2. Click Workflow.
3. Click the name of the workflow.
   The Active Workflow Design page is displayed with the message “Onboarding Workflow not configured.”

   

4. Click one of the Configure buttons.
   The Workflow Designer page is displayed.
   On this page, you can build the client onboarding workflow, customize the client portal design, and preview the configured portal content. The workflow is automatically validated to ensure that each step meets predefined criteria before publishing. This validation helps prevent errors and maintain consistency. Refer to Workflow Validation for more details.
5. Click Start building your Onboarding Workflow.
   A sidebar is displayed, organized into Actions Library and Workflows Library tabs.

   • Actions Library: Displays workflow action tiles (widgets) organized by the following types: User Interaction, Device Onboarding, Authentication, Operational, and Splits.
   • Workflows Library: Displays a list of existing workflows that you can reuse in your onboarding workflow. Refer to Adding an Existing Workflow to a New Workflow for more details.
   The following information applies to multiple steps in the workflow design process.

   Note: When designing a workflow, you can use the following common actions and options across multiple steps:

   • Select a process flow tile on the Workflow Designer page. The icon is displayed. Click the icon to open the Actions Library sidebar.
   • Use the Preview option, which is available in multiple steps, to view how the configured portal design appears on a PC, tablet, or mobile device.
   • Select an added action tile on the Workflow Designer page. An icon appears in the upper-right corner. Hover your cursor over the icon to access the (edit), (preview), and (delete) icons. To delete the step, click Delete Step Only or Delete Step and Children.
6. (Optional) Configure one or both of the following User Interaction actions in the Actions Library tab, as required:
   • Acceptable Use Policy (AUP): Displays the network usage terms and requires users to accept the policy before continuing.
   • Custom Message: Presents a custom title and message to users during onboarding.
   Do one or both of the following:

   • Acceptable Use Policy (AUP): Hover your cursor over Acceptable Use Policy (AUP) and click Add.
     The Acceptable Use Policy (AUP) sidebar is displayed.

     

     In the Acceptable Use Policy (AUP) sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Title: Displays the default text Welcome to the ACCOUNT_NAME Network for the portal welcome statement. Replace ACCOUNT_NAME with your network name. You can modify the text if required.
     • Message: Displays the default text. Replace ACCOUNT_NAME with the name of your network. You can modify the text if required.
     • Policy Content: Enter the terms and conditions that the user must agree to before accessing the network.

       Alternatively, click Upload file instead to select and upload a local file containing policy wording that you have already written. Supported file formats are .pdf, .docx, .dot, and .doc.

     After clicking Add Step, the process tile is added to the Workflow Designer.
   • Custom Message: Hover your cursor over Custom Message and click Add.
     The Custom Message sidebar is displayed.

     

     In the Custom Message sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Page Title: Enter the page title.
     • Page Body Text: Enter the text to display on the onboarding page.
   After clicking Add Step, the process tile is added to the Workflow Designer.
7. (Optional) Configure one of the following Device Onboarding actions in the Actions Library tab:
   • Provide DPSK: Generates a DPSK and an identity for the selected identity group.
   • MAC Address Registration: Registers the client device MAC address with RADIUS and associates it with the selected identity group.
   • Install a certificate: Issues a device certificate based on the selected template and maps it to the identity group and linked networks.
   • Stay on Captive Network: Keeps devices on the initial Wi‑Fi network while they complete a simple click‑through onboarding workflow before receiving internet access. After joining the Wi-Fi network, the device is redirected to an onboarding page to complete a short workflow. Once the workflow completes, internet access is granted.
   • Provide Passphrase: Configures and delivers a Wi-Fi network pre-shared key to users during onboarding. Depending on the selected communication template, the email notification can include a QR code.
   Note: Configure an identity group before adding a Device Onboarding action. Refer to Adding an Identity Group for more details.

   Do one of the following:

   • Provide DPSK: Hover your cursor over Provide DPSK and click Add.
     The Provide DPSK sidebar is displayed.

     

     In the Provide DPSK sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose DPSK Service: Select a DPSK service from the drop-down list.

       If a DPSK service with the required configuration is not available, click Add Service to create a new DPSK service. The Add DPSK Service dialog box is displayed. Refer to Adding a DPSK Service for more details.

       When you select a DPSK service, the following details appear:

       • The identity group associated with the service is automatically populated in the Identity Group field.
       • The Wi‑Fi networks linked to the DPSK service are listed in the Wi-Fi Networks field. If no networks are linked, a message indicating that no networks are linked to this DPSK service is displayed.
     • Assign to Identity: Select an identity from the drop‑down list that you want to associate with the DPSK service.
     • Wi-Fi Networks: Click Add Network to add a network. The Add DPSK Network dialog box is displayed. Enter the required network configuration details. Refer to GUID-3B1452E6-A847-41D0-B0B2-E26A0289E1FB.html for more details.

     After clicking Add Step, the process tile is added to the Workflow Designer.

   • MAC Address Registration: Hover your cursor over MAC Address Registration and click Add.
     The MAC Address Registration sidebar is displayed.

     

     In the MAC Address Registration sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose MAC Registration List: Select a MAC registration list from the drop‑down list.

       If a MAC registration list with the required configuration is not available, click Add List to create a new one. The Add MAC Registration List dialog box is displayed. Refer to Adding MAC Registration Lists for more details.

       When you select a MAC registration list, the following details appear:

       • The identity group associated with the selected list is automatically populated in the Identity Group field.
       • The networks linked to the selected MAC registration list are displayed in the Linked Networks field. If no networks are linked, a message indicating that no networks are linked to this MAC registration list is displayed.
     • Assign to Identity: Select the identity you want to associate with the MAC address registration.
     • Linked Networks: Click Add a network to add a network. The Add MAC Registration Network dialog box is displayed. Enter the required network configuration details.
     • (Optional) Ask client to manually enter MAC Address: Select this checkbox if you want the client to manually enter the MAC address.

     After clicking Add Step, the process tile is added to the Workflow Designer.

   • Install a certificate: Hover your cursor over Install a certificate and click Add.
     The Install a certificate sidebar is displayed.

     

     In the Install a certificate sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose Certificate Template: Select the required certificate template from the drop‑down list.
       When you select a certificate template:

       • The Identity Group field displays the target identity group.
       • The Linked Networks field displays the Wi‑Fi networks associated with the template. The total number of networks appears in parentheses. If no networks are linked, a message indicating that no networks are linked is displayed.
     • Assign to Identity: Select the identity to which the certificate must be assigned.

     After clicking Add Step, the process tile is added to the Workflow Designer.

   • Stay on Captive Network: Hover your cursor over Stay on Captive Network and click Add.
     The Stay on Captive Network sidebar is displayed.

     

     In the Stay on Captive Network sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Add Wi‑Fi Network: Click Add Wi‑Fi Network to create a new captive portal network that uses a workflow portal.

       The Add Wi‑Fi Network dialog box is displayed. Refer to Creating a Captive Portal Network That Uses a Workflow Portal for more information.

       The newly created captive portal network appears under Associated Networks, showing the number of associated networks in parentheses, associated clients, and venues.

       You can create multiple captive portal networks that use a workflow portal.

       Note: The access point (AP) uses this captive portal network to redirect users to the onboarding workflow.
     • (Optional) Redirect users to: Select the Redirect users to checkbox to enable URL redirection. When enabled, enter the URL where end users should be redirected after completing the workflow. If the checkbox is not selected or no URL is configured, users remain on either the page they originally requested or the network’s default landing page.

     After clicking Add Step, the process tile is added to the Workflow Designer.

     Note:

     • If the onboarding URL is opened directly instead of through the Wi‑Fi redirect, the process cannot complete because required device information is not received.
     • If the device identity changes each time it connects, the onboarding page may reappear or the connection experience may become inconsistent.
   • Provide Passphrase: Hover your cursor over Provide Passphrase and click Add.
     The Provide Passphrase sidebar is displayed.

     

     In the Provide Passphrase sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose Passphrase (PSK/SAE) Network: Select the passphrase network from the drop‑down list.

       If the required network does not exist, click Add Network to create a new Passphrase (PSK/SAE) network. Refer to Creating a Network That Uses a Passphrase (PSK/SAE).

       When you select a passphrase network:

       • The Identity Group field displays the target identity group.
       • The Assign to Identity field displays the mapped identity for that network.
     • Passphrase Delivery: Toggle the switch on to enable passphrase delivery to the end user. When enabled, the following fields are displayed:
       • Communication Template: Select the communication template used for passphrase delivery from the drop-down list. The following options are available: Default Template, Default Template (Mixed Mode), Default Template (QR Code), and Default Template (Mixed Mode, QR Code).
         Note: QR-code-enabled templates include a QR code in the email notification. QR codes are not supported in SMS notifications.
         Note: QR code onboarding is subject to certain operating-system limitations. Apple iOS does not support Wi‑Fi passphrases longer than 63 characters when they are entered manually or through a QR code. Microsoft Windows does not correctly process QR codes that contain passphrases with the # or ? characters and stops reading the passphrase at those characters, even when they are escaped. These limitations are imposed by the client operating system and are not controlled by RUCKUS One.
       • Delivery Control: Select Send automatically to send the email or SMS when the workflow completes, or select User Controls Delivery to display Email and SMS buttons in the enrollment portal so the user can send the passphrase.
         Note: The enrollment portal displays Email and SMS buttons only for delivery methods enabled in Delivery Medium and only when the workflow has collected the user’s email address or phone number.
       • Delivery Medium: Enable Email or SMS, depending on your workflow design.
         Note: An Authentication or Display a Form step earlier in the workflow must collect the user’s email address and/or phone number. If no prior step collects the email address or phone number, an error message is displayed.
         Note: If no SMS provider is configured in Administration > Settings, the SMS option is disabled, and users do not see SMS delivery options in the enrollment portal.
         Note: If the SMS provider is removed after configuration, SMS delivery becomes unavailable.
       • Preview Passphrase Delivery: Click Preview Passphrase Delivery to open the preview window and verify the content generated by the selected communication template.

         The Email tab displays the Wi‑Fi Network Name, Personal Password (passphrase), and the message body used for email delivery. The SMS tab displays the SSID and passphrase in a text message.

   After clicking Add Step, the process tile is added to the Workflow Designer.

   Note: The Workflow Designer does not enforce that a prior step collects email or phone information, so ensure that your workflow includes a step to gather these values.
8. (Optional) Configure one of the following Authentication actions in the Actions Library tab:
   • SAML Authentication: Authenticates users through a configured SAML Identity Provider profile.
   • Directory Server Auth: Authenticates users against a configured directory server profile such as AD or LDAP.

   Do one of the following:

   • SAML Authentication: Hover your cursor over SAML Authentication and click Add.
     The SAML Authentication sidebar is displayed.

     

     In the SAML Authentication sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose SAML IdP Profile: Select a SAML IdP profile from the drop-down list or click Add Profile to create a new SAML IdP profile. Refer to Adding and Managing a SAML Identity Profile for more details.

       When you select an existing profile, the following details are displayed:

       • Require SAML requests to be signed: Displays Yes if request signing is enabled, and No if it is disabled.
       • SAML response encryption: Displays Yes if response encryption is enabled, and No if it is disabled.
       • Server Certificate: Displays the name of the server certificate.

     After clicking Add Step, the process tile is added to the Workflow Designer.
   • Directory Server Auth: Hover your cursor over Directory Server Auth and click Add.
     The Directory Server Auth sidebar is displayed.

     

     In the Directory Server Auth sidebar, complete the following fields and then click Add Step:

     • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
     • Choose Directory Server Profile: Select a Directory Server profile from the drop‑down list, or select Add Profile to create a new Directory Server profile. Refer to Adding and Managing a Directory Server Profile for more details.

       When you select an existing profile, the following details are displayed:

       • Server Type: Displays the server type (AD or LDAP).
       • Enables TLS encryption: Displays Yes if TLS encryption is enabled and No if it is disabled.
       • FQDN or IP Address: Displays the domain name or IPv4 address and port number.
       • Windows Domain Name: Displays the Windows domain name in comma-separated format, such as dc=domain, dc=ruckuswireless, dc=com. This field is displayed only when the selected server profile is for an Active Directory Server.
       • Base Domain Name: Displays the LDAP base domain name in comma-separated format, such as dc=ldap, dc=com. This field is displayed only when the selected server profile is for an LDAP Server.
       • Admin Domain Name: Displays the administrator domain name in a format such as admin@domain.ruckuswireless.com.
       • Admin Password: Displays the password in dotted format with an icon to reveal it.

     After clicking Add Step, the process tile is added to the Workflow Designer.
9. (Optional) In the Actions Library tab, hover your cursor over Display a Form from the Operational section and click Add.
   The Display a Form sidebar is displayed.

   

   In the Display a Form sidebar, complete the following fields and then click Add Step:

   • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
   • Title: Enter a title for the form. The title appears at the top of the portal UI page.
     Note: This field is enabled by default but can be disabled using the toggle switch on the right.
   • Intro text: Enter introductory text. The text appears near the top of the portal UI page.
     Note: This field is enabled by default but can be disabled using the toggle switch on the right.
   • Field 1: This field is predefined. This predefined field has a modifiable label called Username, and its field type is Username, which cannot be changed.
   • Add Field: Click Add Field to add additional fields. For each added field, enter a label and select a field type from the drop‑down list. The available field types include Email Address, Phone Number, First Name, Last Name, and Custom Field.

   After clicking Add Step, the process tile is added to the Workflow Designer.
10. Configure one or both of the following Splits actions in the Actions Library tab, as required:
    • User Choice Split: Displays multiple options and allows the user to select a workflow path.
    • Logical Split: Automatically routes users to different workflow paths based on defined conditions.

    Note: A workflow can contain up to 20 split steps, including User Choice Split and Logical Split.

    Note: You can create up to 25 branches across all splits in the workflow.

    Do one or both of the following:

    • User Choice Split: Hover your cursor over User Choice Split and click Add.
      The User Choice Split sidebar is displayed.

      

      In the User Choice Split sidebar, complete the following fields and then click Add Step:

      • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.
      • Page Title: Toggle the switch on to enter the title shown to users when they reach this split step. This title helps users understand the choice they need to make.
      • Page Body Text: Toggle the switch on to enter a brief instruction or message.

        Example: Select the type of onboarding process to continue.

      • Branch 1: Configure the default branch:
        • Branch title: Enter the display name for the option (for example, Student or Employee). This name appears as the selectable button or tile.
        • Branch description: Enter a brief explanation of what happens when users choose this option. The field supports a maximum of 100 characters.

          Example: Continue with student onboarding steps.

        • Change icon: Click Change icon to upload an image that represents the option. The maximum image size is 2 MB, and supported formats include PNG, JPEG, and SVG.
      • Click Add Branch to add more branches and repeat the configuration for each option.
      • Click the icon next to the option name to remove a branch.
        Note:

        • At least one branch is required for the split to be valid.
        • Removing a branch detaches its connected steps from the workflow without deleting them. Detached steps can be reattached later.
        • All branches under a single split must contain the same type of action to maintain workflow consistency.

      After clicking Add Step, the process tile is added to the Workflow Designer. Each branch appears as a separate workflow path that can be further configured with additional steps or actions.
    • Logical Split: Hover your cursor over Logical Split and click Add.
      The Logical Split sidebar is displayed, including the Branch 1 tab.

      

      In the Logical Split sidebar, complete the following fields and then click Add Step:

      • Action Label: Enter a name for the step. This label identifies the step in the workflow and is editable. The field supports a maximum of 32 characters.

        A logical split contains one or more branches. Each branch represents a path the workflow can follow when its conditions evaluate to true.

      • Source Field: Select a field from the drop‑down list.
        The available fields depend on the workflow steps configured before the Logical Split and are organized under non-selectable text delimiters (such as Device Properties, Directory Server Auth, Acceptable Use Policy (AUP), and so on).

        • Device Properties includes fields such as Venue Name, Language, Device OS, Browser Name, AP Group, Device MAC Address, Device Type, Captive Portal SSID, and Device IP Address.
        • If an Acceptable Use Policy (AUP) step is configured before the Logical Split, the Accept AUP field becomes available.
        • If a Directory Server Auth step is configured before the Logical Split, Active Directory (AD) and LDAP authentication attributes become available. These attributes include AD Auth User Name, AD Auth User ID, AD Auth First Name, AD Auth Last Name, AD Auth Display Name, AD Auth Email Address, AD Auth Phone Number, AD Auth Groups, AD Auth Roles, LDAP Auth User Name, LDAP Auth User ID, LDAP Auth First Name, LDAP Auth Last Name, LDAP Auth Display Name, LDAP Auth Email Address, LDAP Auth Groups, and LDAP Auth Roles.
        • If a SAML Authentication step is configured before the Logical Split, SAML authentication attributes become available. These attributes include SAML Auth User Name, SAML Auth User ID, SAML Auth First Name, SAML Auth Last Name, SAML Auth Display Name, SAML Auth Email Address, SAML Auth Groups, and SAML Auth Roles.
        Note: Duplicate source fields are not allowed in the same branch. Fields already selected in the branch are displayed as disabled.
      • Evaluator: Select how the system compares the field with the value. Options include Equals, Does not equal, Starts with, Ends with, Contains, and Does not contain.
      • Value: Enter the comparison value.
      • Add Condition: Click Add Condition to add one or more logical conditions.
        Note: Each branch can include up to five conditions, and all conditions use AND logic, meaning every condition must be TRUE for the branch to match.

        The Summary box displays a read‑only summary of the conditions in the branch. The summary is displayed in plain text and updates automatically as you add or modify conditions.

      • (Optional) You can click the icon to rename a branch and the icon to remove a branch.
      • (Optional) Click Add Branch to create additional branches.
        Note: A Logical Split includes 1 to 10 branches. Each branch name must be unique. Names longer than 32 characters are truncated and displayed with a tooltip. The user interface automatically expands horizontally to display up to 10 branch tabs, and labels may be truncated when space is limited.

      Note:

      • The workflow evaluates branches in order.
      • The first matching branch, in which all conditions evaluate to TRUE, is selected.
      • A branch with no conditions always matches and can serve as a default route.
      • You can add, reorder, or delete branches at any time.

      After clicking Add Step, the process tile is added to the Workflow Designer.
11. In the upper-right corner of the Workflow Designer page, click Portal Look & Feel.
    The Portal Design page is displayed.

    

    On the Portal Design page, you can customize the following:

    • Your Logo
    • Title Text Style
    • Body Text Style
    • Button Style
    • Background Image or Color

    In the upper-right corner of the Portal Design page, click Components to manage portal components.

    Use the corresponding toggle switches to show or hide the following components in the portal:

    • Logo
    • Powered By
    • WiFi4EU (Snippet Settings)
12. Click in the upper-right corner of the Portal Design page to return to the Workflow Designer wizard.
13. Click Close in the upper-right corner of the Workflow Designer wizard to return to the specified workflow details page.
14. Click Publish to publish the workflow.
    The Onboarding Workflows page refreshes. The workflow table row displays a Status of Published and a URL that you can open in a new browser tab or copy to share with clients.