HomeBlogDocsContact

Configuring OneSearch for Service Operations Workspace

Before OneSearch will appear on a workspace, you must configure a Form/Portal/Workspace record for the table being shown in the workspace. More information on this can be found in the Tips & Tricks section.

  1. Open UI Builder to the “Record” page of a desired workspace experience. Make sure you are on the desired page variant as well.

  1. Click on the “Contextual Side Panel” component and then add a new tab using the “+Add” button.

If adding to a page collection, navigate to the page collection, click "Edit Content", and then click the "+" button next to pages & variants. Update the name as-needed (Ex: OneSearch)

NOTE: If you don’t have the “+Add” button, skip Steps 2 and 3 and go to the Alternate Steps section, then return to Step 4)

  1. Fill in the tab information and click “Create”.

If adding to a page collection, and you'd like to add an icon to the sidebar button. Once the page is created, navigate to the page collection settings, click on the link to "Open page collection". There you will see a related list title "UX App Routes" - here you can set the icon for the OneSearch page you added.

  1. UI Builder should redirect to a new page where you can design the tab layout. Select the “Body” component from the component tree. Click “Edit” in the Config tab.

  1. In the modal, click the “+ Add” button to add a new page property. Name it “sysId” and then click “Add”. Click “+ Add” again to add another page property named “table” and then click “Add”. Repeat the steps one more time for a page property called “fields”. Save.

  1. Edit the config properties on the “Body” component so that table points to “@data.gform.nowRecordFormBlob.table”, sysId points to “@data.gform.nowRecordFormBlob.sysId”, and fields points to “@data.gform.nowRecordFormBlob.fields” (use dynamic data binding).

Depending on your version of UI Builder, the properties may need to be pulled from SOW Record Control.

  1. Add the “YDS OneSearch - General Search Widget” component to the page.

  1. Edit the config properties on the “YDS OneSearch - General Search Widget” component so that Table points to “@context.props.table”, Record points to “@context.props.sysId”, and Form fields points to “@context.props.fields” (use dynamic data binding).

    1. Note: You do not need to set the “Searcher override” unless you are using the OneSearch component on a page that is not a record/form and do not have a “Table” and “Record” to pass in.

  1. Save the changes and then go to a record on your workspace to verify the OneSearch component is visible.

See ServiceNow’s documentation for reference.

PreviousAdding OneSearch to a Workspace Record PageNextAlternate Steps

Last updated