Configuring Native Search

ServiceNow search sources make it easier for users to search data on the portal. SailPoint's search source can be configured to help users in finding SailPoint’s access objects through portal search. For more information on searchable fields, refer to Searchable Fields - SailPoint Identity Services.

Admins in ServiceNow can configure the SailPoint Search Source by performing the following steps.

Go to Service Portal > Portals and open the relevant portal record.
AI Search in ServiceNow doesn't support external sources. Ensure the Enable AI Search checkbox is unchecked, and that the scope has been set correctly.

Screenshot
Go to the Search Sources list and select Edit.
Add SailPoint Requestables to the Search Source List and select Save.

Screenshot

Note
ServiceNow does not support external sources when the AI search feature is enabled.

After completing the above mentioned configuration, users will be able to use the service portal search to look for SailPoint access objects.

Screenshot

Upon selection of any result from the SailPoint requestable source, the signed in user will be redirected to the page that has been defined in the Native Search field on the setup page. For example, manage_access. The pages Manage_Access and ISC_Request have been configured to access the values. If you use a custom page, the target page should include the widget for ISC Access Object Selection.

Screenshot

Note
Search Source will work only for users that have x_sap_integration.user or admin access in ServiceNow and a valid identity present in Identity Security Cloud.

Adding Paginated Result Support for the SailPoint Search Source

By default, the paginate results option is disabled for the SailPoint Search Source, however, ServiceNow admins can enable it.

Caution
Due to the data retrieval method of the SailPoint Search Source from the REST API, it is essential to utilize facets in conjunction with pagination when conducting searches. This approach guarantees accurate results.

To add paginated support for the SailPoint Requestables Search Source, refer to the Knowledge Base search source, Product Documentation | ServiceNow, as recommended by ServiceNow.

In the data retrieval script, ServiceNow uses undocumented objects like query, queryLocation, etc. Any changes made to these objects either by ServiceNow or any other customization may result in paginated search failure.

Enable the Paginated Result and Facets for the Search Source

Admins in ServiceNow can disable pagination for the SailPoint Search Source by performing the following steps:

Go to Service Portal > Search > Search Sources and open the SailPoint Requestables search source record.
Select the checkbox to enable Paginate Results.

Copy the following code, and paste it into the Data Fetch Script.

For v3.2 and earlier

Copy

var queryLocation = queryLocation || 0;
var count = count || 30;
(function(query, queryLocation, count) {
    var results = [];
    var snAccountAttributeValue = '';
    var identityAttributeName = gs.getProperty('x_sap_intidn.x_sp_spnt_snow_int.spnt_identity_attribute', '').trim();
    var snAccountAttribute = gs.getProperty('x_sap_intidn.x_sp_spnt_snow_int.servicenow_account_attribute', 'name').trim();
    var userID = gs.getUserName();

    var grUser = new GlideRecord('sys_user');
    if (grUser.get('user_name', userID)) {
        snAccountAttributeValue = grUser.getValue(snAccountAttribute);
    }
    var authScript = new x_sap_intidn.SP_SPNT_SNOW_INT_Auth();
    var accessToken = authScript.getServiceAccountAccessToken();

    var cmnObj = new x_sap_intidn.SP_SPNT_SNOW_INT_Common();
    var valid = false;
    valid = cmnObj.checkIfValidIdentity(accessToken, identityAttributeName, snAccountAttributeValue);

    if (valid) {
        var idn_extractRole_scriptIncludes = new x_sap_intidn.SP_SPNT_SNOW_INT_GetAccessListREST();
        idn_extractRole_scriptIncludes.setAuthScript(authScript);

        var accessObjectType = {
            'Access Profiles': 'ACCESS_PROFILE',
            'Roles': 'ROLE',
            'Entitlements': 'ENTITLEMENT'
        };

        var tabs = gs.getProperty("x_sap_intidn.x_sp_spnt_snow_int.specify_tab_order", "");
        tabs = tabs.trim().split(",");
 
        if (facets.AOType) {
            tabs = tabs.filter(function(objType) {
                return objType == facets.AOType;
            });
        }
        if (global.JSUtil.notNil(data.limit) && !isNaN(data.limit))
            count = data.limit + queryLocation;
        var resCount = 0;

        tabs.forEach(function(tab) {
            if (accessObjectType[tab]) {
                var accessList = idn_extractRole_scriptIncludes.getAccessEntitiesCombined(accessToken, query, accessObjectType[tab], '', '', true, queryLocation, count);
                if (accessList.count > 0) {
                    accessList.items.forEach(function(accessObject) {
                        results.push({
                            'name': accessObject.name,
                            'description': accessObject.description ? accessObject.description : '',
                            'type': accessObject.type,
                            'query_location': queryLocation + resCount,
                            'owner': accessObject.Owner,
                            'url': '?id=manage_access&itemId=' + accessObject.id
                        });
                        resCount++;
                    });
                }
            }
        });
    } else {
        gs.info(userID + ' is not a valid identity in IdentityNow');
    }
    if (results.length == 0)
        return results;
    if (results.length < count) {
        var lastResult = results.pop();
        lastResult.isLastResult = true;
        results.push(lastResult);
    }
    return results;
})(query, queryLocation, count);

For v4.0

Copy

var queryLocation = queryLocation || 0;
var count = count || 30;
(function(query, queryLocation, count) {
    var results = [];
    var snAccountAttributeValue = '';
    var identityAttributeName = gs.getProperty('x_sap_intidn.x_sp_spnt_snow_int.spnt_identity_attribute', '').trim();
    var snAccountAttribute = gs.getProperty('x_sap_intidn.x_sp_spnt_snow_int.servicenow_account_attribute', 'name').trim();
    var userID = gs.getUserName();
    var page_id = gs.getProperty('x_sap_intidn.Native_Search_Redirect_Page_ID','manage_access');    var grUser = new GlideRecord('sys_user');
    if (grUser.get('user_name', userID)) {
        snAccountAttributeValue = grUser.getValue(snAccountAttribute);
    }
    var authScript = new x_sap_intidn.SP_SPNT_SNOW_INT_Auth();
    var accessToken = authScript.getServiceAccountAccessToken();    var cmnObj = new x_sap_intidn.SP_SPNT_SNOW_INT_Common();
    var valid = false;
    valid = cmnObj.checkIfValidIdentity(accessToken, identityAttributeName, snAccountAttributeValue);    if (valid) {
        var idn_extractRole_scriptIncludes = new x_sap_intidn.SP_SPNT_SNOW_INT_GetAccessListREST();
        idn_extractRole_scriptIncludes.setAuthScript(authScript);        var accessObjectType = {
            'Access Profiles': 'ACCESS_PROFILE',
            'Roles': 'ROLE',
            'Entitlements': 'ENTITLEMENT'
        };        var tabs = gs.getProperty("x_sap_intidn.x_sp_spnt_snow_int.specify_tab_order", "");
        tabs = tabs.trim().split(",");        if (facets.AOType) {
            tabs = tabs.filter(function(objType) {
                return objType == facets.AOType;
            });
        }
        if (global.JSUtil.notNil(data.limit) && !isNaN(data.limit))
            count = data.limit + queryLocation;
        var resCount = 0;        tabs.forEach(function(tab) {
            if (accessObjectType[tab]) {
                var accessList = idn_extractRole_scriptIncludes.getAccessEntitiesCombined(accessToken, query, accessObjectType[tab], '', '', true, queryLocation, count);
                if (accessList.count > 0) {
                    accessList.items.forEach(function(accessObject) {
                        results.push({
                            'name': accessObject.name,
                            'description': accessObject.description ? accessObject.description : '',
                            'type': accessObject.type,
                            'query_location': queryLocation + resCount,
                            'owner': accessObject.Owner,
                            'url': '?id='+page_id+'&itemId=' + accessObject.id,
                        });
                        resCount++;
                    });
                }
            }
        });
    } else {
        gs.info(userID + ' is not a valid identity in IdentityNow');
    }
    if (results.length == 0)
        return results;
    if (results.length < count) {
        var lastResult = results.pop();
        lastResult.isLastResult = true;
        results.push(lastResult);
    }
    return results;
})(query, queryLocation, count);

Uncomment the code from the Facet Generation Script and select Update.

Note
Any modifications to the internal ServiceNow object utilized in the data fetch script will cause the paginated search to fail.
Select Update.

Feedback is provided as an informational resource only and does not form part of SailPoint's official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.


	You are here:

Configuring Native Search

Adding Paginated Result Support for the SailPoint Search Source

Enable the Paginated Result and Facets for the Search Source

Documentation Feedback