Skip to main content

Create People Finder Spoke

A spoke is a scoped application containing Flow Designer content dedicated to a particular application or record type. This includes integrations that connect external systems or services with the ServiceNow platform. By leveraging spokes, organizations can extend the capabilities of their ServiceNow instance and integrate it with a wide range of external tools and services, enhancing automation, collaboration, and efficiency across their IT operations and business processes.

Click here to learn more about Spokes.

Spoke Generator allows users to create custom spokes for integrating ServiceNow with external systems or services. It provides a graphical interface and a set of tools to streamline the process of building, configuring, and deploying spokes tailored to specific integration scenarios.

Click here to learn more about Spoke Generator.

We will create a re-usble integration to the finance department's People Finder Open API, so that we can access this data in our Main flow.

Open Flow Designer to use Spoke Generator to create the People Finder Integration

  1. Go to the tab with the ServiceNow Admin Home Page (your title may be different).

  2. Open Flow Desginer from the All Menu

    1. Click the All menu
    1. Search for "flow designer"
    1. Click on: Process Automation > Flow Designer
  3. Create New Spoke

    1. Click Create new ▼
    1. Click "Spoke"
  4. Setup General Information for the Spoke (💡 double-click to select, copy & paste into the form).

    Field NameField Value
    Drag and drop the icon in the telework_lab files folder we downloaded earlierpeople_finder.png
    Spoke Name (App scope name will auto-populate)People Finder
    DescriptionAPI to find people in a remote system
    Click on the Create and continue button.

  5. Specify how we want to build our Spoke

    1. Select OpenAPI Specification
    1. Click Continue
  6. For the OpenAPI source, click Import new

  7. Fill the user form with the following values (💡 double-click to select, copy & paste into the form).

    Field NameField Value
    Import methodImport from URL
    OpenAPI URLhttps://low-code.guide/api-specs.json
    Click on the Import button.

  8. For the Connection alias, click Create new

  9. Fill the user form with the following values (💡 double-click to select, copy & paste into the form).

    Field NameField Value
    Connection alias namePeople Finder
    Authentication Configuration TemplateAPI Key Template
    Click on the Create button.

  10. To continue, click the Generate operations button

  11. Select the actions you want to create

    1. Select all actions
    1. Click the Publish(1) | ▼ button
  12. Click the "GET /user" link to view the action we just created

  13. Before we can test and use our spoke, we need to set the Base URL for the Connection.

    Click to expand the OpenAPI step

  14. Click the plus sign next to the Connection Alias

  15. Set up the HTTPs(s) Connection (💡 double-click to select, copy & paste into the form).

    Field NameField Value
    NamePeople Finder
    Connection aliasx_snc_people_finde.People_Finder
    Connection URLhttps://low-code.guide/api
    Click on the Submit button.

  16. The Base URL should now be populated.

    Click on the Test button

  17. Test the action with David Loo's email (💡 double-click to select, copy & paste into the form).

    Field NameField Value
    emaildavid.loo@example.com
    Click on the Run Test button.

  18. When the test completes, click the link to view the execution results

  19. Click on the RUNTIME VALUE link

  20. Review the JSON results. We can switch to the Formatted view.

    Click Formatted toggle.

  21. Expand the output.

  22. Review the Formatted JSON results.

    1. Note the telework-certified value.
    1. Click Close
  23. Close the Execution Details tab

  24. Close the Test Action model by clicking the Cancel button

  25. Save the GET /user spoke action

    Click the Save button

  26. Now, we publish the spoke, so it will be available to call from our Main Flow.

    Click the Publish button

  27. Confirm publication of the action

    Click the Publish button

Bonus: Explore Spoke Generator More

Open a new browser tab or window and explore the following: https://developer.opentext.com/imservices/products/contentstorageservice/apis/contentstorage

On your own, create a new spoke using the following OpenAPI spec: https://raw.githubusercontent.com/deflant/opentext-content-storage-swagger/main/opentext-content-storage-swagger.yaml