Skip to main content

Smart Search

Universal search across the brainCloud Portal

Written by Paul Winterhalder
Updated over a week ago

The text panel at the top-center of the new brainCloud Portal provides access to Smart Search.

Any search string typed into the smart search field first gets checked to see if it contains a hint (i.e. the user manually included the hint).

These hinted searches adhere to the following form (note the “:” character that separates the “hint” from the “search term”).

<hint>:<search_term> (NOTE: The "hint" string itself is case-insensitive)

If no hint was supplied then the search string gets passed into our “smart” generator that will perform various regex tests and generate a set of applicable hinted searches.

  • If the search string looks like an appId (i.e. a 5 digit number, /^\\d{5,5}$/i) this will generate an "appId" hinted search.

  • If the search string looks like an accountNumber (i.e. a 7 digit number, /^\\d{7,7}$/i) this will generate an "accountNumber" hinted search.

  • If the search string looks like an email (i.e. /^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$/) this will generate an "email" hinted search.

  • If the search string looks like an UUID (i.e. /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/i) this will generate both "companyId" and "playerId" hinted searches.

  • If none of the above cases apply, then this will result in a "name" hinted search as a fallback.

---

Some search examples:

  • "awesome" <- looks for an app, user, or screen with "awesome" in the name

  • "12345" <- looks for an app with an appId of 12345

  • "user@awesomeapp.com" <- looks for an end-user / player that has this email

---

Search Types / Hints

App Supported Hints (attempts to locate apps):

NOTE: “appId”, “gameId” and “id” are treated the same.

NOTE: “appName”, “gameName” and “name” are treated the same.

  • appId

  • gameId

  • id

  • appName

  • gameName

  • name

  • accountNumber

User/Player Supported Hints (attempts to locate players):

NOTE: “playerId”, “profileId” and “id” are treated the same.

NOTE: “emailAddress”, “contactEmail” and “email” are treated the same.

  • playerId

  • profileId

  • id

  • emailAddress

  • contactEmail

  • email

Screen Supported Hints (attempts to locate portal screens):

NOTE: “pageKey” and “key” are treated the same.

NOTE: “pageName” and “name” are treated the same.

  • pageKey

  • key

  • pageName

  • name

---

brainCloud will be continuing to add more search types + hints in the future. When in doubt - check this page for updates!

Did this answer your question?