Configuring an Onboarding Workflow

The RUCKUS One Enrollment System enables you to configure network portals by creating custom device onboarding workflows.

Complete the following steps to add a workflow.

  1. From the navigation bar, select Network Control > Policies & Profiles.
    The Policies & Profiles page is displayed.
  2. In the Policies & Profiles page, click Workflow.
    The Policies & Profiles page is displayed. The Onboarding Workflows page is displayed. The Onboarding Workflows displays the following information:
    • Name: Displays the name of the workflow
    • Description: Displays the workflow description.
    • Status: Displays the status of the workflow: Draft or Published.
    • URL: Displays the URL of the published workflow.
    Onboarding Workflows
    In the Onboarding Workflows page, clicking on a specific workflow name reveals a details page displaying the status, active workflow design, and the URL (if the workflow is published). From this details page you can also configure, preview, compare, and publish the workflow.
  3. Click Add Workflow.
    The Add Workflow page is displayed.
    Adding a Workflow
  4. In the Add Workflow page, complete the following fields:
    • Workflow Name: Enter the name for the workflow.
    • Description: (Optional) Enter a short description for the workflow.
  5. Click Next.
    A new workflow is created displaying its Status and Active Workflow Design.
    Configuring a Workflow
  6. Click either one of the Configure to the navigate to the Workflow Designer page.
    The Workflow Designer page allows you to not only build the client onboarding workflow, but also customize the client portal look and feel, and preview the configured portal content.
  7. Click Start building your Onboarding Workflow.
    The Actions Library sidebar is displayed. The Actions Library sidebar has the following subsections, each containing plugins (services) that you can add to the workflow:
    • User Interaction
    • Device Onboarding
    • Operational
    Actions Library Sidebar
  8. Under User Interaction, hover over Acceptable Use Policy (AUP) and click Add.
    The Acceptable Use Policy (AUP) sidebar is displayed.
    Adding the Acceptable Use Policy (AUP)
  9. In the Acceptable Use Policy (AUP) sidebar, complete the following and then click Add Step:
    • Title: Specify the name of your network. Default text for the portal welcome title is provided such that you only need to replace ACCOUNT_NAME with the name of your network, but you can modify any of the text as necessary.
    • Message: Enter the message to be displayed to your client. Default text is provided such that you only need to replace ACCOUNT_NAME with the name of your network, but you can modify any of the text as necessary.
    • Policy Content: Enter the terms and conditions to which your client must agree prior to network access. for your client. Alternatively, click Upload file instead upload the policy from your system. Supported file formats are .pdf, .docx, .dot, and .doc.

    Click Preview to preview the AUP as it will appear in the client portal UI on a PC, tablet, or a mobile device. After clicking Add Step, the AUP is successfully created and is displayed as a process tile in the Workflow Designer.

  10. Click the Acceptable Use Policy (AUP) tile and click the icon.
    The Actions Library sidebar is displayed.
    Note: When you select any added plugin tile on the Workflow Designerr, a three-dot icon appears on the upper right-hand corner. Hover over to access the (edit), (preview), and (delete ) icons.
  11. In the Actions Library sidebar, hover over Custom Message and click Add.
    The Custom Message sidebar appears.
    Adding a Custom Message
  12. In the Custom Message sidebar, for Page Title, enter a title, for Page Body Text, enter the text that you want to display in the onboarding page, and click Add Step.
    After clicking Add Step, the custom message is successfully created and is displayed as a process tile in the Workflow Designer.
  13. Select the Custom Message tile and click the icon.
    The Actions Library sidebar is displayed.
  14. Hover over Display a Form and click Add.
    The Display a Form sidebar appears.
    Adding a Display Form
  15. In the Display a Form sidebar, complete the following and then click Add Step:
    • Title: Enter a title for the form. The title will appear at the top of the portal UI page. Note that this field is enabled by default, but you may disable it by toggling the switch located on the right side of the sidebar.
    • Intro text: Enter an introduction. The introduction text will appear near the top of the portal UI page. Note that this field is enabled by default, but you may disable it by toggling the switch located on the right side of the sidebar
    • Field 1: This field is predefined; the Label is Username and the corresponding Field Type is Username. You may modify the label, but the corresponding Field Type value cannot be changed.
    • Add Field : Click to add Field 2, Field 3, and so on, as necessary. For each added field, enter a label and select a Field Type from the drop-down list (choices include: Email Address, Phone Number, First Name, Last Name, or Custom Field).
    After clicking Add Step, the user information form is successfully created and is displayed as a Display a Form process tile in the Workflow Designer.
  16. Select the Display a Form wizard and click the icon to access the Actions Library sidebar.
  17. In the Actions Library sidebar, configure only one of the following device authentication options:
    • Provide DPSK: You must have an Identity Group defined prior to adding a device authentication option.
    • MAC Address Registration: The client device MAC address is registered and authenticated with RADIUS, and assigned to the selected Identity Group.
    Note: You must have an Identity Group defined prior to adding a device authentication option.

    Provide DPSK

    1. In the Provide DPSK tile, click Add.
      The Provide DPSK sidebar appears.
      Configuring the Provide DPSK Plugin for a Workflow
    2. From the Choose Identity Group drop-down, select an identity group.
    3. From the Choose Identity drop-down, select an identity.
    4. Click Add Step.
    MAC Address Registration
    1. In the MAC Address Registration tile, click Add.
      The MAC Address Registration sidebar is displayed.
      Configuring the MAC Address Registration Plugin for a Workflow
    2. From the Choose Identity Group drop-down, select an identity group.
    3. From the Choose Identity drop-down, select an identity.
    4. Click Add Step.
  18. On the upper right-hand corner of the Workflow Designer page, click Portal Look & Feel.
    The Portal Design page is displayed.
  19. In the Portal Design page, you can customize the following:
    Customizing the Portal Design
    • Your Logo
    • Title Text Stye
    • Body Text Style
    • Button Style
    • Background Image or Color
    On the upper right-hand corner of the Portal Design page, click Components to manage components of the Portal. Using the corresponding toggle buttons, you can show or hide the following components in the portal.
    • Logo
    • Powered By
    • WiFi4EU (Snippet Settings)
  20. Click X in the upper-right corner of the Portal Design page to return to the Workflow Designer wizard.
  21. 20. Click Close in the upper-right corner of the Workflow Designer wizard to return to the specified workflow details page.
  22. 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 may click to open in a new browser tab or copy to share with clients.