ClusteringSolutionStore - Global

concept brazil Updated Sep 10, 2026 3 min read ClusteringSolutionStoreAPI.md
Raw file servicenow.com

Enables storing and retrieving solutions.

The ClusteringSolutionStore API requires the Predictive Intelligence plugin (com.glide.platform_ml) and is provided within the sn_ml namespace.

Parent Topic:Server API reference

ClusteringSolutionStore - add(Object mlSolution)

Adds a new solution object to the store and returns a unique name.

Note: Label values do not need to be unique. For example, if you run this method with the same label 10 times, this method adds 10 different uniquely-named objects to the store.

Name Type Description
mlSolution ClusteringSolution ClusteringSolution() object to add to the store.
Type Description
String System-generated solution name.

The following example shows how to add a solution to the store. Use ClusteringSolution - submitTrainingJob() to run the training job after adding it to the store.

JavaScript
// Create a dataset var myData = new sn_ml.DatasetDefinition({
  'tableName' : 'incident',  'fieldNames' : ['assignment_group', 'short_description', 'description'],  'encodedQuery' : 'activeANYTHING'
});
// Create a solution var mySolution = new sn_ml.ClusteringSolution({
  'label': "my solution definition",  'dataset' : myData,  'predictedFieldName' : 'assignment_group',  'inputFieldNames':['short_description']
});
// Add the solution to the store to later be able to retrieve it.var my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);

ClusteringSolutionStore - deleteObject(String name)

Removes a specified solution object from the store.

Name Type Description
name String Name of the ClusteringSolution() object to be deleted.
Type Description
None

The following example shows how to delete a solution from the store.

JavaScript
sn_ml.ClusteringSolutionStore.deleteObject("ml_sn_global_global_solution");

ClusteringSolutionStore - get(String name)

Gets a solution object from the store.

Name Type Description
name String Name of a solution in the store.
Type Description
Object ClusteringSolution object. Returns an error if the object does not exist.

The following example shows how to get a solution object from the store using the get() method and view its training status using the ClusteringSolution - getActiveVersion() and ClusteringSolutionVersion - getStatus() methods.

JavaScript
// Get statusvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');
gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));

Output:

JSON
{ "state":"solution_complete", "percentComplete":"100", "hasJobEnded":"true"}

ClusteringSolutionStore - getAllNames(Object options)

Gets the names of all solution definition records in the store.

Name

Type

Description

options

Object

Options for restricting results within the specified properties.``` { "label": "String", "domainName": "String", "scope": "String" };

Text
</td></tr><tr><td>
options.label
</td><td>
String
</td><td>
Optional. Label of your solution object.
</td></tr><tr><td>
options.domainName
</td><td>
String
</td><td>
Optional. Name of the domain for your solution object. Refer to [Domain separation and Predictive Intelligence](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/intelligent-experiences/domain-separation-predictive-intelligence.md).
</td></tr><tr><td>
options.scope
</td><td>
String
</td><td>
Optional. Name of an [application scope](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/c_ApplicationScope.md) for your solution object.
</td></tr></tbody></table>|Type|Description||----|-----------||Array|List of strings representing solution object names in the store.|
In the following example, the getAllNames\(\) method returns a list of all names in the store.

gs.print(JSON.stringify(JSON.parse(sn_ml.ClusteringSolutionStore.getAllNames()), null, 2));

Text
Output:

[ "ml_x_snc_global_global_clustering_solution_1", "ml_x_snc_global_global_clustering_solution" ]

SQL
In the following example, the getAllNames\(\) method returns only names associated with values set in the **options** parameter.

var options = { 'label' : 'my solution definition', 'domainName' : 'global', 'scope' : 'global' }; var solNames = sn_ml.ClusteringSolutionStore.getAllNames(options); gs.print(JSON.stringify(JSON.parse(solNames), null, 2));

Text
Output:

[ "ml_x_snc_global_global_my_solution_definition" ]

Text
## ClusteringSolutionStore - update\(String name, Object mlSolution\)
Replaces an existing object in the store with the object passed as a parameter. The object name provided must be empty or match.
|Name|Type|Description||----|----|-----------||name|String|Name of the solution to update.||mlSolution|[ClusteringSolution](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/server-api-reference/ClusteringSolutionAPI.md)|[ClusteringSolution\(\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/server-api-reference/ClusteringSolutionAPI.md) object properties to update.|
|Type|Description||----|-----------||None| |
The following example shows how to update a solution object in the store.

var solutionUpdate = new sn_ml.ClusteringSolution({ 'label': 'my solution definition', 'dataset' : myData, 'predictedFieldName' : 'assignment_group', 'inputFieldNames': ['short_description'] });

sn_ml.ClusteringSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);

Text
Search documentation
Search document titles and file paths on the brazil branch