Update an API Entry Point display - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
  1. Select an existing API Entry Point, and click Actions > Update.

    You can only update an API Entry Point that has been created by your administrator.

  2. Update the API Entry Point in the Main Details section.

    • Click Redirect To Search Bar to redirect the API Entry Point function to appear in the search bar so you can enter search criteria.

    • Click Equal To Operator set by default to change the default search operator behavior to the 'Is equal to' Operator in the search bar.

    The default behavior of the API Entry Point search is to use the Contains operator. By changing the default search operator to Is equal to, you can produce more targeted searches and help improve search performance. For example, if you leave Contains as the default operator, a search returns all data that contains your search criteria. However, setting Is equal to as your default operator allows you to narrow the results to set of data that is an exact match to your search criteria.

  3. In the Update dialog box, find the Entry point for APIs UI details section:

    • Click Hide API entry point from list in the UI to hide the API Entry Point function from the search functionality.

    • Click Hide from Home Page to hide the API Entry Point function from display in a feature set.

    • Click Home Page Group, and enter the name of a sub-group to which you want to add the API Entry Point function.

    • Click Number of characters for peek search request, and enter a value to increase the character limit before a peek search is invoked. The default is three.

    SHARED Tip The sub-group names are managed in the Home Page Group column in the Manage Entry Points dialog box. For more information, see Configure API Entry Points to display as functions in a feature set.

To completely remove an API Entry Point from the display, you must terminate it. If you only remove the relationships between the API Entry Point and its access groups, the API Entry Point becomes available to all users.