Using Search in the Community Manager developer portal

Learn about the different ways to find information in the Community Manager developer portal.


Table of Contents

  1. How do I search for information in the Community Manager developer portal?
  2. What types of information are included in search results?
  3. How do I use the Search feature?
  4. How do I use special characters in search?
  5. How can I search in forums?
  6. How do tags work in search?

How do I search for information in the Community Manager developer portal?

The Community Manager developer portal includes multiple ways of finding the information you need, including information about APIs, Forum discussions, and Alerts.

You can search in the following ways:

Back to top

What types of information are included in search results?

You can choose a functional area for your search, as shown below. The platform searches through information associated with APIs, apps, groups, and users.

Functional Area Searchable Entities
APIs

API Name, API Description, API Version (Name, Description, Type, Tag), API Documentation, API endpoint (partial or complete)

Note: When searching for a complete API endpoint, use surrounding double quotes. Example: "https://example.com/v1/payments" searches for the full endpoint.

Apps App Name, App Description, App Version (Name, Description, Type, Tag)
Groups Group Name, Description, Tag.
Discussions API Name, Post Type, Content, Username, Tag, Comment (Content, Username)
Tickets API Name, Title, Description, Username, Label, Tag, Comment (Content, Username)
Alerts API Name, Title, Description, Username, Tag, Comment (Content, Username)
Reviews Review Title, Content.
Documentation Any site content pages, such as help pages or homepage.
Users Username, email address.

With optional Lifecycle Repository feature

(2019.1.14 and later)

If Lifecycle Repository is installed, search results include metadata values defined for the following resources:

  • Apps
  • APIs
  • Users

Note: Certain types of data, such as Boolean values, are filtered out of the search results since this would not be useful information in search results.

Back to top

How do I use the Search feature?

Select the Search menu by clicking the magnifying glass icon that displays to the right of the top navigation. Specify search criteria in the Search text box (at least three characters).

To search from the top menu bar

  1. From the top menu bar, use the Search box to search for any content on the platform, as shown below.

    Hermosa Theme, 2019.1.0 and later: click the magnifying glass in the top menu bar to open the Search bar.

    Using Search (Hermosa Theme)

    Hermosa Theme, versions up to 2019.1.0: The Search bar is in the top menu bar.

    Using Search (Hermosa Theme)

  2. Type your search criteria into the text box (3–20 characters), and then click to search. The search results are displayed.
  3. When you have your search results, you can also use the additional options to refine your search, as shown below.

    Hermosa Theme, below top menu bar:

    Search feature secondary menu bar (Hermosa Theme)

    You can filter using these options:

    • Type: All, APIs, Apps, Groups, Organizations, Discussions, Tickets, Alerts, Reviews, or Documents
    • Sort By: Highest Rated, Most Used, Most Popular, Last Updated, Most Relevant, or Alphabetical
    • Search: If needed, modify the search term in the Search box. Otherwise, it defaults to the initial search term you entered.

Back to top

How do I use special characters in search?

If you're searching for something that has special characters in it, you might not get the expected results. A search for text containing special characters has to be written in a special way.

The search feature has certain characters that are reserved. The reserved characters are:

+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /

If any reserved characters are included in search terms, they'll need to be escaped, or the search feature will not work as expected. Escaping the character means that you include a backslash (\) immediately before it.

For example, to search for (123)app, you'd have to search for the following: \(123\)app.

If you're naming platform resources such as apps and APIs, it's best to steer clear of special characters. If you're searching for resources that include these characters, escape them as above and you'll get the expected results.

Back to top

How can I search in forums?

You can search in the following forums:

  • My Forum: available to all logged-in users. Includes forum entries for all APIs, apps, and groups that the specific user is associated with.
  • App Forum: for public apps, or apps the logged-in user is associated with.
  • API Forum: for public APIs, or APIs the logged-in user is associated with.
  • Group Forum for public groups, or groups the logged-in user is associated with.

My Forum

The example below shows how search works on the Forum page for an individual. In this example, the user types in a few characters of a search term and the Community Manager developer portal offers matching results. The user can then choose from the drop-down results list.

The platform searches through information associated with APIs, apps, groups, and users.

The user can:

  • Search by Published or Unpublished items.
  • Search by Alerts, Contract Requests, Discussions, Group Membership Requests, Reviews, Tickets, or All Forum Items:

    User forum search: forum items

  • Enter search wording; the UI presents matching results in a list that the user can then choose from.

User forum search

App Forum

The example below shows how search works on the Forum page for an app. In this example, the user is searching by tags. The user types in the first few letters of the word "offer" and there is one matching result, since there is one discussion that has "offer" set up as a tag. In this example, you can see the matching entry, even though the user didn't yet choose the result, because it happens to be at the top of the list.

In the App Forum, the user can:

  • Search by Type: Discussions, Tickets, Alerts, Requests, or All.
  • In the API drop-down list, choose an API the app is associated with, or All.
  • Sort search results by Most Recent, Most Popular, or Most Marked.
  • Specify version: This version, or All versions.
  • Search by tags. For more information, see How do tags work in search? below.

App forum search

API Forum

The example below shows how search works on the Forum page for an API. In this example, the user is searching in Discussions, for a discussion with a tag of "version." The user types in the first few letters of the word "version" and there is one matching result, since there is one discussion that has "version" set up as a tag. In this example, you can see the matching entry, even though the user didn't yet choose the result, because it happens to be at the top of the list.

In the API Forum, the user can:

  • Search by Type: Discussions, Tickets, Alerts, Requests, or All.
  • In the Apps drop-down list, choose an app that the API is associated with, or All.
  • Sort search results by Most Recent, Most Popular, or Most Marked.
  • Specify version: This version, or All versions.
  • Search by tags.

API forum search

Group Forum

The example below shows how search works on the Forum page for a group.

The user can:

  • Search by Type: Discussions, Tickets, Alerts, Requests, or All.
  • Sort search results by Most Recent, Most Popular, or Most Marked.
  • Search by tags.

Group forum search

For additional information on forums, refer to:

Back to top

How do tags work in search?

When a platform user creates an app, API, or group, there is an option to define specific tags to describe the resource. Tags are essentially search keywords, used by the search feature to help you find what you want.

For example, a group for Android game developers might have tags of game, Android; a banking API might have tags of bank, banking, finance.

When you're using tags to search for resources, the search scope depends on the page you search from in the Community Manager developer portal:

  • Top search bar: Searches for tags across all resources (apps, APIs, groups).
  • My APIs page: Searches for tags across all APIs.
  • My Apps page: Searches for tags across all apps.
  • My Groups page: Searches for tags across all groups.

Valid in Version: 2020.1.6 and later

In some contexts, tags are displayed as clickable links; for example, in the All APIs and All Apps pages, for each resource, tags are displayed in the list view, and each tag is a link. Click the link to see a list of all resources of that type that have the same tag.

Back to top