\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClssfnV-setPredictionSettings_O__table_c45_tdw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClssfnV-setPredictionSettings_O__table_c45_tdw_plb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClssfnV-setPredictionSettings_O__table_c45_tdw_plb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to set a precision metric to 89.5 for a class named\\n <code class=\\\"ph codeph\\\">Clone Issues</code>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');\\nvar input = {"metricName" : "precision", "metricValue" : "89.5", "className" : "Clone Issues"};\\n\\nmlSolution.getActiveVersion().setTrainingStatistics(input);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClassificationSolutionVersion - Global\n\nThe ClassificationSolutionVersion API is a scriptable object used in\nPredictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used for working with solution versions based on ClassificationSolution API objects in the ClassificationSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nClassificationSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## ClassificationSolutionVersion - getPredictionPerformance(Object options)\n\nCalculates solution precision and coverage.\n\nTo use this method, you must first create settings using the\nsetPredictionSettings() method.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Selects a metric to retrieve within a span of dates. For more information, see Configuring target metrics. ```None { \"metricName\" : \"String\", \"fromDate\" : \"String\", \"toDate\" : \"String\" } ``` |\n| options.metricName | | Name of the metric.Valid values: * precision * coverage |\n| options.fromDate | | Optional. Start date from which to retrieve metrics in system date time format. |\n| options.toDate | | Optional. End date from which to retrieve metrics in system date time format. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Parseable JavaScript object containing the results for the input metric. ```None { \"metricName\" : \"String\", \"metricValue\" : \"String\", \"numberOfPredictionsConsidered\" : \"String\" } ``` |\n| Object.metricName | Name of metric selected as input. Data type: String |\n| Object.metricValue | Value of the selected metric. Data type: String |\n| Object.numberOfRecordsConsidered | Number of records in the Predictor Results [ml\\_predictor\\_results] table considered for calculations. Data type: String |\n\n### Example\n\nThe following example shows how to get a precision value from the active version of a\nsolution.\n\n```None\n// Get precision value\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionPerformance({\"metricName\": \"precision\"})), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"metricName\": \"precision\",\n \"metricValue\": \"70.10\",\n \"numberOfPredictionsConsidered\": \"10\"\n}\n```\n\n## ClassificationSolutionVersion - getPredictionSettings()\n\nGets estimated precision, estimated coverage, estimated recall values from the ML\nSolutions [ml\\_solution] table and records from the Class Confidence [ml\\_class]\ntable.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Returns prediction settings for each class. Data includes precision, coverage, recall, and distribution values of all classes included in the trained model from the ML Solutions [ml\\_solution] table. For details, see Predictive model components. ```None { \"<class name>\": {Object} } ``` |\n| <Object>.<class name> | Array of objects providing training statistics data from the Class Confidence [ml\\_class] table. For more information, see Configuring target metrics. ```None { \"precision\": \"String\", \"coverage\": \"String\", \"recall\": \"String\" } ``` |\n| <Object>.<class name>.precision | Estimated solution precision metric for this class. Data type: String (numerical value) |\n| <Object>.<class name>.coverage | Estimated solution coverage metric for this class. Data type: String (numerical value) |\n| <Object>.<class name>.recall | Estimated solution recall metric for this class. Data type: String (numerical value) |\n\n### Example\n\nThe following example shows how to get prediction settings of an active solution\nversion.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionSettings()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"solutionSettings\": {\n \"precision\": \"61.69\",\n \"coverage\": \"66.75\",\n \"recall\": \"57.54\"\n },\n \"classSettings\": {\n \"Approvals\": {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\"\n },\n \"Authentication\": {\n \"precision\": \"38.71\",\n \"coverage\": \"98.44\",\n \"recall\": \"56.25\"\n },\n \"Automation\": {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\"\n }, ...\n```\n\n## ClassificationSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClassificationSolution version details. Results vary by object property setup. ```None { \"algorithmConfig\": { \"algorithm\": \"String\", \"targetClassRecall\": \"String\" }, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"versionNumber\": \"Number\" } ``` |\n| <Object>.algorithmConfig | Method for encoding the solution. Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Name of the encoding algorithm for training this solution. Possible values: * xgboost: XGBoost encoding to optimize the training. * logisticRegression: Method using the logistic regression model for categorical targets such as nominal or ordinal. Data type: String. |\n| <Object>.algorithmConfig.targetClassRecall | Class recall parameter to steer a solution's training to bias a specific class. The recall value is a number between 0 and 100 representing a percentage. Data type: String |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.groupByFieldName | Field name by which the system groups records to build classification solutions. Data type: String |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.versionNumber | Version number of the ClassificationSolution object. Data type: String. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n*** Script: {\n \"datasetProperties\": {\n \"encodedQuery\": \"activeANYTHING^EQ\",\n \"fieldNames\": [\n \"short_description\",\n \"category\"\n ],\n \"tableName\": \"incident\"\n },\n \"domainName\": \"global\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"isActive\": \"true\",\n \"label\": \"Incident Categorization_Trainer\",\n \"name\": \"ml_incident_categorization\",\n \"predictedFieldName\": \"category\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n}\n```\n\n## ClassificationSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a ClassificationSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_classification_solution';\nvar mlSolution = sn_ml.ClassificationSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClassificationSolutionVersion - getTrainingStatistics()\n\nGets all the training statistics for a given solution.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object with statistics for each class included in training and values for each class that was excluded from training. For details, see Predictive model components. ```None { \"includedClasses\": {Object}, \"excludedClasses\": {Object} } ``` |\n| <Object>.includedClasses | Object containing precision, coverage, recall, and distribution values of each class in the trained model. ```None \"includedClasses\": { \"<class name>\": { \"distribution\": \"String\", \"statistics\": [Array] }, ``` Data type: Object. |\n| <Object>.includedClasses.<class name>.distribution | Value of the outcome probability distribution for this class. Data type: String |\n| <Object>.includedClasses.<class name>.statistics | List of objects providing training statistics data. For more information, see Configuring target metrics. ```None [ { \"precision\": \"String\", \"coverage\": \"String\", \"recall\": \"String\", \"selected\": \"String\" } ] ``` Data type: Array |\n| <Object>.includedClasses.<class name>.statistics.precision | Estimated solution precision metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.coverage | Estimated solution coverage metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.recall | Estimated solution recall metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.selected | Flag that indicates whether this class contains records included in solution training. Valid values: * true: This class contains records selected for training the solution. * false: This class is excluded from training. Default: false Data type: String (Boolean value) |\n| <Object>.excludedClasses | Distribution and row count of all the classes excluded from training. ```None \"excludedClasses\": { \"<class name>\": { \"distribution\": \"0.11\", \"rowCount\": \"9\" } ``` Data type: Object. |\n| <Object>.excludedClasses.<class name>.distribution | Value of the outcome probability distribution for this class. Data type: String |\n| <Object>.excludedClasses.<class name>.rowCount | Number of rows excluded from training. Data type: String (numerical value) |\n\n### Example\n\nThe following example shows how to get training statistics from the active solution.\n\n```None\n// Get training stats\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getTrainingStatistics()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"includedClasses\": {\n \"Approvals\": {\n \"distribution\": \"0.43\",\n \"statistics\": [\n {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\",\n \"selected\": \"true\"\n }\n ]\n }, \n \"Authentication\": {\n \"distribution\": \"4.3\",\n \"statistics\": [\n {\n \"precision\": \"39.33\",\n \"coverage\": \"95.31\",\n \"recall\": \"54.69\",\n \"selected\": \"false\"\n },\n {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\",\n \"selected\": \"false\"\n },\n ...\n }\n ...\n \"excludedClasses\": {\n \"ACE\": {\n \"distribution\": \"0.11\",\n \"rowCount\": \"9\"\n },\n \"AHA\": {\n \"distribution\": \"0.01\",\n \"rowCount\": \"1\"\n }, \n ...\n}\n```\n\n## ClassificationSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## ClassificationSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"<sys_id/gr>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n## ClassificationSolutionVersion - setPredictionSettings(Object options)\n\nSets precision, coverage, or recall values at solution level or class\nlevel.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Metric configuration values. For information about these features, see Configuring target metrics. ```None { \t \"metricName\" : \"String\", \"metricValue\" : \"String\", \"className\" : \"String\" } ``` |\n| options.metricName | String | Name of the metric to set.Valid values: * precision * coverage * recall |\n| options.metricValue | String | Numeric value to assign to the metric. |\n| options.className | String | Optional. Name of the class to restrict results to. Use the getTrainingStatistics() method to retrieve a complete list of classes for a solution. |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to set a precision metric to 89.5 for a class named\n`Clone Issues`.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');\nvar input = {\"metricName\" : \"precision\", \"metricValue\" : \"89.5\", \"className\" : \"Clone Issues\"};\n\nmlSolution.getActiveVersion().setTrainingStatistics(input);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ClassificationSolutionVersion - Global\ndescription: The ClassificationSolutionVersion API is a scriptable object used in\n Predictive Intelligence stores.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClassificationSolutionVersion - Global\n\nThe ClassificationSolutionVersion API is a scriptable object used in\nPredictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used for working with solution versions based on ClassificationSolution API objects in the ClassificationSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nClassificationSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## ClassificationSolutionVersion - getPredictionPerformance(Object options)\n\nCalculates solution precision and coverage.\n\nTo use this method, you must first create settings using the\nsetPredictionSettings() method.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Selects a metric to retrieve within a span of dates. For more information, see Configuring target metrics. ```None { \"metricName\" : \"String\", \"fromDate\" : \"String\", \"toDate\" : \"String\" } ``` |\n| options.metricName | | Name of the metric.Valid values: * precision * coverage |\n| options.fromDate | | Optional. Start date from which to retrieve metrics in system date time format. |\n| options.toDate | | Optional. End date from which to retrieve metrics in system date time format. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Parseable JavaScript object containing the results for the input metric. ```None { \"metricName\" : \"String\", \"metricValue\" : \"String\", \"numberOfPredictionsConsidered\" : \"String\" } ``` |\n| Object.metricName | Name of metric selected as input. Data type: String |\n| Object.metricValue | Value of the selected metric. Data type: String |\n| Object.numberOfRecordsConsidered | Number of records in the Predictor Results [ml\\_predictor\\_results] table considered for calculations. Data type: String |\n\n### Example\n\nThe following example shows how to get a precision value from the active version of a\nsolution.\n\n```None\n// Get precision value\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionPerformance({\"metricName\": \"precision\"})), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"metricName\": \"precision\",\n \"metricValue\": \"70.10\",\n \"numberOfPredictionsConsidered\": \"10\"\n}\n```\n\n## ClassificationSolutionVersion - getPredictionSettings()\n\nGets estimated precision, estimated coverage, estimated recall values from the ML\nSolutions [ml\\_solution] table and records from the Class Confidence [ml\\_class]\ntable.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Returns prediction settings for each class. Data includes precision, coverage, recall, and distribution values of all classes included in the trained model from the ML Solutions [ml\\_solution] table. For details, see Predictive model components. ```None { \"<class name>\": {Object} } ``` |\n| <Object>.<class name> | Array of objects providing training statistics data from the Class Confidence [ml\\_class] table. For more information, see Configuring target metrics. ```None { \"precision\": \"String\", \"coverage\": \"String\", \"recall\": \"String\" } ``` |\n| <Object>.<class name>.precision | Estimated solution precision metric for this class. Data type: String (numerical value) |\n| <Object>.<class name>.coverage | Estimated solution coverage metric for this class. Data type: String (numerical value) |\n| <Object>.<class name>.recall | Estimated solution recall metric for this class. Data type: String (numerical value) |\n\n### Example\n\nThe following example shows how to get prediction settings of an active solution\nversion.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionSettings()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"solutionSettings\": {\n \"precision\": \"61.69\",\n \"coverage\": \"66.75\",\n \"recall\": \"57.54\"\n },\n \"classSettings\": {\n \"Approvals\": {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\"\n },\n \"Authentication\": {\n \"precision\": \"38.71\",\n \"coverage\": \"98.44\",\n \"recall\": \"56.25\"\n },\n \"Automation\": {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\"\n }, ...\n```\n\n## ClassificationSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClassificationSolution version details. Results vary by object property setup. ```None { \"algorithmConfig\": { \"algorithm\": \"String\", \"targetClassRecall\": \"String\" }, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"name\": \"String\", \"predictedFieldName\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"versionNumber\": \"Number\" } ``` |\n| <Object>.algorithmConfig | Method for encoding the solution. Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Name of the encoding algorithm for training this solution. Possible values: * xgboost: XGBoost encoding to optimize the training. * logisticRegression: Method using the logistic regression model for categorical targets such as nominal or ordinal. Data type: String. |\n| <Object>.algorithmConfig.targetClassRecall | Class recall parameter to steer a solution's training to bias a specific class. The recall value is a number between 0 and 100 representing a percentage. Data type: String |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoder | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.groupByFieldName | Field name by which the system groups records to build classification solutions. Data type: String |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.versionNumber | Version number of the ClassificationSolution object. Data type: String. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n*** Script: {\n \"datasetProperties\": {\n \"encodedQuery\": \"activeANYTHING^EQ\",\n \"fieldNames\": [\n \"short_description\",\n \"category\"\n ],\n \"tableName\": \"incident\"\n },\n \"domainName\": \"global\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"isActive\": \"true\",\n \"label\": \"Incident Categorization_Trainer\",\n \"name\": \"ml_incident_categorization\",\n \"predictedFieldName\": \"category\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n}\n```\n\n## ClassificationSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a ClassificationSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_classification_solution';\nvar mlSolution = sn_ml.ClassificationSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClassificationSolutionVersion - getTrainingStatistics()\n\nGets all the training statistics for a given solution.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object with statistics for each class included in training and values for each class that was excluded from training. For details, see Predictive model components. ```None { \"includedClasses\": {Object}, \"excludedClasses\": {Object} } ``` |\n| <Object>.includedClasses | Object containing precision, coverage, recall, and distribution values of each class in the trained model. ```None \"includedClasses\": { \"<class name>\": { \"distribution\": \"String\", \"statistics\": [Array] }, ``` Data type: Object. |\n| <Object>.includedClasses.<class name>.distribution | Value of the outcome probability distribution for this class. Data type: String |\n| <Object>.includedClasses.<class name>.statistics | List of objects providing training statistics data. For more information, see Configuring target metrics. ```None [ { \"precision\": \"String\", \"coverage\": \"String\", \"recall\": \"String\", \"selected\": \"String\" } ] ``` Data type: Array |\n| <Object>.includedClasses.<class name>.statistics.precision | Estimated solution precision metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.coverage | Estimated solution coverage metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.recall | Estimated solution recall metric for this class. Data type: String (numerical value) |\n| <Object>.includedClasses.<class name>.statistics.selected | Flag that indicates whether this class contains records included in solution training. Valid values: * true: This class contains records selected for training the solution. * false: This class is excluded from training. Default: false Data type: String (Boolean value) |\n| <Object>.excludedClasses | Distribution and row count of all the classes excluded from training. ```None \"excludedClasses\": { \"<class name>\": { \"distribution\": \"0.11\", \"rowCount\": \"9\" } ``` Data type: Object. |\n| <Object>.excludedClasses.<class name>.distribution | Value of the outcome probability distribution for this class. Data type: String |\n| <Object>.excludedClasses.<class name>.rowCount | Number of rows excluded from training. Data type: String (numerical value) |\n\n### Example\n\nThe following example shows how to get training statistics from the active solution.\n\n```None\n// Get training stats\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getTrainingStatistics()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"includedClasses\": {\n \"Approvals\": {\n \"distribution\": \"0.43\",\n \"statistics\": [\n {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\",\n \"selected\": \"true\"\n }\n ]\n }, \n \"Authentication\": {\n \"distribution\": \"4.3\",\n \"statistics\": [\n {\n \"precision\": \"39.33\",\n \"coverage\": \"95.31\",\n \"recall\": \"54.69\",\n \"selected\": \"false\"\n },\n {\n \"precision\": \"100\",\n \"coverage\": \"0\",\n \"recall\": \"0\",\n \"selected\": \"false\"\n },\n ...\n }\n ...\n \"excludedClasses\": {\n \"ACE\": {\n \"distribution\": \"0.11\",\n \"rowCount\": \"9\"\n },\n \"AHA\": {\n \"distribution\": \"0.01\",\n \"rowCount\": \"1\"\n }, \n ...\n}\n```\n\n## ClassificationSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## ClassificationSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"<sys_id/gr>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');\n\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n## ClassificationSolutionVersion - setPredictionSettings(Object options)\n\nSets precision, coverage, or recall values at solution level or class\nlevel.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Metric configuration values. For information about these features, see Configuring target metrics. ```None { \t \"metricName\" : \"String\", \"metricValue\" : \"String\", \"className\" : \"String\" } ``` |\n| options.metricName | String | Name of the metric to set.Valid values: * precision * coverage * recall |\n| options.metricValue | String | Numeric value to assign to the metric. |\n| options.className | String | Optional. Name of the class to restrict results to. Use the getTrainingStatistics() method to retrieve a complete list of classes for a solution. |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to set a precision metric to 89.5 for a class named\n`Clone Issues`.\n\n```None\nvar mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');\nvar input = {\"metricName\" : \"precision\", \"metricValue\" : \"89.5\", \"className\" : \"Clone Issues\"};\n\nmlSolution.getActiveVersion().setTrainingStatistics(input);\n```\n"}}},{"rowIdx":1684,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ClassifierProbes - Global"},"description":{"kind":"string","value":"The ClassifierProbes API provides a classifier probe launch facility. Encapsulates an array of probe information records, initialized either from a JavaScript array or the XML serialized version."},"keywords":{"kind":"list like","value":["ClassifierProbes API","ClassifierProbes","launch()","launchSupplementary()","size()"],"string":"[\n \"ClassifierProbes API\",\n \"ClassifierProbes\",\n \"launch()\",\n \"launchSupplementary()\",\n \"size()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_c_ClassifierProbesAPI\"><article class=\"nested0\" aria-labelledby=\"title_c_ClassifierProbesAPI\" id=\"c_ClassifierProbesAPI\">\n <h1 class=\"title topictitle1\" id=\"title_c_ClassifierProbesAPI\">ClassifierProbes<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">ClassifierProbes</span> API provides a classifier probe launch facility.\n Encapsulates an array of probe information records, initialized either from a JavaScript array or\n the XML serialized version.</p>\n <p class=\"p\">Use in any server-side script where you need to define a classifier probe launch facility.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CLSP-launch\" id=\"r_CLSP-launch\">\n <h2 class=\"title topictitle2\" id=\"title_r_CLSP-launch\">ClassifierProbes - launch()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Launches the next highest priority classifier from those in the list.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CLSP-launch__table_rqz_jsd_5t\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launch__table_rqz_jsd_5t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launch__table_rqz_jsd_5t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launch__table_rqz_jsd_5t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launch__table_rqz_jsd_5t__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launch__table_rqz_jsd_5t__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launch__table_rqz_jsd_5t__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CLSP-launch__table_sqz_jsd_5t\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launch__table_sqz_jsd_5t__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launch__table_sqz_jsd_5t__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launch__table_sqz_jsd_5t__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launch__table_sqz_jsd_5t__entry__2\">True if a classifier is launched; otherwise, false.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CLSP-launchSupplementary\" id=\"r_CLSP-launchSupplementary\">\n <h2 class=\"title topictitle2\" id=\"title_r_CLSP-launchSupplementary\">ClassifierProbes - launchSupplementary()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Launches a supplementary probe.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CLSP-launchSupplementary__table_ax4_vsd_5t\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CLSP-size\" id=\"r_CLSP-size\">\n <h2 class=\"title topictitle2\" id=\"title_r_CLSP-size\">ClassifierProbes - size()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the probe length.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CLSP-size__table_rrr_btd_5t\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-size__table_rrr_btd_5t__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-size__table_rrr_btd_5t__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-size__table_rrr_btd_5t__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-size__table_rrr_btd_5t__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-size__table_rrr_btd_5t__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-size__table_rrr_btd_5t__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CLSP-size__table_srr_btd_5t\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-size__table_srr_btd_5t__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CLSP-size__table_srr_btd_5t__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-size__table_srr_btd_5t__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CLSP-size__table_srr_btd_5t__entry__2\">The probe length</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ClassifierProbes - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205425\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205425\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_ClassifierProbesAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"ClassifierProbes API,ClassifierProbes,launch(),launchSupplementary(),size()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ClassifierProbes API provides a classifier probe launch facility. Encapsulates an array of probe information records, initialized either from a JavaScript array or the XML serialized version.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"ClassifierProbes API, ClassifierProbes, launch(), launchSupplementary(), size()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\",\n \"page_key\": 41205425,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 674,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 93\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ClassifierProbes - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_c_ClassifierProbesAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_ClassifierProbesAPI\\\" id=\\\"c_ClassifierProbesAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_ClassifierProbesAPI\\\">ClassifierProbes<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">ClassifierProbes</span> API provides a classifier probe launch facility.\\n Encapsulates an array of probe information records, initialized either from a JavaScript array or\\n the XML serialized version.</p>\\n <p class=\\\"p\\\">Use in any server-side script where you need to define a classifier probe launch facility.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CLSP-launch\\\" id=\\\"r_CLSP-launch\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CLSP-launch\\\">ClassifierProbes - launch()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Launches the next highest priority classifier from those in the list.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CLSP-launch__table_rqz_jsd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launch__table_rqz_jsd_5t__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CLSP-launch__table_sqz_jsd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launch__table_sqz_jsd_5t__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launch__table_sqz_jsd_5t__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launch__table_sqz_jsd_5t__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launch__table_sqz_jsd_5t__entry__2\\\">True if a classifier is launched; otherwise, false.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CLSP-launchSupplementary\\\" id=\\\"r_CLSP-launchSupplementary\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CLSP-launchSupplementary\\\">ClassifierProbes - launchSupplementary()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Launches a supplementary probe.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launchSupplementary__table_zw4_vsd_5t__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CLSP-launchSupplementary__table_ax4_vsd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-launchSupplementary__table_ax4_vsd_5t__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CLSP-size\\\" id=\\\"r_CLSP-size\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CLSP-size\\\">ClassifierProbes - size()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the probe length.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CLSP-size__table_rrr_btd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-size__table_rrr_btd_5t__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-size__table_rrr_btd_5t__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-size__table_rrr_btd_5t__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-size__table_rrr_btd_5t__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-size__table_rrr_btd_5t__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-size__table_rrr_btd_5t__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CLSP-size__table_srr_btd_5t\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-size__table_srr_btd_5t__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CLSP-size__table_srr_btd_5t__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-size__table_srr_btd_5t__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CLSP-size__table_srr_btd_5t__entry__2\\\">The probe length</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClassifierProbes - Global\n\nThe ClassifierProbes API provides a classifier probe launch facility.\nEncapsulates an array of probe information records, initialized either from a JavaScript array or\nthe XML serialized version.\n\nUse in any server-side script where you need to define a classifier probe launch facility.\n\n## ClassifierProbes - launch()\n\nLaunches the next highest priority classifier from those in the list.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if a classifier is launched; otherwise, false. |\n\n## ClassifierProbes - launchSupplementary()\n\nLaunches a supplementary probe.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## ClassifierProbes - size()\n\nReturns the probe length.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Number | The probe length |\n"},"rich_text":{"kind":"string","value":"---\ntitle: ClassifierProbes - Global\ndescription: The ClassifierProbes API provides a classifier probe launch facility.\n Encapsulates an array of probe information records, initialized either from a JavaScript\n array or the XML serialized version.\nkeywords:\n- ClassifierProbes API\n- ClassifierProbes\n- launch()\n- launchSupplementary()\n- size()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClassifierProbes - Global\n\nThe ClassifierProbes API provides a classifier probe launch facility.\nEncapsulates an array of probe information records, initialized either from a JavaScript array or\nthe XML serialized version.\n\nUse in any server-side script where you need to define a classifier probe launch facility.\n\n## ClassifierProbes - launch()\n\nLaunches the next highest priority classifier from those in the list.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if a classifier is launched; otherwise, false. |\n\n## ClassifierProbes - launchSupplementary()\n\nLaunches a supplementary probe.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## ClassifierProbes - size()\n\nReturns the probe length.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Number | The probe length |\n"}}},{"rowIdx":1685,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Client - Scoped, Global"},"description":{"kind":"string","value":"The Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase database, and to receive the results of the transforms."},"keywords":{"kind":"list like","value":["Client","Client","Client()","deleteSeries(GlideRecord now_GR","String metric)","getSeries(GlideRecord now_GR","String metric)","put(DataBuilder metricData)"],"string":"[\n \"Client\",\n \"Client\",\n \"Client()\",\n \"deleteSeries(GlideRecord now_GR\",\n \"String metric)\",\n \"getSeries(GlideRecord now_GR\",\n \"String metric)\",\n \"put(DataBuilder metricData)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_ClientScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_ClientScopedAPI\" id=\"ClientScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_ClientScopedAPI\">Client - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">Client</span> API provides methods to add data to the <span class=\"ph\">MetricBase</span> database, to execute transforms on the <span class=\"ph\">MetricBase</span>\n database, and to receive the results of the transforms.</p>\n <p class=\"p\">You can use the <span class=\"keyword apiname\">Client</span> class in both scoped and global server scripts.\n This class is part of the <span class=\"ph\">MetricBase</span> application and must run within the\n <code class=\"ph codeph\">sn_clotho</code> namespace.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClientS-accumulate_GR_N\" id=\"ClientS-accumulate_GR_N\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-accumulate_GR_N\">Client - accumulate(GlideRecord now_GR, String metric)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Accumulates metric values at specified timestamp and saves the\n result to the database rather than overwriting the value.</span></p>\n <section class=\"section\">\n <p class=\"p\">Use this method <span class=\"ph\">to handle metrics that can\n be summed for an accumulation, such as kilowatt-hours (kWhs) of electricity. Accumulate\n makes a call for each metric at the provided timestamp. For example, collected kilowatts\n for a heater, electric kettle and washing machine would result in three calls to\n accumulate.</span></p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\">now_GR</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\">GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\">Name of the series GlideRecord from which to obtain the accumulated\n value.<p class=\"p\">See also: <a class=\"xref\" href=\"#ClientS-getSeries_O_S_O\" title=\"Get all series from a specific dimension.\">getSeries()</a></p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\">default_value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\">Optional. <span class=\"ph\">Default value for accumulation at a given\n timestamp. Used only during the first call to accumulate if a value is unavailable\n for a given timestamp.</span>\n <p class=\"p\">A use case could be accumulating a watts\n metric for a total_power. You want to accumulate watts for a router connected to an\n outlet without a power meter to measure it. If you know the consumption value and it\n is constant), you can use the constant value as a default value to accumulate\n total_power. For example, you would use 20 if the router is constantly plugged in\n and consumes 20 Watts.</p>\n <p class=\"p\">The timestamp value can be provided using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\" class=\"xref\" title=\"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.\">DataBuilder</a> API.</p>\n <p class=\"p\">Default: 0</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClientS-accumulate_GR_N__table_atz_5jd_1db\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to accumulate the <code class=\"ph codeph\">total_power</code> metric value\n in a record called <code class=\"ph codeph\">building_a</code>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var time = new GlideDateTime();\n\n// total_power is the name of a metric within building_a which stores accumulated values\n\nvar dataBuilder1 = new sn_clotho.DataBuilder(building_a, "total_power");\n// values to be accumulated\ndataBuilder1.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder1, 0);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(building_a, "total_power");\n// values to be accumulated\ndataBuilder2.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder2, 0);\n\nvar dataBuilder3 = new sn_clotho.DataBuilder(building_a, "total_power");\n// values to be accumulated\ndataBuilder3.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder3, 0);\n\n// As a result of these operations client will save value of\n// 3.5+12+4.3+0(default value) at the timestamp 'time'</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_ClientS-Client\" id=\"ClientS-Client\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-Client\">Client - Client()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Create an instance of the client class to access the <span class=\"ph\">MetricBase</span> database.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-Client__table_pzg_hvz_31b\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-Client__table_pzg_hvz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-Client__table_pzg_hvz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-Client__table_pzg_hvz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-Client__table_pzg_hvz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-Client__table_pzg_hvz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-Client__table_pzg_hvz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var client = new sn_clotho.Client();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClientS-deleteMetric_S_S\" id=\"ClientS-deleteMetric_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-deleteMetric_S_S\">Client - deleteMetric(String tableName, String metricName)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Remove a specified metric from a specified table in the <span class=\"ph\">MetricBase</span>\n database</p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This method deletes data from the <span class=\"ph\">MetricBase</span> database. There is no\n recovery mechanism.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\">tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\">The name of the table whose specified metric is to be deleted.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\">metricName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\">The name of the metric.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClientS-deleteMetric_S_S__table_atz_5jd_1db\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to remove a metric from a table.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var client = new sn_clotho.Client();\n\n// delete metric (Speed) from the Drones table\nclient.deleteMetric("mb_demo_drone", "mb_demo_mt_speed");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClientS-deleteSeries_GR_S\" id=\"ClientS-deleteSeries_GR_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-deleteSeries_GR_S\">Client - deleteSeries(GlideRecord now_GR, String metric)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Remove the data in the <span class=\"ph\">MetricBase</span> database associated with\n the specified metric in the specified GlideRecord. Use this method for removing test data.</p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This method deletes data from the <span class=\"ph\">MetricBase</span> database. There is no\n recovery mechanism.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\">now_GR</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\">GlideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\">The records whose time series data for the specified metric is to be\n deleted.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\">metric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\">The name of the metric.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var client = new sn_clotho.Client();\n//query drones of a specific model\nvar drones = new GlideRecord("mb_demo_drone");\ndrones.addQuery("model", "Kingfisher Phantom");\ndrones.query();\n\nclient.deleteSeries(drones, 'mb_demo_mt_speed');</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClientS-getSeries_O_S_O\" id=\"ClientS-getSeries_O_S_O\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-getSeries_O_S_O\">Client - getSeries(GlideRecord now_GR, String metricName, GlideDateTime\n lastUpdateBefore)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Get all series from a specific dimension.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\">now_GR</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/glideRecordScoped/concept/c_GlideRecordScopedAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideRecordScoped/concept/c_GlideRecordScopedAPI.html\" class=\"xref\" title=\"Scoped GlideRecord is used for database operations.\">GlideRecord</a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\">The record from which to obtain the series.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\">metric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\">The name of the metric.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\">lastUpdateBefore</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\" class=\"xref\" title=\"The scoped GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\">Optional. Date in the future representing the end of the period to be\n evaluated.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClientS-getSeries_O_S_O__table_atz_5jd_1db\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__2\">List of string sys_ids representing the series containing data for the\n specified metric. If the <span class=\"keyword parmname\">lastUpdateBefore</span> parameter is\n provided, returns series that have no data more recent than the lastUpdateBefore\n date (non-inclusive).</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get the complete list of speed values listed in the\n Drones [mb_demo_drone] table.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var client = new sn_clotho.Client();\n\n// query subject records\nvar grDrone = new GlideRecord('mb_demo_drone');\ngrDrone.query();\n\nvar series = client.getSeries(grDrone,'mb_demo_mt_speed');</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClientS-put_DB\" id=\"ClientS-put_DB\">\n <h2 class=\"title topictitle2\" id=\"title_ClientS-put_DB\">Client - put(Object metricData)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Saves metric data to the <span class=\"ph\">MetricBase</span> database.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClientS-put_DB__table_vxt_wvz_31b\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-put_DB__table_vxt_wvz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-put_DB__table_vxt_wvz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-put_DB__table_vxt_wvz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-put_DB__table_vxt_wvz_31b__entry__1\">metricData</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-put_DB__table_vxt_wvz_31b__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-put_DB__table_vxt_wvz_31b__entry__3\">One of the following:<ul class=\"ul\" id=\"ClientS-put_DB__ul_ldw_bbh_yjb\">\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\" class=\"xref\" title=\"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.\">DataBuilder</a> object containing metric data.</li>\n <li class=\"li\">Array of DataBuilder objects containing metric data.</li>\n </ul></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClientS-put_DB__table_wxt_wvz_31b\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-put_DB__table_wxt_wvz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClientS-put_DB__table_wxt_wvz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-put_DB__table_wxt_wvz_31b__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClientS-put_DB__table_wxt_wvz_31b__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var time = new GlideDateTime();\n\n// two different GlideRecord instances and metrics\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\ndataBuilder.add(time, 0.6);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(gr2, 'disk_free_percentage');\ndataBuilder2.add(time, 0.2);\n\nnew sn_clotho.Client().put([dataBuilder,dataBuilder2]);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Client - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205428\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205428\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"ClientScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Client,Client,Client(),deleteSeries(GlideRecord now_GR, String metric),getSeries(GlideRecord now_GR, String metric),put(DataBuilder metricData)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase database, and to receive the results of the transforms.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Client, Client, Client(), deleteSeries(GlideRecord now_GR, String metric), getSeries(GlideRecord now_GR, String metric), put(DataBuilder metricData)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\",\n \"page_key\": 41205428,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 5767,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 750\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Client - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_ClientScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_ClientScopedAPI\\\" id=\\\"ClientScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_ClientScopedAPI\\\">Client - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">Client</span> API provides methods to add data to the <span class=\\\"ph\\\">MetricBase</span> database, to execute transforms on the <span class=\\\"ph\\\">MetricBase</span>\\n database, and to receive the results of the transforms.</p>\\n <p class=\\\"p\\\">You can use the <span class=\\\"keyword apiname\\\">Client</span> class in both scoped and global server scripts.\\n This class is part of the <span class=\\\"ph\\\">MetricBase</span> application and must run within the\\n <code class=\\\"ph codeph\\\">sn_clotho</code> namespace.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClientS-accumulate_GR_N\\\" id=\\\"ClientS-accumulate_GR_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-accumulate_GR_N\\\">Client - accumulate(GlideRecord now_GR, String metric)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Accumulates metric values at specified timestamp and saves the\\n result to the database rather than overwriting the value.</span></p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Use this method <span class=\\\"ph\\\">to handle metrics that can\\n be summed for an accumulation, such as kilowatt-hours (kWhs) of electricity. Accumulate\\n makes a call for each metric at the provided timestamp. For example, collected kilowatts\\n for a heater, electric kettle and washing machine would result in three calls to\\n accumulate.</span></p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\\\">now_GR</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\\\">GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\\\">Name of the series GlideRecord from which to obtain the accumulated\\n value.<p class=\\\"p\\\">See also: <a class=\\\"xref\\\" href=\\\"#ClientS-getSeries_O_S_O\\\" title=\\\"Get all series from a specific dimension.\\\">getSeries()</a></p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__1\\\">default_value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_zsz_5jd_1db__entry__3\\\">Optional. <span class=\\\"ph\\\">Default value for accumulation at a given\\n timestamp. Used only during the first call to accumulate if a value is unavailable\\n for a given timestamp.</span>\\n <p class=\\\"p\\\">A use case could be accumulating a watts\\n metric for a total_power. You want to accumulate watts for a router connected to an\\n outlet without a power meter to measure it. If you know the consumption value and it\\n is constant), you can use the constant value as a default value to accumulate\\n total_power. For example, you would use 20 if the router is constantly plugged in\\n and consumes 20 Watts.</p>\\n <p class=\\\"p\\\">The timestamp value can be provided using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\" class=\\\"xref\\\" title=\\\"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.\\\">DataBuilder</a> API.</p>\\n <p class=\\\"p\\\">Default: 0</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClientS-accumulate_GR_N__table_atz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-accumulate_GR_N__table_atz_5jd_1db__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to accumulate the <code class=\\\"ph codeph\\\">total_power</code> metric value\\n in a record called <code class=\\\"ph codeph\\\">building_a</code>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var time = new GlideDateTime();\\n\\n// total_power is the name of a metric within building_a which stores accumulated values\\n\\nvar dataBuilder1 = new sn_clotho.DataBuilder(building_a, "total_power");\\n// values to be accumulated\\ndataBuilder1.add(time, 3.5);\\nnew sn_clotho.Client().accumulate(dataBuilder1, 0);\\n\\nvar dataBuilder2 = new sn_clotho.DataBuilder(building_a, "total_power");\\n// values to be accumulated\\ndataBuilder2.add(time, 3.5);\\nnew sn_clotho.Client().accumulate(dataBuilder2, 0);\\n\\nvar dataBuilder3 = new sn_clotho.DataBuilder(building_a, "total_power");\\n// values to be accumulated\\ndataBuilder3.add(time, 3.5);\\nnew sn_clotho.Client().accumulate(dataBuilder3, 0);\\n\\n// As a result of these operations client will save value of\\n// 3.5+12+4.3+0(default value) at the timestamp 'time'</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_ClientS-Client\\\" id=\\\"ClientS-Client\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-Client\\\">Client - Client()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Create an instance of the client class to access the <span class=\\\"ph\\\">MetricBase</span> database.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-Client__table_pzg_hvz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-Client__table_pzg_hvz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-Client__table_pzg_hvz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-Client__table_pzg_hvz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-Client__table_pzg_hvz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-Client__table_pzg_hvz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-Client__table_pzg_hvz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var client = new sn_clotho.Client();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClientS-deleteMetric_S_S\\\" id=\\\"ClientS-deleteMetric_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-deleteMetric_S_S\\\">Client - deleteMetric(String tableName, String metricName)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Remove a specified metric from a specified table in the <span class=\\\"ph\\\">MetricBase</span>\\n database</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This method deletes data from the <span class=\\\"ph\\\">MetricBase</span> database. There is no\\n recovery mechanism.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\\\">tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\\\">The name of the table whose specified metric is to be deleted.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__1\\\">metricName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_zsz_5jd_1db__entry__3\\\">The name of the metric.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClientS-deleteMetric_S_S__table_atz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteMetric_S_S__table_atz_5jd_1db__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to remove a metric from a table.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var client = new sn_clotho.Client();\\n\\n// delete metric (Speed) from the Drones table\\nclient.deleteMetric("mb_demo_drone", "mb_demo_mt_speed");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClientS-deleteSeries_GR_S\\\" id=\\\"ClientS-deleteSeries_GR_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-deleteSeries_GR_S\\\">Client - deleteSeries(GlideRecord now_GR, String metric)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Remove the data in the <span class=\\\"ph\\\">MetricBase</span> database associated with\\n the specified metric in the specified GlideRecord. Use this method for removing test data.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This method deletes data from the <span class=\\\"ph\\\">MetricBase</span> database. There is no\\n recovery mechanism.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\\\">now_GR</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\\\">GlideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\\\">The records whose time series data for the specified metric is to be\\n deleted.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__1\\\">metric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_zsz_5jd_1db__entry__3\\\">The name of the metric.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-deleteSeries_GR_S__table_atz_5jd_1db__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var client = new sn_clotho.Client();\\n//query drones of a specific model\\nvar drones = new GlideRecord("mb_demo_drone");\\ndrones.addQuery("model", "Kingfisher Phantom");\\ndrones.query();\\n\\nclient.deleteSeries(drones, 'mb_demo_mt_speed');</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClientS-getSeries_O_S_O\\\" id=\\\"ClientS-getSeries_O_S_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-getSeries_O_S_O\\\">Client - getSeries(GlideRecord now_GR, String metricName, GlideDateTime\\n lastUpdateBefore)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Get all series from a specific dimension.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\\\">now_GR</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/glideRecordScoped/concept/c_GlideRecordScopedAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideRecordScoped/concept/c_GlideRecordScopedAPI.html\\\" class=\\\"xref\\\" title=\\\"Scoped GlideRecord is used for database operations.\\\">GlideRecord</a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\\\">The record from which to obtain the series.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\\\">metric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\\\">The name of the metric.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__1\\\">lastUpdateBefore</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\\\" class=\\\"xref\\\" title=\\\"The scoped GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_zsz_5jd_1db__entry__3\\\">Optional. Date in the future representing the end of the period to be\\n evaluated.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClientS-getSeries_O_S_O__table_atz_5jd_1db\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-getSeries_O_S_O__table_atz_5jd_1db__entry__2\\\">List of string sys_ids representing the series containing data for the\\n specified metric. If the <span class=\\\"keyword parmname\\\">lastUpdateBefore</span> parameter is\\n provided, returns series that have no data more recent than the lastUpdateBefore\\n date (non-inclusive).</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get the complete list of speed values listed in the\\n Drones [mb_demo_drone] table.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var client = new sn_clotho.Client();\\n\\n// query subject records\\nvar grDrone = new GlideRecord('mb_demo_drone');\\ngrDrone.query();\\n\\nvar series = client.getSeries(grDrone,'mb_demo_mt_speed');</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClientS-put_DB\\\" id=\\\"ClientS-put_DB\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClientS-put_DB\\\">Client - put(Object metricData)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Saves metric data to the <span class=\\\"ph\\\">MetricBase</span> database.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClientS-put_DB__table_vxt_wvz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__1\\\">metricData</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-put_DB__table_vxt_wvz_31b__entry__3\\\">One of the following:<ul class=\\\"ul\\\" id=\\\"ClientS-put_DB__ul_ldw_bbh_yjb\\\">\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\" class=\\\"xref\\\" title=\\\"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.\\\">DataBuilder</a> object containing metric data.</li>\\n <li class=\\\"li\\\">Array of DataBuilder objects containing metric data.</li>\\n </ul></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClientS-put_DB__table_wxt_wvz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-put_DB__table_wxt_wvz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClientS-put_DB__table_wxt_wvz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-put_DB__table_wxt_wvz_31b__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClientS-put_DB__table_wxt_wvz_31b__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var time = new GlideDateTime();\\n\\n// two different GlideRecord instances and metrics\\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\\ndataBuilder.add(time, 0.6);\\n\\nvar dataBuilder2 = new sn_clotho.DataBuilder(gr2, 'disk_free_percentage');\\ndataBuilder2.add(time, 0.2);\\n\\nnew sn_clotho.Client().put([dataBuilder,dataBuilder2]);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Client - Scoped, Global\n\nThe Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase\ndatabase, and to receive the results of the transforms.\n\nYou can use the Client class in both scoped and global server scripts.\nThis class is part of the MetricBase application and must run within the\n`sn_clotho` namespace.\n\n## Client - accumulate(GlideRecord now\\_GR, String metric)\n\nAccumulates metric values at specified timestamp and saves the\nresult to the database rather than overwriting the value.\n\nUse this method to handle metrics that can\nbe summed for an accumulation, such as kilowatt-hours (kWhs) of electricity. Accumulate\nmakes a call for each metric at the provided timestamp. For example, collected kilowatts\nfor a heater, electric kettle and washing machine would result in three calls to\naccumulate.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | Name of the series GlideRecord from which to obtain the accumulated value. See also: getSeries() |\n| default\\_value | Number | Optional. Default value for accumulation at a given timestamp. Used only during the first call to accumulate if a value is unavailable for a given timestamp. A use case could be accumulating a watts metric for a total\\_power. You want to accumulate watts for a router connected to an outlet without a power meter to measure it. If you know the consumption value and it is constant), you can use the constant value as a default value to accumulate total\\_power. For example, you would use 20 if the router is constantly plugged in and consumes 20 Watts. The timestamp value can be provided using the DataBuilder API. Default: 0 |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to accumulate the `total_power` metric value\nin a record called `building_a`.\n\n```None\nvar time = new GlideDateTime();\n\n// total_power is the name of a metric within building_a which stores accumulated values\n\nvar dataBuilder1 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder1.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder1, 0);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder2.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder2, 0);\n\nvar dataBuilder3 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder3.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder3, 0);\n\n// As a result of these operations client will save value of\n// 3.5+12+4.3+0(default value) at the timestamp 'time'\n```\n\n## Client - Client()\n\nCreate an instance of the client class to access the MetricBase database.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n### Example\n\n```None\nvar client = new sn_clotho.Client();\n```\n\n## Client - deleteMetric(String tableName, String metricName)\n\nRemove a specified metric from a specified table in the MetricBase\ndatabase\n\nNote: This method deletes data from the MetricBase database. There is no\nrecovery mechanism.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | The name of the table whose specified metric is to be deleted. |\n| metricName | String | The name of the metric. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to remove a metric from a table.\n\n```None\nvar client = new sn_clotho.Client();\n\n// delete metric (Speed) from the Drones table\nclient.deleteMetric(\"mb_demo_drone\", \"mb_demo_mt_speed\");\n```\n\n## Client - deleteSeries(GlideRecord now\\_GR, String metric)\n\nRemove the data in the MetricBase database associated with\nthe specified metric in the specified GlideRecord. Use this method for removing test data.\n\nNote: This method deletes data from the MetricBase database. There is no\nrecovery mechanism.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | The records whose time series data for the specified metric is to be deleted. |\n| metric | String | The name of the metric. |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar client = new sn_clotho.Client();\n//query drones of a specific model\nvar drones = new GlideRecord(\"mb_demo_drone\");\ndrones.addQuery(\"model\", \"Kingfisher Phantom\");\ndrones.query();\n\nclient.deleteSeries(drones, 'mb_demo_mt_speed');\n```\n\n## Client - getSeries(GlideRecord now\\_GR, String metricName, GlideDateTime lastUpdateBefore)\n\nGet all series from a specific dimension.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | The record from which to obtain the series. |\n| metric | String | The name of the metric. |\n| lastUpdateBefore | GlideDateTime | Optional. Date in the future representing the end of the period to be evaluated. |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of string sys\\_ids representing the series containing data for the specified metric. If the lastUpdateBefore parameter is provided, returns series that have no data more recent than the lastUpdateBefore date (non-inclusive). |\n\n### Example\n\nThe following example shows how to get the complete list of speed values listed in the\nDrones [mb\\_demo\\_drone] table.\n\n```None\nvar client = new sn_clotho.Client();\n\n// query subject records\nvar grDrone = new GlideRecord('mb_demo_drone');\ngrDrone.query();\n\nvar series = client.getSeries(grDrone,'mb_demo_mt_speed');\n```\n\n## Client - put(Object metricData)\n\nSaves metric data to the MetricBase database.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| metricData | Object | One of the following: * DataBuilder object containing metric data. * Array of DataBuilder objects containing metric data. |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar time = new GlideDateTime();\n\n// two different GlideRecord instances and metrics\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\ndataBuilder.add(time, 0.6);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(gr2, 'disk_free_percentage');\ndataBuilder2.add(time, 0.2);\n\nnew sn_clotho.Client().put([dataBuilder,dataBuilder2]);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: Client - Scoped, Global\ndescription: The Client API provides methods to add data to the MetricBase database,\n to execute transforms on the MetricBase database, and to receive the results of\n the transforms.\nkeywords:\n- Client\n- Client\n- Client()\n- deleteSeries(GlideRecord now_GR\n- String metric)\n- getSeries(GlideRecord now_GR\n- String metric)\n- put(DataBuilder metricData)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Client - Scoped, Global\n\nThe Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase\ndatabase, and to receive the results of the transforms.\n\nYou can use the Client class in both scoped and global server scripts.\nThis class is part of the MetricBase application and must run within the\n`sn_clotho` namespace.\n\n## Client - accumulate(GlideRecord now\\_GR, String metric)\n\nAccumulates metric values at specified timestamp and saves the\nresult to the database rather than overwriting the value.\n\nUse this method to handle metrics that can\nbe summed for an accumulation, such as kilowatt-hours (kWhs) of electricity. Accumulate\nmakes a call for each metric at the provided timestamp. For example, collected kilowatts\nfor a heater, electric kettle and washing machine would result in three calls to\naccumulate.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | Name of the series GlideRecord from which to obtain the accumulated value. See also: getSeries() |\n| default\\_value | Number | Optional. Default value for accumulation at a given timestamp. Used only during the first call to accumulate if a value is unavailable for a given timestamp. A use case could be accumulating a watts metric for a total\\_power. You want to accumulate watts for a router connected to an outlet without a power meter to measure it. If you know the consumption value and it is constant), you can use the constant value as a default value to accumulate total\\_power. For example, you would use 20 if the router is constantly plugged in and consumes 20 Watts. The timestamp value can be provided using the DataBuilder API. Default: 0 |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to accumulate the `total_power` metric value\nin a record called `building_a`.\n\n```None\nvar time = new GlideDateTime();\n\n// total_power is the name of a metric within building_a which stores accumulated values\n\nvar dataBuilder1 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder1.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder1, 0);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder2.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder2, 0);\n\nvar dataBuilder3 = new sn_clotho.DataBuilder(building_a, \"total_power\");\n// values to be accumulated\ndataBuilder3.add(time, 3.5);\nnew sn_clotho.Client().accumulate(dataBuilder3, 0);\n\n// As a result of these operations client will save value of\n// 3.5+12+4.3+0(default value) at the timestamp 'time'\n```\n\n## Client - Client()\n\nCreate an instance of the client class to access the MetricBase database.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n### Example\n\n```None\nvar client = new sn_clotho.Client();\n```\n\n## Client - deleteMetric(String tableName, String metricName)\n\nRemove a specified metric from a specified table in the MetricBase\ndatabase\n\nNote: This method deletes data from the MetricBase database. There is no\nrecovery mechanism.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableName | String | The name of the table whose specified metric is to be deleted. |\n| metricName | String | The name of the metric. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to remove a metric from a table.\n\n```None\nvar client = new sn_clotho.Client();\n\n// delete metric (Speed) from the Drones table\nclient.deleteMetric(\"mb_demo_drone\", \"mb_demo_mt_speed\");\n```\n\n## Client - deleteSeries(GlideRecord now\\_GR, String metric)\n\nRemove the data in the MetricBase database associated with\nthe specified metric in the specified GlideRecord. Use this method for removing test data.\n\nNote: This method deletes data from the MetricBase database. There is no\nrecovery mechanism.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | The records whose time series data for the specified metric is to be deleted. |\n| metric | String | The name of the metric. |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar client = new sn_clotho.Client();\n//query drones of a specific model\nvar drones = new GlideRecord(\"mb_demo_drone\");\ndrones.addQuery(\"model\", \"Kingfisher Phantom\");\ndrones.query();\n\nclient.deleteSeries(drones, 'mb_demo_mt_speed');\n```\n\n## Client - getSeries(GlideRecord now\\_GR, String metricName, GlideDateTime lastUpdateBefore)\n\nGet all series from a specific dimension.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| now\\_GR | GlideRecord | The record from which to obtain the series. |\n| metric | String | The name of the metric. |\n| lastUpdateBefore | GlideDateTime | Optional. Date in the future representing the end of the period to be evaluated. |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of string sys\\_ids representing the series containing data for the specified metric. If the lastUpdateBefore parameter is provided, returns series that have no data more recent than the lastUpdateBefore date (non-inclusive). |\n\n### Example\n\nThe following example shows how to get the complete list of speed values listed in the\nDrones [mb\\_demo\\_drone] table.\n\n```None\nvar client = new sn_clotho.Client();\n\n// query subject records\nvar grDrone = new GlideRecord('mb_demo_drone');\ngrDrone.query();\n\nvar series = client.getSeries(grDrone,'mb_demo_mt_speed');\n```\n\n## Client - put(Object metricData)\n\nSaves metric data to the MetricBase database.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| metricData | Object | One of the following: * DataBuilder object containing metric data. * Array of DataBuilder objects containing metric data. |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar time = new GlideDateTime();\n\n// two different GlideRecord instances and metrics\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\ndataBuilder.add(time, 0.6);\n\nvar dataBuilder2 = new sn_clotho.DataBuilder(gr2, 'disk_free_percentage');\ndataBuilder2.add(time, 0.2);\n\nnew sn_clotho.Client().put([dataBuilder,dataBuilder2]);\n```\n"}}},{"rowIdx":1686,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ClusteringSolution - Global"},"description":{"kind":"string","value":"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_ClusteringSolutionAPI\"><article class=\"nested0\" aria-labelledby=\"title_ClusteringSolutionAPI\" id=\"ClusteringSolutionAPI\">\n <h1 class=\"title topictitle1\" id=\"title_ClusteringSolutionAPI\">ClusteringSolution<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">ClusteringSolution</span> API is a scriptable object used in <span class=\"ph\">Predictive Intelligence</span> stores.</p>\n <p class=\"p\">This <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n <div class=\"p\">The solution setup-to-training flow is as follows:<ol class=\"ol\" id=\"ClusteringSolutionAPI__ol_mmm_n1c_dmb\">\n <li class=\"li\">Create a dataset using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\"><span class=\"keyword apiname\">DatasetDefinition</span></a> API.</li>\n <li class=\"li\">Mandatory if using the K-means clustering algorithm. Build an encoder using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" class=\"xref\" title=\"Scriptable object used in Predictive Intelligence stores. This object converts input data into vectors of numbers, based on encoder-specific goals and configurations. Encoders can be used independently to run encodings, or can be configured as part of solutions to encode text columns.\"><span class=\"keyword apiname\">Encoder</span></a> API.</li>\n <li class=\"li\">Use the <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\">constructor</a> to create a clustering solution object.</li>\n <li class=\"li\">Add the solution object to the clustering solution store using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html#ClusteringStore-add_O\" class=\"xref\" title=\"Adds a new solution object to the store and returns a unique name.\"><span class=\"keyword apiname\">ClusteringSolutionStore - add()</span></a> method.</li>\n <li class=\"li\">Train the solution using the <a class=\"xref\" href=\"#ClusteringSol-submitTrainingJob\" title=\"Submits a training job.\"><span class=\"keyword apiname\">submitTrainingJob()</span></a> method. This creates a version of the\n object that you can manage using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a> API.</li>\n <li class=\"li\">Get predictions using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html#C-predict_O_O\" class=\"xref\" title=\"Gets the input data for a prediction.\"><span class=\"keyword apiname\">ClusteringSolutionVersion – predict()</span></a> method.</li>\n </ol>\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This API runs <span class=\"ph\" id=\"ClusteringSolutionAPI__ml-api-access-comp\">with full\n privileges. To restrict user access, include an access control mechanism in the\n script.</span></div></div>\n <p class=\"p\">For usage guidelines, refer to <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=using-ml-apis&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Using ML APIs</a>.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_ClusteringSol-ClusteringSolution_O\" id=\"ClusteringSol-ClusteringSolution_O\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-ClusteringSolution_O\">ClusteringSolution - ClusteringSolution(Object config)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Creates a cluster solution.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:40%\"/><col style=\"width:20%\"/><col style=\"width:40%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">JavaScript object containing configuration\n properties of the </span>solution.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "algorithmConfig": {Object},\n "clusterConcept": "String",\n "clusterConceptFieldNames": [Array],\n "dataset": {Object},\n "domainName": "String",\n "encoder": {Object},\n "groupByFieldName": "String",\n "groupUnclusteredRecords": Boolean,\n "inputFieldNames": [Array],\n "label": "String",\n "maxTimeWindowForUpdate" : Number,\n "minRecordsPerCluster" : Number,\n "minRowCount": "String",\n "processingLanguage": "String",\n "stopwords": [Array],\n "trainingFrequency": "String",\n "updateFrequency": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Required unless setting the <span class=\"keyword parmname\">encoder</span> property. <span class=\"ph\">JavaScript object containing algorithm\n configuration properties.</span> Property settings vary by the value set in the <span class=\"keyword parmname\">algorithm</span>\n property.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "String", \n // See algorithmConfig.algorithm setting description for property settings based on algorithm\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.algorithm</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">Method for\n encoding your solution.</span>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_wtd_l2k_xlb\">\n <li class=\"li\"><span class=\"keyword parmname\">dbscan</span> – Density-Based Spatial Clustering of\n Applications with Noise (DBSCAN) clustering algorithm. Properties used with\n this algorithm:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_cfy_mkk_xlb\">\n <li class=\"li\"><span class=\"keyword parmname\">distanceMetric</span></li>\n <li class=\"li\"><span class=\"keyword parmname\">epsilon</span></li>\n <li class=\"li\"><span class=\"keyword parmname\">minimumNeighbours</span></li>\n </ul></li>\n <li class=\"li\"><span class=\"keyword parmname\">hdbscan</span> – Hierarchical Density Based Spatial Clustering\n of Applications with Noise (HDBSCAN) clustering algorithm. Properties used\n with this algorithm:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_o3n_zcw_wnb\">\n <li class=\"li\"><span class=\"keyword parmname\">minimumSamples</span></li>\n </ul></li>\n <li class=\"li\"><span class=\"keyword parmname\">kmeans</span> – K-means clustering algorithm. Default. The\n <span class=\"keyword parmname\">targetCoverage</span> property is used with this\n algorithm.</li>\n </ul></div>\n <p class=\"p\">Some users prefer DBSCAN because it doesn't require you to specify the\n number of clusters in the data before clustering.</p>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">dbscan</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "dbscan",\n "distanceMetric": "String",\n "epsilon": Number,\n "minimumNeighbours": Number\n}</code></pre></div>\n <div class=\"p\" id=\"ClusteringSol-ClusteringSolution_O__clustering-Properties-dbscan-codeblock\">Properties for\n <span class=\"keyword parmname\">hdbscan</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "hdbscan",\n "minimumSamples": Number\n}</code></pre></div>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">kmeans</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "kmeans",\n "targetCoverage": Number\n}</code></pre></div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.distanceMetric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-distanceM-desc\">DBSCAN\n algorithm only. Distance metric to scan for similar data objects.</span>\n <p class=\"p\" id=\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-distanceM-vals\">Valid values:\n <span class=\"keyword parmname\">levenshteinDistance</span></p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.epsilon</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-epsilon-desc\">DBSCAN\n algorithm only. Decimal value between 0 and 1 representing the size of the\n neighborhood search radius.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.minimumNeighbours</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-minNeighbs-desc\">DBSCAN\n algorithm only. Minimum number of neighbors required in a point to be a part of a\n cluster. For <span class=\"keyword parmname\">levenshteinDistance</span> the value must be 1 so that\n no points are excluded from the dataset.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.minimumSamples</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Minimum number of data samples in a neighborhood required to determine if a\n point is a core point.<p class=\"p\">Default: None</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.algorithmConfig.targetCoverage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__cluster-kmeans-targetC-desc\">K-means\n algorithm only. Percentile field to filter out records that are less similar to\n each other.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.clusterConcept</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. Concept type. A concept is a set of words listed in descending order\n of frequency. To generate a TFIDF-based cluster concept, set the value to\n <code class=\"ph codeph\">tfidf</code>. Concept types are listed in the Clustering Definitions\n [ml_capability_definition_clustering] table. <p class=\"p\">Default: Frequency-based cluster\n concept</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.clusterConceptFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. List of cluster concept field names. These values are external\n columns for creating a cluster concept and not used for cluster solution training.\n If external columns are provided, those columns are only used for the cluster\n concept and not for clustering solution training. Cluster concept fields are listed\n in the Clustering Definitions [ml_capability_definition_clustering]\n table.<p class=\"p\">Default: Input text columns generate the cluster concept</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.dataset</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\">DatasetDefinition</a>\n object name.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__solution-obj-domainN-desc\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\" id=\"ClusteringSol-ClusteringSolution_O__solution-obj-domainN-default\">Default: Current domain, for example, <code class=\"ph codeph\">"global"</code>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.encoder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Required unless setting the <span class=\"keyword parmname\">algorithmConfig</span> property to\n <code class=\"ph codeph\">"levenshteinDistance"</code>. <span class=\"ph\">Trained encoder object to\n assign to this solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.groupByFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\">Field name by which\n the system groups records into one or more clusters.</span>\n <div class=\"p\">In the following setup example, the system groups each type into an\n individual cluster, rendering 10 clusters.<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_bt4_y3h_dmb\">\n <li class=\"li\"><span class=\"keyword parmname\">groupByFieldName</span> value is\n <code class=\"ph codeph\">'category'</code></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\">DatasetDefinition</a>\n <span class=\"keyword parmname\">tableName</span> value is <code class=\"ph codeph\">'incident'</code></li>\n <li class=\"li\">Incident [incident] table has 10 category types</li>\n </ul></div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.groupUnclusteredRecords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><p class=\"p\">Flag that indicates whether to group unclustered records in results.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_ar4_blq_wnb\">\n <li class=\"li\">true: Group unclustered records separately in results.</li>\n <li class=\"li\">false: Do not group unclustered records in results. Unclustered values (-1)\n display with the rest of the results.</li>\n </ul></div>\n <p class=\"p\">Default: false</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">Identifies the prediction\n task.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.maxTimeWindowForUpdate</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. Number of minutes preceding the model update point to look for\n records. For example, if the value is 15, the system only looks for records created\n in the preceding 15 minutes. By default, the system scans all records.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.minRecordsPerCluster</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. <span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__solution-cluster-minrec-desc\">Minimum number of records to allow in any cluster.</span> The value must be greater\n than or equal to 2.<p class=\"p\">Default: 2</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.minRowCount</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\">Optional. Minimum number of records required in\n the dataset for training.<p class=\"p\">Default: 10000</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">Processing language in two-letter ISO 639-1 language code format.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-ClusteringSolution_O__solution-obj-stop-desc\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Default: English Stopwords</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.trainingFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">The frequency to retrain the model.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_pmw_523_plb\">\n <li class=\"li\">every_30_days</li>\n <li class=\"li\">every_60_days</li>\n <li class=\"li\">every_90_days</li>\n <li class=\"li\">every_120_days</li>\n <li class=\"li\">every_180_days</li>\n <li class=\"li\">run_once</li>\n </ul>Default: run_once</div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\">config.updateFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\"><span class=\"ph\">The frequency at which the model for\n the solution definition must be rebuilt.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"ClusteringSol-ClusteringSolution_O__ul_kjm_2jh_3mb\">\n <li class=\"li\">do_not_update</li>\n <li class=\"li\">every_1_day</li>\n <li class=\"li\">every_1_hour</li>\n <li class=\"li\">every_6_hours</li>\n <li class=\"li\">every_12_hours</li>\n <li class=\"li\">every_1_minute</li>\n <li class=\"li\">every_15_minutes</li>\n <li class=\"li\">every_30_minutes</li>\n </ul>Default: do_not_update</div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to create an object\n and add it to the</span> ClusteringSolution store. The example also shows how to submit the object for\n training.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">try{\n var myData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'state', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n });\n\n // get a trained encoder from the store\n var myEncoder = sn_ml.EncoderStore.get('<encoder_name >');\n \n var mySolution = new sn_ml.ClusteringSolution({\n 'label': "clustering solution",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'inputFieldNames':['short_description'], \n 'groupByFieldName' : 'category', \n 'algorithmConfig' : {\n 'algorithm' : 'kmeans',\n 'targetCoverage' : '90'\n }\n });\n \n // add solution\n var solutionName = sn_ml.ClusteringSolutionStore.add(mySolution);\n var solutionVersion = mySolution.submitTrainingJob(); \n var trainingStatus = solutionVersion.getStatus();\n gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n\n} catch(ex){\n gs.print('Exception caught: '+ ex.getMessage());\n}</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "waiting_for_training",\n "percentComplete": "0",\n "hasJobEnded": "false"\n}</code></pre>\n </div>\n <div class=\"example\" id=\"ClusteringSol-ClusteringSolution_O__example_plp_xyn_14b\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to include the 'description' field as a cluster concept\n field.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'description'],\n});\n\nvar encodersolutionName = sn_ml.EncoderStore.get('<encoder_name >');\n\nvar mySolution = new sn_ml.ClusteringSolution({\n\t'label': 'clustering_test',\n\t'dataset': myIncidentData,\n\t'inputFieldNames': ['short_description'],\n\t'encoder': encodersolutionName,\n\t'clusterConceptFieldNames': ['description']\n});\n\nvar solutionNameFromStore = sn_ml.ClusteringSolutionStore.add(mySolution);\nvar myClassifier = mySolution.submitTrainingJob(); </code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-cancelTrainingJob\" id=\"ClusteringSol-cancelTrainingJob\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-cancelTrainingJob\">ClusteringSolution - cancelTrainingJob()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Cancels a job for</span> a solution object <span class=\"ph\">that has been submitted for training.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to cancel an existing\n training job.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mySolution = sn_ml.ClusteringSolutionStore.get('ml_sn_global_global_clustering');\n\nmySolution.cancelTrainingJob();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getActiveVersion\" id=\"ClusteringSol-getActiveVersion\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getActiveVersion\">ClusteringSolution - getActiveVersion()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the active</span> ClusteringSolutionVersion object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__2\">Active <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a> object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to get an\n active</span>\n <span class=\"keyword apiname\">ClusteringSolution</span>\n <span class=\"ph\">version from the store and return its\n training status.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getAllVersions\" id=\"ClusteringSol-getAllVersions\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getAllVersions\">ClusteringSolution - getAllVersions()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets all versions of</span> a clustering solution.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getAllVersions__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__2\"><span class=\"ph\">Existing versions of a solution object.\n See also</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a> API.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get all <span class=\"keyword apiname\">ClusteringSolution</span>\n version objects and call the <span class=\"keyword apiname\">getVersionNumber()</span> and\n <span class=\"keyword apiname\">getStatus()</span> solution version methods on them.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\\n");\n};</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\n\nVersion 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\n\nVersion 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getLatestVersion\" id=\"ClusteringSol-getLatestVersion\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getLatestVersion\">ClusteringSolution - getLatestVersion()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the latest version of</span> a solution.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a>\n <span class=\"ph\"> object corresponding to the latest\n version of</span> a <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a>.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"ClusteringSol-getLatestVersion__mlsol-getLatestVersion-example\">The following example shows how to get the latest version of</span> a solution\n and return its training status.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getName\" id=\"ClusteringSol-getName\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getName\">ClusteringSolution - getName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the name of the object to use for interaction\n with the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getName__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getName__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getName__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getName__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getName__table_pps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getName__table_pps_43z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getName__table_pps_43z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getName__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getName__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getName__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getName__table_qps_43z_llb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getName__table_qps_43z_llb__entry__2\">Name of the solution object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to\n update</span>\n <span class=\"keyword apiname\">ClusteringSolution</span>\n <span class=\"ph\">dataset information and print the name\n of the object.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('clustering'));\n\nvar myCluster = new sn_ml.ClusteringSolution({\n 'label': "my clustering solution",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.ClusteringSolutionStore.update('ml_x_snc_global_global_clustering_solution', myCluster);\n\n// print solution name\ngs.print('Solution Name: '+myCluster.getName());</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Solution Name: ml_x_snc_global_global_clustering_solution</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getProperties\" id=\"ClusteringSol-getProperties\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getProperties\">ClusteringSolution - getProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets solution object\n properties</span>.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getProperties__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_pps_43z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getProperties__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\">Contents of the Dataset and <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a> object details in the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" class=\"xref\" title=\"Enables storing and retrieving solutions.\"><span class=\"keyword apiname\">ClusteringSolutionStore</span></a>.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "algorithmConfig": {Object},\n "datasetProperties": {Object},\n "domainName": "String",\n "encoder": {Object},\n "groupByFieldName": "String",\n "inputFieldNames": [Array],\n "label": "String",\n "minRecordsPerCluster" : Number,\n "name": "String",\n "processingLanguage": "String",\n "scope": "String",\n "stopwords": [Array],\n "trainingFrequency": "String",\n "updateFrequency": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">JavaScript object containing algorithm\n configuration properties.</span> Property results vary by the value set in the <span class=\"keyword parmname\">algorithm</span>\n property.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig' : {\n "algorithm": "String", \n // See algorithmConfig.algorithm setting description for property settings based on algorithm\n}</code></pre>\n <p class=\"p\">Data\n type: Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig.algorithm</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Method for\n encoding your solution.</span>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">dbscan</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "dbscan",\n "distanceMetric": "String",\n "epsilon": Number,\n "minimumNeighbours": Number\n}</code></pre></div>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">kmeans</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "kmeans",\n "targetCoverage": Number\n}</code></pre></div>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig.distanceMetric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Distance metric to scan for similar data objects.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig.epsilon</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Decimal value between 0 and 1 representing the size of the\n neighborhood search radius.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig.minimumNeighbours</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Minimum number of neighbors required in a point to be a part of a\n cluster. For <span class=\"keyword parmname\">levenshteinDistance</span> the value must be 1 so that\n no points are excluded from the dataset.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.algorithmConfig.targetCoverage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">K-means\n algorithm only. Percentile field to filter out records that are less similar to\n each other.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><p class=\"p\">Lists the properties of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\" class=\"xref\" title=\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\"><span class=\"keyword apiname\">DatasetDefinition()</span></a> object associated with the\n solution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "encodedQuery": "String",\n "fieldDetails": [Array],\n "fieldNames": [Array],\n "tableName": "String"\n}</code></pre>\n <p class=\"p\">Data type: Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Name of the table for the dataset. For\n example, <code class=\"ph codeph\">"tableName" : "Incident"</code>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of field names from the specified table\n as strings. For example, <code class=\"ph codeph\">"fieldNames" : ["short_description",\n "priority"]</code>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of JavaScript objects that specify field\n properties.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "name": "String",\n "type": "String"\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Name of the field defining the type of\n information to restrict this dataset to.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Machine-learning field type.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Encoded query string in standard Glide format.\n See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\" class=\"xref\">Encoded query\n strings</a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.encoderProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Encoder object assigned to this\n solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.<p class=\"p\">Data type:\n Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.groupByFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\" id=\"ClusteringSol-getProperties__solution-obj-group-desc\">Field name by which\n the system groups records into one or more clusters.</span>\n <p class=\"p\">Data type:\n String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Identifies the prediction\n task.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "my first prediction"\n}</code></pre>\n <p class=\"p\">Data\n type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.minRecordsPerCluster</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Minimum number of records to allow in any cluster.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">System-assigned name.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.predictedFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Identifies a field to be trained for\n predictability.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Processing language in two-letter ISO 639-1 language code format.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\">Object scope. Currently the only valid value is\n <code class=\"ph codeph\">global</code>.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.trainingFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">The frequency to retrain the model.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"ClusteringSol-getProperties__ul_pmw_523_plb\">\n <li class=\"li\">every_30_days</li>\n <li class=\"li\">every_60_days</li>\n <li class=\"li\">every_90_days</li>\n <li class=\"li\">every_120_days</li>\n <li class=\"li\">every_180_days</li>\n <li class=\"li\">run_once</li>\n </ul>Default: run_once</div>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\"><Object>.updateFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\"><span class=\"ph\">The frequency at which the model for\n the solution definition must be rebuilt.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"ClusteringSol-getProperties__ul_kjm_2jh_3mb\">\n <li class=\"li\">do_not_update</li>\n <li class=\"li\">every_1_day</li>\n <li class=\"li\">every_1_hour</li>\n <li class=\"li\">every_6_hours</li>\n <li class=\"li\">every_12_hours</li>\n <li class=\"li\">every_1_minute</li>\n <li class=\"li\">every_15_minutes</li>\n <li class=\"li\">every_30_minutes</li>\n </ul>Default: do_not_update</div>\n <p class=\"p\">Datatype: String</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"ClusteringSol-getProperties__mlsol-getProps-example-other1\">The\n following example gets properties of</span> a solution object <span class=\"ph\" id=\"ClusteringSol-getProperties__mlsol-getProps-example-other2\">in the store.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\ngs.print(JSON.stringify(JSON.parse(myCluster.getProperties()), null, 2));</code></pre>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">*** Script: {\n "algorithmConfig": {\n "algorithm": "kmeans",\n "targetCoverage": "90"\n },\n "datasetProperties": {\n "tableName": "incident",\n "fieldNames": [\n "category",\n "short_description",\n "state",\n "description"\n ],\n "encodedQuery": "activeANYTHING"\n },\n "domainName": "global",\n "encoderProperties": {\n "datasetsProperties": [\n {\n "tableName": "incident",\n "fieldNames": [\n "assignment_group",\n "short_description",\n "description"\n ],\n "encodedQuery": "activeANYTHING"\n }\n ],\n "domainName": "global",\n "label": "my encoder definition",\n "name": "ml_x_snc_global_global_my_encoder_definition",\n "processingLanguage": "en",\n "scope": "global",\n "stopwords": [\n "Default English Stopwords"\n ],\n "trainingFrequency": "run_once"\n },\n "groupByFieldName": "category",\n "inputFieldNames": [\n "short_description"\n ],\n "label": "clustering solution",\n "minRecordsPerCluster": 2,\n "name": "ml_x_snc_global_global_clustering_solution",\n "processingLanguage": "en",\n "scope": "global",\n "stopwords": [\n "Default English Stopwords"\n ],\n "trainingFrequency": "run_once",\n "updateFrequency": "do_not_update"\n}}</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-getVersion_S\" id=\"ClusteringSol-getVersion_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-getVersion_S\">ClusteringSolution - getVersion(String version)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets a solution <span class=\"ph\">by provided version number.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-getVersion_S__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__1\">version</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__3\"><span class=\"ph\" id=\"ClusteringSol-getVersion_S__mlsol-gerversion-returns-other\">Existing version number of</span> a solution.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-getVersion_S__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__2\">Specified version of the <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a> object on which you can call\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a> API methods.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"ClusteringSol-getVersion_S__mlsol-gerversion-example-other\">The following example shows how to get the training status of</span> a solution\n by version number.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "solution_complete",\n "percentComplete": "100",\n "hasJobEnded": "true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-setActiveVersion_S\" id=\"ClusteringSol-setActiveVersion_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-setActiveVersion_S\">ClusteringSolution - setActiveVersion(String version)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Activates a specified version of a\n solution in the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__1\">version</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__3\">Name of the <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a> object version to activate.<p class=\"p\">Activating this version deactivates any other version.</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"ClusteringSol-setActiveVersion_S__mlsol-setActive-example1\">The\n following example shows how to activate</span> a solution <span class=\"ph\" id=\"ClusteringSol-setActiveVersion_S__mlsol-setActive-example2\">version in the store.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">sn_ml.ClusteringSolution.setActiveVersion("ml_incident_categorization");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringSol-submitTrainingJob\" id=\"ClusteringSol-submitTrainingJob\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringSol-submitTrainingJob\">ClusteringSolution - submitTrainingJob()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Submits a training job.</span></p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Before running this method, you must first add a solution to the store using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html#ClusteringStore-add_O\" class=\"xref\" title=\"Adds a new solution object to the store and returns a unique name.\"><span class=\"keyword apiname\">ClusteringSolutionStore - add()</span></a> method.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" class=\"xref\" title=\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolutionVersion</span></a>\n <span class=\"ph\">object corresponding to the</span>\n <a class=\"xref\" href=\"#ClusteringSol-ClusteringSolution_O\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution</span></a>\n <span class=\"ph\">being trained.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\" id=\"ClusteringSol-submitTrainingJob__mlsol-submit-example-nonSol1\">The\n following example shows how to create a dataset, apply it to</span> a solution,\n add the solution <span class=\"ph\" id=\"ClusteringSol-submitTrainingJob__mlsol-submit-example-nonSol2\">to a store, and submit the\n training job.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': "my solution definition",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myClusterVersion = mySolution.submitTrainingJob();</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ClusteringSolution - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205436\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205436\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"ClusteringSolutionAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\",\n \"page_key\": 41205436,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 23209,\n \"img_count\": 0,\n \"read_time\": 9,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 2379\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ClusteringSolution - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_ClusteringSolutionAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_ClusteringSolutionAPI\\\" id=\\\"ClusteringSolutionAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_ClusteringSolutionAPI\\\">ClusteringSolution<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">ClusteringSolution</span> API is a scriptable object used in <span class=\\\"ph\\\">Predictive Intelligence</span> stores.</p>\\n <p class=\\\"p\\\">This <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n <div class=\\\"p\\\">The solution setup-to-training flow is as follows:<ol class=\\\"ol\\\" id=\\\"ClusteringSolutionAPI__ol_mmm_n1c_dmb\\\">\\n <li class=\\\"li\\\">Create a dataset using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition</span></a> API.</li>\\n <li class=\\\"li\\\">Mandatory if using the K-means clustering algorithm. Build an encoder using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" class=\\\"xref\\\" title=\\\"Scriptable object used in Predictive Intelligence stores. This object converts input data into vectors of numbers, based on encoder-specific goals and configurations. Encoders can be used independently to run encodings, or can be configured as part of solutions to encode text columns.\\\"><span class=\\\"keyword apiname\\\">Encoder</span></a> API.</li>\\n <li class=\\\"li\\\">Use the <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\">constructor</a> to create a clustering solution object.</li>\\n <li class=\\\"li\\\">Add the solution object to the clustering solution store using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html#ClusteringStore-add_O\\\" class=\\\"xref\\\" title=\\\"Adds a new solution object to the store and returns a unique name.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionStore - add()</span></a> method.</li>\\n <li class=\\\"li\\\">Train the solution using the <a class=\\\"xref\\\" href=\\\"#ClusteringSol-submitTrainingJob\\\" title=\\\"Submits a training job.\\\"><span class=\\\"keyword apiname\\\">submitTrainingJob()</span></a> method. This creates a version of the\\n object that you can manage using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a> API.</li>\\n <li class=\\\"li\\\">Get predictions using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html#C-predict_O_O\\\" class=\\\"xref\\\" title=\\\"Gets the input data for a prediction.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion – predict()</span></a> method.</li>\\n </ol>\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This API runs <span class=\\\"ph\\\" id=\\\"ClusteringSolutionAPI__ml-api-access-comp\\\">with full\\n privileges. To restrict user access, include an access control mechanism in the\\n script.</span></div></div>\\n <p class=\\\"p\\\">For usage guidelines, refer to <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=using-ml-apis&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Using ML APIs</a>.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_ClusteringSol-ClusteringSolution_O\\\" id=\\\"ClusteringSol-ClusteringSolution_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-ClusteringSolution_O\\\">ClusteringSolution - ClusteringSolution(Object config)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Creates a cluster solution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:40%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:40%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">JavaScript object containing configuration\\n properties of the </span>solution.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "algorithmConfig": {Object},\\n "clusterConcept": "String",\\n "clusterConceptFieldNames": [Array],\\n "dataset": {Object},\\n "domainName": "String",\\n "encoder": {Object},\\n "groupByFieldName": "String",\\n "groupUnclusteredRecords": Boolean,\\n "inputFieldNames": [Array],\\n "label": "String",\\n "maxTimeWindowForUpdate" : Number,\\n "minRecordsPerCluster" : Number,\\n "minRowCount": "String",\\n "processingLanguage": "String",\\n "stopwords": [Array],\\n "trainingFrequency": "String",\\n "updateFrequency": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Required unless setting the <span class=\\\"keyword parmname\\\">encoder</span> property. <span class=\\\"ph\\\">JavaScript object containing algorithm\\n configuration properties.</span> Property settings vary by the value set in the <span class=\\\"keyword parmname\\\">algorithm</span>\\n property.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "String", \\n // See algorithmConfig.algorithm setting description for property settings based on algorithm\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.algorithm</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">Method for\\n encoding your solution.</span>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_wtd_l2k_xlb\\\">\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">dbscan</span> – Density-Based Spatial Clustering of\\n Applications with Noise (DBSCAN) clustering algorithm. Properties used with\\n this algorithm:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_cfy_mkk_xlb\\\">\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">distanceMetric</span></li>\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">epsilon</span></li>\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">minimumNeighbours</span></li>\\n </ul></li>\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">hdbscan</span> – Hierarchical Density Based Spatial Clustering\\n of Applications with Noise (HDBSCAN) clustering algorithm. Properties used\\n with this algorithm:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_o3n_zcw_wnb\\\">\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">minimumSamples</span></li>\\n </ul></li>\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">kmeans</span> – K-means clustering algorithm. Default. The\\n <span class=\\\"keyword parmname\\\">targetCoverage</span> property is used with this\\n algorithm.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Some users prefer DBSCAN because it doesn't require you to specify the\\n number of clusters in the data before clustering.</p>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">dbscan</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "dbscan",\\n "distanceMetric": "String",\\n "epsilon": Number,\\n "minimumNeighbours": Number\\n}</code></pre></div>\\n <div class=\\\"p\\\" id=\\\"ClusteringSol-ClusteringSolution_O__clustering-Properties-dbscan-codeblock\\\">Properties for\\n <span class=\\\"keyword parmname\\\">hdbscan</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "hdbscan",\\n "minimumSamples": Number\\n}</code></pre></div>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">kmeans</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "kmeans",\\n "targetCoverage": Number\\n}</code></pre></div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.distanceMetric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-distanceM-desc\\\">DBSCAN\\n algorithm only. Distance metric to scan for similar data objects.</span>\\n <p class=\\\"p\\\" id=\\\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-distanceM-vals\\\">Valid values:\\n <span class=\\\"keyword parmname\\\">levenshteinDistance</span></p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.epsilon</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-epsilon-desc\\\">DBSCAN\\n algorithm only. Decimal value between 0 and 1 representing the size of the\\n neighborhood search radius.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.minimumNeighbours</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__cluster-dbscan-minNeighbs-desc\\\">DBSCAN\\n algorithm only. Minimum number of neighbors required in a point to be a part of a\\n cluster. For <span class=\\\"keyword parmname\\\">levenshteinDistance</span> the value must be 1 so that\\n no points are excluded from the dataset.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.minimumSamples</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Minimum number of data samples in a neighborhood required to determine if a\\n point is a core point.<p class=\\\"p\\\">Default: None</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.algorithmConfig.targetCoverage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__cluster-kmeans-targetC-desc\\\">K-means\\n algorithm only. Percentile field to filter out records that are less similar to\\n each other.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.clusterConcept</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. Concept type. A concept is a set of words listed in descending order\\n of frequency. To generate a TFIDF-based cluster concept, set the value to\\n <code class=\\\"ph codeph\\\">tfidf</code>. Concept types are listed in the Clustering Definitions\\n [ml_capability_definition_clustering] table. <p class=\\\"p\\\">Default: Frequency-based cluster\\n concept</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.clusterConceptFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. List of cluster concept field names. These values are external\\n columns for creating a cluster concept and not used for cluster solution training.\\n If external columns are provided, those columns are only used for the cluster\\n concept and not for clustering solution training. Cluster concept fields are listed\\n in the Clustering Definitions [ml_capability_definition_clustering]\\n table.<p class=\\\"p\\\">Default: Input text columns generate the cluster concept</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.dataset</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\">DatasetDefinition</a>\\n object name.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__solution-obj-domainN-desc\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\" id=\\\"ClusteringSol-ClusteringSolution_O__solution-obj-domainN-default\\\">Default: Current domain, for example, <code class=\\\"ph codeph\\\">"global"</code>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.encoder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Required unless setting the <span class=\\\"keyword parmname\\\">algorithmConfig</span> property to\\n <code class=\\\"ph codeph\\\">"levenshteinDistance"</code>. <span class=\\\"ph\\\">Trained encoder object to\\n assign to this solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.groupByFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\">Field name by which\\n the system groups records into one or more clusters.</span>\\n <div class=\\\"p\\\">In the following setup example, the system groups each type into an\\n individual cluster, rendering 10 clusters.<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_bt4_y3h_dmb\\\">\\n <li class=\\\"li\\\"><span class=\\\"keyword parmname\\\">groupByFieldName</span> value is\\n <code class=\\\"ph codeph\\\">'category'</code></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\">DatasetDefinition</a>\\n <span class=\\\"keyword parmname\\\">tableName</span> value is <code class=\\\"ph codeph\\\">'incident'</code></li>\\n <li class=\\\"li\\\">Incident [incident] table has 10 category types</li>\\n </ul></div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.groupUnclusteredRecords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><p class=\\\"p\\\">Flag that indicates whether to group unclustered records in results.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_ar4_blq_wnb\\\">\\n <li class=\\\"li\\\">true: Group unclustered records separately in results.</li>\\n <li class=\\\"li\\\">false: Do not group unclustered records in results. Unclustered values (-1)\\n display with the rest of the results.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Default: false</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.maxTimeWindowForUpdate</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. Number of minutes preceding the model update point to look for\\n records. For example, if the value is 15, the system only looks for records created\\n in the preceding 15 minutes. By default, the system scans all records.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.minRecordsPerCluster</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. <span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__solution-cluster-minrec-desc\\\">Minimum number of records to allow in any cluster.</span> The value must be greater\\n than or equal to 2.<p class=\\\"p\\\">Default: 2</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.minRowCount</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\">Optional. Minimum number of records required in\\n the dataset for training.<p class=\\\"p\\\">Default: 10000</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">Processing language in two-letter ISO 639-1 language code format.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-ClusteringSolution_O__solution-obj-stop-desc\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Default: English Stopwords</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.trainingFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">The frequency to retrain the model.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_pmw_523_plb\\\">\\n <li class=\\\"li\\\">every_30_days</li>\\n <li class=\\\"li\\\">every_60_days</li>\\n <li class=\\\"li\\\">every_90_days</li>\\n <li class=\\\"li\\\">every_120_days</li>\\n <li class=\\\"li\\\">every_180_days</li>\\n <li class=\\\"li\\\">run_once</li>\\n </ul>Default: run_once</div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__1\\\">config.updateFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3\\\"><span class=\\\"ph\\\">The frequency at which the model for\\n the solution definition must be rebuilt.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-ClusteringSolution_O__ul_kjm_2jh_3mb\\\">\\n <li class=\\\"li\\\">do_not_update</li>\\n <li class=\\\"li\\\">every_1_day</li>\\n <li class=\\\"li\\\">every_1_hour</li>\\n <li class=\\\"li\\\">every_6_hours</li>\\n <li class=\\\"li\\\">every_12_hours</li>\\n <li class=\\\"li\\\">every_1_minute</li>\\n <li class=\\\"li\\\">every_15_minutes</li>\\n <li class=\\\"li\\\">every_30_minutes</li>\\n </ul>Default: do_not_update</div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to create an object\\n and add it to the</span> ClusteringSolution store. The example also shows how to submit the object for\\n training.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">try{\\n var myData = new sn_ml.DatasetDefinition({\\n 'tableName' : 'incident',\\n 'fieldNames' : ['category', 'short_description', 'state', 'description'],\\n 'encodedQuery' : 'activeANYTHING'\\n });\\n\\n // get a trained encoder from the store\\n var myEncoder = sn_ml.EncoderStore.get('<encoder_name >');\\n \\n var mySolution = new sn_ml.ClusteringSolution({\\n 'label': "clustering solution",\\n 'dataset' : myData,\\n 'encoder' : myEncoder,\\n 'inputFieldNames':['short_description'], \\n 'groupByFieldName' : 'category', \\n 'algorithmConfig' : {\\n 'algorithm' : 'kmeans',\\n 'targetCoverage' : '90'\\n }\\n });\\n \\n // add solution\\n var solutionName = sn_ml.ClusteringSolutionStore.add(mySolution);\\n var solutionVersion = mySolution.submitTrainingJob(); \\n var trainingStatus = solutionVersion.getStatus();\\n gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\\n\\n} catch(ex){\\n gs.print('Exception caught: '+ ex.getMessage());\\n}</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "waiting_for_training",\\n "percentComplete": "0",\\n "hasJobEnded": "false"\\n}</code></pre>\\n </div>\\n <div class=\\\"example\\\" id=\\\"ClusteringSol-ClusteringSolution_O__example_plp_xyn_14b\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to include the 'description' field as a cluster concept\\n field.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myIncidentData = new sn_ml.DatasetDefinition({\\n 'tableName' : 'incident',\\n 'fieldNames' : ['category', 'short_description', 'description'],\\n});\\n\\nvar encodersolutionName = sn_ml.EncoderStore.get('<encoder_name >');\\n\\nvar mySolution = new sn_ml.ClusteringSolution({\\n\\t'label': 'clustering_test',\\n\\t'dataset': myIncidentData,\\n\\t'inputFieldNames': ['short_description'],\\n\\t'encoder': encodersolutionName,\\n\\t'clusterConceptFieldNames': ['description']\\n});\\n\\nvar solutionNameFromStore = sn_ml.ClusteringSolutionStore.add(mySolution);\\nvar myClassifier = mySolution.submitTrainingJob(); </code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-cancelTrainingJob\\\" id=\\\"ClusteringSol-cancelTrainingJob\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-cancelTrainingJob\\\">ClusteringSolution - cancelTrainingJob()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Cancels a job for</span> a solution object <span class=\\\"ph\\\">that has been submitted for training.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to cancel an existing\\n training job.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mySolution = sn_ml.ClusteringSolutionStore.get('ml_sn_global_global_clustering');\\n\\nmySolution.cancelTrainingJob();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getActiveVersion\\\" id=\\\"ClusteringSol-getActiveVersion\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getActiveVersion\\\">ClusteringSolution - getActiveVersion()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the active</span> ClusteringSolutionVersion object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__2\\\">Active <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a> object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to get an\\n active</span>\\n <span class=\\\"keyword apiname\\\">ClusteringSolution</span>\\n <span class=\\\"ph\\\">version from the store and return its\\n training status.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getAllVersions\\\" id=\\\"ClusteringSol-getAllVersions\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getAllVersions\\\">ClusteringSolution - getAllVersions()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets all versions of</span> a clustering solution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getAllVersions__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__2\\\"><span class=\\\"ph\\\">Existing versions of a solution object.\\n See also</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a> API.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get all <span class=\\\"keyword apiname\\\">ClusteringSolution</span>\\n version objects and call the <span class=\\\"keyword apiname\\\">getVersionNumber()</span> and\\n <span class=\\\"keyword apiname\\\">getStatus()</span> solution version methods on them.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\\n\\nvar mlSolutionVersions = mlSolution.getAllVersions();\\n\\nfor (i = 0; i < mlSolutionVersions.length; i++) {\\ngs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\\\\n");\\n};</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\\n\\nVersion 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}\\n\\nVersion 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getLatestVersion\\\" id=\\\"ClusteringSol-getLatestVersion\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getLatestVersion\\\">ClusteringSolution - getLatestVersion()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the latest version of</span> a solution.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a>\\n <span class=\\\"ph\\\"> object corresponding to the latest\\n version of</span> a <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a>.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-getLatestVersion__mlsol-getLatestVersion-example\\\">The following example shows how to get the latest version of</span> a solution\\n and return its training status.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getName\\\" id=\\\"ClusteringSol-getName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getName\\\">ClusteringSolution - getName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the name of the object to use for interaction\\n with the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getName__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getName__table_pps_43z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getName__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getName__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getName__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getName__table_qps_43z_llb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getName__table_qps_43z_llb__entry__2\\\">Name of the solution object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to\\n update</span>\\n <span class=\\\"keyword apiname\\\">ClusteringSolution</span>\\n <span class=\\\"ph\\\">dataset information and print the name\\n of the object.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Update solution\\nvar myIncidentData = new sn_ml.DatasetDefinition({\\n 'tableName' : 'incident',\\n 'fieldNames' : ['category', 'short_description', 'priority'],\\n 'encodedQuery' : 'activeANYTHING'\\n});\\n\\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('clustering'));\\n\\nvar myCluster = new sn_ml.ClusteringSolution({\\n 'label': "my clustering solution",\\n 'dataset' : myIncidentData,\\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\\n 'predictedFieldName': 'category'\\n});\\n\\n// update solution\\nsn_ml.ClusteringSolutionStore.update('ml_x_snc_global_global_clustering_solution', myCluster);\\n\\n// print solution name\\ngs.print('Solution Name: '+myCluster.getName());</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Solution Name: ml_x_snc_global_global_clustering_solution</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getProperties\\\" id=\\\"ClusteringSol-getProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getProperties\\\">ClusteringSolution - getProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets solution object\\n properties</span>.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getProperties__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_pps_43z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getProperties__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\">Contents of the Dataset and <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a> object details in the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" class=\\\"xref\\\" title=\\\"Enables storing and retrieving solutions.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionStore</span></a>.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "algorithmConfig": {Object},\\n "datasetProperties": {Object},\\n "domainName": "String",\\n "encoder": {Object},\\n "groupByFieldName": "String",\\n "inputFieldNames": [Array],\\n "label": "String",\\n "minRecordsPerCluster" : Number,\\n "name": "String",\\n "processingLanguage": "String",\\n "scope": "String",\\n "stopwords": [Array],\\n "trainingFrequency": "String",\\n "updateFrequency": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">JavaScript object containing algorithm\\n configuration properties.</span> Property results vary by the value set in the <span class=\\\"keyword parmname\\\">algorithm</span>\\n property.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig' : {\\n "algorithm": "String", \\n // See algorithmConfig.algorithm setting description for property settings based on algorithm\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig.algorithm</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Method for\\n encoding your solution.</span>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">dbscan</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "dbscan",\\n "distanceMetric": "String",\\n "epsilon": Number,\\n "minimumNeighbours": Number\\n}</code></pre></div>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">kmeans</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "kmeans",\\n "targetCoverage": Number\\n}</code></pre></div>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig.distanceMetric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Distance metric to scan for similar data objects.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig.epsilon</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Decimal value between 0 and 1 representing the size of the\\n neighborhood search radius.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig.minimumNeighbours</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Minimum number of neighbors required in a point to be a part of a\\n cluster. For <span class=\\\"keyword parmname\\\">levenshteinDistance</span> the value must be 1 so that\\n no points are excluded from the dataset.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.algorithmConfig.targetCoverage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">K-means\\n algorithm only. Percentile field to filter out records that are less similar to\\n each other.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><p class=\\\"p\\\">Lists the properties of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html#DDef-DatasetDefinition_O\\\" class=\\\"xref\\\" title=\\\"Creates an instance of the DatasetDefinition class, enabling you to define a dataset by table name, fields, and query.\\\"><span class=\\\"keyword apiname\\\">DatasetDefinition()</span></a> object associated with the\\n solution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "encodedQuery": "String",\\n "fieldDetails": [Array],\\n "fieldNames": [Array],\\n "tableName": "String"\\n}</code></pre>\\n <p class=\\\"p\\\">Data type: Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Name of the table for the dataset. For\\n example, <code class=\\\"ph codeph\\\">"tableName" : "Incident"</code>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of field names from the specified table\\n as strings. For example, <code class=\\\"ph codeph\\\">"fieldNames" : ["short_description",\\n "priority"]</code>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of JavaScript objects that specify field\\n properties.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "name": "String",\\n "type": "String"\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Name of the field defining the type of\\n information to restrict this dataset to.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Machine-learning field type.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Encoded query string in standard Glide format.\\n See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\\\" class=\\\"xref\\\">Encoded query\\n strings</a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.encoderProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Encoder object assigned to this\\n solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.<p class=\\\"p\\\">Data type:\\n Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.groupByFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-getProperties__solution-obj-group-desc\\\">Field name by which\\n the system groups records into one or more clusters.</span>\\n <p class=\\\"p\\\">Data type:\\n String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "my first prediction"\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.minRecordsPerCluster</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Minimum number of records to allow in any cluster.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">System-assigned name.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.predictedFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Identifies a field to be trained for\\n predictability.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Processing language in two-letter ISO 639-1 language code format.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\">Object scope. Currently the only valid value is\\n <code class=\\\"ph codeph\\\">global</code>.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.trainingFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">The frequency to retrain the model.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-getProperties__ul_pmw_523_plb\\\">\\n <li class=\\\"li\\\">every_30_days</li>\\n <li class=\\\"li\\\">every_60_days</li>\\n <li class=\\\"li\\\">every_90_days</li>\\n <li class=\\\"li\\\">every_120_days</li>\\n <li class=\\\"li\\\">every_180_days</li>\\n <li class=\\\"li\\\">run_once</li>\\n </ul>Default: run_once</div>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__1\\\"><Object>.updateFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getProperties__table_qps_43z_llb__entry__2\\\"><span class=\\\"ph\\\">The frequency at which the model for\\n the solution definition must be rebuilt.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"ClusteringSol-getProperties__ul_kjm_2jh_3mb\\\">\\n <li class=\\\"li\\\">do_not_update</li>\\n <li class=\\\"li\\\">every_1_day</li>\\n <li class=\\\"li\\\">every_1_hour</li>\\n <li class=\\\"li\\\">every_6_hours</li>\\n <li class=\\\"li\\\">every_12_hours</li>\\n <li class=\\\"li\\\">every_1_minute</li>\\n <li class=\\\"li\\\">every_15_minutes</li>\\n <li class=\\\"li\\\">every_30_minutes</li>\\n </ul>Default: do_not_update</div>\\n <p class=\\\"p\\\">Datatype: String</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-getProperties__mlsol-getProps-example-other1\\\">The\\n following example gets properties of</span> a solution object <span class=\\\"ph\\\" id=\\\"ClusteringSol-getProperties__mlsol-getProps-example-other2\\\">in the store.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\ngs.print(JSON.stringify(JSON.parse(myCluster.getProperties()), null, 2));</code></pre>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">*** Script: {\\n "algorithmConfig": {\\n "algorithm": "kmeans",\\n "targetCoverage": "90"\\n },\\n "datasetProperties": {\\n "tableName": "incident",\\n "fieldNames": [\\n "category",\\n "short_description",\\n "state",\\n "description"\\n ],\\n "encodedQuery": "activeANYTHING"\\n },\\n "domainName": "global",\\n "encoderProperties": {\\n "datasetsProperties": [\\n {\\n "tableName": "incident",\\n "fieldNames": [\\n "assignment_group",\\n "short_description",\\n "description"\\n ],\\n "encodedQuery": "activeANYTHING"\\n }\\n ],\\n "domainName": "global",\\n "label": "my encoder definition",\\n "name": "ml_x_snc_global_global_my_encoder_definition",\\n "processingLanguage": "en",\\n "scope": "global",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "trainingFrequency": "run_once"\\n },\\n "groupByFieldName": "category",\\n "inputFieldNames": [\\n "short_description"\\n ],\\n "label": "clustering solution",\\n "minRecordsPerCluster": 2,\\n "name": "ml_x_snc_global_global_clustering_solution",\\n "processingLanguage": "en",\\n "scope": "global",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "trainingFrequency": "run_once",\\n "updateFrequency": "do_not_update"\\n}}</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-getVersion_S\\\" id=\\\"ClusteringSol-getVersion_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-getVersion_S\\\">ClusteringSolution - getVersion(String version)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets a solution <span class=\\\"ph\\\">by provided version number.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__1\\\">version</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getVersion_S__table_pps_43z_llb__entry__3\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-getVersion_S__mlsol-gerversion-returns-other\\\">Existing version number of</span> a solution.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-getVersion_S__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-getVersion_S__table_qps_43z_llb__entry__2\\\">Specified version of the <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a> object on which you can call\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a> API methods.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-getVersion_S__mlsol-gerversion-example-other\\\">The following example shows how to get the training status of</span> a solution\\n by version number.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "solution_complete",\\n "percentComplete": "100",\\n "hasJobEnded": "true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-setActiveVersion_S\\\" id=\\\"ClusteringSol-setActiveVersion_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-setActiveVersion_S\\\">ClusteringSolution - setActiveVersion(String version)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Activates a specified version of a\\n solution in the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__1\\\">version</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__3\\\">Name of the <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a> object version to activate.<p class=\\\"p\\\">Activating this version deactivates any other version.</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-setActiveVersion_S__mlsol-setActive-example1\\\">The\\n following example shows how to activate</span> a solution <span class=\\\"ph\\\" id=\\\"ClusteringSol-setActiveVersion_S__mlsol-setActive-example2\\\">version in the store.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">sn_ml.ClusteringSolution.setActiveVersion("ml_incident_categorization");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringSol-submitTrainingJob\\\" id=\\\"ClusteringSol-submitTrainingJob\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringSol-submitTrainingJob\\\">ClusteringSolution - submitTrainingJob()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Submits a training job.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Before running this method, you must first add a solution to the store using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html#ClusteringStore-add_O\\\" class=\\\"xref\\\" title=\\\"Adds a new solution object to the store and returns a unique name.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionStore - add()</span></a> method.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span></a>\\n <span class=\\\"ph\\\">object corresponding to the</span>\\n <a class=\\\"xref\\\" href=\\\"#ClusteringSol-ClusteringSolution_O\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution</span></a>\\n <span class=\\\"ph\\\">being trained.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\" id=\\\"ClusteringSol-submitTrainingJob__mlsol-submit-example-nonSol1\\\">The\\n following example shows how to create a dataset, apply it to</span> a solution,\\n add the solution <span class=\\\"ph\\\" id=\\\"ClusteringSol-submitTrainingJob__mlsol-submit-example-nonSol2\\\">to a store, and submit the\\n training job.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Create a dataset \\nvar myData = new sn_ml.DatasetDefinition({\\n\\n 'tableName' : 'incident',\\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\\n 'encodedQuery' : 'activeANYTHING'\\n\\n});\\n\\n// get a trained encoder from the store\\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\\n\\n// Create a solution \\nvar mySolution = new sn_ml.ClusteringSolution({\\n\\n 'label': "my solution definition",\\n 'dataset' : myData,\\n 'encoder' : myEncoder,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames':['short_description']\\n\\n});\\n\\n// Add the solution to the store to later be able to retrieve it.\\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\\n\\n// Train the solution - this is a long running job \\nvar myClusterVersion = mySolution.submitTrainingJob();</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolution - Global\n\nThe ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThe solution setup-to-training flow is as follows:\n\n1. Create a dataset using the DatasetDefinition API.\n2. Mandatory if using the K-means clustering algorithm. Build an encoder using the Encoder API.\n3. Use the constructor to create a clustering solution object.\n4. Add the solution object to the clustering solution store using the ClusteringSolutionStore - add() method.\n5. Train the solution using the submitTrainingJob() method. This creates a version of the\n object that you can manage using the ClusteringSolutionVersion API.\n6. Get predictions using the ClusteringSolutionVersion – predict() method.\n\nNote: This API runs with full\nprivileges. To restrict user access, include an access control mechanism in the\nscript.\n\nFor usage guidelines, refer to Using ML APIs.\n\n## ClusteringSolution - ClusteringSolution(Object config)\n\nCreates a cluster solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| config | Object | JavaScript object containing configuration properties of the solution. ```None { \"algorithmConfig\": {Object}, \"clusterConcept\": \"String\", \"clusterConceptFieldNames\": [Array], \"dataset\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"groupUnclusteredRecords\": Boolean, \"inputFieldNames\": [Array], \"label\": \"String\", \"maxTimeWindowForUpdate\" : Number, \"minRecordsPerCluster\" : Number, \"minRowCount\": \"String\", \"processingLanguage\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\" } ``` |\n| config.algorithmConfig | Object | Required unless setting the encoder property. JavaScript object containing algorithm configuration properties. Property settings vary by the value set in the algorithm property. ```None 'algorithmConfig': { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` |\n| config.algorithmConfig.algorithm | String | Method for encoding your solution. Valid values: * dbscan – Density-Based Spatial Clustering of Applications with Noise (DBSCAN) clustering algorithm. Properties used with this algorithm: + distanceMetric + epsilon + minimumNeighbours * hdbscan – Hierarchical Density Based Spatial Clustering of Applications with Noise (HDBSCAN) clustering algorithm. Properties used with this algorithm: + minimumSamples * kmeans – K-means clustering algorithm. Default. The targetCoverage property is used with this algorithm. Some users prefer DBSCAN because it doesn't require you to specify the number of clusters in the data before clustering. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for hdbscan: ```None 'algorithmConfig': { \"algorithm\": \"hdbscan\", \"minimumSamples\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` |\n| config.algorithmConfig.distanceMetric | String | DBSCAN algorithm only. Distance metric to scan for similar data objects. Valid values: levenshteinDistance |\n| config.algorithmConfig.epsilon | Number | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. |\n| config.algorithmConfig.minimumNeighbours | Number | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. |\n| config.algorithmConfig.minimumSamples | Number | Minimum number of data samples in a neighborhood required to determine if a point is a core point. Default: None |\n| config.algorithmConfig.targetCoverage | Number | K-means algorithm only. Percentile field to filter out records that are less similar to each other. |\n| config.clusterConcept | String | Optional. Concept type. A concept is a set of words listed in descending order of frequency. To generate a TFIDF-based cluster concept, set the value to `tfidf`. Concept types are listed in the Clustering Definitions [ml\\_capability\\_definition\\_clustering] table. Default: Frequency-based cluster concept |\n| config.clusterConceptFieldNames | Array | Optional. List of cluster concept field names. These values are external columns for creating a cluster concept and not used for cluster solution training. If external columns are provided, those columns are only used for the cluster concept and not for clustering solution training. Cluster concept fields are listed in the Clustering Definitions [ml\\_capability\\_definition\\_clustering] table. Default: Input text columns generate the cluster concept |\n| config.dataset | Object | DatasetDefinition object name. |\n| config.domainName | String | Optional. Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Default: Current domain, for example, `\"global\"`. |\n| config.encoder | Object | Required unless setting the algorithmConfig property to `\"levenshteinDistance\"`. Trained encoder object to assign to this solution. See Encoder - Encoder(Object config). |\n| config.groupByFieldName | String | Optional. Field name by which the system groups records into one or more clusters. In the following setup example, the system groups each type into an individual cluster, rendering 10 clusters. * groupByFieldName value is `'category'` * DatasetDefinition tableName value is `'incident'` * Incident [incident] table has 10 category types |\n| config.groupUnclusteredRecords | Boolean | Flag that indicates whether to group unclustered records in results. Valid values: * true: Group unclustered records separately in results. * false: Do not group unclustered records in results. Unclustered values (-1) display with the rest of the results. Default: false |\n| config.inputFieldNames | Array | List of input field names as strings. The model uses these fields used to make predictions. |\n| config.label | String | Identifies the prediction task. |\n| config.maxTimeWindowForUpdate | Number | Optional. Number of minutes preceding the model update point to look for records. For example, if the value is 15, the system only looks for records created in the preceding 15 minutes. By default, the system scans all records. |\n| config.minRecordsPerCluster | Number | Optional. Minimum number of records to allow in any cluster. The value must be greater than or equal to 2. Default: 2 |\n| config.minRowCount | String | Optional. Minimum number of records required in the dataset for training. Default: 10000 |\n| config.processingLanguage | String | Processing language in two-letter ISO 639-1 language code format. |\n| config.stopwords | Array | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Default: English Stopwords |\n| config.trainingFrequency | String | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once |\n| config.updateFrequency | | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update |\n\n### Example\n\nThe following example shows how to create an object\nand add it to the ClusteringSolution store. The example also shows how to submit the object for\ntraining.\n\n```None\ntry{\n var myData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'state', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n });\n\n // get a trained encoder from the store\n var myEncoder = sn_ml.EncoderStore.get('<encoder_name >');\n \n var mySolution = new sn_ml.ClusteringSolution({\n 'label': \"clustering solution\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'inputFieldNames':['short_description'], \n 'groupByFieldName' : 'category', \n 'algorithmConfig' : {\n 'algorithm' : 'kmeans',\n 'targetCoverage' : '90'\n }\n });\n \n // add solution\n var solutionName = sn_ml.ClusteringSolutionStore.add(mySolution);\n var solutionVersion = mySolution.submitTrainingJob(); \n var trainingStatus = solutionVersion.getStatus();\n gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n\n} catch(ex){\n gs.print('Exception caught: '+ ex.getMessage());\n}\n```\n\nOutput:\n\n```None\n{\n \"state\": \"waiting_for_training\",\n \"percentComplete\": \"0\",\n \"hasJobEnded\": \"false\"\n}\n```\n\n### Example\n\nThe following example shows how to include the 'description' field as a cluster concept\nfield.\n\n```None\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'description'],\n});\n\nvar encodersolutionName = sn_ml.EncoderStore.get('<encoder_name >');\n\nvar mySolution = new sn_ml.ClusteringSolution({\n\t'label': 'clustering_test',\n\t'dataset': myIncidentData,\n\t'inputFieldNames': ['short_description'],\n\t'encoder': encodersolutionName,\n\t'clusterConceptFieldNames': ['description']\n});\n\nvar solutionNameFromStore = sn_ml.ClusteringSolutionStore.add(mySolution);\nvar myClassifier = mySolution.submitTrainingJob(); \n```\n\n## ClusteringSolution - cancelTrainingJob()\n\nCancels a job for a solution object that has been submitted for training.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an existing\ntraining job.\n\n```None\nvar mySolution = sn_ml.ClusteringSolutionStore.get('ml_sn_global_global_clustering');\n\nmySolution.cancelTrainingJob();\n```\n\n## ClusteringSolution - getActiveVersion()\n\nGets the active ClusteringSolutionVersion object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Active ClusteringSolutionVersion object. |\n\n### Example\n\nThe following example shows how to get an\nactive\nClusteringSolution\nversion from the store and return its\ntraining status.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - getAllVersions()\n\nGets all versions of a clustering solution.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| Array | Existing versions of a solution object. See also ClusteringSolutionVersion API. |\n\n### Example\n\nThe following example shows how to get all ClusteringSolution\nversion objects and call the getVersionNumber() and\ngetStatus() solution version methods on them.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print(\"Version \" + mlSolutionVersions[i].getVersionNumber() + \" Status: \" + mlSolutionVersions[i].getStatus() +\"\\n\");\n};\n```\n\nOutput:\n\n```None\nVersion 3 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 2 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 1 Status: {\"state\":\"solution_cancelled\",\"percentComplete\":\"0\",\"hasJobEnded\":\"true\"}\n```\n\n## ClusteringSolution - getLatestVersion()\n\nGets the latest version of a solution.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolutionVersion object corresponding to the latest version of a ClusteringSolution(). |\n\n### Example\n\nThe following example shows how to get the latest version of a solution\nand return its training status.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - getName()\n\nGets the name of the object to use for interaction\nwith the store.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the solution object. |\n\n### Example\n\nThe following example shows how to\nupdate\nClusteringSolution\ndataset information and print the name\nof the object.\n\n```None\n// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('clustering'));\n\nvar myCluster = new sn_ml.ClusteringSolution({\n 'label': \"my clustering solution\",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.ClusteringSolutionStore.update('ml_x_snc_global_global_clustering_solution', myCluster);\n\n// print solution name\ngs.print('Solution Name: '+myCluster.getName());\n```\n\nOutput:\n\n```None\nSolution Name: ml_x_snc_global_global_clustering_solution\n```\n\n## ClusteringSolution - getProperties()\n\nGets solution object\nproperties.\n\nTable 12. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 13. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClusteringSolution() object details in the ClusteringSolutionStore. ```None { \"algorithmConfig\": {Object}, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"label\": \"String\", \"minRecordsPerCluster\" : Number, \"name\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\" } ``` |\n| <Object>.algorithmConfig | JavaScript object containing algorithm configuration properties. Property results vary by the value set in the algorithm property. ```None 'algorithmConfig' : { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Method for encoding your solution. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` Data type: String. |\n| <Object>.algorithmConfig.distanceMetric | DBSCAN algorithm only. Distance metric to scan for similar data objects. Data type: String. |\n| <Object>.algorithmConfig.epsilon | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. Data type: Number. |\n| <Object>.algorithmConfig.minimumNeighbours | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. Data type: Number. |\n| <Object>.algorithmConfig.targetCoverage | K-means algorithm only. Percentile field to filter out records that are less similar to each other. Data type: Number. |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoderProperties | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.groupByFieldName | Field name by which the system groups records into one or more clusters. Data type: String |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.minRecordsPerCluster | Minimum number of records to allow in any cluster. Data type: Number. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.updateFrequency | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update Datatype: String |\n\n### Example\n\nThe\nfollowing example gets properties of a solution object in the store.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\ngs.print(JSON.stringify(JSON.parse(myCluster.getProperties()), null, 2));\n```\nOutput:\n```None\n*** Script: {\n \"algorithmConfig\": {\n \"algorithm\": \"kmeans\",\n \"targetCoverage\": \"90\"\n },\n \"datasetProperties\": {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"category\",\n \"short_description\",\n \"state\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [\n {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"assignment_group\",\n \"short_description\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n }\n ],\n \"domainName\": \"global\",\n \"label\": \"my encoder definition\",\n \"name\": \"ml_x_snc_global_global_my_encoder_definition\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"run_once\"\n },\n \"groupByFieldName\": \"category\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"label\": \"clustering solution\",\n \"minRecordsPerCluster\": 2,\n \"name\": \"ml_x_snc_global_global_clustering_solution\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"run_once\",\n \"updateFrequency\": \"do_not_update\"\n}}\n```\n\n## ClusteringSolution - getVersion(String version)\n\nGets a solution by provided version number.\n\nTable 14. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Existing version number of a solution. |\n\nTable 15. Returns\n| Type | Description |\n| --- | --- |\n| Object | Specified version of the ClusteringSolution() object on which you can call ClusteringSolutionVersion API methods. |\n\n### Example\n\nThe following example shows how to get the training status of a solution\nby version number.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - setActiveVersion(String version)\n\nActivates a specified version of a\nsolution in the store.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Name of the ClusteringSolution() object version to activate. Activating this version deactivates any other version. |\n\nTable 17. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe\nfollowing example shows how to activate a solution version in the store.\n\n```None\nsn_ml.ClusteringSolution.setActiveVersion(\"ml_incident_categorization\");\n```\n\n## ClusteringSolution - submitTrainingJob()\n\nSubmits a training job.\n\nNote: Before running this method, you must first add a solution to the store using the ClusteringSolutionStore - add() method.\n\nTable 18. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 19. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolutionVersion object corresponding to the ClusteringSolution being trained. |\n\n### Example\n\nThe\nfollowing example shows how to create a dataset, apply it to a solution,\nadd the solution to a store, and submit the\ntraining job.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myClusterVersion = mySolution.submitTrainingJob();\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ClusteringSolution - Global\ndescription: The ClusteringSolution API is a scriptable object used in Predictive\n Intelligence stores.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolution - Global\n\nThe ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThe solution setup-to-training flow is as follows:\n\n1. Create a dataset using the DatasetDefinition API.\n2. Mandatory if using the K-means clustering algorithm. Build an encoder using the Encoder API.\n3. Use the constructor to create a clustering solution object.\n4. Add the solution object to the clustering solution store using the ClusteringSolutionStore - add() method.\n5. Train the solution using the submitTrainingJob() method. This creates a version of the\n object that you can manage using the ClusteringSolutionVersion API.\n6. Get predictions using the ClusteringSolutionVersion – predict() method.\n\nNote: This API runs with full\nprivileges. To restrict user access, include an access control mechanism in the\nscript.\n\nFor usage guidelines, refer to Using ML APIs.\n\n## ClusteringSolution - ClusteringSolution(Object config)\n\nCreates a cluster solution.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| config | Object | JavaScript object containing configuration properties of the solution. ```None { \"algorithmConfig\": {Object}, \"clusterConcept\": \"String\", \"clusterConceptFieldNames\": [Array], \"dataset\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"groupUnclusteredRecords\": Boolean, \"inputFieldNames\": [Array], \"label\": \"String\", \"maxTimeWindowForUpdate\" : Number, \"minRecordsPerCluster\" : Number, \"minRowCount\": \"String\", \"processingLanguage\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\" } ``` |\n| config.algorithmConfig | Object | Required unless setting the encoder property. JavaScript object containing algorithm configuration properties. Property settings vary by the value set in the algorithm property. ```None 'algorithmConfig': { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` |\n| config.algorithmConfig.algorithm | String | Method for encoding your solution. Valid values: * dbscan – Density-Based Spatial Clustering of Applications with Noise (DBSCAN) clustering algorithm. Properties used with this algorithm: + distanceMetric + epsilon + minimumNeighbours * hdbscan – Hierarchical Density Based Spatial Clustering of Applications with Noise (HDBSCAN) clustering algorithm. Properties used with this algorithm: + minimumSamples * kmeans – K-means clustering algorithm. Default. The targetCoverage property is used with this algorithm. Some users prefer DBSCAN because it doesn't require you to specify the number of clusters in the data before clustering. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for hdbscan: ```None 'algorithmConfig': { \"algorithm\": \"hdbscan\", \"minimumSamples\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` |\n| config.algorithmConfig.distanceMetric | String | DBSCAN algorithm only. Distance metric to scan for similar data objects. Valid values: levenshteinDistance |\n| config.algorithmConfig.epsilon | Number | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. |\n| config.algorithmConfig.minimumNeighbours | Number | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. |\n| config.algorithmConfig.minimumSamples | Number | Minimum number of data samples in a neighborhood required to determine if a point is a core point. Default: None |\n| config.algorithmConfig.targetCoverage | Number | K-means algorithm only. Percentile field to filter out records that are less similar to each other. |\n| config.clusterConcept | String | Optional. Concept type. A concept is a set of words listed in descending order of frequency. To generate a TFIDF-based cluster concept, set the value to `tfidf`. Concept types are listed in the Clustering Definitions [ml\\_capability\\_definition\\_clustering] table. Default: Frequency-based cluster concept |\n| config.clusterConceptFieldNames | Array | Optional. List of cluster concept field names. These values are external columns for creating a cluster concept and not used for cluster solution training. If external columns are provided, those columns are only used for the cluster concept and not for clustering solution training. Cluster concept fields are listed in the Clustering Definitions [ml\\_capability\\_definition\\_clustering] table. Default: Input text columns generate the cluster concept |\n| config.dataset | Object | DatasetDefinition object name. |\n| config.domainName | String | Optional. Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Default: Current domain, for example, `\"global\"`. |\n| config.encoder | Object | Required unless setting the algorithmConfig property to `\"levenshteinDistance\"`. Trained encoder object to assign to this solution. See Encoder - Encoder(Object config). |\n| config.groupByFieldName | String | Optional. Field name by which the system groups records into one or more clusters. In the following setup example, the system groups each type into an individual cluster, rendering 10 clusters. * groupByFieldName value is `'category'` * DatasetDefinition tableName value is `'incident'` * Incident [incident] table has 10 category types |\n| config.groupUnclusteredRecords | Boolean | Flag that indicates whether to group unclustered records in results. Valid values: * true: Group unclustered records separately in results. * false: Do not group unclustered records in results. Unclustered values (-1) display with the rest of the results. Default: false |\n| config.inputFieldNames | Array | List of input field names as strings. The model uses these fields used to make predictions. |\n| config.label | String | Identifies the prediction task. |\n| config.maxTimeWindowForUpdate | Number | Optional. Number of minutes preceding the model update point to look for records. For example, if the value is 15, the system only looks for records created in the preceding 15 minutes. By default, the system scans all records. |\n| config.minRecordsPerCluster | Number | Optional. Minimum number of records to allow in any cluster. The value must be greater than or equal to 2. Default: 2 |\n| config.minRowCount | String | Optional. Minimum number of records required in the dataset for training. Default: 10000 |\n| config.processingLanguage | String | Processing language in two-letter ISO 639-1 language code format. |\n| config.stopwords | Array | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Default: English Stopwords |\n| config.trainingFrequency | String | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once |\n| config.updateFrequency | | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update |\n\n### Example\n\nThe following example shows how to create an object\nand add it to the ClusteringSolution store. The example also shows how to submit the object for\ntraining.\n\n```None\ntry{\n var myData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'state', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n });\n\n // get a trained encoder from the store\n var myEncoder = sn_ml.EncoderStore.get('<encoder_name >');\n \n var mySolution = new sn_ml.ClusteringSolution({\n 'label': \"clustering solution\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'inputFieldNames':['short_description'], \n 'groupByFieldName' : 'category', \n 'algorithmConfig' : {\n 'algorithm' : 'kmeans',\n 'targetCoverage' : '90'\n }\n });\n \n // add solution\n var solutionName = sn_ml.ClusteringSolutionStore.add(mySolution);\n var solutionVersion = mySolution.submitTrainingJob(); \n var trainingStatus = solutionVersion.getStatus();\n gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n\n} catch(ex){\n gs.print('Exception caught: '+ ex.getMessage());\n}\n```\n\nOutput:\n\n```None\n{\n \"state\": \"waiting_for_training\",\n \"percentComplete\": \"0\",\n \"hasJobEnded\": \"false\"\n}\n```\n\n### Example\n\nThe following example shows how to include the 'description' field as a cluster concept\nfield.\n\n```None\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'description'],\n});\n\nvar encodersolutionName = sn_ml.EncoderStore.get('<encoder_name >');\n\nvar mySolution = new sn_ml.ClusteringSolution({\n\t'label': 'clustering_test',\n\t'dataset': myIncidentData,\n\t'inputFieldNames': ['short_description'],\n\t'encoder': encodersolutionName,\n\t'clusterConceptFieldNames': ['description']\n});\n\nvar solutionNameFromStore = sn_ml.ClusteringSolutionStore.add(mySolution);\nvar myClassifier = mySolution.submitTrainingJob(); \n```\n\n## ClusteringSolution - cancelTrainingJob()\n\nCancels a job for a solution object that has been submitted for training.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an existing\ntraining job.\n\n```None\nvar mySolution = sn_ml.ClusteringSolutionStore.get('ml_sn_global_global_clustering');\n\nmySolution.cancelTrainingJob();\n```\n\n## ClusteringSolution - getActiveVersion()\n\nGets the active ClusteringSolutionVersion object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Active ClusteringSolutionVersion object. |\n\n### Example\n\nThe following example shows how to get an\nactive\nClusteringSolution\nversion from the store and return its\ntraining status.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - getAllVersions()\n\nGets all versions of a clustering solution.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| Array | Existing versions of a solution object. See also ClusteringSolutionVersion API. |\n\n### Example\n\nThe following example shows how to get all ClusteringSolution\nversion objects and call the getVersionNumber() and\ngetStatus() solution version methods on them.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\nvar mlSolutionVersions = mlSolution.getAllVersions();\n\nfor (i = 0; i < mlSolutionVersions.length; i++) {\ngs.print(\"Version \" + mlSolutionVersions[i].getVersionNumber() + \" Status: \" + mlSolutionVersions[i].getStatus() +\"\\n\");\n};\n```\n\nOutput:\n\n```None\nVersion 3 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 2 Status: {\"state\":\"solution_complete\",\"percentComplete\":\"100\",\"hasJobEnded\":\"true\"}\n\nVersion 1 Status: {\"state\":\"solution_cancelled\",\"percentComplete\":\"0\",\"hasJobEnded\":\"true\"}\n```\n\n## ClusteringSolution - getLatestVersion()\n\nGets the latest version of a solution.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolutionVersion object corresponding to the latest version of a ClusteringSolution(). |\n\n### Example\n\nThe following example shows how to get the latest version of a solution\nand return its training status.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - getName()\n\nGets the name of the object to use for interaction\nwith the store.\n\nTable 10. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 11. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the solution object. |\n\n### Example\n\nThe following example shows how to\nupdate\nClusteringSolution\ndataset information and print the name\nof the object.\n\n```None\n// Update solution\nvar myIncidentData = new sn_ml.DatasetDefinition({\n 'tableName' : 'incident',\n 'fieldNames' : ['category', 'short_description', 'priority'],\n 'encodedQuery' : 'activeANYTHING'\n});\n\nvar eligibleFields = JSON.parse(myIncidentData.getEligibleFields('clustering'));\n\nvar myCluster = new sn_ml.ClusteringSolution({\n 'label': \"my clustering solution\",\n 'dataset' : myIncidentData,\n 'inputFieldNames': eligibleFields['eligibleInputFieldNames'],\n 'predictedFieldName': 'category'\n});\n\n// update solution\nsn_ml.ClusteringSolutionStore.update('ml_x_snc_global_global_clustering_solution', myCluster);\n\n// print solution name\ngs.print('Solution Name: '+myCluster.getName());\n```\n\nOutput:\n\n```None\nSolution Name: ml_x_snc_global_global_clustering_solution\n```\n\n## ClusteringSolution - getProperties()\n\nGets solution object\nproperties.\n\nTable 12. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 13. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClusteringSolution() object details in the ClusteringSolutionStore. ```None { \"algorithmConfig\": {Object}, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"label\": \"String\", \"minRecordsPerCluster\" : Number, \"name\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\" } ``` |\n| <Object>.algorithmConfig | JavaScript object containing algorithm configuration properties. Property results vary by the value set in the algorithm property. ```None 'algorithmConfig' : { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Method for encoding your solution. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` Data type: String. |\n| <Object>.algorithmConfig.distanceMetric | DBSCAN algorithm only. Distance metric to scan for similar data objects. Data type: String. |\n| <Object>.algorithmConfig.epsilon | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. Data type: Number. |\n| <Object>.algorithmConfig.minimumNeighbours | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. Data type: Number. |\n| <Object>.algorithmConfig.targetCoverage | K-means algorithm only. Percentile field to filter out records that are less similar to each other. Data type: Number. |\n| <Object>.datasetProperties | Lists the properties of the DatasetDefinition() object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| <Object>.encoderProperties | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| <Object>.groupByFieldName | Field name by which the system groups records into one or more clusters. Data type: String |\n| <Object>.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.minRecordsPerCluster | Minimum number of records to allow in any cluster. Data type: Number. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.predictedFieldName | Identifies a field to be trained for predictability. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.updateFrequency | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update Datatype: String |\n\n### Example\n\nThe\nfollowing example gets properties of a solution object in the store.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\ngs.print(JSON.stringify(JSON.parse(myCluster.getProperties()), null, 2));\n```\nOutput:\n```None\n*** Script: {\n \"algorithmConfig\": {\n \"algorithm\": \"kmeans\",\n \"targetCoverage\": \"90\"\n },\n \"datasetProperties\": {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"category\",\n \"short_description\",\n \"state\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [\n {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"assignment_group\",\n \"short_description\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n }\n ],\n \"domainName\": \"global\",\n \"label\": \"my encoder definition\",\n \"name\": \"ml_x_snc_global_global_my_encoder_definition\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"run_once\"\n },\n \"groupByFieldName\": \"category\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"label\": \"clustering solution\",\n \"minRecordsPerCluster\": 2,\n \"name\": \"ml_x_snc_global_global_clustering_solution\",\n \"processingLanguage\": \"en\",\n \"scope\": \"global\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"trainingFrequency\": \"run_once\",\n \"updateFrequency\": \"do_not_update\"\n}}\n```\n\n## ClusteringSolution - getVersion(String version)\n\nGets a solution by provided version number.\n\nTable 14. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Existing version number of a solution. |\n\nTable 15. Returns\n| Type | Description |\n| --- | --- |\n| Object | Specified version of the ClusteringSolution() object on which you can call ClusteringSolutionVersion API methods. |\n\n### Example\n\nThe following example shows how to get the training status of a solution\nby version number.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\": \"solution_complete\",\n \"percentComplete\": \"100\",\n \"hasJobEnded\": \"true\"\n}\n```\n\n## ClusteringSolution - setActiveVersion(String version)\n\nActivates a specified version of a\nsolution in the store.\n\nTable 16. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| version | String | Name of the ClusteringSolution() object version to activate. Activating this version deactivates any other version. |\n\nTable 17. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe\nfollowing example shows how to activate a solution version in the store.\n\n```None\nsn_ml.ClusteringSolution.setActiveVersion(\"ml_incident_categorization\");\n```\n\n## ClusteringSolution - submitTrainingJob()\n\nSubmits a training job.\n\nNote: Before running this method, you must first add a solution to the store using the ClusteringSolutionStore - add() method.\n\nTable 18. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 19. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolutionVersion object corresponding to the ClusteringSolution being trained. |\n\n### Example\n\nThe\nfollowing example shows how to create a dataset, apply it to a solution,\nadd the solution to a store, and submit the\ntraining job.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\n\n// Train the solution - this is a long running job \nvar myClusterVersion = mySolution.submitTrainingJob();\n```\n"}}},{"rowIdx":1687,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ClusteringSolutionStore - Global"},"description":{"kind":"string","value":"Enables storing and retrieving solutions."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_ClusteringSolutionStoreAPI\"><article class=\"nested0\" aria-labelledby=\"title_ClusteringSolutionStoreAPI\" id=\"ClusteringSolutionStoreAPI\">\n <h1 class=\"title topictitle1\" id=\"title_ClusteringSolutionStoreAPI\">ClusteringSolutionStore <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\"><span class=\"ph\">\n <span class=\"ph\" id=\"ClusteringSolutionStoreAPI__mlstore-concept-sdesc-e\">Enables storing\n and retrieving</span> solutions.</span></p>\n <p class=\"p\">The <span class=\"keyword apiname\">ClusteringSolutionStore</span>\n <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringStore-add_O\" id=\"ClusteringStore-add_O\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringStore-add_O\">ClusteringSolutionStore - add(Object mlSolution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Adds a new solution <span class=\"ph\" id=\"ClusteringStore-add_O__mlstore-add-sdesc-e\">object to the store and returns a unique name.</span>\n </span></p>\n <section class=\"section\">\n <div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Label values do not need to be unique. For example, if you run this method\n with the same label 10 times, this method adds 10 different uniquely-named\n objects to the store.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringStore-add_O__table_vwy_1fr_llb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__1\">mlSolution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" class=\"xref\" title=\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\">ClusteringSolution</a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\" class=\"xref\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a>\n <span class=\"ph\">object to add to the store.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringStore-add_O__table_wwy_1fr_llb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__2\">System-generated solution name.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example\n shows how to add</span> a solution <span class=\"ph\">to the\n store.</span> Use <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-submitTrainingJob\" class=\"xref\" title=\"Submits a training job.\"><span class=\"keyword apiname\">ClusteringSolution - submitTrainingJob()</span></a>\n <span class=\"ph\">to run the training job after adding it to the\n store.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': "my solution definition",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringStore-deleteObject_S\" id=\"ClusteringStore-deleteObject_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringStore-deleteObject_S\">ClusteringSolutionStore - deleteObject(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Removes a specified solution object from the\n store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__3\">Name of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\" class=\"xref\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a>\n <span class=\"ph\">object to be deleted.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringStore-deleteObject_S__table_smj_lfr_llb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to delete a solution\n from the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">sn_ml.ClusteringSolutionStore.deleteObject("ml_sn_global_global_solution");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringStore-get_S\" id=\"ClusteringStore-get_S\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringStore-get_S\">ClusteringSolutionStore - get(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets a solution object from the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringStore-get_S__table_zvw_v2r_llb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__3\">Name of a solution in the store.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringStore-get_S__table_aww_v2r_llb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-get_S__table_aww_v2r_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-get_S__table_aww_v2r_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-get_S__table_aww_v2r_llb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-get_S__table_aww_v2r_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" class=\"xref\" title=\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolution</span></a>\n <span class=\"ph\">object. Returns an error if the object does not\n exist.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">The following example shows how to get a solution\n object from the store using the <span class=\"keyword apiname\">get()</span> method and view its\n training status using the</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getActiveVersion\" class=\"xref\" title=\"Gets the active ClusteringSolutionVersion object.\">ClusteringSolution - getActiveVersion()</a> and\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html#C-getStatus_B\" class=\"xref\" title=\"Gets training completion status.\">ClusteringSolutionVersion - getStatus()</a> methods.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_complete",\n "percentComplete":"100",\n "hasJobEnded":"true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringStore-getAllNames\" id=\"ClusteringStore-getAllNames\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringStore-getAllNames\">ClusteringSolutionStore - getAllNames(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the names of all solution definition\n records in the store.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Options for restricting results within the specified\n properties.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "String",\n "domainName": "String",\n "scope": "String"\n};</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Label of your solution object.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Name of the domain for your solution object. Refer to <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\">options.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\">Optional. Name of an <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_ApplicationScope&version=vancouver&pubname=vancouver-application-development\" class=\"xref\">application scope</a> for\n your solution object.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringStore-getAllNames__table_aww_v2r_llb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__2\">List of strings representing solution object\n names in the store.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, the\n <span class=\"keyword apiname\">getAllNames()</span> method returns a list of all names in the\n store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">gs.print(JSON.stringify(JSON.parse(sn_ml.ClusteringSolutionStore.getAllNames()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n "ml_x_snc_global_global_clustering_solution_1",\n "ml_x_snc_global_global_clustering_solution"\n]</code></pre>\n </div>\n <div class=\"example\" id=\"ClusteringStore-getAllNames__example_jzt_l5h_wnb\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">In the following example, the\n <span class=\"keyword apiname\">getAllNames()</span> method returns only names associated with\n values set in the <span class=\"keyword parmname\">options</span> parameter.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.ClusteringSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n "ml_x_snc_global_global_my_solution_definition"\n]</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_ClusteringStore-update_S_O\" id=\"ClusteringStore-update_S_O\">\n <h2 class=\"title topictitle2\" id=\"title_ClusteringStore-update_S_O\">ClusteringSolutionStore - update(String name, Object mlSolution)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Replaces an existing object in the store with the\n object passed as a parameter. The object name provided must be empty or\n match.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"ClusteringStore-update_S_O__table_v5p_wxr_llb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:20%\"/><col style=\"width:20%\"/><col style=\"width:60%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\">Name of the solution to update.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\">mlSolution</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" class=\"xref\" title=\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\"><span class=\"keyword apiname\">ClusteringSolution</span></a></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\" class=\"xref\" title=\"Creates a cluster solution.\"><span class=\"keyword apiname\">ClusteringSolution()</span></a>\n <span class=\"ph\">object properties to update.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"ClusteringStore-update_S_O__table_w5p_wxr_llb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to update a solution\n object in the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var solutionUpdate = new sn_ml.ClusteringSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.ClusteringSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ClusteringSolutionStore - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205440\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205440\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"ClusteringSolutionStoreAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"Enables storing and retrieving solutions.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\",\n \"page_key\": 41205440,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 5055,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 547\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ClusteringSolutionStore - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_ClusteringSolutionStoreAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_ClusteringSolutionStoreAPI\\\" id=\\\"ClusteringSolutionStoreAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_ClusteringSolutionStoreAPI\\\">ClusteringSolutionStore <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">\\n <span class=\\\"ph\\\" id=\\\"ClusteringSolutionStoreAPI__mlstore-concept-sdesc-e\\\">Enables storing\\n and retrieving</span> solutions.</span></p>\\n <p class=\\\"p\\\">The <span class=\\\"keyword apiname\\\">ClusteringSolutionStore</span>\\n <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringStore-add_O\\\" id=\\\"ClusteringStore-add_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringStore-add_O\\\">ClusteringSolutionStore - add(Object mlSolution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Adds a new solution <span class=\\\"ph\\\" id=\\\"ClusteringStore-add_O__mlstore-add-sdesc-e\\\">object to the store and returns a unique name.</span>\\n </span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Label values do not need to be unique. For example, if you run this method\\n with the same label 10 times, this method adds 10 different uniquely-named\\n objects to the store.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringStore-add_O__table_vwy_1fr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__1\\\">mlSolution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\\\">ClusteringSolution</a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-add_O__table_vwy_1fr_llb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a>\\n <span class=\\\"ph\\\">object to add to the store.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringStore-add_O__table_wwy_1fr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-add_O__table_wwy_1fr_llb__entry__2\\\">System-generated solution name.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example\\n shows how to add</span> a solution <span class=\\\"ph\\\">to the\\n store.</span> Use <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-submitTrainingJob\\\" class=\\\"xref\\\" title=\\\"Submits a training job.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution - submitTrainingJob()</span></a>\\n <span class=\\\"ph\\\">to run the training job after adding it to the\\n store.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Create a dataset \\nvar myData = new sn_ml.DatasetDefinition({\\n\\n 'tableName' : 'incident',\\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\\n 'encodedQuery' : 'activeANYTHING'\\n\\n});\\n\\n// get a trained encoder from the store\\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\\n\\n// Create a solution \\nvar mySolution = new sn_ml.ClusteringSolution({\\n\\n 'label': "my solution definition",\\n 'dataset' : myData,\\n 'encoder' : myEncoder,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames':['short_description']\\n\\n});\\n\\n// Add the solution to the store to later be able to retrieve it.\\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringStore-deleteObject_S\\\" id=\\\"ClusteringStore-deleteObject_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringStore-deleteObject_S\\\">ClusteringSolutionStore - deleteObject(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Removes a specified solution object from the\\n store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-deleteObject_S__table_rmj_lfr_llb__entry__3\\\">Name of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a>\\n <span class=\\\"ph\\\">object to be deleted.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringStore-deleteObject_S__table_smj_lfr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-deleteObject_S__table_smj_lfr_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to delete a solution\\n from the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">sn_ml.ClusteringSolutionStore.deleteObject("ml_sn_global_global_solution");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringStore-get_S\\\" id=\\\"ClusteringStore-get_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringStore-get_S\\\">ClusteringSolutionStore - get(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets a solution object from the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringStore-get_S__table_zvw_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-get_S__table_zvw_v2r_llb__entry__3\\\">Name of a solution in the store.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringStore-get_S__table_aww_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-get_S__table_aww_v2r_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-get_S__table_aww_v2r_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-get_S__table_aww_v2r_llb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-get_S__table_aww_v2r_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution</span></a>\\n <span class=\\\"ph\\\">object. Returns an error if the object does not\\n exist.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">The following example shows how to get a solution\\n object from the store using the <span class=\\\"keyword apiname\\\">get()</span> method and view its\\n training status using the</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getActiveVersion\\\" class=\\\"xref\\\" title=\\\"Gets the active ClusteringSolutionVersion object.\\\">ClusteringSolution - getActiveVersion()</a> and\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html#C-getStatus_B\\\" class=\\\"xref\\\" title=\\\"Gets training completion status.\\\">ClusteringSolutionVersion - getStatus()</a> methods.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_complete",\\n "percentComplete":"100",\\n "hasJobEnded":"true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringStore-getAllNames\\\" id=\\\"ClusteringStore-getAllNames\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringStore-getAllNames\\\">ClusteringSolutionStore - getAllNames(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the names of all solution definition\\n records in the store.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Options for restricting results within the specified\\n properties.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "String",\\n "domainName": "String",\\n "scope": "String"\\n};</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Label of your solution object.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Name of the domain for your solution object. Refer to <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__1\\\">options.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__id_bfn_kwh_wnb__entry__3\\\">Optional. Name of an <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_ApplicationScope&version=vancouver&pubname=vancouver-application-development\\\" class=\\\"xref\\\">application scope</a> for\\n your solution object.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringStore-getAllNames__table_aww_v2r_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-getAllNames__table_aww_v2r_llb__entry__2\\\">List of strings representing solution object\\n names in the store.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, the\\n <span class=\\\"keyword apiname\\\">getAllNames()</span> method returns a list of all names in the\\n store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">gs.print(JSON.stringify(JSON.parse(sn_ml.ClusteringSolutionStore.getAllNames()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n "ml_x_snc_global_global_clustering_solution_1",\\n "ml_x_snc_global_global_clustering_solution"\\n]</code></pre>\\n </div>\\n <div class=\\\"example\\\" id=\\\"ClusteringStore-getAllNames__example_jzt_l5h_wnb\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">In the following example, the\\n <span class=\\\"keyword apiname\\\">getAllNames()</span> method returns only names associated with\\n values set in the <span class=\\\"keyword parmname\\\">options</span> parameter.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var options = {\\n 'label' : 'my solution definition',\\n 'domainName' : 'global',\\n 'scope' : 'global'\\n};\\nvar solNames = sn_ml.ClusteringSolutionStore.getAllNames(options);\\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n "ml_x_snc_global_global_my_solution_definition"\\n]</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_ClusteringStore-update_S_O\\\" id=\\\"ClusteringStore-update_S_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_ClusteringStore-update_S_O\\\">ClusteringSolutionStore - update(String name, Object mlSolution)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Replaces an existing object in the store with the\\n object passed as a parameter. The object name provided must be empty or\\n match.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:20%\\\"/><col style=\\\"width:20%\\\"/><col style=\\\"width:60%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\\\">Name of the solution to update.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__1\\\">mlSolution</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__2\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution</span></a></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_v5p_wxr_llb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a cluster solution.\\\"><span class=\\\"keyword apiname\\\">ClusteringSolution()</span></a>\\n <span class=\\\"ph\\\">object properties to update.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"ClusteringStore-update_S_O__table_w5p_wxr_llb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"ClusteringStore-update_S_O__table_w5p_wxr_llb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to update a solution\\n object in the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var solutionUpdate = new sn_ml.ClusteringSolution({\\n 'label': 'my solution definition',\\n 'dataset' : myData,\\n 'predictedFieldName' : 'assignment_group',\\n 'inputFieldNames': ['short_description']\\n});\\n\\nsn_ml.ClusteringSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolutionStore - Global\n\nEnables storing\nand retrieving solutions.\n\nThe ClusteringSolutionStore\n API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\n## ClusteringSolutionStore - add(Object mlSolution)\n\nAdds a new solution object to the store and returns a unique name.\n\nNote: Label values do not need to be unique. For example, if you run this method\nwith the same label 10 times, this method adds 10 different uniquely-named\nobjects to the store.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| mlSolution | ClusteringSolution | ClusteringSolution() object to add to the store. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | System-generated solution name. |\n\n### Example\n\nThe following example\nshows how to add a solution to the\nstore. Use ClusteringSolution - submitTrainingJob()\nto run the training job after adding it to the\nstore.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\n```\n\n## ClusteringSolutionStore - deleteObject(String name)\n\nRemoves a specified solution object from the\nstore.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the ClusteringSolution() object to be deleted. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to delete a solution\nfrom the store.\n\n```None\nsn_ml.ClusteringSolutionStore.deleteObject(\"ml_sn_global_global_solution\");\n```\n\n## ClusteringSolutionStore - get(String name)\n\nGets a solution object from the store.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a solution in the store. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolution object. Returns an error if the object does not exist. |\n\n### Example\n\nThe following example shows how to get a solution\nobject from the store using the get() method and view its\ntraining status using the\nClusteringSolution - getActiveVersion() and\nClusteringSolutionVersion - getStatus() methods.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClusteringSolutionStore - getAllNames(Object options)\n\nGets the names of all solution definition\nrecords in the store.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options for restricting results within the specified properties. ```None { \"label\": \"String\", \"domainName\": \"String\", \"scope\": \"String\" }; ``` |\n| options.label | String | Optional. Label of your solution object. |\n| options.domainName | String | Optional. Name of the domain for your solution object. Refer to Domain separation and Predictive Intelligence. |\n| options.scope | String | Optional. Name of an application scope for your solution object. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of strings representing solution object names in the store. |\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns a list of all names in the\nstore.\n\n```None\ngs.print(JSON.stringify(JSON.parse(sn_ml.ClusteringSolutionStore.getAllNames()), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_clustering_solution_1\",\n \"ml_x_snc_global_global_clustering_solution\"\n]\n```\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns only names associated with\nvalues set in the options parameter.\n\n```None\nvar options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.ClusteringSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition\"\n]\n```\n\n## ClusteringSolutionStore - update(String name, Object mlSolution)\n\nReplaces an existing object in the store with the\nobject passed as a parameter. The object name provided must be empty or\nmatch.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the solution to update. |\n| mlSolution | ClusteringSolution | ClusteringSolution() object properties to update. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to update a solution\nobject in the store.\n\n```None\nvar solutionUpdate = new sn_ml.ClusteringSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.ClusteringSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ClusteringSolutionStore - Global\ndescription: Enables storing and retrieving solutions.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolutionStore - Global\n\nEnables storing\nand retrieving solutions.\n\nThe ClusteringSolutionStore\n API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\n## ClusteringSolutionStore - add(Object mlSolution)\n\nAdds a new solution object to the store and returns a unique name.\n\nNote: Label values do not need to be unique. For example, if you run this method\nwith the same label 10 times, this method adds 10 different uniquely-named\nobjects to the store.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| mlSolution | ClusteringSolution | ClusteringSolution() object to add to the store. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | System-generated solution name. |\n\n### Example\n\nThe following example\nshows how to add a solution to the\nstore. Use ClusteringSolution - submitTrainingJob()\nto run the training job after adding it to the\nstore.\n\n```None\n// Create a dataset \nvar myData = new sn_ml.DatasetDefinition({\n\n 'tableName' : 'incident',\n 'fieldNames' : ['assignment_group', 'short_description', 'description'],\n 'encodedQuery' : 'activeANYTHING'\n\n});\n\n// get a trained encoder from the store\nvar myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');\n\n// Create a solution \nvar mySolution = new sn_ml.ClusteringSolution({\n\n 'label': \"my solution definition\",\n 'dataset' : myData,\n 'encoder' : myEncoder,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames':['short_description']\n\n});\n\n// Add the solution to the store to later be able to retrieve it.\nvar my_unique_name = sn_ml.ClusteringSolutionStore.add(mySolution);\n```\n\n## ClusteringSolutionStore - deleteObject(String name)\n\nRemoves a specified solution object from the\nstore.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the ClusteringSolution() object to be deleted. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to delete a solution\nfrom the store.\n\n```None\nsn_ml.ClusteringSolutionStore.deleteObject(\"ml_sn_global_global_solution\");\n```\n\n## ClusteringSolutionStore - get(String name)\n\nGets a solution object from the store.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a solution in the store. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | ClusteringSolution object. Returns an error if the object does not exist. |\n\n### Example\n\nThe following example shows how to get a solution\nobject from the store using the get() method and view its\ntraining status using the\nClusteringSolution - getActiveVersion() and\nClusteringSolutionVersion - getStatus() methods.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClusteringSolutionStore - getAllNames(Object options)\n\nGets the names of all solution definition\nrecords in the store.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options for restricting results within the specified properties. ```None { \"label\": \"String\", \"domainName\": \"String\", \"scope\": \"String\" }; ``` |\n| options.label | String | Optional. Label of your solution object. |\n| options.domainName | String | Optional. Name of the domain for your solution object. Refer to Domain separation and Predictive Intelligence. |\n| options.scope | String | Optional. Name of an application scope for your solution object. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of strings representing solution object names in the store. |\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns a list of all names in the\nstore.\n\n```None\ngs.print(JSON.stringify(JSON.parse(sn_ml.ClusteringSolutionStore.getAllNames()), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_clustering_solution_1\",\n \"ml_x_snc_global_global_clustering_solution\"\n]\n```\n\n### Example\n\nIn the following example, the\ngetAllNames() method returns only names associated with\nvalues set in the options parameter.\n\n```None\nvar options = {\n 'label' : 'my solution definition',\n 'domainName' : 'global',\n 'scope' : 'global'\n};\nvar solNames = sn_ml.ClusteringSolutionStore.getAllNames(options);\ngs.print(JSON.stringify(JSON.parse(solNames), null, 2));\n```\n\nOutput:\n\n```None\n[\n \"ml_x_snc_global_global_my_solution_definition\"\n]\n```\n\n## ClusteringSolutionStore - update(String name, Object mlSolution)\n\nReplaces an existing object in the store with the\nobject passed as a parameter. The object name provided must be empty or\nmatch.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of the solution to update. |\n| mlSolution | ClusteringSolution | ClusteringSolution() object properties to update. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to update a solution\nobject in the store.\n\n```None\nvar solutionUpdate = new sn_ml.ClusteringSolution({\n 'label': 'my solution definition',\n 'dataset' : myData,\n 'predictedFieldName' : 'assignment_group',\n 'inputFieldNames': ['short_description']\n});\n\nsn_ml.ClusteringSolutionStore.update('ml_sn_global_global_incident_service', solutionUpdate);\n```\n"}}},{"rowIdx":1688,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ClusteringSolutionVersion - Global"},"description":{"kind":"string","value":"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_ClusteringSolutionVersionAPI\"><article class=\"nested0\" aria-labelledby=\"title_ClusteringSolutionVersionAPI\" id=\"ClusteringSolutionVersionAPI\">\n <h1 class=\"title topictitle1\" id=\"title_ClusteringSolutionVersionAPI\">ClusteringSolutionVersion<span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">ClusteringSolutionVersion</span> API is a scriptable object used in <span class=\"ph\">Predictive Intelligence</span> stores.</p>\n <p class=\"p\">This <span class=\"ph\"> API requires the <span class=\"ph\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\n within the <code class=\"ph codeph\">sn_ml</code> namespace.</span></p>\n <p class=\"p\">This API is used for working with solution versions based on <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" class=\"xref\" title=\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\">ClusteringSolution\n API</a> objects in the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\" class=\"xref\" title=\"Enables storing and retrieving solutions.\">ClusteringSolution store</a>.</p>\n <p class=\"p\">The system creates a solution version each time you train\n a solution definition. Most versions are created during scheduled solution\n training.</p>\n <div class=\"p\">Methods in this API are accessible using the following\n <span class=\"keyword apiname\">ClusteringSolution</span> methods:<ul class=\"ul\" id=\"ClusteringSolutionVersionAPI__ul_ycl_fzf_tlb\">\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getActiveVersion\" class=\"xref\" title=\"Gets the active ClusteringSolutionVersion object.\"><span class=\"keyword apiname\">getActiveVersion()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getAllVersions\" class=\"xref\" title=\"Gets all versions of a clustering solution.\"><span class=\"keyword apiname\">getAllVersions()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getLatestVersion\" class=\"xref\" title=\"Gets the latest version of a solution.\"><span class=\"keyword apiname\">getLatestVersion()</span></a></li>\n <li class=\"li\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getVersion_S\" class=\"xref\" title=\"Gets a solution by provided version number.\"><span class=\"keyword apiname\">getVersion()</span></a></li>\n </ul></div>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-cancelUpdateJob\" id=\"C-cancelUpdateJob\">\n <h2 class=\"title topictitle2\" id=\"title_C-cancelUpdateJob\">ClusteringSolutionVersion - cancelUpdateJob()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Cancels an update job on a trainer.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-cancelUpdateJob__table_cb4_q3b_rlb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-cancelUpdateJob__table_db4_q3b_rlb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to cancel an active training job that has been submitted\n using the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-submitTrainingJob\" class=\"xref\" title=\"Submits a training job.\"><span class=\"keyword apiname\">submitTrainingJob()</span></a> method.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\nvar mlSolutionVersion = myCluster.getActiveVersion();\n\nmlSolutionVersion.cancelUpdateJob();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-deleteClusterAssignments_O\" id=\"C-deleteClusterAssignments_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-deleteClusterAssignments_O\">ClusteringSolutionVersion - deleteClusterAssignments(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Deletes cluster assignments from rows by position in table sequence or\n GlideDateTime.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\">Object defining one option for deleting cluster assignments.<div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Only one\n delete option is valid.</div></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\">options.updatedUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\">Deletes rows for clusters with <samp class=\"ph systemoutput sysout\">updated_since</samp>\n values occurring before this value. Format must be provided as <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" class=\"xref\" title=\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a>.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{ "updatedUntil" : "String" }</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\">options.sequenceUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\">Deletes rows for clusters <span class=\"ph\">with\n <samp class=\"ph systemoutput sysout\">insert_sequence</samp> values occurring before this value\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\n point value is 1.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{ "sequenceUntil" : Number }</code></pre></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__2\">Number of rows deleted from the ML Cluster Detail [ml_cluster_detail]\n table.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to delete rows for clusters with\n <samp class=\"ph systemoutput sysout\">updated_since</samp> time preceding <kbd class=\"ph userinput\">'2020-06-28\n 02:50:53'</kbd>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedUntil = '2020-06-28 02:50:53';\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print("Number of deleted rows: "+results);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Number of deleted rows: 6417</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to delete rows for clusters with\n <samp class=\"ph systemoutput sysout\">updated_since</samp> that are sequentially positioned prior to\n <kbd class=\"ph userinput\">1000</kbd>.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.sequenceUntil = 1000;\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print("Number of deleted rows: "+results);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Number of deleted rows: 999</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getClusterAssignments_O\" id=\"C-getClusterAssignments_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-getClusterAssignments_O\">ClusteringSolutionVersion - getClusterAssignments(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets assignments for a clustering\n solution.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getClusterAssignments_O__table_gby_x2w_plb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Values to use to narrow down the returned results by group, level, system\n update times, and table row number within a clustering solution. Minimum of one\n argument must be\n specified.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "cluster_id": "String",\n "group_by": "String",\n "limit": Number,\n "sequenceSince": Number,\n "sequenceUntil": Number,\n "topNPerCluster": Number,\n "updatedSince": "String",\n "updatedUntil": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.cluster_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Cluster ID of a trained solution in the Cluster\n Summary [ml_cluster_summary] table.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.group_by</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Optional. Identifies the segmentation field for which to\n retrieve cluster memberships, for example, assignment_group.<p class=\"p\">This field provides\n the same grouping as options provided in the <span class=\"ph uicontrol\">Use Group By</span>\n check box in the <span class=\"ph uicontrol\">Clustering Definition</span> form. The\n information provided varies based on the table selected in the\n <span class=\"ph uicontrol\">Table</span> field. For more information, see <span class=\"ph\" id=\"C-getClusterAssignments_O__ml-cluster-create-xbl\">\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create and train a\n clustering solution</a>\n </span>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.limit</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Optional. Maximum number of cluster assignments\n to retrieve.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.sequenceSince</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Starting position in a table sequence.\n Returns information for clusters with insert_sequence enabled and positioned after\n this value in the ML Cluster Detail [ml_cluster_detail] table. The sequence position\n starting point value is 1.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.sequenceUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Returns assignments for clusters <span class=\"ph\">with\n <samp class=\"ph systemoutput sysout\">insert_sequence</samp> values occurring before this value\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\n point value is 1.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.topNPerCluster</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\">Number of top results to receive for each\n cluster.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.updatedSince</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Date and\n time. Returns information for clusters with\n <samp class=\"ph systemoutput sysout\">sys_updated_on</samp> after the value provided\n in</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" class=\"xref\" title=\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\">options.updatedUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Date and time.\n Returns information for clusters with <samp class=\"ph systemoutput sysout\">sys_updated_on</samp>\n before the value provided in</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" class=\"xref\" title=\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a>.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getClusterAssignments_O__table_u1q_hxt_rhb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:83.33333333333334%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\">List of objects containing cluster information in increasing order by\n cluster_id.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "cluster_id": "String",\n "group_by": "String",\n "rec_display_id": "String",\n "rec_sys_id": "String"\n }\n]</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\"><object>.cluster_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\"><span class=\"ph\">Unique cluster number within a solution of clusters.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\"><object>.group_by</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\"><span class=\"ph\">If\n grouped, name of the segmentation field associated with this\n cluster.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\"><object>.rec_display_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\"><span class=\"ph\">Record type and number.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\"><object>.rec_sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\"><span class=\"ph\">Record sys_id.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to use the <span class=\"keyword parmname\">options</span> object to filter\n clustering results.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get("solution_name");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.clusterId = 56;\noptions.topNPerCluster = 10;\noptions.updatedUntil = '2020-01-17 23:16:14'; \noptions.updatedSince = '2020-01-17 23:16:13'; \noptions.sequenceUntil = 1000; \noptions.sequenceSince = 1100; \noptions.limit = 100;\n\nvar results = mlSolutionVersion.getClusterAssignments(options)\n\ngs.print(results);</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[{"cluster_id":"1","rec_display_id":"Incident": "INC0014483","rec_sys_id":"04e33e7adb401300864adfea5e961900","group_by":"network"},\n {"cluster_id":"1","rec_display_id":"Incident": "INC0011133","rec_sys_id":"5bd23af2db401300864adfea5e96194d","group_by":"network"}]</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getClusterInfo_O\" id=\"C-getClusterInfo_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-getClusterInfo_O\">ClusteringSolutionVersion - getClusterInfo(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets information for a specified clustering\n solution</span> in the store. The purity measurement provides insights as a percentage for the clustering\n fields on which the purity is based.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getClusterInfo_O__table_gby_x2w_plb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Optional. Object containing properties that enable filtering results within a\n clustering\n solution.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "clusterId": "String", \n "groupBy": "String",\n "limit": "String",\n "recSysId": "String",\n "sequenceSince": Number,\n "sequenceUntil": Number,\n "updatedSince": "String",\n "updatedUntil": "String"\n}</code></pre>\n <p class=\"p\">Default: Return cluster memberships for all\n clusters.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.clusterId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Cluster ID of a trained solution in the Cluster\n Summary [ml_cluster_summary] table.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.groupBy</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Optional. Identifies the segmentation field for which to\n retrieve cluster memberships, for example, assignment_group.<p class=\"p\">This field provides\n the same grouping as options provided in the <span class=\"ph uicontrol\">Use Group By</span>\n check box in the <span class=\"ph uicontrol\">Clustering Definition</span> form. The\n information provided varies based on the table selected in the\n <span class=\"ph uicontrol\">Table</span> field. For more information, see <span class=\"ph\" id=\"C-getClusterInfo_O__ml-cluster-create-xbl\">\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create and train a\n clustering solution</a>\n </span>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.limit</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Optional. Maximum number of cluster assignments\n to retrieve.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.recSysId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Optional. Sys_id of a record by which to find cluster information.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.sequenceSince</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Starting position in a table sequence.\n Returns information for clusters with insert_sequence enabled and positioned after\n this value in the ML Cluster Detail [ml_cluster_detail] table. The sequence position\n starting point value is 1.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.sequenceUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\">Optional. Ending position in a table sequence. Returns assignments for clusters\n <span class=\"ph\">with\n <samp class=\"ph systemoutput sysout\">insert_sequence</samp> values occurring before this value\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\n point value is 1.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.updatedSince</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Date and\n time. Returns information for clusters with\n <samp class=\"ph systemoutput sysout\">sys_updated_on</samp> after the value provided\n in</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" class=\"xref\" title=\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a> format.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\">options.updatedUntil</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Optional. Date and time.\n Returns information for clusters with <samp class=\"ph systemoutput sysout\">sys_updated_on</samp>\n before the value provided in</span>\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\" class=\"xref\" title=\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a>.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getClusterInfo_O__table_xk3_v3b_rlb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\">List of objects containing cluster\n information.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n { \n "cluster_concept": "String",\n "cluster_id": "String",\n "cluster_quality": "String",\n "cluster_size": "String",\n "group_by": "String",\n "insert_sequence": "String",\n "purity": "String",\n "sys_updated_on": "String"\n }\n]</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.cluster_concept</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\"><span class=\"ph\">Set of words that describe the cluster\n in descending order of frequency.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.cluster_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\"><span class=\"ph\">Unique cluster number within a solution of clusters.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.cluster_quality</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\"><span class=\"ph\">Number from 0 to 100. Higher numbers\n indicate higher cluster density.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.cluster_size</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\"><span class=\"ph\">Number of records in a cluster.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.group_by</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\"><span class=\"ph\">If\n grouped, name of the segmentation field associated with this\n cluster.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.insert_sequence</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\">Sequential position number of the cluster in the Cluster Summary\n [ml_cluster_summary] table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.purity</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\">Percentage value representing the purity of cluster quality.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\"><object>.sys_updated_on</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\">System <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\" class=\"xref\" title=\"The scoped GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\">GlideDateTime</a> value representing the date and time at which this cluster\n was last updated.<p class=\"p\">Data type: String</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to set the options object parameter and print the filtered\n cluster results.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedSince = '2020-05-28 02:09:53'; \noptions.updatedUntil = '2020-05-28 03:15:00';\noptions.sequenceSince = 1;\noptions.limit = 10;\n\nvar results = mlSolutionVersion.getClusterInfo(options);\n\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "cluster_id": "1",\n "cluster_quality": "100",\n "cluster_size": "17",\n "purity": "",\n "insert_sequence": "8",\n "group_by": "VPN Customer",\n "sys_updated_on": "2020-05-28 02:09:53",\n "cluster_concept": "vpn instance connection ldap user log unable usability tunnel"\n },\n {\n "cluster_id": "1",\n "cluster_quality": "100",\n "cluster_size": "10",\n "purity": "",\n "insert_sequence": "24",\n "group_by": "Live Feed",\n "sys_updated_on": "2020-05-28 02:09:53",\n "cluster_concept": "feed live user note work disable group default usability sort"\n },\n {\n "cluster_id": "1",\n "cluster_quality": "100",\n "cluster_size": "18",\n "purity": "",\n "insert_sequence": "40",\n "group_by": "Integrations",\n "sys_updated_on": "2020-05-28 02:09:53",\n "cluster_concept": "integrate usability certificate error"\n },\n...\n]</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getProperties\" id=\"C-getProperties\">\n <h2 class=\"title topictitle2\" id=\"title_C-getProperties\">ClusteringSolutionVersion - getProperties()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets solution object\n properties</span>\n <span class=\"ph\">and version number</span>.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getProperties__table_d2m_zwz_4lb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getProperties__table_d2m_zwz_4lb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getProperties__table_d2m_zwz_4lb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getProperties__table_d2m_zwz_4lb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_d2m_zwz_4lb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_d2m_zwz_4lb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_d2m_zwz_4lb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getProperties__table_e2m_zwz_4lb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getProperties__table_e2m_zwz_4lb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getProperties__table_e2m_zwz_4lb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\">Contents of the Dataset and <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\" class=\"xref\" title=\"Creates a cluster solution.\">ClusteringSolution</a> version details. Results vary by object property\n setup.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "algorithmConfig": {Object},\n "datasetProperties": {Object},\n "domainName": "String",\n "encoder": {Object},\n "groupByFieldName": "String", \n "inputFieldNames": [Array],\n "isActive": "Boolean",\n "label": "String",\n "minRecordsPerCluster" : Number,\n "name": "String", "processingLanguage": "String",\n "scope": "String",\n "stopwords": [Array],\n "trainingFrequency": "String",\n "updateFrequency": "String",\n "versionNumber": "Number"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">JavaScript object containing algorithm\n configuration properties.</span> Property results vary by the value set in the <span class=\"keyword parmname\">algorithm</span>\n property.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig' : {\n "algorithm": "String", \n // See algorithmConfig.algorithm setting description for property settings based on algorithm\n}</code></pre>\n <p class=\"p\">Data\n type: Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig.algorithm</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Method for\n encoding your solution.</span>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">dbscan</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "dbscan",\n "distanceMetric": "String",\n "epsilon": Number,\n "minimumNeighbours": Number\n}</code></pre></div>\n <div class=\"p\">Properties for\n <span class=\"keyword parmname\">kmeans</span>:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">'algorithmConfig': {\n "algorithm": "kmeans",\n "targetCoverage": Number\n}</code></pre></div>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig.distanceMetric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Distance metric to scan for similar data objects.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig.epsilon</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Decimal value between 0 and 1 representing the size of the\n neighborhood search radius.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig.minimumNeighbours</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">DBSCAN\n algorithm only. Minimum number of neighbors required in a point to be a part of a\n cluster. For <span class=\"keyword parmname\">levenshteinDistance</span> the value must be 1 so that\n no points are excluded from the dataset.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.algorithmConfig.targetCoverage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">K-means\n algorithm only. Percentile field to filter out records that are less similar to\n each other.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><p class=\"p\">Lists the properties of the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\" class=\"xref\" title=\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\">DatatsetDefinition</a> object associated with the solution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "encodedQuery": "String",\n "fieldDetails": [Array],\n "fieldNames": [Array],\n "tableName": "String"\n}</code></pre>\n <p class=\"p\">Data type: Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.tableName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Name of the table for the dataset. For\n example, <code class=\"ph codeph\">"tableName" : "Incident"</code>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of field names from the specified table\n as strings. For example, <code class=\"ph codeph\">"fieldNames" : ["short_description",\n "priority"]</code>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of JavaScript objects that specify field\n properties.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "name": "String",\n "type": "String"\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Name of the field defining the type of\n information to restrict this dataset to.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Machine-learning field type.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Encoded query string in standard Glide format.\n See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\" class=\"xref\">Encoded query\n strings</a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.domainName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Domain name associated with this dataset. See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Domain separation and <span class=\"ph\">Predictive Intelligence</span></a>.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\">Object.encoderProperties</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Encoder object assigned to this\n solution.</span> See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\" class=\"xref\" title=\"Creates an encoder.\">Encoder - Encoder(Object config)</a>.<p class=\"p\">Data type:\n Object.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\">Object.groupByFieldName</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\" id=\"C-getProperties__solution-obj-group-desc\">Field name by which\n the system groups records into one or more clusters.</span>\n <p class=\"p\">Data type:\n String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\">Object.inputFieldNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">List of input field names as strings. The\n model uses these fields used to make\n predictions.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.isActive</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\">Flag that indicates whether this version is\n active.<div class=\"p\">Valid values:<ul class=\"ul\" id=\"C-getProperties__ul_i5m_lp1_dmb\">\n <li class=\"li\">true: Version is active.</li>\n <li class=\"li\">false: Version is not active.</li>\n </ul></div>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.label</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Identifies the prediction\n task.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "label": "my first prediction"\n}</code></pre>\n <p class=\"p\">Data\n type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.minRecordsPerCluster</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Minimum number of records to allow in any cluster.</span>\n <p class=\"p\">Data type: Number.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">System-assigned name.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.processingLanguage</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Processing language in two-letter ISO 639-1 language code format.</span>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.scope</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\">Object scope. Currently the only valid value is\n <code class=\"ph codeph\">global</code>.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.stopwords</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Optional. Preset\n list of strings that the system automatically generates based on the\n <span class=\"keyword parmname\">language</span> property setting. For details, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create a custom stopwords\n list</a>.</span>\n <p class=\"p\">Data type: Array.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.trainingFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">The frequency to retrain the model.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"C-getProperties__ul_pmw_523_plb\">\n <li class=\"li\">every_30_days</li>\n <li class=\"li\">every_60_days</li>\n <li class=\"li\">every_90_days</li>\n <li class=\"li\">every_120_days</li>\n <li class=\"li\">every_180_days</li>\n <li class=\"li\">run_once</li>\n </ul>Default: run_once</div>\n <p class=\"p\">Data type: String.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.updateFrequency</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">The frequency at which the model for\n the solution definition must be rebuilt.</span>\n <div class=\"p\">Possible values:<ul class=\"ul\" id=\"C-getProperties__ul_kjm_2jh_3mb\">\n <li class=\"li\">do_not_update</li>\n <li class=\"li\">every_1_day</li>\n <li class=\"li\">every_1_hour</li>\n <li class=\"li\">every_6_hours</li>\n <li class=\"li\">every_12_hours</li>\n <li class=\"li\">every_1_minute</li>\n <li class=\"li\">every_15_minutes</li>\n <li class=\"li\">every_30_minutes</li>\n </ul>Default: do_not_update</div>\n <p class=\"p\">Datatype: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__1\"><Object>.versionNumber</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getProperties__table_e2m_zwz_4lb__entry__2\"><span class=\"ph\">Version number of\n the</span>\n <span class=\"keyword apiname\">ClusteringSolution</span> object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example gets properties of the active object\n version in the store.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get properties\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">*** Script: {\n "algorithmConfig": {\n "algorithm": "kmeans",\n "targetCoverage": "90"\n },\n "datasetProperties": {\n "tableName": "incident",\n "fieldNames": [\n "category",\n "short_description",\n "state",\n "description"\n ],\n "encodedQuery": "activeANYTHING"\n },\n "domainName": "global",\n "encoderProperties": {\n "datasetsProperties": [\n {\n "tableName": "incident",\n "fieldNames": [\n "assignment_group",\n "short_description",\n "description"\n ],\n "encodedQuery": "activeANYTHING"\n }\n ],\n "domainName": "global",\n "isActive": "true",\n "label": "my encoder definition",\n "name": "ml_x_snc_global_global_my_encoder_definition",\n "processingLanguage": "en",\n "stopwords": [\n "Default English Stopwords"\n ],\n "versionNumber": "1"\n },\n "groupByFieldName": "category",\n "inputFieldNames": [\n "short_description"\n ],\n "isActive": "true",\n "label": "clustering solution",\n "minRecordsPerCluster": 2,\n "name": "ml_x_snc_global_global_clustering_solution",\n "processingLanguage": "en",\n "stopwords": [\n "Default English Stopwords"\n ],\n "updateFrequency": "do_not_update",\n "versionNumber": "1"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getStatus_B\" id=\"C-getStatus_B\">\n <h2 class=\"title topictitle2\" id=\"title_C-getStatus_B\">ClusteringSolutionVersion - getStatus(Boolean includeDetails)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets training completion status.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getStatus_B__table_xfh_vbw_plb\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getStatus_B__table_xfh_vbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getStatus_B__table_xfh_vbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getStatus_B__table_xfh_vbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_xfh_vbw_plb__entry__1\">includeDetails</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_xfh_vbw_plb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_xfh_vbw_plb__entry__3\"><p class=\"p\">Flag that indicates whether to return status <span class=\"keyword parmname\">details</span>.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"C-getStatus_B__ul_n33_ckw_plb\">\n <li class=\"li\">true: Return additional details.</li>\n <li class=\"li\">false: Do not return additional details.</li>\n </ul></div>\n <p class=\"p\">Default: False</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getStatus_B__table_yfh_vbw_plb\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\"><span class=\"ph\">JavaScript object containing training\n status information\n for</span> a <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\" class=\"xref\" title=\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\">ClusteringSolution</a>\n object.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state": "String",\n "percentComplete": "Number as a String",\n "hasJobEnded": "Boolean value as a String",\n "details": {Object}\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.state</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\">Training completion state. If the training\n job reaches a terminal state, the job does not leave that state. If the state is\n terminal, the <span class=\"keyword parmname\">hasJobEnded</span> property is set to\n <code class=\"ph codeph\">true</code>.<div class=\"p\">Possible values:<ul class=\"ul\" id=\"C-getStatus_B__ul_a5q_gh4_vlb\">\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">fetching_files_for_training</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">preparing_data</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">retry</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_cancelled</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_complete </samp>(terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_error</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">solution_incomplete</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_request_received</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_request_timed_out</samp> (terminal)</li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">training_solution</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">uploading_solution</samp></li>\n <li class=\"li\"><samp class=\"ph systemoutput sysout\">waiting_for_training</samp></li>\n </ul></div>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.hasJobEnded</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\"><p class=\"p\">Flag that indicates whether training is complete.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"C-getStatus_B__ul_icy_zjx_rlb\">\n <li class=\"li\">true: Training is complete.</li>\n <li class=\"li\">false: Training is incomplete.</li>\n </ul></div>\n <p class=\"p\">Data type: Boolean value as a String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.percentComplete</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\">Number between zero and 100 representing\n training percent complete. If the completion percentage is less than 100, the job\n might be in a terminal state. For example, if training times out.<p class=\"p\">Data type:\n Number as a String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__1\"><Object>.details</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getStatus_B__table_yfh_vbw_plb__entry__2\">Object containing a list of additional\n training details.<p class=\"p\">Data type: Object</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows a successful result\n with training complete.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_complete",\n "percentComplete":"100",\n "hasJobEnded":"true",\n "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);\n}</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows an unsuccessful\n result with training complete.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get status\nvar solutionName = 'ml_x_snc_global_global_cluster_solution';\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "state":"solution_error",\n "percentComplete":"100",\n "hasJobEnded":"true"\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getTopNPurityInfo_O\" id=\"C-getTopNPurityInfo_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-getTopNPurityInfo_O\">ClusteringSolutionVersion - getTopNPurityInfo(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the top purity results for a clustering solution. The purity measurement provides\n insights as a percentage for the clustering fields on which the purity is based.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Options that determine the number and format of the top cluster purity\n results.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "clusterIds": [Array],\n "groupBy": [Array],\n "purityFields": [Array],\n "topN": Number,\n "topNFields": Number\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options.clusterIds</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Optional. List of cluster IDs provided as strings. A cluster ID is provided in\n the Cluster Summary [ml_cluster_summary] table. If provided, this method returns\n purity cluster information for each specified cluster. <p class=\"p\">Default: This method\n returns purity information for all clusters.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options.groupBy</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Optional.\n List\n of group_by field strings from your table to help the system identify the class\n which is most frequent in the cluster. If provided, returns purity information for\n cluster solutions using group_by fields. The Cluster Summary [ml_cluster_summary]\n table lists clusters and any associated Group by values.<p class=\"p\">This field only applies\n to clusters that use group by in the clustering definition. Eligible fields are\n listed in the <span class=\"ph uicontrol\">Table</span> field. For details on the group by\n feature, refer to <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\" class=\"xref\">Create and train a\n clustering solution</a>.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options.purityFields</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Optional. List of purity field strings. If provided, this method only returns\n information for these purity fields. You can view purity values for a cluster in the\n Cluster Summary [ml_cluster_summary] table lists.<div class=\"note note note_note\"><span class=\"note__title\">Note:</span> If both\n <span class=\"keyword parmname\">purity_fields</span> and <span class=\"keyword parmname\">top_n_fields</span> are\n provided, this method returns <span class=\"keyword parmname\">top_n_fields</span> first, then\n selects fields from <span class=\"keyword parmname\">purity_fields</span>.</div>\n <p class=\"p\">Default: Return\n purity information for all purity fields saved for the cluster.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options.topN</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Optional. Restricts the number of predictions to return to the highest values\n for each purity field.<p class=\"p\">Maximum value: 10</p>\n <p class=\"p\">Default: Return all purity\n information for each purity field.</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\">options.topNFields</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\">Optional. Restricts the number of purity fields returned to fields with the\n highest purity for each cluster.<p class=\"p\">Maximum value: 10</p>\n <p class=\"p\">Default: Return all\n fields in the cluster.</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\">JSON-formatted string containing a list of clusters with purity fields and details.<div class=\"p\"><div class=\"note note note_note\"><span class=\"note__title\">Note:</span> Results vary based on settings made in the <span class=\"keyword parmname\">options</span>\n input parameter.</div></div>\n <p class=\"p\">The following information illustrates how cluster purity results are sorted\n and categorized. Refer to the example for actual\n output.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "<clusterID>":[\n // List sorted by purity per field\n { "<fieldName>":[\n // List sorted by purity per field value\n {"<field_val1_1>":"<purity>"},\n // Additional field values\n ]},\n // Additional fields\n ],\t \n // Additional clusters\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\">String.<clusterID></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\">List of clusters arranged in descending order by purity value per\n cluster.<p class=\"p\">Data type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\">String.<clusterID>.<field></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\">List of objects representing purity fields arranged in descending order by\n purity value per field. The <span class=\"keyword parmname\">options.top_n_fields</span> input object\n parameter property determines the number of fields\n returned.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"<field>":[{"<field_val>":"<purity>"}]}</code></pre>\n <p class=\"p\">Data\n type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\">String.<clusterID>.<field>.<values></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\">List of objects containing field value and purity. For example,\n <code class=\"ph codeph\">{"priority":[{"5":"100"}]}</code> is a priority field with a score of 5\n and a purity value of 100 percent. Results list in descending order by purity\n percentage. The <span class=\"keyword parmname\">options.top_n</span> input object parameter property\n determines the number of results returned.<p class=\"p\">Data type: Array</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get the top two purity results for the category field in\n specific cluster solutions.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var solution = new GlideRecord('ml_solution');\nsolution.addQuery('sys_id', '<clustering_solution_sys_id>');\nsolution.addQuery('active', 'true');\nsolution.query();\n\nwhile (solution.next()) {\n\n var options = {};\n options.clusterIds = ['1', '3', '5'];\n options.purityFields = ['category'];\n options.topN = '2';\n options.topNFields = '2';\n\n var clustering = new sn_ml.ClusteringSolutionVersion(solution);\n var results = clustering.getTopNPurityInfo(options);\n\n gs.info(results);\n}</code></pre>\n <p class=\"p\">Output displays purity insights based on the settings provided in the options\n parameter.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{"1":[{"category":[{"network":"99.96"},{"inquiry":"0.04"}]}],"3":[{"category":[{"Systems Engineering":"100"}]}],\n"5":[{"category":[{"Security":"100"}]}]}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getUpdateStatus\" id=\"C-getUpdateStatus\">\n <h2 class=\"title topictitle2\" id=\"title_C-getUpdateStatus\">ClusteringSolutionVersion - getUpdateStatus()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Gets the status of the most recent clustering solution update job.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getUpdateStatus__table_kx2_w3b_rlb\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getUpdateStatus__table_lx2_w3b_rlb\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__2\">State of the clustering solution update.<div class=\"p\">States:<ul class=\"ul\" id=\"C-getUpdateStatus__ul_fgs_w54_wlb\">\n <li class=\"li\">Configuration or network error</li>\n <li class=\"li\">Error while updating solution</li>\n <li class=\"li\">Fetching files for updating</li>\n <li class=\"li\">Preparing data</li>\n <li class=\"li\">Unauthorized</li>\n <li class=\"li\">Update complete</li>\n <li class=\"li\">Updating is cancelled</li>\n <li class=\"li\">Updating request received</li>\n <li class=\"li\">Updating request timed out</li>\n <li class=\"li\">Updating solution</li>\n <li class=\"li\">Uploading</li>\n <li class=\"li\">Waiting</li>\n </ul></div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get the update status of a clustering solution.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\ngs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"Update Complete"</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-getVersionNumber\" id=\"C-getVersionNumber\">\n <h2 class=\"title topictitle2\" id=\"title_C-getVersionNumber\">ClusteringSolutionVersion - getVersionNumber()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the version number of</span> a solution object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-getVersionNumber__table_jsz_sbw_plb\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getVersionNumber__table_jsz_sbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getVersionNumber__table_jsz_sbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getVersionNumber__table_jsz_sbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getVersionNumber__table_jsz_sbw_plb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getVersionNumber__table_jsz_sbw_plb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getVersionNumber__table_jsz_sbw_plb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-getVersionNumber__table_ksz_sbw_plb\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getVersionNumber__table_ksz_sbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-getVersionNumber__table_ksz_sbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getVersionNumber__table_ksz_sbw_plb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-getVersionNumber__table_ksz_sbw_plb__entry__2\"><span class=\"ph\">Version number.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to get a version\n number.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Get version number\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">Version number: 1</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-predict_O_O\" id=\"C-predict_O_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-predict_O_O\">ClusteringSolutionVersion - predict(Object input, Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Gets the input data for a prediction.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-predict_O_O__table_wwz_pbw_plb\"><caption><span class=\"table--title-label\">Table 19. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-predict_O_O__table_wwz_pbw_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-predict_O_O__table_wwz_pbw_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-predict_O_O__table_wwz_pbw_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__1\">input</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__3\"><a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\" class=\"xref\" title=\"The GlideRecord API is used for database operations.\"><span class=\"keyword apiname\">GlideRecord</span></a>\n <span class=\"ph\"> or array of JSON objects containing field names and\n values as key-value pairs.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__3\">Optional values for filtering prediction\n results.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "apply_threshold": Boolean,\n "top_n": Number\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__1\">options.apply_threshold</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__3\">Flag that indicates whether to check the\n threshold value for the solution and apply it to the result set.<div class=\"p\">Valid values:<ul class=\"ul\" id=\"C-predict_O_O__ul_f4d_xyx_slb\">\n <li class=\"li\">true: Return results in which confidence is greater than threshold.</li>\n <li class=\"li\">false: Return all results.</li>\n </ul></div>\n <p class=\"p\">Default: True</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__1\">options.top_n</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_wwz_pbw_plb__entry__3\"><span class=\"ph\">If provided, returns the top\n results, up to the specified number of predictions.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-predict_O_O__table_xwz_pbw_plb\"><caption><span class=\"table--title-label\">Table 20. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">JSON object containing the prediction results sorted by\n sys_id or record_number.</span>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n <identifier>: [Array]\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\">List of objects with details for each\n prediction\n result.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"><identifier>: [\n {\n "confidence": Number,\n "predictedSysId": "String",\n "predictedValue": "String", \n "threshold": Number\n }\n]</code></pre>\n <p class=\"p\">Data\n type: Array</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.confidence</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value of the confidence associated\n with the prediction. For example, 53.84.</span>\n <p class=\"p\">Data type: Number</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.predictedSysId</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">The sys_id of the predicted\n value. Results can be from any table on which information is being\n predicted.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.predictedValue</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value representing the\n prediction result.</span>\n <p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__1\"><Object>.<identifier>.<object>.threshold</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-predict_O_O__table_xwz_pbw_plb__entry__2\"><span class=\"ph\">Value of the configured threshold\n associated with the prediction.</span>\n <p class=\"p\">Data type: Number</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to display prediction\n results for a <span class=\"keyword apiname\">predict()</span> method that takes a GlideRecord by\n sys_id for input and includes optional parameters to restrict to top three results\n and exclude the threshold value.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord("incident");\ninput.get("<sys_id>");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "<sys_id/gr>": [\n {\n "confidence": 62.10782320780268,\n "threshold": 20.36,\n "predictedValue": "Clone Issues",\n "predictedSysId": ""\n },\n {\n "confidence": 6.945237375770391,\n "threshold": 16.63,\n "predictedValue": "Instance Administration",\n "predictedSysId": ""\n },\n {\n "confidence": 5.321061076300759,\n "threshold": 23.7,\n "predictedValue": "Administration",\n "predictedSysId": ""\n }\n ]\n}</code></pre>\n </div>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to display prediction\n results for a <span class=\"keyword apiname\">predict()</span> method that takes an array of field\n names as key-value pairs for input and includes optional parameters to restrict to\n top three results and exclude the threshold value.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_incident_categorization");\n\n// key-value pairs input\nvar input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "1": [\n {\n "confidence": 37.5023032262591,\n "threshold": 10.72,\n "predictedValue": "Authentication",\n "predictedSysId": ""\n },\n {\n "confidence": 24.439964862166583,\n "threshold": 23.7,\n "predictedValue": "Administration",\n "predictedSysId": ""\n },\n {\n "confidence": 11.736320486031047,\n "threshold": 100,\n "predictedValue": "Security",\n "predictedSysId": ""\n }\n ],\n "2": [\n {\n "confidence": 99,\n "threshold": 17.77,\n "predictedValue": "Email",\n "predictedSysId": ""\n },\n {\n "confidence": 3.182137005157543,\n "threshold": 10.72,\n "predictedValue": "Authentication",\n "predictedSysId": ""\n },\n {\n "confidence": 2.8773826570713514,\n "threshold": -1,\n "predictedValue": "Email (I/f)",\n "predictedSysId": ""\n }\n ]\n}</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_C-submitUpdateJob_O\" id=\"C-submitUpdateJob_O\">\n <h2 class=\"title topictitle2\" id=\"title_C-submitUpdateJob_O\">ClusteringSolutionVersion - submitUpdateJob(Object options)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Submits clustering update jobs with options to narrow results to a specific table and\n filter for matching records.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"C-submitUpdateJob_O__table_gby_x2w_plb\"><caption><span class=\"table--title-label\">Table 21. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\">options</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\">JavaScript object containing options on which to base a clustering solution\n update.<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "filter" : "String",\n "table" : "String"\n }</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\">options.filter</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\"><span class=\"ph\">Encoded query string in standard Glide format.\n See <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\" class=\"xref\">Encoded query\n strings</a>.</span> Enables running an update job based on the filter provided.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\">options.table</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\">Name of the table on which to run an update job.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"C-submitUpdateJob_O__table_qpm_x3b_rlb\"><caption><span class=\"table--title-label\">Table 22. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to submit an update job.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\n\nvar options = {"filter" : "precision", "table" : "incident"};\n\nmyCluster.getActiveVersion().submitUpdateJob(options);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ClusteringSolutionVersion - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205448\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205448\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"ClusteringSolutionVersionAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\",\n \"page_key\": 41205448,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 33584,\n \"img_count\": 0,\n \"read_time\": 14,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 3501\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ClusteringSolutionVersion - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_ClusteringSolutionVersionAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_ClusteringSolutionVersionAPI\\\" id=\\\"ClusteringSolutionVersionAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_ClusteringSolutionVersionAPI\\\">ClusteringSolutionVersion<span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">ClusteringSolutionVersion</span> API is a scriptable object used in <span class=\\\"ph\\\">Predictive Intelligence</span> stores.</p>\\n <p class=\\\"p\\\">This <span class=\\\"ph\\\"> API requires the <span class=\\\"ph\\\">Predictive Intelligence</span> plugin (com.glide.platform_ml) and is provided\\n within the <code class=\\\"ph codeph\\\">sn_ml</code> namespace.</span></p>\\n <p class=\\\"p\\\">This API is used for working with solution versions based on <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\\\">ClusteringSolution\\n API</a> objects in the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html\\\" class=\\\"xref\\\" title=\\\"Enables storing and retrieving solutions.\\\">ClusteringSolution store</a>.</p>\\n <p class=\\\"p\\\">The system creates a solution version each time you train\\n a solution definition. Most versions are created during scheduled solution\\n training.</p>\\n <div class=\\\"p\\\">Methods in this API are accessible using the following\\n <span class=\\\"keyword apiname\\\">ClusteringSolution</span> methods:<ul class=\\\"ul\\\" id=\\\"ClusteringSolutionVersionAPI__ul_ycl_fzf_tlb\\\">\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getActiveVersion\\\" class=\\\"xref\\\" title=\\\"Gets the active ClusteringSolutionVersion object.\\\"><span class=\\\"keyword apiname\\\">getActiveVersion()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getAllVersions\\\" class=\\\"xref\\\" title=\\\"Gets all versions of a clustering solution.\\\"><span class=\\\"keyword apiname\\\">getAllVersions()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getLatestVersion\\\" class=\\\"xref\\\" title=\\\"Gets the latest version of a solution.\\\"><span class=\\\"keyword apiname\\\">getLatestVersion()</span></a></li>\\n <li class=\\\"li\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-getVersion_S\\\" class=\\\"xref\\\" title=\\\"Gets a solution by provided version number.\\\"><span class=\\\"keyword apiname\\\">getVersion()</span></a></li>\\n </ul></div>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-cancelUpdateJob\\\" id=\\\"C-cancelUpdateJob\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-cancelUpdateJob\\\">ClusteringSolutionVersion - cancelUpdateJob()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Cancels an update job on a trainer.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-cancelUpdateJob__table_cb4_q3b_rlb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-cancelUpdateJob__table_db4_q3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-cancelUpdateJob__table_db4_q3b_rlb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to cancel an active training job that has been submitted\\n using the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-submitTrainingJob\\\" class=\\\"xref\\\" title=\\\"Submits a training job.\\\"><span class=\\\"keyword apiname\\\">submitTrainingJob()</span></a> method.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\nvar mlSolutionVersion = myCluster.getActiveVersion();\\n\\nmlSolutionVersion.cancelUpdateJob();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-deleteClusterAssignments_O\\\" id=\\\"C-deleteClusterAssignments_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-deleteClusterAssignments_O\\\">ClusteringSolutionVersion - deleteClusterAssignments(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Deletes cluster assignments from rows by position in table sequence or\\n GlideDateTime.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\\\">Object defining one option for deleting cluster assignments.<div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Only one\\n delete option is valid.</div></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\\\">options.updatedUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\\\">Deletes rows for clusters with <samp class=\\\"ph systemoutput sysout\\\">updated_since</samp>\\n values occurring before this value. Format must be provided as <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a>.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{ "updatedUntil" : "String" }</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__1\\\">options.sequenceUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3\\\">Deletes rows for clusters <span class=\\\"ph\\\">with\\n <samp class=\\\"ph systemoutput sysout\\\">insert_sequence</samp> values occurring before this value\\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\\n point value is 1.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{ "sequenceUntil" : Number }</code></pre></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__2\\\">Number of rows deleted from the ML Cluster Detail [ml_cluster_detail]\\n table.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to delete rows for clusters with\\n <samp class=\\\"ph systemoutput sysout\\\">updated_since</samp> time preceding <kbd class=\\\"ph userinput\\\">'2020-06-28\\n 02:50:53'</kbd>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\nvar mlSolutionVersion = mlSolution.getActiveVersion();\\n\\nvar options = {};\\noptions.updatedUntil = '2020-06-28 02:50:53';\\n\\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\\n\\ngs.print("Number of deleted rows: "+results);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Number of deleted rows: 6417</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to delete rows for clusters with\\n <samp class=\\\"ph systemoutput sysout\\\">updated_since</samp> that are sequentially positioned prior to\\n <kbd class=\\\"ph userinput\\\">1000</kbd>.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\nvar mlSolutionVersion = mlSolution.getActiveVersion();\\n\\nvar options = {};\\noptions.sequenceUntil = 1000;\\n\\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\\n\\ngs.print("Number of deleted rows: "+results);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Number of deleted rows: 999</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getClusterAssignments_O\\\" id=\\\"C-getClusterAssignments_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getClusterAssignments_O\\\">ClusteringSolutionVersion - getClusterAssignments(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets assignments for a clustering\\n solution.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getClusterAssignments_O__table_gby_x2w_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Values to use to narrow down the returned results by group, level, system\\n update times, and table row number within a clustering solution. Minimum of one\\n argument must be\\n specified.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "cluster_id": "String",\\n "group_by": "String",\\n "limit": Number,\\n "sequenceSince": Number,\\n "sequenceUntil": Number,\\n "topNPerCluster": Number,\\n "updatedSince": "String",\\n "updatedUntil": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.cluster_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Cluster ID of a trained solution in the Cluster\\n Summary [ml_cluster_summary] table.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.group_by</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Optional. Identifies the segmentation field for which to\\n retrieve cluster memberships, for example, assignment_group.<p class=\\\"p\\\">This field provides\\n the same grouping as options provided in the <span class=\\\"ph uicontrol\\\">Use Group By</span>\\n check box in the <span class=\\\"ph uicontrol\\\">Clustering Definition</span> form. The\\n information provided varies based on the table selected in the\\n <span class=\\\"ph uicontrol\\\">Table</span> field. For more information, see <span class=\\\"ph\\\" id=\\\"C-getClusterAssignments_O__ml-cluster-create-xbl\\\">\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create and train a\\n clustering solution</a>\\n </span>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.limit</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Optional. Maximum number of cluster assignments\\n to retrieve.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.sequenceSince</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Starting position in a table sequence.\\n Returns information for clusters with insert_sequence enabled and positioned after\\n this value in the ML Cluster Detail [ml_cluster_detail] table. The sequence position\\n starting point value is 1.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.sequenceUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Returns assignments for clusters <span class=\\\"ph\\\">with\\n <samp class=\\\"ph systemoutput sysout\\\">insert_sequence</samp> values occurring before this value\\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\\n point value is 1.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.topNPerCluster</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\">Number of top results to receive for each\\n cluster.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.updatedSince</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Date and\\n time. Returns information for clusters with\\n <samp class=\\\"ph systemoutput sysout\\\">sys_updated_on</samp> after the value provided\\n in</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__1\\\">options.updatedUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Date and time.\\n Returns information for clusters with <samp class=\\\"ph systemoutput sysout\\\">sys_updated_on</samp>\\n before the value provided in</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a>.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:83.33333333333334%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\">List of objects containing cluster information in increasing order by\\n cluster_id.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "cluster_id": "String",\\n "group_by": "String",\\n "rec_display_id": "String",\\n "rec_sys_id": "String"\\n }\\n]</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\"><object>.cluster_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\"><span class=\\\"ph\\\">Unique cluster number within a solution of clusters.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\"><object>.group_by</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\"><span class=\\\"ph\\\">If\\n grouped, name of the segmentation field associated with this\\n cluster.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\"><object>.rec_display_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\"><span class=\\\"ph\\\">Record type and number.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__1\\\"><object>.rec_sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2\\\"><span class=\\\"ph\\\">Record sys_id.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to use the <span class=\\\"keyword parmname\\\">options</span> object to filter\\n clustering results.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get("solution_name");\\n\\nvar mlSolutionVersion = mlSolution.getActiveVersion();\\n\\nvar options = {};\\noptions.clusterId = 56;\\noptions.topNPerCluster = 10;\\noptions.updatedUntil = '2020-01-17 23:16:14'; \\noptions.updatedSince = '2020-01-17 23:16:13'; \\noptions.sequenceUntil = 1000; \\noptions.sequenceSince = 1100; \\noptions.limit = 100;\\n\\nvar results = mlSolutionVersion.getClusterAssignments(options)\\n\\ngs.print(results);</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[{"cluster_id":"1","rec_display_id":"Incident": "INC0014483","rec_sys_id":"04e33e7adb401300864adfea5e961900","group_by":"network"},\\n {"cluster_id":"1","rec_display_id":"Incident": "INC0011133","rec_sys_id":"5bd23af2db401300864adfea5e96194d","group_by":"network"}]</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getClusterInfo_O\\\" id=\\\"C-getClusterInfo_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getClusterInfo_O\\\">ClusteringSolutionVersion - getClusterInfo(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets information for a specified clustering\\n solution</span> in the store. The purity measurement provides insights as a percentage for the clustering\\n fields on which the purity is based.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getClusterInfo_O__table_gby_x2w_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Optional. Object containing properties that enable filtering results within a\\n clustering\\n solution.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "clusterId": "String", \\n "groupBy": "String",\\n "limit": "String",\\n "recSysId": "String",\\n "sequenceSince": Number,\\n "sequenceUntil": Number,\\n "updatedSince": "String",\\n "updatedUntil": "String"\\n}</code></pre>\\n <p class=\\\"p\\\">Default: Return cluster memberships for all\\n clusters.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.clusterId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Cluster ID of a trained solution in the Cluster\\n Summary [ml_cluster_summary] table.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.groupBy</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Optional. Identifies the segmentation field for which to\\n retrieve cluster memberships, for example, assignment_group.<p class=\\\"p\\\">This field provides\\n the same grouping as options provided in the <span class=\\\"ph uicontrol\\\">Use Group By</span>\\n check box in the <span class=\\\"ph uicontrol\\\">Clustering Definition</span> form. The\\n information provided varies based on the table selected in the\\n <span class=\\\"ph uicontrol\\\">Table</span> field. For more information, see <span class=\\\"ph\\\" id=\\\"C-getClusterInfo_O__ml-cluster-create-xbl\\\">\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create and train a\\n clustering solution</a>\\n </span>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.limit</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Optional. Maximum number of cluster assignments\\n to retrieve.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.recSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Optional. Sys_id of a record by which to find cluster information.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.sequenceSince</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Starting position in a table sequence.\\n Returns information for clusters with insert_sequence enabled and positioned after\\n this value in the ML Cluster Detail [ml_cluster_detail] table. The sequence position\\n starting point value is 1.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.sequenceUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\">Optional. Ending position in a table sequence. Returns assignments for clusters\\n <span class=\\\"ph\\\">with\\n <samp class=\\\"ph systemoutput sysout\\\">insert_sequence</samp> values occurring before this value\\n in the ML Cluster Detail [ml_cluster_detail] table. The sequence position starting\\n point value is 1.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.updatedSince</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Date and\\n time. Returns information for clusters with\\n <samp class=\\\"ph systemoutput sysout\\\">sys_updated_on</samp> after the value provided\\n in</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a> format.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__1\\\">options.updatedUntil</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Optional. Date and time.\\n Returns information for clusters with <samp class=\\\"ph systemoutput sysout\\\">sys_updated_on</samp>\\n before the value provided in</span>\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideDateTime/concept/c_GlideDateTimeAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a>.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\">List of objects containing cluster\\n information.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n { \\n "cluster_concept": "String",\\n "cluster_id": "String",\\n "cluster_quality": "String",\\n "cluster_size": "String",\\n "group_by": "String",\\n "insert_sequence": "String",\\n "purity": "String",\\n "sys_updated_on": "String"\\n }\\n]</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.cluster_concept</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\"><span class=\\\"ph\\\">Set of words that describe the cluster\\n in descending order of frequency.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.cluster_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\"><span class=\\\"ph\\\">Unique cluster number within a solution of clusters.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.cluster_quality</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\"><span class=\\\"ph\\\">Number from 0 to 100. Higher numbers\\n indicate higher cluster density.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.cluster_size</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\"><span class=\\\"ph\\\">Number of records in a cluster.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.group_by</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\"><span class=\\\"ph\\\">If\\n grouped, name of the segmentation field associated with this\\n cluster.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.insert_sequence</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\">Sequential position number of the cluster in the Cluster Summary\\n [ml_cluster_summary] table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.purity</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\">Percentage value representing the purity of cluster quality.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__1\\\"><object>.sys_updated_on</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2\\\">System <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/glideDateTimeScoped/concept/c_GlideDateTimeScoped.html\\\" class=\\\"xref\\\" title=\\\"The scoped GlideDateTime class provides methods for performing operations on GlideDateTime objects, such as instantiating GlideDateTime objects or working with glide_date_time fields.\\\">GlideDateTime</a> value representing the date and time at which this cluster\\n was last updated.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to set the options object parameter and print the filtered\\n cluster results.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\nvar mlSolutionVersion = mlSolution.getActiveVersion();\\n\\nvar options = {};\\noptions.updatedSince = '2020-05-28 02:09:53'; \\noptions.updatedUntil = '2020-05-28 03:15:00';\\noptions.sequenceSince = 1;\\noptions.limit = 10;\\n\\nvar results = mlSolutionVersion.getClusterInfo(options);\\n\\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "cluster_id": "1",\\n "cluster_quality": "100",\\n "cluster_size": "17",\\n "purity": "",\\n "insert_sequence": "8",\\n "group_by": "VPN Customer",\\n "sys_updated_on": "2020-05-28 02:09:53",\\n "cluster_concept": "vpn instance connection ldap user log unable usability tunnel"\\n },\\n {\\n "cluster_id": "1",\\n "cluster_quality": "100",\\n "cluster_size": "10",\\n "purity": "",\\n "insert_sequence": "24",\\n "group_by": "Live Feed",\\n "sys_updated_on": "2020-05-28 02:09:53",\\n "cluster_concept": "feed live user note work disable group default usability sort"\\n },\\n {\\n "cluster_id": "1",\\n "cluster_quality": "100",\\n "cluster_size": "18",\\n "purity": "",\\n "insert_sequence": "40",\\n "group_by": "Integrations",\\n "sys_updated_on": "2020-05-28 02:09:53",\\n "cluster_concept": "integrate usability certificate error"\\n },\\n...\\n]</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getProperties\\\" id=\\\"C-getProperties\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getProperties\\\">ClusteringSolutionVersion - getProperties()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets solution object\\n properties</span>\\n <span class=\\\"ph\\\">and version number</span>.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getProperties__table_d2m_zwz_4lb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getProperties__table_d2m_zwz_4lb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getProperties__table_d2m_zwz_4lb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getProperties__table_d2m_zwz_4lb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_d2m_zwz_4lb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_d2m_zwz_4lb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_d2m_zwz_4lb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getProperties__table_e2m_zwz_4lb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\">Contents of the Dataset and <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html#ClusteringSol-ClusteringSolution_O\\\" class=\\\"xref\\\" title=\\\"Creates a cluster solution.\\\">ClusteringSolution</a> version details. Results vary by object property\\n setup.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "algorithmConfig": {Object},\\n "datasetProperties": {Object},\\n "domainName": "String",\\n "encoder": {Object},\\n "groupByFieldName": "String", \\n "inputFieldNames": [Array],\\n "isActive": "Boolean",\\n "label": "String",\\n "minRecordsPerCluster" : Number,\\n "name": "String", "processingLanguage": "String",\\n "scope": "String",\\n "stopwords": [Array],\\n "trainingFrequency": "String",\\n "updateFrequency": "String",\\n "versionNumber": "Number"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">JavaScript object containing algorithm\\n configuration properties.</span> Property results vary by the value set in the <span class=\\\"keyword parmname\\\">algorithm</span>\\n property.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig' : {\\n "algorithm": "String", \\n // See algorithmConfig.algorithm setting description for property settings based on algorithm\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig.algorithm</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Method for\\n encoding your solution.</span>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">dbscan</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "dbscan",\\n "distanceMetric": "String",\\n "epsilon": Number,\\n "minimumNeighbours": Number\\n}</code></pre></div>\\n <div class=\\\"p\\\">Properties for\\n <span class=\\\"keyword parmname\\\">kmeans</span>:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">'algorithmConfig': {\\n "algorithm": "kmeans",\\n "targetCoverage": Number\\n}</code></pre></div>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig.distanceMetric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Distance metric to scan for similar data objects.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig.epsilon</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Decimal value between 0 and 1 representing the size of the\\n neighborhood search radius.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig.minimumNeighbours</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">DBSCAN\\n algorithm only. Minimum number of neighbors required in a point to be a part of a\\n cluster. For <span class=\\\"keyword parmname\\\">levenshteinDistance</span> the value must be 1 so that\\n no points are excluded from the dataset.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.algorithmConfig.targetCoverage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">K-means\\n algorithm only. Percentile field to filter out records that are less similar to\\n each other.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><p class=\\\"p\\\">Lists the properties of the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DatasetDefinition/concept/DatasetDefinitionAPI.html\\\" class=\\\"xref\\\" title=\\\"Identifies a set of records including a table name, columns, and row selection criteria to use as input for ML training algorithms. Datasets do not contain the actual data.\\\">DatatsetDefinition</a> object associated with the solution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "encodedQuery": "String",\\n "fieldDetails": [Array],\\n "fieldNames": [Array],\\n "tableName": "String"\\n}</code></pre>\\n <p class=\\\"p\\\">Data type: Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.tableName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Name of the table for the dataset. For\\n example, <code class=\\\"ph codeph\\\">"tableName" : "Incident"</code>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of field names from the specified table\\n as strings. For example, <code class=\\\"ph codeph\\\">"fieldNames" : ["short_description",\\n "priority"]</code>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of JavaScript objects that specify field\\n properties.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "name": "String",\\n "type": "String"\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldNames.fieldDetails.<object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Name of the field defining the type of\\n information to restrict this dataset to.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldDetails.<object>.type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Machine-learning field type.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.datasetProperties.fieldDetails.encodedQuery</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Encoded query string in standard Glide format.\\n See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\\\" class=\\\"xref\\\">Encoded query\\n strings</a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.domainName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Domain name associated with this dataset. See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=domain-separation-predictive-intelligence&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Domain separation and <span class=\\\"ph\\\">Predictive Intelligence</span></a>.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\">Object.encoderProperties</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Encoder object assigned to this\\n solution.</span> See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Encoder/concept/EncoderAPI.html#Encoder-Encoder_O\\\" class=\\\"xref\\\" title=\\\"Creates an encoder.\\\">Encoder - Encoder(Object config)</a>.<p class=\\\"p\\\">Data type:\\n Object.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\">Object.groupByFieldName</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\" id=\\\"C-getProperties__solution-obj-group-desc\\\">Field name by which\\n the system groups records into one or more clusters.</span>\\n <p class=\\\"p\\\">Data type:\\n String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\">Object.inputFieldNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">List of input field names as strings. The\\n model uses these fields used to make\\n predictions.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.isActive</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\">Flag that indicates whether this version is\\n active.<div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"C-getProperties__ul_i5m_lp1_dmb\\\">\\n <li class=\\\"li\\\">true: Version is active.</li>\\n <li class=\\\"li\\\">false: Version is not active.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.label</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Identifies the prediction\\n task.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "label": "my first prediction"\\n}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.minRecordsPerCluster</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Minimum number of records to allow in any cluster.</span>\\n <p class=\\\"p\\\">Data type: Number.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">System-assigned name.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.processingLanguage</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Processing language in two-letter ISO 639-1 language code format.</span>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.scope</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\">Object scope. Currently the only valid value is\\n <code class=\\\"ph codeph\\\">global</code>.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.stopwords</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Optional. Preset\\n list of strings that the system automatically generates based on the\\n <span class=\\\"keyword parmname\\\">language</span> property setting. For details, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-custom-stopwords-list&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create a custom stopwords\\n list</a>.</span>\\n <p class=\\\"p\\\">Data type: Array.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.trainingFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">The frequency to retrain the model.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"C-getProperties__ul_pmw_523_plb\\\">\\n <li class=\\\"li\\\">every_30_days</li>\\n <li class=\\\"li\\\">every_60_days</li>\\n <li class=\\\"li\\\">every_90_days</li>\\n <li class=\\\"li\\\">every_120_days</li>\\n <li class=\\\"li\\\">every_180_days</li>\\n <li class=\\\"li\\\">run_once</li>\\n </ul>Default: run_once</div>\\n <p class=\\\"p\\\">Data type: String.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.updateFrequency</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">The frequency at which the model for\\n the solution definition must be rebuilt.</span>\\n <div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"C-getProperties__ul_kjm_2jh_3mb\\\">\\n <li class=\\\"li\\\">do_not_update</li>\\n <li class=\\\"li\\\">every_1_day</li>\\n <li class=\\\"li\\\">every_1_hour</li>\\n <li class=\\\"li\\\">every_6_hours</li>\\n <li class=\\\"li\\\">every_12_hours</li>\\n <li class=\\\"li\\\">every_1_minute</li>\\n <li class=\\\"li\\\">every_15_minutes</li>\\n <li class=\\\"li\\\">every_30_minutes</li>\\n </ul>Default: do_not_update</div>\\n <p class=\\\"p\\\">Datatype: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__1\\\"><Object>.versionNumber</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getProperties__table_e2m_zwz_4lb__entry__2\\\"><span class=\\\"ph\\\">Version number of\\n the</span>\\n <span class=\\\"keyword apiname\\\">ClusteringSolution</span> object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example gets properties of the active object\\n version in the store.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get properties\\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">*** Script: {\\n "algorithmConfig": {\\n "algorithm": "kmeans",\\n "targetCoverage": "90"\\n },\\n "datasetProperties": {\\n "tableName": "incident",\\n "fieldNames": [\\n "category",\\n "short_description",\\n "state",\\n "description"\\n ],\\n "encodedQuery": "activeANYTHING"\\n },\\n "domainName": "global",\\n "encoderProperties": {\\n "datasetsProperties": [\\n {\\n "tableName": "incident",\\n "fieldNames": [\\n "assignment_group",\\n "short_description",\\n "description"\\n ],\\n "encodedQuery": "activeANYTHING"\\n }\\n ],\\n "domainName": "global",\\n "isActive": "true",\\n "label": "my encoder definition",\\n "name": "ml_x_snc_global_global_my_encoder_definition",\\n "processingLanguage": "en",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "versionNumber": "1"\\n },\\n "groupByFieldName": "category",\\n "inputFieldNames": [\\n "short_description"\\n ],\\n "isActive": "true",\\n "label": "clustering solution",\\n "minRecordsPerCluster": 2,\\n "name": "ml_x_snc_global_global_clustering_solution",\\n "processingLanguage": "en",\\n "stopwords": [\\n "Default English Stopwords"\\n ],\\n "updateFrequency": "do_not_update",\\n "versionNumber": "1"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getStatus_B\\\" id=\\\"C-getStatus_B\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getStatus_B\\\">ClusteringSolutionVersion - getStatus(Boolean includeDetails)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets training completion status.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getStatus_B__table_xfh_vbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__1\\\">includeDetails</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_xfh_vbw_plb__entry__3\\\"><p class=\\\"p\\\">Flag that indicates whether to return status <span class=\\\"keyword parmname\\\">details</span>.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"C-getStatus_B__ul_n33_ckw_plb\\\">\\n <li class=\\\"li\\\">true: Return additional details.</li>\\n <li class=\\\"li\\\">false: Do not return additional details.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Default: False</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getStatus_B__table_yfh_vbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\"><span class=\\\"ph\\\">JavaScript object containing training\\n status information\\n for</span> a <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html\\\" class=\\\"xref\\\" title=\\\"The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.\\\">ClusteringSolution</a>\\n object.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state": "String",\\n "percentComplete": "Number as a String",\\n "hasJobEnded": "Boolean value as a String",\\n "details": {Object}\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.state</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Training completion state. If the training\\n job reaches a terminal state, the job does not leave that state. If the state is\\n terminal, the <span class=\\\"keyword parmname\\\">hasJobEnded</span> property is set to\\n <code class=\\\"ph codeph\\\">true</code>.<div class=\\\"p\\\">Possible values:<ul class=\\\"ul\\\" id=\\\"C-getStatus_B__ul_a5q_gh4_vlb\\\">\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">fetching_files_for_training</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">preparing_data</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">retry</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_cancelled</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_complete </samp>(terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_error</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">solution_incomplete</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_request_received</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_request_timed_out</samp> (terminal)</li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">training_solution</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">uploading_solution</samp></li>\\n <li class=\\\"li\\\"><samp class=\\\"ph systemoutput sysout\\\">waiting_for_training</samp></li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.hasJobEnded</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\"><p class=\\\"p\\\">Flag that indicates whether training is complete.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"C-getStatus_B__ul_icy_zjx_rlb\\\">\\n <li class=\\\"li\\\">true: Training is complete.</li>\\n <li class=\\\"li\\\">false: Training is incomplete.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Data type: Boolean value as a String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.percentComplete</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Number between zero and 100 representing\\n training percent complete. If the completion percentage is less than 100, the job\\n might be in a terminal state. For example, if training times out.<p class=\\\"p\\\">Data type:\\n Number as a String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__1\\\"><Object>.details</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getStatus_B__table_yfh_vbw_plb__entry__2\\\">Object containing a list of additional\\n training details.<p class=\\\"p\\\">Data type: Object</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows a successful result\\n with training complete.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');\\n\\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_complete",\\n "percentComplete":"100",\\n "hasJobEnded":"true",\\n "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);\\n}</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows an unsuccessful\\n result with training complete.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get status\\nvar solutionName = 'ml_x_snc_global_global_cluster_solution';\\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);\\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\\n\\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "state":"solution_error",\\n "percentComplete":"100",\\n "hasJobEnded":"true"\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getTopNPurityInfo_O\\\" id=\\\"C-getTopNPurityInfo_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getTopNPurityInfo_O\\\">ClusteringSolutionVersion - getTopNPurityInfo(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the top purity results for a clustering solution. The purity measurement provides\\n insights as a percentage for the clustering fields on which the purity is based.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Options that determine the number and format of the top cluster purity\\n results.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "clusterIds": [Array],\\n "groupBy": [Array],\\n "purityFields": [Array],\\n "topN": Number,\\n "topNFields": Number\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options.clusterIds</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Optional. List of cluster IDs provided as strings. A cluster ID is provided in\\n the Cluster Summary [ml_cluster_summary] table. If provided, this method returns\\n purity cluster information for each specified cluster. <p class=\\\"p\\\">Default: This method\\n returns purity information for all clusters.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options.groupBy</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Optional.\\n List\\n of group_by field strings from your table to help the system identify the class\\n which is most frequent in the cluster. If provided, returns purity information for\\n cluster solutions using group_by fields. The Cluster Summary [ml_cluster_summary]\\n table lists clusters and any associated Group by values.<p class=\\\"p\\\">This field only applies\\n to clusters that use group by in the clustering definition. Eligible fields are\\n listed in the <span class=\\\"ph uicontrol\\\">Table</span> field. For details on the group by\\n feature, refer to <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=create-clustering-solution&version=vancouver&pubname=vancouver-intelligent-experiences\\\" class=\\\"xref\\\">Create and train a\\n clustering solution</a>.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options.purityFields</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Optional. List of purity field strings. If provided, this method only returns\\n information for these purity fields. You can view purity values for a cluster in the\\n Cluster Summary [ml_cluster_summary] table lists.<div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> If both\\n <span class=\\\"keyword parmname\\\">purity_fields</span> and <span class=\\\"keyword parmname\\\">top_n_fields</span> are\\n provided, this method returns <span class=\\\"keyword parmname\\\">top_n_fields</span> first, then\\n selects fields from <span class=\\\"keyword parmname\\\">purity_fields</span>.</div>\\n <p class=\\\"p\\\">Default: Return\\n purity information for all purity fields saved for the cluster.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options.topN</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Optional. Restricts the number of predictions to return to the highest values\\n for each purity field.<p class=\\\"p\\\">Maximum value: 10</p>\\n <p class=\\\"p\\\">Default: Return all purity\\n information for each purity field.</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__1\\\">options.topNFields</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3\\\">Optional. Restricts the number of purity fields returned to fields with the\\n highest purity for each cluster.<p class=\\\"p\\\">Maximum value: 10</p>\\n <p class=\\\"p\\\">Default: Return all\\n fields in the cluster.</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\\\">JSON-formatted string containing a list of clusters with purity fields and details.<div class=\\\"p\\\"><div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> Results vary based on settings made in the <span class=\\\"keyword parmname\\\">options</span>\\n input parameter.</div></div>\\n <p class=\\\"p\\\">The following information illustrates how cluster purity results are sorted\\n and categorized. Refer to the example for actual\\n output.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "<clusterID>":[\\n // List sorted by purity per field\\n { "<fieldName>":[\\n // List sorted by purity per field value\\n {"<field_val1_1>":"<purity>"},\\n // Additional field values\\n ]},\\n // Additional fields\\n ],\\t \\n // Additional clusters\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\\\">String.<clusterID></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\\\">List of clusters arranged in descending order by purity value per\\n cluster.<p class=\\\"p\\\">Data type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\\\">String.<clusterID>.<field></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\\\">List of objects representing purity fields arranged in descending order by\\n purity value per field. The <span class=\\\"keyword parmname\\\">options.top_n_fields</span> input object\\n parameter property determines the number of fields\\n returned.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"<field>":[{"<field_val>":"<purity>"}]}</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__1\\\">String.<clusterID>.<field>.<values></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2\\\">List of objects containing field value and purity. For example,\\n <code class=\\\"ph codeph\\\">{"priority":[{"5":"100"}]}</code> is a priority field with a score of 5\\n and a purity value of 100 percent. Results list in descending order by purity\\n percentage. The <span class=\\\"keyword parmname\\\">options.top_n</span> input object parameter property\\n determines the number of results returned.<p class=\\\"p\\\">Data type: Array</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get the top two purity results for the category field in\\n specific cluster solutions.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var solution = new GlideRecord('ml_solution');\\nsolution.addQuery('sys_id', '<clustering_solution_sys_id>');\\nsolution.addQuery('active', 'true');\\nsolution.query();\\n\\nwhile (solution.next()) {\\n\\n var options = {};\\n options.clusterIds = ['1', '3', '5'];\\n options.purityFields = ['category'];\\n options.topN = '2';\\n options.topNFields = '2';\\n\\n var clustering = new sn_ml.ClusteringSolutionVersion(solution);\\n var results = clustering.getTopNPurityInfo(options);\\n\\n gs.info(results);\\n}</code></pre>\\n <p class=\\\"p\\\">Output displays purity insights based on the settings provided in the options\\n parameter.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{"1":[{"category":[{"network":"99.96"},{"inquiry":"0.04"}]}],"3":[{"category":[{"Systems Engineering":"100"}]}],\\n"5":[{"category":[{"Security":"100"}]}]}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getUpdateStatus\\\" id=\\\"C-getUpdateStatus\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getUpdateStatus\\\">ClusteringSolutionVersion - getUpdateStatus()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Gets the status of the most recent clustering solution update job.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getUpdateStatus__table_kx2_w3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getUpdateStatus__table_kx2_w3b_rlb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getUpdateStatus__table_lx2_w3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getUpdateStatus__table_lx2_w3b_rlb__entry__2\\\">State of the clustering solution update.<div class=\\\"p\\\">States:<ul class=\\\"ul\\\" id=\\\"C-getUpdateStatus__ul_fgs_w54_wlb\\\">\\n <li class=\\\"li\\\">Configuration or network error</li>\\n <li class=\\\"li\\\">Error while updating solution</li>\\n <li class=\\\"li\\\">Fetching files for updating</li>\\n <li class=\\\"li\\\">Preparing data</li>\\n <li class=\\\"li\\\">Unauthorized</li>\\n <li class=\\\"li\\\">Update complete</li>\\n <li class=\\\"li\\\">Updating is cancelled</li>\\n <li class=\\\"li\\\">Updating request received</li>\\n <li class=\\\"li\\\">Updating request timed out</li>\\n <li class=\\\"li\\\">Updating solution</li>\\n <li class=\\\"li\\\">Uploading</li>\\n <li class=\\\"li\\\">Waiting</li>\\n </ul></div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get the update status of a clustering solution.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\ngs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"Update Complete"</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-getVersionNumber\\\" id=\\\"C-getVersionNumber\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-getVersionNumber\\\">ClusteringSolutionVersion - getVersionNumber()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the version number of</span> a solution object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-getVersionNumber__table_jsz_sbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getVersionNumber__table_jsz_sbw_plb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-getVersionNumber__table_ksz_sbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getVersionNumber__table_ksz_sbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-getVersionNumber__table_ksz_sbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getVersionNumber__table_ksz_sbw_plb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-getVersionNumber__table_ksz_sbw_plb__entry__2\\\"><span class=\\\"ph\\\">Version number.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to get a version\\n number.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Get version number\\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\\n\\ngs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">Version number: 1</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-predict_O_O\\\" id=\\\"C-predict_O_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-predict_O_O\\\">ClusteringSolutionVersion - predict(Object input, Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Gets the input data for a prediction.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-predict_O_O__table_wwz_pbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 19. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__1\\\">input</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__3\\\"><a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/GlideRecord/concept/c_GlideRecordAPI.html\\\" class=\\\"xref\\\" title=\\\"The GlideRecord API is used for database operations.\\\"><span class=\\\"keyword apiname\\\">GlideRecord</span></a>\\n <span class=\\\"ph\\\"> or array of JSON objects containing field names and\\n values as key-value pairs.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Optional values for filtering prediction\\n results.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "apply_threshold": Boolean,\\n "top_n": Number\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options.apply_threshold</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__3\\\">Flag that indicates whether to check the\\n threshold value for the solution and apply it to the result set.<div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"C-predict_O_O__ul_f4d_xyx_slb\\\">\\n <li class=\\\"li\\\">true: Return results in which confidence is greater than threshold.</li>\\n <li class=\\\"li\\\">false: Return all results.</li>\\n </ul></div>\\n <p class=\\\"p\\\">Default: True</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__1\\\">options.top_n</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_wwz_pbw_plb__entry__3\\\"><span class=\\\"ph\\\">If provided, returns the top\\n results, up to the specified number of predictions.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-predict_O_O__table_xwz_pbw_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 20. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">JSON object containing the prediction results sorted by\\n sys_id or record_number.</span>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n <identifier>: [Array]\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\">List of objects with details for each\\n prediction\\n result.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"><identifier>: [\\n {\\n "confidence": Number,\\n "predictedSysId": "String",\\n "predictedValue": "String", \\n "threshold": Number\\n }\\n]</code></pre>\\n <p class=\\\"p\\\">Data\\n type: Array</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.confidence</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value of the confidence associated\\n with the prediction. For example, 53.84.</span>\\n <p class=\\\"p\\\">Data type: Number</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.predictedSysId</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">The sys_id of the predicted\\n value. Results can be from any table on which information is being\\n predicted.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.predictedValue</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value representing the\\n prediction result.</span>\\n <p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__1\\\"><Object>.<identifier>.<object>.threshold</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-predict_O_O__table_xwz_pbw_plb__entry__2\\\"><span class=\\\"ph\\\">Value of the configured threshold\\n associated with the prediction.</span>\\n <p class=\\\"p\\\">Data type: Number</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to display prediction\\n results for a <span class=\\\"keyword apiname\\\">predict()</span> method that takes a GlideRecord by\\n sys_id for input and includes optional parameters to restrict to top three results\\n and exclude the threshold value.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\\n\\n// single GlideRecord input\\nvar input = new GlideRecord("incident");\\ninput.get("<sys_id>");\\n\\n// configure optional parameters\\nvar options = {};\\noptions.top_n = 3;\\noptions.apply_threshold = false;\\n\\nvar results = mlSolution.getVersion(1).predict(input, options);\\n// pretty print JSON results\\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "<sys_id/gr>": [\\n {\\n "confidence": 62.10782320780268,\\n "threshold": 20.36,\\n "predictedValue": "Clone Issues",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 6.945237375770391,\\n "threshold": 16.63,\\n "predictedValue": "Instance Administration",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 5.321061076300759,\\n "threshold": 23.7,\\n "predictedValue": "Administration",\\n "predictedSysId": ""\\n }\\n ]\\n}</code></pre>\\n </div>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to display prediction\\n results for a <span class=\\\"keyword apiname\\\">predict()</span> method that takes an array of field\\n names as key-value pairs for input and includes optional parameters to restrict to\\n top three results and exclude the threshold value.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_incident_categorization");\\n\\n// key-value pairs input\\nvar input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];\\n\\n// configure optional parameters\\nvar options = {};\\noptions.top_n = 3;\\noptions.apply_threshold = false;\\nvar results = mlSolution.predict(input, options);\\n\\n// pretty print JSON results\\ngs.print(JSON.stringify(JSON.parse(results), null, 2));</code></pre>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "1": [\\n {\\n "confidence": 37.5023032262591,\\n "threshold": 10.72,\\n "predictedValue": "Authentication",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 24.439964862166583,\\n "threshold": 23.7,\\n "predictedValue": "Administration",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 11.736320486031047,\\n "threshold": 100,\\n "predictedValue": "Security",\\n "predictedSysId": ""\\n }\\n ],\\n "2": [\\n {\\n "confidence": 99,\\n "threshold": 17.77,\\n "predictedValue": "Email",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 3.182137005157543,\\n "threshold": 10.72,\\n "predictedValue": "Authentication",\\n "predictedSysId": ""\\n },\\n {\\n "confidence": 2.8773826570713514,\\n "threshold": -1,\\n "predictedValue": "Email (I/f)",\\n "predictedSysId": ""\\n }\\n ]\\n}</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_C-submitUpdateJob_O\\\" id=\\\"C-submitUpdateJob_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_C-submitUpdateJob_O\\\">ClusteringSolutionVersion - submitUpdateJob(Object options)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Submits clustering update jobs with options to narrow results to a specific table and\\n filter for matching records.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"C-submitUpdateJob_O__table_gby_x2w_plb\\\"><caption><span class=\\\"table--title-label\\\">Table 21. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\\\">options</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\\\">JavaScript object containing options on which to base a clustering solution\\n update.<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "filter" : "String",\\n "table" : "String"\\n }</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\\\">options.filter</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\\\"><span class=\\\"ph\\\">Encoded query string in standard Glide format.\\n See <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=c_EncodedQueryStrings&version=vancouver&pubname=vancouver-platform-user-interface\\\" class=\\\"xref\\\">Encoded query\\n strings</a>.</span> Enables running an update job based on the filter provided.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__1\\\">options.table</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_gby_x2w_plb__entry__3\\\">Name of the table on which to run an update job.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"C-submitUpdateJob_O__table_qpm_x3b_rlb\\\"><caption><span class=\\\"table--title-label\\\">Table 22. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to submit an update job.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");\\n\\nvar options = {"filter" : "precision", "table" : "incident"};\\n\\nmyCluster.getActiveVersion().submitUpdateJob(options);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolutionVersion - Global\n\nThe ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used for working with solution versions based on ClusteringSolution\nAPI objects in the ClusteringSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nClusteringSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## ClusteringSolutionVersion - cancelUpdateJob()\n\nCancels an update job on a trainer.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an active training job that has been submitted\nusing the submitTrainingJob() method.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\nvar mlSolutionVersion = myCluster.getActiveVersion();\n\nmlSolutionVersion.cancelUpdateJob();\n```\n\n## ClusteringSolutionVersion - deleteClusterAssignments(Object options)\n\nDeletes cluster assignments from rows by position in table sequence or\nGlideDateTime.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Object defining one option for deleting cluster assignments.Note: Only one delete option is valid. |\n| options.updatedUntil | String | Deletes rows for clusters with `updated_since` values occurring before this value. Format must be provided as GlideDateTime. ```None { \"updatedUntil\" : \"String\" } ``` |\n| options.sequenceUntil | String | Deletes rows for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. ```None { \"sequenceUntil\" : Number } ``` |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Number | Number of rows deleted from the ML Cluster Detail [ml\\_cluster\\_detail] table. |\n\n### Example\n\nThe following example shows how to delete rows for clusters with\n`updated_since` time preceding `'2020-06-28\n02:50:53'`.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedUntil = '2020-06-28 02:50:53';\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print(\"Number of deleted rows: \"+results);\n```\n\nOutput:\n\n```None\nNumber of deleted rows: 6417\n```\n\n### Example\n\nThe following example shows how to delete rows for clusters with\n`updated_since` that are sequentially positioned prior to\n`1000`.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.sequenceUntil = 1000;\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print(\"Number of deleted rows: \"+results);\n```\n\nOutput:\n\n```None\nNumber of deleted rows: 999\n```\n\n## ClusteringSolutionVersion - getClusterAssignments(Object options)\n\nGets assignments for a clustering\nsolution.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Values to use to narrow down the returned results by group, level, system update times, and table row number within a clustering solution. Minimum of one argument must be specified. ```None { \"cluster_id\": \"String\", \"group_by\": \"String\", \"limit\": Number, \"sequenceSince\": Number, \"sequenceUntil\": Number, \"topNPerCluster\": Number, \"updatedSince\": \"String\", \"updatedUntil\": \"String\" } ``` |\n| options.cluster\\_id | String | Optional. Cluster ID of a trained solution in the Cluster Summary [ml\\_cluster\\_summary] table. |\n| options.group\\_by | String | Optional. Identifies the segmentation field for which to retrieve cluster memberships, for example, assignment\\_group. This field provides the same grouping as options provided in the Use Group By check box in the Clustering Definition form. The information provided varies based on the table selected in the Table field. For more information, see Create and train a clustering solution . |\n| options.limit | Number | Optional. Maximum number of cluster assignments to retrieve. |\n| options.sequenceSince | Number | Starting position in a table sequence. Returns information for clusters with insert\\_sequence enabled and positioned after this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.sequenceUntil | Number | Returns assignments for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.topNPerCluster | Number | Number of top results to receive for each cluster. |\n| options.updatedSince | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` after the value provided in GlideDateTime. |\n| options.updatedUntil | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` before the value provided in GlideDateTime. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of objects containing cluster information in increasing order by cluster\\_id. ```None [ { \"cluster_id\": \"String\", \"group_by\": \"String\", \"rec_display_id\": \"String\", \"rec_sys_id\": \"String\" } ] ``` |\n| <object>.cluster\\_id | Unique cluster number within a solution of clusters. |\n| <object>.group\\_by | If grouped, name of the segmentation field associated with this cluster. |\n| <object>.rec\\_display\\_id | Record type and number. |\n| <object>.rec\\_sys\\_id | Record sys\\_id. |\n\n### Example\n\nThe following example shows how to use the options object to filter\nclustering results.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"solution_name\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.clusterId = 56;\noptions.topNPerCluster = 10;\noptions.updatedUntil = '2020-01-17 23:16:14'; \noptions.updatedSince = '2020-01-17 23:16:13'; \noptions.sequenceUntil = 1000; \noptions.sequenceSince = 1100; \noptions.limit = 100;\n\nvar results = mlSolutionVersion.getClusterAssignments(options)\n\ngs.print(results);\n```\n\nOutput:\n\n```None\n[{\"cluster_id\":\"1\",\"rec_display_id\":\"Incident\": \"INC0014483\",\"rec_sys_id\":\"04e33e7adb401300864adfea5e961900\",\"group_by\":\"network\"},\n {\"cluster_id\":\"1\",\"rec_display_id\":\"Incident\": \"INC0011133\",\"rec_sys_id\":\"5bd23af2db401300864adfea5e96194d\",\"group_by\":\"network\"}]\n```\n\n## ClusteringSolutionVersion - getClusterInfo(Object options)\n\nGets information for a specified clustering\nsolution in the store. The purity measurement provides insights as a percentage for the clustering\nfields on which the purity is based.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Optional. Object containing properties that enable filtering results within a clustering solution. ```None { \"clusterId\": \"String\", \"groupBy\": \"String\", \"limit\": \"String\", \"recSysId\": \"String\", \"sequenceSince\": Number, \"sequenceUntil\": Number, \"updatedSince\": \"String\", \"updatedUntil\": \"String\" } ``` Default: Return cluster memberships for all clusters. |\n| options.clusterId | String | Optional. Cluster ID of a trained solution in the Cluster Summary [ml\\_cluster\\_summary] table. |\n| options.groupBy | String | Optional. Identifies the segmentation field for which to retrieve cluster memberships, for example, assignment\\_group. This field provides the same grouping as options provided in the Use Group By check box in the Clustering Definition form. The information provided varies based on the table selected in the Table field. For more information, see Create and train a clustering solution . |\n| options.limit | Number | Optional. Maximum number of cluster assignments to retrieve. |\n| options.recSysId | String | Optional. Sys\\_id of a record by which to find cluster information. |\n| options.sequenceSince | Number | Starting position in a table sequence. Returns information for clusters with insert\\_sequence enabled and positioned after this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.sequenceUntil | Number | Optional. Ending position in a table sequence. Returns assignments for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.updatedSince | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` after the value provided in GlideDateTime format. |\n| options.updatedUntil | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` before the value provided in GlideDateTime. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of objects containing cluster information. ```None [ { \"cluster_concept\": \"String\", \"cluster_id\": \"String\", \"cluster_quality\": \"String\", \"cluster_size\": \"String\", \"group_by\": \"String\", \"insert_sequence\": \"String\", \"purity\": \"String\", \"sys_updated_on\": \"String\" } ] ``` |\n| <object>.cluster\\_concept | Set of words that describe the cluster in descending order of frequency. Data type: String |\n| <object>.cluster\\_id | Unique cluster number within a solution of clusters. |\n| <object>.cluster\\_quality | Number from 0 to 100. Higher numbers indicate higher cluster density. Data type: String |\n| <object>.cluster\\_size | Number of records in a cluster. Data type: String |\n| <object>.group\\_by | If grouped, name of the segmentation field associated with this cluster. Data type: String |\n| <object>.insert\\_sequence | Sequential position number of the cluster in the Cluster Summary [ml\\_cluster\\_summary] table. Data type: String |\n| <object>.purity | Percentage value representing the purity of cluster quality. |\n| <object>.sys\\_updated\\_on | System GlideDateTime value representing the date and time at which this cluster was last updated. Data type: String |\n\n### Example\n\nThe following example shows how to set the options object parameter and print the filtered\ncluster results.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedSince = '2020-05-28 02:09:53'; \noptions.updatedUntil = '2020-05-28 03:15:00';\noptions.sequenceSince = 1;\noptions.limit = 10;\n\nvar results = mlSolutionVersion.getClusterInfo(options);\n\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n[\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"17\",\n \"purity\": \"\",\n \"insert_sequence\": \"8\",\n \"group_by\": \"VPN Customer\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"vpn instance connection ldap user log unable usability tunnel\"\n },\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"10\",\n \"purity\": \"\",\n \"insert_sequence\": \"24\",\n \"group_by\": \"Live Feed\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"feed live user note work disable group default usability sort\"\n },\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"18\",\n \"purity\": \"\",\n \"insert_sequence\": \"40\",\n \"group_by\": \"Integrations\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"integrate usability certificate error\"\n },\n...\n]\n```\n\n## ClusteringSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClusteringSolution version details. Results vary by object property setup. ```None { \"algorithmConfig\": {Object}, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"minRecordsPerCluster\" : Number, \"name\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\", \"versionNumber\": \"Number\" } ``` |\n| <Object>.algorithmConfig | JavaScript object containing algorithm configuration properties. Property results vary by the value set in the algorithm property. ```None 'algorithmConfig' : { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Method for encoding your solution. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` Data type: String. |\n| <Object>.algorithmConfig.distanceMetric | DBSCAN algorithm only. Distance metric to scan for similar data objects. Data type: String. |\n| <Object>.algorithmConfig.epsilon | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. Data type: Number. |\n| <Object>.algorithmConfig.minimumNeighbours | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. Data type: Number. |\n| <Object>.algorithmConfig.targetCoverage | K-means algorithm only. Percentile field to filter out records that are less similar to each other. Data type: Number. |\n| <Object>.datasetProperties | Lists the properties of the DatatsetDefinition object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| Object.encoderProperties | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| Object.groupByFieldName | Field name by which the system groups records into one or more clusters. Data type: String |\n| Object.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.minRecordsPerCluster | Minimum number of records to allow in any cluster. Data type: Number. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.updateFrequency | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update Datatype: String |\n| <Object>.versionNumber | Version number of the ClusteringSolution object. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n*** Script: {\n \"algorithmConfig\": {\n \"algorithm\": \"kmeans\",\n \"targetCoverage\": \"90\"\n },\n \"datasetProperties\": {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"category\",\n \"short_description\",\n \"state\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [\n {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"assignment_group\",\n \"short_description\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n }\n ],\n \"domainName\": \"global\",\n \"isActive\": \"true\",\n \"label\": \"my encoder definition\",\n \"name\": \"ml_x_snc_global_global_my_encoder_definition\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n },\n \"groupByFieldName\": \"category\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"isActive\": \"true\",\n \"label\": \"clustering solution\",\n \"minRecordsPerCluster\": 2,\n \"name\": \"ml_x_snc_global_global_clustering_solution\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"updateFrequency\": \"do_not_update\",\n \"versionNumber\": \"1\"\n}\n```\n\n## ClusteringSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a ClusteringSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_cluster_solution';\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClusteringSolutionVersion - getTopNPurityInfo(Object options)\n\nGets the top purity results for a clustering solution. The purity measurement provides\ninsights as a percentage for the clustering fields on which the purity is based.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options that determine the number and format of the top cluster purity results. ```None { \"clusterIds\": [Array], \"groupBy\": [Array], \"purityFields\": [Array], \"topN\": Number, \"topNFields\": Number } ``` |\n| options.clusterIds | Array | Optional. List of cluster IDs provided as strings. A cluster ID is provided in the Cluster Summary [ml\\_cluster\\_summary] table. If provided, this method returns purity cluster information for each specified cluster. Default: This method returns purity information for all clusters. |\n| options.groupBy | Array | Optional. List of group\\_by field strings from your table to help the system identify the class which is most frequent in the cluster. If provided, returns purity information for cluster solutions using group\\_by fields. The Cluster Summary [ml\\_cluster\\_summary] table lists clusters and any associated Group by values. This field only applies to clusters that use group by in the clustering definition. Eligible fields are listed in the Table field. For details on the group by feature, refer to Create and train a clustering solution. |\n| options.purityFields | Array | Optional. List of purity field strings. If provided, this method only returns information for these purity fields. You can view purity values for a cluster in the Cluster Summary [ml\\_cluster\\_summary] table lists.Note: If both purity\\_fields and top\\_n\\_fields are provided, this method returns top\\_n\\_fields first, then selects fields from purity\\_fields. Default: Return purity information for all purity fields saved for the cluster. |\n| options.topN | Number | Optional. Restricts the number of predictions to return to the highest values for each purity field. Maximum value: 10 Default: Return all purity information for each purity field. |\n| options.topNFields | Number | Optional. Restricts the number of purity fields returned to fields with the highest purity for each cluster. Maximum value: 10 Default: Return all fields in the cluster. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| String | JSON-formatted string containing a list of clusters with purity fields and details.Note: Results vary based on settings made in the options input parameter. The following information illustrates how cluster purity results are sorted and categorized. Refer to the example for actual output. ```None { \"<clusterID>\":[ // List sorted by purity per field { \"<fieldName>\":[ // List sorted by purity per field value {\"<field_val1_1>\":\"<purity>\"}, // Additional field values ]}, // Additional fields ],\t // Additional clusters } ``` |\n| String.<clusterID> | List of clusters arranged in descending order by purity value per cluster. Data type: Array |\n| String.<clusterID>.<field> | List of objects representing purity fields arranged in descending order by purity value per field. The options.top\\_n\\_fields input object parameter property determines the number of fields returned. ```None \"<field>\":[{\"<field_val>\":\"<purity>\"}]} ``` Data type: Array |\n| String.<clusterID>.<field>.<values> | List of objects containing field value and purity. For example, `{\"priority\":[{\"5\":\"100\"}]}` is a priority field with a score of 5 and a purity value of 100 percent. Results list in descending order by purity percentage. The options.top\\_n input object parameter property determines the number of results returned. Data type: Array |\n\n### Example\n\nThe following example shows how to get the top two purity results for the category field in\nspecific cluster solutions.\n\n```None\nvar solution = new GlideRecord('ml_solution');\nsolution.addQuery('sys_id', '<clustering_solution_sys_id>');\nsolution.addQuery('active', 'true');\nsolution.query();\n\nwhile (solution.next()) {\n\n var options = {};\n options.clusterIds = ['1', '3', '5'];\n options.purityFields = ['category'];\n options.topN = '2';\n options.topNFields = '2';\n\n var clustering = new sn_ml.ClusteringSolutionVersion(solution);\n var results = clustering.getTopNPurityInfo(options);\n\n gs.info(results);\n}\n```\n\nOutput displays purity insights based on the settings provided in the options\nparameter.\n\n```None\n{\"1\":[{\"category\":[{\"network\":\"99.96\"},{\"inquiry\":\"0.04\"}]}],\"3\":[{\"category\":[{\"Systems Engineering\":\"100\"}]}],\n\"5\":[{\"category\":[{\"Security\":\"100\"}]}]}\n```\n\n## ClusteringSolutionVersion - getUpdateStatus()\n\nGets the status of the most recent clustering solution update job.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| String | State of the clustering solution update.States: * Configuration or network error * Error while updating solution * Fetching files for updating * Preparing data * Unauthorized * Update complete * Updating is cancelled * Updating request received * Updating request timed out * Updating solution * Uploading * Waiting |\n\n### Example\n\nThe following example shows how to get the update status of a clustering solution.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\ngs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));\n```\n\nOutput:\n\n```None\n\"Update Complete\"\n```\n\n## ClusteringSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## ClusteringSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"<sys_id/gr>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_incident_categorization\");\n\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n## ClusteringSolutionVersion - submitUpdateJob(Object options)\n\nSubmits clustering update jobs with options to narrow results to a specific table and\nfilter for matching records.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | JavaScript object containing options on which to base a clustering solution update. ```None { \"filter\" : \"String\", \"table\" : \"String\" } ``` |\n| options.filter | String | Encoded query string in standard Glide format. See Encoded query strings. Enables running an update job based on the filter provided. |\n| options.table | String | Name of the table on which to run an update job. |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to submit an update job.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar options = {\"filter\" : \"precision\", \"table\" : \"incident\"};\n\nmyCluster.getActiveVersion().submitUpdateJob(options);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ClusteringSolutionVersion - Global\ndescription: The ClusteringSolutionVersion API is a scriptable object used in Predictive\n Intelligence stores.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ClusteringSolutionVersion - Global\n\nThe ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.\n\nThis API requires the Predictive Intelligence plugin (com.glide.platform\\_ml) and is provided\nwithin the `sn_ml` namespace.\n\nThis API is used for working with solution versions based on ClusteringSolution\nAPI objects in the ClusteringSolution store.\n\nThe system creates a solution version each time you train\na solution definition. Most versions are created during scheduled solution\ntraining.\n\nMethods in this API are accessible using the following\nClusteringSolution methods:\n\n* getActiveVersion()\n* getAllVersions()\n* getLatestVersion()\n* getVersion()\n\n## ClusteringSolutionVersion - cancelUpdateJob()\n\nCancels an update job on a trainer.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to cancel an active training job that has been submitted\nusing the submitTrainingJob() method.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\nvar mlSolutionVersion = myCluster.getActiveVersion();\n\nmlSolutionVersion.cancelUpdateJob();\n```\n\n## ClusteringSolutionVersion - deleteClusterAssignments(Object options)\n\nDeletes cluster assignments from rows by position in table sequence or\nGlideDateTime.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Object defining one option for deleting cluster assignments.Note: Only one delete option is valid. |\n| options.updatedUntil | String | Deletes rows for clusters with `updated_since` values occurring before this value. Format must be provided as GlideDateTime. ```None { \"updatedUntil\" : \"String\" } ``` |\n| options.sequenceUntil | String | Deletes rows for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. ```None { \"sequenceUntil\" : Number } ``` |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Number | Number of rows deleted from the ML Cluster Detail [ml\\_cluster\\_detail] table. |\n\n### Example\n\nThe following example shows how to delete rows for clusters with\n`updated_since` time preceding `'2020-06-28\n02:50:53'`.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedUntil = '2020-06-28 02:50:53';\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print(\"Number of deleted rows: \"+results);\n```\n\nOutput:\n\n```None\nNumber of deleted rows: 6417\n```\n\n### Example\n\nThe following example shows how to delete rows for clusters with\n`updated_since` that are sequentially positioned prior to\n`1000`.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.sequenceUntil = 1000;\n\nvar results = mlSolutionVersion.deleteClusterAssignments(options);\n\ngs.print(\"Number of deleted rows: \"+results);\n```\n\nOutput:\n\n```None\nNumber of deleted rows: 999\n```\n\n## ClusteringSolutionVersion - getClusterAssignments(Object options)\n\nGets assignments for a clustering\nsolution.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Values to use to narrow down the returned results by group, level, system update times, and table row number within a clustering solution. Minimum of one argument must be specified. ```None { \"cluster_id\": \"String\", \"group_by\": \"String\", \"limit\": Number, \"sequenceSince\": Number, \"sequenceUntil\": Number, \"topNPerCluster\": Number, \"updatedSince\": \"String\", \"updatedUntil\": \"String\" } ``` |\n| options.cluster\\_id | String | Optional. Cluster ID of a trained solution in the Cluster Summary [ml\\_cluster\\_summary] table. |\n| options.group\\_by | String | Optional. Identifies the segmentation field for which to retrieve cluster memberships, for example, assignment\\_group. This field provides the same grouping as options provided in the Use Group By check box in the Clustering Definition form. The information provided varies based on the table selected in the Table field. For more information, see Create and train a clustering solution . |\n| options.limit | Number | Optional. Maximum number of cluster assignments to retrieve. |\n| options.sequenceSince | Number | Starting position in a table sequence. Returns information for clusters with insert\\_sequence enabled and positioned after this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.sequenceUntil | Number | Returns assignments for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.topNPerCluster | Number | Number of top results to receive for each cluster. |\n| options.updatedSince | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` after the value provided in GlideDateTime. |\n| options.updatedUntil | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` before the value provided in GlideDateTime. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of objects containing cluster information in increasing order by cluster\\_id. ```None [ { \"cluster_id\": \"String\", \"group_by\": \"String\", \"rec_display_id\": \"String\", \"rec_sys_id\": \"String\" } ] ``` |\n| <object>.cluster\\_id | Unique cluster number within a solution of clusters. |\n| <object>.group\\_by | If grouped, name of the segmentation field associated with this cluster. |\n| <object>.rec\\_display\\_id | Record type and number. |\n| <object>.rec\\_sys\\_id | Record sys\\_id. |\n\n### Example\n\nThe following example shows how to use the options object to filter\nclustering results.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"solution_name\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.clusterId = 56;\noptions.topNPerCluster = 10;\noptions.updatedUntil = '2020-01-17 23:16:14'; \noptions.updatedSince = '2020-01-17 23:16:13'; \noptions.sequenceUntil = 1000; \noptions.sequenceSince = 1100; \noptions.limit = 100;\n\nvar results = mlSolutionVersion.getClusterAssignments(options)\n\ngs.print(results);\n```\n\nOutput:\n\n```None\n[{\"cluster_id\":\"1\",\"rec_display_id\":\"Incident\": \"INC0014483\",\"rec_sys_id\":\"04e33e7adb401300864adfea5e961900\",\"group_by\":\"network\"},\n {\"cluster_id\":\"1\",\"rec_display_id\":\"Incident\": \"INC0011133\",\"rec_sys_id\":\"5bd23af2db401300864adfea5e96194d\",\"group_by\":\"network\"}]\n```\n\n## ClusteringSolutionVersion - getClusterInfo(Object options)\n\nGets information for a specified clustering\nsolution in the store. The purity measurement provides insights as a percentage for the clustering\nfields on which the purity is based.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Optional. Object containing properties that enable filtering results within a clustering solution. ```None { \"clusterId\": \"String\", \"groupBy\": \"String\", \"limit\": \"String\", \"recSysId\": \"String\", \"sequenceSince\": Number, \"sequenceUntil\": Number, \"updatedSince\": \"String\", \"updatedUntil\": \"String\" } ``` Default: Return cluster memberships for all clusters. |\n| options.clusterId | String | Optional. Cluster ID of a trained solution in the Cluster Summary [ml\\_cluster\\_summary] table. |\n| options.groupBy | String | Optional. Identifies the segmentation field for which to retrieve cluster memberships, for example, assignment\\_group. This field provides the same grouping as options provided in the Use Group By check box in the Clustering Definition form. The information provided varies based on the table selected in the Table field. For more information, see Create and train a clustering solution . |\n| options.limit | Number | Optional. Maximum number of cluster assignments to retrieve. |\n| options.recSysId | String | Optional. Sys\\_id of a record by which to find cluster information. |\n| options.sequenceSince | Number | Starting position in a table sequence. Returns information for clusters with insert\\_sequence enabled and positioned after this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.sequenceUntil | Number | Optional. Ending position in a table sequence. Returns assignments for clusters with `insert_sequence` values occurring before this value in the ML Cluster Detail [ml\\_cluster\\_detail] table. The sequence position starting point value is 1. |\n| options.updatedSince | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` after the value provided in GlideDateTime format. |\n| options.updatedUntil | String | Optional. Date and time. Returns information for clusters with `sys_updated_on` before the value provided in GlideDateTime. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Array | List of objects containing cluster information. ```None [ { \"cluster_concept\": \"String\", \"cluster_id\": \"String\", \"cluster_quality\": \"String\", \"cluster_size\": \"String\", \"group_by\": \"String\", \"insert_sequence\": \"String\", \"purity\": \"String\", \"sys_updated_on\": \"String\" } ] ``` |\n| <object>.cluster\\_concept | Set of words that describe the cluster in descending order of frequency. Data type: String |\n| <object>.cluster\\_id | Unique cluster number within a solution of clusters. |\n| <object>.cluster\\_quality | Number from 0 to 100. Higher numbers indicate higher cluster density. Data type: String |\n| <object>.cluster\\_size | Number of records in a cluster. Data type: String |\n| <object>.group\\_by | If grouped, name of the segmentation field associated with this cluster. Data type: String |\n| <object>.insert\\_sequence | Sequential position number of the cluster in the Cluster Summary [ml\\_cluster\\_summary] table. Data type: String |\n| <object>.purity | Percentage value representing the purity of cluster quality. |\n| <object>.sys\\_updated\\_on | System GlideDateTime value representing the date and time at which this cluster was last updated. Data type: String |\n\n### Example\n\nThe following example shows how to set the options object parameter and print the filtered\ncluster results.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar mlSolutionVersion = mlSolution.getActiveVersion();\n\nvar options = {};\noptions.updatedSince = '2020-05-28 02:09:53'; \noptions.updatedUntil = '2020-05-28 03:15:00';\noptions.sequenceSince = 1;\noptions.limit = 10;\n\nvar results = mlSolutionVersion.getClusterInfo(options);\n\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n\nOutput:\n\n```None\n[\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"17\",\n \"purity\": \"\",\n \"insert_sequence\": \"8\",\n \"group_by\": \"VPN Customer\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"vpn instance connection ldap user log unable usability tunnel\"\n },\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"10\",\n \"purity\": \"\",\n \"insert_sequence\": \"24\",\n \"group_by\": \"Live Feed\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"feed live user note work disable group default usability sort\"\n },\n {\n \"cluster_id\": \"1\",\n \"cluster_quality\": \"100\",\n \"cluster_size\": \"18\",\n \"purity\": \"\",\n \"insert_sequence\": \"40\",\n \"group_by\": \"Integrations\",\n \"sys_updated_on\": \"2020-05-28 02:09:53\",\n \"cluster_concept\": \"integrate usability certificate error\"\n },\n...\n]\n```\n\n## ClusteringSolutionVersion - getProperties()\n\nGets solution object\nproperties\nand version number.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| Object | Contents of the Dataset and ClusteringSolution version details. Results vary by object property setup. ```None { \"algorithmConfig\": {Object}, \"datasetProperties\": {Object}, \"domainName\": \"String\", \"encoder\": {Object}, \"groupByFieldName\": \"String\", \"inputFieldNames\": [Array], \"isActive\": \"Boolean\", \"label\": \"String\", \"minRecordsPerCluster\" : Number, \"name\": \"String\", \"processingLanguage\": \"String\", \"scope\": \"String\", \"stopwords\": [Array], \"trainingFrequency\": \"String\", \"updateFrequency\": \"String\", \"versionNumber\": \"Number\" } ``` |\n| <Object>.algorithmConfig | JavaScript object containing algorithm configuration properties. Property results vary by the value set in the algorithm property. ```None 'algorithmConfig' : { \"algorithm\": \"String\", // See algorithmConfig.algorithm setting description for property settings based on algorithm } ``` Data type: Object. |\n| <Object>.algorithmConfig.algorithm | Method for encoding your solution. Properties for dbscan: ```None 'algorithmConfig': { \"algorithm\": \"dbscan\", \"distanceMetric\": \"String\", \"epsilon\": Number, \"minimumNeighbours\": Number } ``` Properties for kmeans: ```None 'algorithmConfig': { \"algorithm\": \"kmeans\", \"targetCoverage\": Number } ``` Data type: String. |\n| <Object>.algorithmConfig.distanceMetric | DBSCAN algorithm only. Distance metric to scan for similar data objects. Data type: String. |\n| <Object>.algorithmConfig.epsilon | DBSCAN algorithm only. Decimal value between 0 and 1 representing the size of the neighborhood search radius. Data type: Number. |\n| <Object>.algorithmConfig.minimumNeighbours | DBSCAN algorithm only. Minimum number of neighbors required in a point to be a part of a cluster. For levenshteinDistance the value must be 1 so that no points are excluded from the dataset. Data type: Number. |\n| <Object>.algorithmConfig.targetCoverage | K-means algorithm only. Percentile field to filter out records that are less similar to each other. Data type: Number. |\n| <Object>.datasetProperties | Lists the properties of the DatatsetDefinition object associated with the solution. ```None { \"encodedQuery\": \"String\", \"fieldDetails\": [Array], \"fieldNames\": [Array], \"tableName\": \"String\" } ``` Data type: Object. |\n| <Object>.datasetProperties.tableName | Name of the table for the dataset. For example, `\"tableName\" : \"Incident\"`. Data type: String. |\n| <Object>.datasetProperties.fieldNames | List of field names from the specified table as strings. For example, `\"fieldNames\" : [\"short_description\", \"priority\"]`. Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails | List of JavaScript objects that specify field properties. ```None [ { \"name\": \"String\", \"type\": \"String\" } ] ``` Data type: Array. |\n| <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name | Name of the field defining the type of information to restrict this dataset to. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.<object>.type | Machine-learning field type. Data type: String. |\n| <Object>.datasetProperties.fieldDetails.encodedQuery | Encoded query string in standard Glide format. See Encoded query strings. Data type: String. |\n| <Object>.domainName | Domain name associated with this dataset. See Domain separation and Predictive Intelligence. Data type: String. |\n| Object.encoderProperties | Encoder object assigned to this solution. See Encoder - Encoder(Object config). Data type: Object. |\n| Object.groupByFieldName | Field name by which the system groups records into one or more clusters. Data type: String |\n| Object.inputFieldNames | List of input field names as strings. The model uses these fields used to make predictions. Data type: String. |\n| <Object>.isActive | Flag that indicates whether this version is active.Valid values: * true: Version is active. * false: Version is not active. Data type: String |\n| <Object>.label | Identifies the prediction task. ```None { \"label\": \"my first prediction\" } ``` Data type: String. |\n| <Object>.minRecordsPerCluster | Minimum number of records to allow in any cluster. Data type: Number. |\n| <Object>.name | System-assigned name. Data type: String. |\n| <Object>.processingLanguage | Processing language in two-letter ISO 639-1 language code format. Data type: String. |\n| <Object>.scope | Object scope. Currently the only valid value is `global`. Data type: String |\n| <Object>.stopwords | Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array. |\n| <Object>.trainingFrequency | The frequency to retrain the model. Possible values: * every\\_30\\_days * every\\_60\\_days * every\\_90\\_days * every\\_120\\_days * every\\_180\\_days * run\\_once Default: run\\_once Data type: String. |\n| <Object>.updateFrequency | The frequency at which the model for the solution definition must be rebuilt. Possible values: * do\\_not\\_update * every\\_1\\_day * every\\_1\\_hour * every\\_6\\_hours * every\\_12\\_hours * every\\_1\\_minute * every\\_15\\_minutes * every\\_30\\_minutes Default: do\\_not\\_update Datatype: String |\n| <Object>.versionNumber | Version number of the ClusteringSolution object. |\n\n### Example\n\nThe following example gets properties of the active object\nversion in the store.\n\n```None\n// Get properties\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));\n```\n\nOutput:\n\n```None\n*** Script: {\n \"algorithmConfig\": {\n \"algorithm\": \"kmeans\",\n \"targetCoverage\": \"90\"\n },\n \"datasetProperties\": {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"category\",\n \"short_description\",\n \"state\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n },\n \"domainName\": \"global\",\n \"encoderProperties\": {\n \"datasetsProperties\": [\n {\n \"tableName\": \"incident\",\n \"fieldNames\": [\n \"assignment_group\",\n \"short_description\",\n \"description\"\n ],\n \"encodedQuery\": \"activeANYTHING\"\n }\n ],\n \"domainName\": \"global\",\n \"isActive\": \"true\",\n \"label\": \"my encoder definition\",\n \"name\": \"ml_x_snc_global_global_my_encoder_definition\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"versionNumber\": \"1\"\n },\n \"groupByFieldName\": \"category\",\n \"inputFieldNames\": [\n \"short_description\"\n ],\n \"isActive\": \"true\",\n \"label\": \"clustering solution\",\n \"minRecordsPerCluster\": 2,\n \"name\": \"ml_x_snc_global_global_clustering_solution\",\n \"processingLanguage\": \"en\",\n \"stopwords\": [\n \"Default English Stopwords\"\n ],\n \"updateFrequency\": \"do_not_update\",\n \"versionNumber\": \"1\"\n}\n```\n\n## ClusteringSolutionVersion - getStatus(Boolean includeDetails)\n\nGets training completion status.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| includeDetails | Boolean | Flag that indicates whether to return status details. Valid values: * true: Return additional details. * false: Do not return additional details. Default: False |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| Object | JavaScript object containing training status information for a ClusteringSolution object. ```None { \"state\": \"String\", \"percentComplete\": \"Number as a String\", \"hasJobEnded\": \"Boolean value as a String\", \"details\": {Object} } ``` |\n| <Object>.state | Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to `true`.Possible values: * `fetching_files_for_training` * `preparing_data` * `retry` * `solution_cancelled` (terminal) * `solution_complete` (terminal) * `solution_error` (terminal) * `solution_incomplete` * `training_request_received` * `training_request_timed_out` (terminal) * `training_solution` * `uploading_solution` * `waiting_for_training` Data type: String |\n| <Object>.hasJobEnded | Flag that indicates whether training is complete. Valid values: * true: Training is complete. * false: Training is incomplete. Data type: Boolean value as a String |\n| <Object>.percentComplete | Number between zero and 100 representing training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out. Data type: Number as a String |\n| <Object>.details | Object containing a list of additional training details. Data type: Object |\n\n### Example\n\nThe following example shows a successful result\nwith training complete.\n\n```None\n// Get status\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');\n\ngs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_complete\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\",\n \"details\":{\"stepLabel\":\"Solution Complete\"} // This information is only returned if getStatus(true);\n}\n```\n\n### Example\n\nThe following example shows an unsuccessful\nresult with training complete.\n\n```None\n// Get status\nvar solutionName = 'ml_x_snc_global_global_cluster_solution';\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);\nvar trainingStatus = mlSolution.getLatestVersion().getStatus();\n\ngs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));\n```\n\nOutput:\n\n```None\n{\n \"state\":\"solution_error\",\n \"percentComplete\":\"100\",\n \"hasJobEnded\":\"true\"\n}\n```\n\n## ClusteringSolutionVersion - getTopNPurityInfo(Object options)\n\nGets the top purity results for a clustering solution. The purity measurement provides\ninsights as a percentage for the clustering fields on which the purity is based.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | Options that determine the number and format of the top cluster purity results. ```None { \"clusterIds\": [Array], \"groupBy\": [Array], \"purityFields\": [Array], \"topN\": Number, \"topNFields\": Number } ``` |\n| options.clusterIds | Array | Optional. List of cluster IDs provided as strings. A cluster ID is provided in the Cluster Summary [ml\\_cluster\\_summary] table. If provided, this method returns purity cluster information for each specified cluster. Default: This method returns purity information for all clusters. |\n| options.groupBy | Array | Optional. List of group\\_by field strings from your table to help the system identify the class which is most frequent in the cluster. If provided, returns purity information for cluster solutions using group\\_by fields. The Cluster Summary [ml\\_cluster\\_summary] table lists clusters and any associated Group by values. This field only applies to clusters that use group by in the clustering definition. Eligible fields are listed in the Table field. For details on the group by feature, refer to Create and train a clustering solution. |\n| options.purityFields | Array | Optional. List of purity field strings. If provided, this method only returns information for these purity fields. You can view purity values for a cluster in the Cluster Summary [ml\\_cluster\\_summary] table lists.Note: If both purity\\_fields and top\\_n\\_fields are provided, this method returns top\\_n\\_fields first, then selects fields from purity\\_fields. Default: Return purity information for all purity fields saved for the cluster. |\n| options.topN | Number | Optional. Restricts the number of predictions to return to the highest values for each purity field. Maximum value: 10 Default: Return all purity information for each purity field. |\n| options.topNFields | Number | Optional. Restricts the number of purity fields returned to fields with the highest purity for each cluster. Maximum value: 10 Default: Return all fields in the cluster. |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| String | JSON-formatted string containing a list of clusters with purity fields and details.Note: Results vary based on settings made in the options input parameter. The following information illustrates how cluster purity results are sorted and categorized. Refer to the example for actual output. ```None { \"<clusterID>\":[ // List sorted by purity per field { \"<fieldName>\":[ // List sorted by purity per field value {\"<field_val1_1>\":\"<purity>\"}, // Additional field values ]}, // Additional fields ],\t // Additional clusters } ``` |\n| String.<clusterID> | List of clusters arranged in descending order by purity value per cluster. Data type: Array |\n| String.<clusterID>.<field> | List of objects representing purity fields arranged in descending order by purity value per field. The options.top\\_n\\_fields input object parameter property determines the number of fields returned. ```None \"<field>\":[{\"<field_val>\":\"<purity>\"}]} ``` Data type: Array |\n| String.<clusterID>.<field>.<values> | List of objects containing field value and purity. For example, `{\"priority\":[{\"5\":\"100\"}]}` is a priority field with a score of 5 and a purity value of 100 percent. Results list in descending order by purity percentage. The options.top\\_n input object parameter property determines the number of results returned. Data type: Array |\n\n### Example\n\nThe following example shows how to get the top two purity results for the category field in\nspecific cluster solutions.\n\n```None\nvar solution = new GlideRecord('ml_solution');\nsolution.addQuery('sys_id', '<clustering_solution_sys_id>');\nsolution.addQuery('active', 'true');\nsolution.query();\n\nwhile (solution.next()) {\n\n var options = {};\n options.clusterIds = ['1', '3', '5'];\n options.purityFields = ['category'];\n options.topN = '2';\n options.topNFields = '2';\n\n var clustering = new sn_ml.ClusteringSolutionVersion(solution);\n var results = clustering.getTopNPurityInfo(options);\n\n gs.info(results);\n}\n```\n\nOutput displays purity insights based on the settings provided in the options\nparameter.\n\n```None\n{\"1\":[{\"category\":[{\"network\":\"99.96\"},{\"inquiry\":\"0.04\"}]}],\"3\":[{\"category\":[{\"Systems Engineering\":\"100\"}]}],\n\"5\":[{\"category\":[{\"Security\":\"100\"}]}]}\n```\n\n## ClusteringSolutionVersion - getUpdateStatus()\n\nGets the status of the most recent clustering solution update job.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| String | State of the clustering solution update.States: * Configuration or network error * Error while updating solution * Fetching files for updating * Preparing data * Unauthorized * Update complete * Updating is cancelled * Updating request received * Updating request timed out * Updating solution * Uploading * Waiting |\n\n### Example\n\nThe following example shows how to get the update status of a clustering solution.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\ngs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));\n```\n\nOutput:\n\n```None\n\"Update Complete\"\n```\n\n## ClusteringSolutionVersion - getVersionNumber()\n\nGets the version number of a solution object.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| String | Version number. |\n\n### Example\n\nThe following example shows how to get a version\nnumber.\n\n```None\n// Get version number\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');\n\ngs.print(\"Version number: \"+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));\n```\n\nOutput:\n\n```None\nVersion number: 1\n```\n\n## ClusteringSolutionVersion - predict(Object input, Object options)\n\nGets the input data for a prediction.\n\nTable 19. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| input | Object | GlideRecord or array of JSON objects containing field names and values as key-value pairs. |\n| options | Object | Optional values for filtering prediction results. ```None { \"apply_threshold\": Boolean, \"top_n\": Number } ``` |\n| options.apply\\_threshold | Boolean | Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values: * true: Return results in which confidence is greater than threshold. * false: Return all results. Default: True |\n| options.top\\_n | Number | If provided, returns the top results, up to the specified number of predictions. |\n\nTable 20. Returns\n| Type | Description |\n| --- | --- |\n| Object | JSON object containing the prediction results sorted by sys\\_id or record\\_number. ```None { <identifier>: [Array] } ``` |\n| <Object>.<identifier> | List of objects with details for each prediction result. ```None <identifier>: [ { \"confidence\": Number, \"predictedSysId\": \"String\", \"predictedValue\": \"String\", \"threshold\": Number } ] ``` Data type: Array |\n| <Object>.<identifier>.<object>.confidence | Value of the confidence associated with the prediction. For example, 53.84. Data type: Number |\n| <Object>.<identifier>.<object>.predictedSysId | The sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String |\n| <Object>.<identifier>.<object>.predictedValue | Value representing the prediction result. Data type: String |\n| <Object>.<identifier>.<object>.threshold | Value of the configured threshold associated with the prediction. Data type: Number |\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes a GlideRecord by\nsys\\_id for input and includes optional parameters to restrict to top three results\nand exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get('ml_incident_categorization');\n\n// single GlideRecord input\nvar input = new GlideRecord(\"incident\");\ninput.get(\"<sys_id>\");\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\n\nvar results = mlSolution.getVersion(1).predict(input, options);\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"<sys_id/gr>\": [\n {\n \"confidence\": 62.10782320780268,\n \"threshold\": 20.36,\n \"predictedValue\": \"Clone Issues\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 6.945237375770391,\n \"threshold\": 16.63,\n \"predictedValue\": \"Instance Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 5.321061076300759,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n### Example\n\nThe following example shows how to display prediction\nresults for a predict() method that takes an array of field\nnames as key-value pairs for input and includes optional parameters to restrict to\ntop three results and exclude the threshold value.\n\n```None\nvar mlSolution = sn_ml.ClusteringSolutionStore.get(\"ml_incident_categorization\");\n\n// key-value pairs input\nvar input = [{\"short_description\":\"my email is not working\"}, {short_description:\"need help with password\"}];\n\n// configure optional parameters\nvar options = {};\noptions.top_n = 3;\noptions.apply_threshold = false;\nvar results = mlSolution.predict(input, options);\n\n// pretty print JSON results\ngs.print(JSON.stringify(JSON.parse(results), null, 2));\n```\n```None\n{\n \"1\": [\n {\n \"confidence\": 37.5023032262591,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 24.439964862166583,\n \"threshold\": 23.7,\n \"predictedValue\": \"Administration\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 11.736320486031047,\n \"threshold\": 100,\n \"predictedValue\": \"Security\",\n \"predictedSysId\": \"\"\n }\n ],\n \"2\": [\n {\n \"confidence\": 99,\n \"threshold\": 17.77,\n \"predictedValue\": \"Email\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 3.182137005157543,\n \"threshold\": 10.72,\n \"predictedValue\": \"Authentication\",\n \"predictedSysId\": \"\"\n },\n {\n \"confidence\": 2.8773826570713514,\n \"threshold\": -1,\n \"predictedValue\": \"Email (I/f)\",\n \"predictedSysId\": \"\"\n }\n ]\n}\n```\n\n## ClusteringSolutionVersion - submitUpdateJob(Object options)\n\nSubmits clustering update jobs with options to narrow results to a specific table and\nfilter for matching records.\n\nTable 21. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| options | Object | JavaScript object containing options on which to base a clustering solution update. ```None { \"filter\" : \"String\", \"table\" : \"String\" } ``` |\n| options.filter | String | Encoded query string in standard Glide format. See Encoded query strings. Enables running an update job based on the filter provided. |\n| options.table | String | Name of the table on which to run an update job. |\n\nTable 22. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to submit an update job.\n\n```None\nvar myCluster = new sn_ml.ClusteringSolutionStore.get(\"ml_x_snc_global_global_clustering_solution\");\n\nvar options = {\"filter\" : \"precision\", \"table\" : \"incident\"};\n\nmyCluster.getActiveVersion().submitUpdateJob(options);\n```\n"}}},{"rowIdx":1689,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Color - Scoped, Global"},"description":{"kind":"string","value":"Creates a Color object used to define color attributes that you can apply to elements in a PDF; such as cells, tables, and lines."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_ColorBothAPI\"><article class=\"nested0\" aria-labelledby=\"title_ColorBothAPI\" id=\"ColorBothAPI\">\n <h1 class=\"title topictitle1\" id=\"title_ColorBothAPI\">Color - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\"><span class=\"ph\">Creates a Color object used to define color\n attributes that you can apply to elements in a PDF; such as cells, tables, and\n lines.</span></p>\n <p class=\"p\">This API is part of the <span class=\"ph\">ServiceNow</span> PDF\n Generation Utilities plugin (com.snc.apppdfgenerator) and is provided within the\n <code class=\"ph codeph\">sn_pdfgeneratorutils</code> namespace. The plugin is activated by default.</p>\n <p class=\"p\">This API is a component used with the <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DocumentBoth/concept/DocumentBothAPI.html\" href=\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DocumentBoth/concept/DocumentBothAPI.html\" class=\"xref\" title=\"The Document API provides methods to initialize a PDF, add content, and close the PDF. After adding content, the document can be attached to a target record.\">Document API</a> to generate a\n PDF.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_Color-Color_A\" id=\"Color-Color_A\">\n <h2 class=\"title topictitle2\" id=\"title_Color-Color_A\">Color - Color(Array colors)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Instantiates a new <span class=\"keyword apiname\">Color</span> object with RGB values.</p>\n <section class=\"section\" id=\"Color-Color_A__section_gkj_tyl_l4b\">\n <p class=\"p\">Color can be applied to the following scenarios:</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"Color-Color_A__table_twm_hjk_34b\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-Color_A__table_twm_hjk_34b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-Color_A__table_twm_hjk_34b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-Color_A__table_twm_hjk_34b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-Color_A__table_twm_hjk_34b__entry__1\">colors</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-Color_A__table_twm_hjk_34b__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-Color_A__table_twm_hjk_34b__entry__3\">Three numbers indicating RGB values using\n a decimal value from 0 through 1. For example, in <code class=\"ph codeph\">[0.1, 0.9, 0.5]</code>,\n the value of the first position is red, second is green, and third is blue. Also,\n <code class=\"ph codeph\">[0, 0, 0]</code> is solid black, <code class=\"ph codeph\">[0.5, 0.5, 0.5]</code> is\n solid gray, and <code class=\"ph codeph\">[1, 1, 1]</code> is solid white.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"Color-Color_A__example_hkj_tyl_l4b\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to create a <span class=\"keyword apiname\">Color</span> object.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_Color-equals_O\" id=\"Color-equals_O\">\n <h2 class=\"title topictitle2\" id=\"title_Color-equals_O\">Color – equals(Color color)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Indicates whether the values of two different color objects match.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"Color-equals_O__table_vv5_52h_44b\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-equals_O__table_vv5_52h_44b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-equals_O__table_vv5_52h_44b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-equals_O__table_vv5_52h_44b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-equals_O__table_vv5_52h_44b__entry__1\">color</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-equals_O__table_vv5_52h_44b__entry__2\">Color</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-equals_O__table_vv5_52h_44b__entry__3\">Color object to check for a match.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"Color-equals_O__table_wv5_52h_44b\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-equals_O__table_wv5_52h_44b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-equals_O__table_wv5_52h_44b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-equals_O__table_wv5_52h_44b__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-equals_O__table_wv5_52h_44b__entry__2\"><p class=\"p\">Flag that indicates whether the values of two color objects match.</p>\n <div class=\"p\">Valid values:<ul class=\"ul\" id=\"Color-equals_O__ul_grr_53x_r4b\">\n <li class=\"li\">true: The colors match.</li>\n <li class=\"li\">false: The colors do not match.</li>\n </ul></div></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to create two color objects and determine if the colors\n match.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); // given as an array of RGB values\nvar color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]); // given as an array of RGB values\nvar isequal = color1.equals(color2);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_Color-getGrayColor_N\" id=\"Color-getGrayColor_N\">\n <h2 class=\"title topictitle2\" id=\"title_Color-getGrayColor_N\">Color – getGrayColor(Number grayScale)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns a black, gray, or white color object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"Color-getGrayColor_N__table_vv5_52h_44b\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__1\">grayScale</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-getGrayColor_N__table_vv5_52h_44b__entry__3\">Decimal value in the range 0 through 1, in which 0 is black and 1 is\n white.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"Color-getGrayColor_N__table_wv5_52h_44b\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-getGrayColor_N__table_wv5_52h_44b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-getGrayColor_N__table_wv5_52h_44b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-getGrayColor_N__table_wv5_52h_44b__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-getGrayColor_N__table_wv5_52h_44b__entry__2\">Color object reflecting the provided grayscale value.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to create a color object that is 50% grayscale.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_Color-setColorValue_A\" id=\"Color-setColorValue_A\">\n <h2 class=\"title topictitle2\" id=\"title_Color-setColorValue_A\">Color – setColorValue(Array colors)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Creates color with given values and enables you to change the values of an existing\n color. Each of the values must be from 0 through 1.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"Color-setColorValue_A__table_vv5_52h_44b\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setColorValue_A__table_vv5_52h_44b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setColorValue_A__table_vv5_52h_44b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setColorValue_A__table_vv5_52h_44b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setColorValue_A__table_vv5_52h_44b__entry__1\">colors</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setColorValue_A__table_vv5_52h_44b__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setColorValue_A__table_vv5_52h_44b__entry__3\">Three numbers indicating RGB values using\n a decimal value from 0 through 1. For example, in <code class=\"ph codeph\">[0.1, 0.9, 0.5]</code>,\n the value of the first position is red, second is green, and third is blue. Also,\n <code class=\"ph codeph\">[0, 0, 0]</code> is solid black, <code class=\"ph codeph\">[0.5, 0.5, 0.5]</code> is\n solid gray, and <code class=\"ph codeph\">[1, 1, 1]</code> is solid white.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"Color-setColorValue_A__table_wv5_52h_44b\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setColorValue_A__table_wv5_52h_44b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setColorValue_A__table_wv5_52h_44b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setColorValue_A__table_wv5_52h_44b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setColorValue_A__table_wv5_52h_44b__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to change the values of an existing color.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var color = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); //given as array of RGB values;\ncolor.setColorValue(color);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_Color-setOpacity_N\" id=\"Color-setOpacity_N\">\n <h2 class=\"title topictitle2\" id=\"title_Color-setOpacity_N\">Color – setOpacity(Number opacity)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Sets the level of color opacity.</p>\n <section class=\"section\" id=\"Color-setOpacity_N__section_ess_h3x_r4b\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"Color-setOpacity_N__table_vv5_52h_44b\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setOpacity_N__table_vv5_52h_44b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setOpacity_N__table_vv5_52h_44b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setOpacity_N__table_vv5_52h_44b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setOpacity_N__table_vv5_52h_44b__entry__1\">color</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setOpacity_N__table_vv5_52h_44b__entry__2\">Color</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setOpacity_N__table_vv5_52h_44b__entry__3\">Floating decimal value from 0 through 1, in which 0 is fully transparent and 1\n is fully opaque.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"Color-setOpacity_N__table_wv5_52h_44b\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setOpacity_N__table_wv5_52h_44b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"Color-setOpacity_N__table_wv5_52h_44b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setOpacity_N__table_wv5_52h_44b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"Color-setOpacity_N__table_wv5_52h_44b__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\" id=\"Color-setOpacity_N__example_fss_h3x_r4b\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">The following example shows how to create a color object and set its opacity to 50\n percent.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var color = new Color([1,0.5,0.5]);\ncolor.setOpacity(0.5);</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Color - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205452\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205452\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"ColorBothAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"Creates a Color object used to define color attributes that you can apply to elements in a PDF; such as cells, tables, and lines.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\",\n \"page_key\": 41205452,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 3287,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 495\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Color - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_ColorBothAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_ColorBothAPI\\\" id=\\\"ColorBothAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_ColorBothAPI\\\">Color - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Creates a Color object used to define color\\n attributes that you can apply to elements in a PDF; such as cells, tables, and\\n lines.</span></p>\\n <p class=\\\"p\\\">This API is part of the <span class=\\\"ph\\\">ServiceNow</span> PDF\\n Generation Utilities plugin (com.snc.apppdfgenerator) and is provided within the\\n <code class=\\\"ph codeph\\\">sn_pdfgeneratorutils</code> namespace. The plugin is activated by default.</p>\\n <p class=\\\"p\\\">This API is a component used with the <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DocumentBoth/concept/DocumentBothAPI.html\\\" href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DocumentBoth/concept/DocumentBothAPI.html\\\" class=\\\"xref\\\" title=\\\"The Document API provides methods to initialize a PDF, add content, and close the PDF. After adding content, the document can be attached to a target record.\\\">Document API</a> to generate a\\n PDF.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_Color-Color_A\\\" id=\\\"Color-Color_A\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_Color-Color_A\\\">Color - Color(Array colors)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Instantiates a new <span class=\\\"keyword apiname\\\">Color</span> object with RGB values.</p>\\n <section class=\\\"section\\\" id=\\\"Color-Color_A__section_gkj_tyl_l4b\\\">\\n <p class=\\\"p\\\">Color can be applied to the following scenarios:</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"Color-Color_A__table_twm_hjk_34b\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-Color_A__table_twm_hjk_34b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-Color_A__table_twm_hjk_34b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-Color_A__table_twm_hjk_34b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-Color_A__table_twm_hjk_34b__entry__1\\\">colors</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-Color_A__table_twm_hjk_34b__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-Color_A__table_twm_hjk_34b__entry__3\\\">Three numbers indicating RGB values using\\n a decimal value from 0 through 1. For example, in <code class=\\\"ph codeph\\\">[0.1, 0.9, 0.5]</code>,\\n the value of the first position is red, second is green, and third is blue. Also,\\n <code class=\\\"ph codeph\\\">[0, 0, 0]</code> is solid black, <code class=\\\"ph codeph\\\">[0.5, 0.5, 0.5]</code> is\\n solid gray, and <code class=\\\"ph codeph\\\">[1, 1, 1]</code> is solid white.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"Color-Color_A__example_hkj_tyl_l4b\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to create a <span class=\\\"keyword apiname\\\">Color</span> object.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_Color-equals_O\\\" id=\\\"Color-equals_O\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_Color-equals_O\\\">Color – equals(Color color)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Indicates whether the values of two different color objects match.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"Color-equals_O__table_vv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-equals_O__table_vv5_52h_44b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-equals_O__table_vv5_52h_44b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-equals_O__table_vv5_52h_44b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-equals_O__table_vv5_52h_44b__entry__1\\\">color</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-equals_O__table_vv5_52h_44b__entry__2\\\">Color</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-equals_O__table_vv5_52h_44b__entry__3\\\">Color object to check for a match.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"Color-equals_O__table_wv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-equals_O__table_wv5_52h_44b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-equals_O__table_wv5_52h_44b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-equals_O__table_wv5_52h_44b__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-equals_O__table_wv5_52h_44b__entry__2\\\"><p class=\\\"p\\\">Flag that indicates whether the values of two color objects match.</p>\\n <div class=\\\"p\\\">Valid values:<ul class=\\\"ul\\\" id=\\\"Color-equals_O__ul_grr_53x_r4b\\\">\\n <li class=\\\"li\\\">true: The colors match.</li>\\n <li class=\\\"li\\\">false: The colors do not match.</li>\\n </ul></div></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to create two color objects and determine if the colors\\n match.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); // given as an array of RGB values\\nvar color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]); // given as an array of RGB values\\nvar isequal = color1.equals(color2);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_Color-getGrayColor_N\\\" id=\\\"Color-getGrayColor_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_Color-getGrayColor_N\\\">Color – getGrayColor(Number grayScale)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns a black, gray, or white color object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"Color-getGrayColor_N__table_vv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__1\\\">grayScale</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-getGrayColor_N__table_vv5_52h_44b__entry__3\\\">Decimal value in the range 0 through 1, in which 0 is black and 1 is\\n white.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"Color-getGrayColor_N__table_wv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-getGrayColor_N__table_wv5_52h_44b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-getGrayColor_N__table_wv5_52h_44b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-getGrayColor_N__table_wv5_52h_44b__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-getGrayColor_N__table_wv5_52h_44b__entry__2\\\">Color object reflecting the provided grayscale value.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to create a color object that is 50% grayscale.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_Color-setColorValue_A\\\" id=\\\"Color-setColorValue_A\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_Color-setColorValue_A\\\">Color – setColorValue(Array colors)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Creates color with given values and enables you to change the values of an existing\\n color. Each of the values must be from 0 through 1.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"Color-setColorValue_A__table_vv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__1\\\">colors</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setColorValue_A__table_vv5_52h_44b__entry__3\\\">Three numbers indicating RGB values using\\n a decimal value from 0 through 1. For example, in <code class=\\\"ph codeph\\\">[0.1, 0.9, 0.5]</code>,\\n the value of the first position is red, second is green, and third is blue. Also,\\n <code class=\\\"ph codeph\\\">[0, 0, 0]</code> is solid black, <code class=\\\"ph codeph\\\">[0.5, 0.5, 0.5]</code> is\\n solid gray, and <code class=\\\"ph codeph\\\">[1, 1, 1]</code> is solid white.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"Color-setColorValue_A__table_wv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setColorValue_A__table_wv5_52h_44b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setColorValue_A__table_wv5_52h_44b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setColorValue_A__table_wv5_52h_44b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setColorValue_A__table_wv5_52h_44b__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to change the values of an existing color.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var color = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); //given as array of RGB values;\\ncolor.setColorValue(color);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_Color-setOpacity_N\\\" id=\\\"Color-setOpacity_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_Color-setOpacity_N\\\">Color – setOpacity(Number opacity)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Sets the level of color opacity.</p>\\n <section class=\\\"section\\\" id=\\\"Color-setOpacity_N__section_ess_h3x_r4b\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"Color-setOpacity_N__table_vv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__1\\\">color</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__2\\\">Color</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setOpacity_N__table_vv5_52h_44b__entry__3\\\">Floating decimal value from 0 through 1, in which 0 is fully transparent and 1\\n is fully opaque.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"Color-setOpacity_N__table_wv5_52h_44b\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setOpacity_N__table_wv5_52h_44b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"Color-setOpacity_N__table_wv5_52h_44b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setOpacity_N__table_wv5_52h_44b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"Color-setOpacity_N__table_wv5_52h_44b__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\" id=\\\"Color-setOpacity_N__example_fss_h3x_r4b\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">The following example shows how to create a color object and set its opacity to 50\\n percent.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var color = new Color([1,0.5,0.5]);\\ncolor.setOpacity(0.5);</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Color - Scoped, Global\n\nCreates a Color object used to define color\nattributes that you can apply to elements in a PDF; such as cells, tables, and\nlines.\n\nThis API is part of the ServiceNow PDF\nGeneration Utilities plugin (com.snc.apppdfgenerator) and is provided within the\n`sn_pdfgeneratorutils` namespace. The plugin is activated by default.\n\nThis API is a component used with the Document API to generate a\nPDF.\n\n## Color - Color(Array colors)\n\nInstantiates a new Color object with RGB values.\n\nColor can be applied to the following scenarios:\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| colors | Array | Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in `[0.1, 0.9, 0.5]`, the value of the first position is red, second is green, and third is blue. Also, `[0, 0, 0]` is solid black, `[0.5, 0.5, 0.5]` is solid gray, and `[1, 1, 1]` is solid white. |\n\n### Example\n\nThe following example shows how to create a Color object.\n\n```None\nvar color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values\n```\n\n## Color – equals(Color color)\n\nIndicates whether the values of two different color objects match.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| color | Color | Color object to check for a match. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the values of two color objects match. Valid values: * true: The colors match. * false: The colors do not match. |\n\n### Example\n\nThe following example shows how to create two color objects and determine if the colors\nmatch.\n\n```None\nvar color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); // given as an array of RGB values\nvar color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]); // given as an array of RGB values\nvar isequal = color1.equals(color2);\n```\n\n## Color – getGrayColor(Number grayScale)\n\nReturns a black, gray, or white color object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| grayScale | Number | Decimal value in the range 0 through 1, in which 0 is black and 1 is white. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Color object reflecting the provided grayscale value. |\n\n### Example\n\nThe following example shows how to create a color object that is 50% grayscale.\n\n```None\nvar grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);\n```\n\n## Color – setColorValue(Array colors)\n\nCreates color with given values and enables you to change the values of an existing\ncolor. Each of the values must be from 0 through 1.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| colors | Array | Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in `[0.1, 0.9, 0.5]`, the value of the first position is red, second is green, and third is blue. Also, `[0, 0, 0]` is solid black, `[0.5, 0.5, 0.5]` is solid gray, and `[1, 1, 1]` is solid white. |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to change the values of an existing color.\n\n```None\nvar color = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); //given as array of RGB values;\ncolor.setColorValue(color);\n```\n\n## Color – setOpacity(Number opacity)\n\nSets the level of color opacity.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| color | Color | Floating decimal value from 0 through 1, in which 0 is fully transparent and 1 is fully opaque. |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to create a color object and set its opacity to 50\npercent.\n\n```None\nvar color = new Color([1,0.5,0.5]);\ncolor.setOpacity(0.5);\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: Color - Scoped, Global\ndescription: Creates a Color object used to define color attributes that you can apply\n to elements in a PDF; such as cells, tables, and lines.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Color - Scoped, Global\n\nCreates a Color object used to define color\nattributes that you can apply to elements in a PDF; such as cells, tables, and\nlines.\n\nThis API is part of the ServiceNow PDF\nGeneration Utilities plugin (com.snc.apppdfgenerator) and is provided within the\n`sn_pdfgeneratorutils` namespace. The plugin is activated by default.\n\nThis API is a component used with the Document API to generate a\nPDF.\n\n## Color - Color(Array colors)\n\nInstantiates a new Color object with RGB values.\n\nColor can be applied to the following scenarios:\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| colors | Array | Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in `[0.1, 0.9, 0.5]`, the value of the first position is red, second is green, and third is blue. Also, `[0, 0, 0]` is solid black, `[0.5, 0.5, 0.5]` is solid gray, and `[1, 1, 1]` is solid white. |\n\n### Example\n\nThe following example shows how to create a Color object.\n\n```None\nvar color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values\n```\n\n## Color – equals(Color color)\n\nIndicates whether the values of two different color objects match.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| color | Color | Color object to check for a match. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | Flag that indicates whether the values of two color objects match. Valid values: * true: The colors match. * false: The colors do not match. |\n\n### Example\n\nThe following example shows how to create two color objects and determine if the colors\nmatch.\n\n```None\nvar color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); // given as an array of RGB values\nvar color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]); // given as an array of RGB values\nvar isequal = color1.equals(color2);\n```\n\n## Color – getGrayColor(Number grayScale)\n\nReturns a black, gray, or white color object.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| grayScale | Number | Decimal value in the range 0 through 1, in which 0 is black and 1 is white. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| Object | Color object reflecting the provided grayscale value. |\n\n### Example\n\nThe following example shows how to create a color object that is 50% grayscale.\n\n```None\nvar grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);\n```\n\n## Color – setColorValue(Array colors)\n\nCreates color with given values and enables you to change the values of an existing\ncolor. Each of the values must be from 0 through 1.\n\nTable 6. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| colors | Array | Three numbers indicating RGB values using a decimal value from 0 through 1. For example, in `[0.1, 0.9, 0.5]`, the value of the first position is red, second is green, and third is blue. Also, `[0, 0, 0]` is solid black, `[0.5, 0.5, 0.5]` is solid gray, and `[1, 1, 1]` is solid white. |\n\nTable 7. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to change the values of an existing color.\n\n```None\nvar color = new sn_pdfgeneratorutils.Color([1,0.5,0.5]); //given as array of RGB values;\ncolor.setColorValue(color);\n```\n\n## Color – setOpacity(Number opacity)\n\nSets the level of color opacity.\n\nTable 8. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| color | Color | Floating decimal value from 0 through 1, in which 0 is fully transparent and 1 is fully opaque. |\n\nTable 9. Returns\n| Type | Description |\n| --- | --- |\n| None | |\n\n### Example\n\nThe following example shows how to create a color object and set its opacity to 50\npercent.\n\n```None\nvar color = new Color([1,0.5,0.5]);\ncolor.setOpacity(0.5);\n```\n"}}},{"rowIdx":1690,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ConnectActionResponse - Global"},"description":{"kind":"string","value":"The ConnectActionResponse API provides a method to create a GlideRecord."},"keywords":{"kind":"list like","value":["ConnectActionResponse API","ConnectActionResponse","newRecord(String table","Object values","String view)"],"string":"[\n \"ConnectActionResponse API\",\n \"ConnectActionResponse\",\n \"newRecord(String table\",\n \"Object values\",\n \"String view)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_c_ConnectActionResponseAPI\"><article class=\"nested0\" aria-labelledby=\"title_c_ConnectActionResponseAPI\" id=\"c_ConnectActionResponseAPI\">\n <h1 class=\"title topictitle1\" id=\"title_c_ConnectActionResponseAPI\">ConnectActionResponse <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The ConnectActionResponse API provides a method to create a GlideRecord.</p>\n <p class=\"p\">ConnectActionResponse methods are accessed through a global object (response) that is available\n only in Connect action scripts.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CAR-newRecord_S_O_S\" id=\"r_CAR-newRecord_S_O_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_CAR-newRecord_S_O_S\">ConnectActionResponse - newRecord(String table, Object values, String view)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Create a GlideRecord in the specified table with the specified values.</p>\n <section class=\"section\">\n <p class=\"p\">Opens a form in the UI based upon the table, which replaces the\n <span class=\"ph uicontrol\">Table</span> and <span class=\"ph uicontrol\">Document</span> fields in the Live Group\n Profile record for the associated conversation.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\">table</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\">Name of the table where the record is to be added.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\">values</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\">An object of name value pairs where the names are field names in the table and\n the values are the field values.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\">view</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\">The form view to load. This parameter is optional.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">response.newRecord("incident", {\n\tshort_description: conversation.document.short_description || "",\n\tcaller_id: conversation.document.opened_by\n});</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ConnectActionResponse - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205455\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205455\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_ConnectActionResponseAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"ConnectActionResponse API,ConnectActionResponse,newRecord(String table, Object values, String view)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ConnectActionResponse API provides a method to create a GlideRecord.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"ConnectActionResponse API, ConnectActionResponse, newRecord(String table, Object values, String view)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\",\n \"page_key\": 41205455,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 964,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 134\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ConnectActionResponse - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_c_ConnectActionResponseAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_ConnectActionResponseAPI\\\" id=\\\"c_ConnectActionResponseAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_ConnectActionResponseAPI\\\">ConnectActionResponse <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The ConnectActionResponse API provides a method to create a GlideRecord.</p>\\n <p class=\\\"p\\\">ConnectActionResponse methods are accessed through a global object (response) that is available\\n only in Connect action scripts.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CAR-newRecord_S_O_S\\\" id=\\\"r_CAR-newRecord_S_O_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CAR-newRecord_S_O_S\\\">ConnectActionResponse - newRecord(String table, Object values, String view)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Create a GlideRecord in the specified table with the specified values.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Opens a form in the UI based upon the table, which replaces the\\n <span class=\\\"ph uicontrol\\\">Table</span> and <span class=\\\"ph uicontrol\\\">Document</span> fields in the Live Group\\n Profile record for the associated conversation.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\\\">table</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\\\">Name of the table where the record is to be added.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\\\">values</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\\\">An object of name value pairs where the names are field names in the table and\\n the values are the field values.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__1\\\">view</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_ltj_jqw_cv__entry__3\\\">The form view to load. This parameter is optional.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CAR-newRecord_S_O_S__table_mtj_jqw_cv__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">response.newRecord("incident", {\\n\\tshort_description: conversation.document.short_description || "",\\n\\tcaller_id: conversation.document.opened_by\\n});</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectActionResponse - Global\n\nThe ConnectActionResponse API provides a method to create a GlideRecord.\n\nConnectActionResponse methods are accessed through a global object (response) that is available\nonly in Connect action scripts.\n\n## ConnectActionResponse - newRecord(String table, Object values, String view)\n\nCreate a GlideRecord in the specified table with the specified values.\n\nOpens a form in the UI based upon the table, which replaces the\nTable and Document fields in the Live Group\nProfile record for the associated conversation.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| table | String | Name of the table where the record is to be added. |\n| values | Object | An object of name value pairs where the names are field names in the table and the values are the field values. |\n| view | String | The form view to load. This parameter is optional. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nresponse.newRecord(\"incident\", {\n\tshort_description: conversation.document.short_description || \"\",\n\tcaller_id: conversation.document.opened_by\n});\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ConnectActionResponse - Global\ndescription: The ConnectActionResponse API provides a method to create a GlideRecord.\nkeywords:\n- ConnectActionResponse API\n- ConnectActionResponse\n- newRecord(String table\n- Object values\n- String view)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectActionResponse - Global\n\nThe ConnectActionResponse API provides a method to create a GlideRecord.\n\nConnectActionResponse methods are accessed through a global object (response) that is available\nonly in Connect action scripts.\n\n## ConnectActionResponse - newRecord(String table, Object values, String view)\n\nCreate a GlideRecord in the specified table with the specified values.\n\nOpens a form in the UI based upon the table, which replaces the\nTable and Document fields in the Live Group\nProfile record for the associated conversation.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| table | String | Name of the table where the record is to be added. |\n| values | Object | An object of name value pairs where the names are field names in the table and the values are the field values. |\n| view | String | The form view to load. This parameter is optional. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nresponse.newRecord(\"incident\", {\n\tshort_description: conversation.document.short_description || \"\",\n\tcaller_id: conversation.document.opened_by\n});\n```\n"}}},{"rowIdx":1691,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ConnectionInfo - Scoped, Global"},"description":{"kind":"string","value":"The ConnectionInfo API enables you to get connection attribute information through the connection and credential alias."},"keywords":{"kind":"list like","value":["ConnectionInfo","ConnectionInfo","getAttribute(name)","getCredentialAttribute()","getDataMap()","getExtendedAttributes()"],"string":"[\n \"ConnectionInfo\",\n \"ConnectionInfo\",\n \"getAttribute(name)\",\n \"getCredentialAttribute()\",\n \"getDataMap()\",\n \"getExtendedAttributes()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_connection-info-api\"><article class=\"nested0\" aria-labelledby=\"title_connection-info-api\" id=\"connection-info-api\">\n <h1 class=\"title topictitle1\" id=\"title_connection-info-api\">ConnectionInfo - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">ConnectionInfo</span> API enables you to get connection attribute\n information through the connection and credential alias.</p>\n <p class=\"p\">You can use this API in scoped applications or within the global scope. In scoped scripts,\n use the <code class=\"ph codeph\">sn_cc</code> namespace identifier.</p>\n <p class=\"p\">For more information on connections and credentials, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/ConnectionInfo/Concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=r-credentials&version=vancouver&pubname=vancouver-platform-security\" class=\"xref\">Credentials and connection\n information</a>.</p>\n <p class=\"p\">This function retrieves connection attribute information identified by the given connection\n and credential alias.</p>\n <div class=\"p\"><pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// "6219afbf9f03320021dd7501942e70fc"\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap["name"]);\n gs.info(datamap["connection_url"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute("name"));\n gs.info(connectionInfo.getAttribute("connection_url"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\n gs.info(connectionInfo.getCredentialAttribute("password")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes["name1"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // "cd5923ff9f03320021dd7501942e70bb"\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\n "c90d4b084a362312013398f051272c0d");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap["name"]);\n }\n</code></pre></div>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CI-getAttribute_S\" id=\"CI-getAttribute_S\">\n <h2 class=\"title topictitle2\" id=\"title_CI-getAttribute_S\">Scoped ConnectionInfo - getAttribute(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the value of a <span class=\"keyword apiname\">ConnectionInfo</span> attribute with the specified\n property name.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CI-getAttribute_S__table_ext_cx2_qbb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getAttribute_S__table_ext_cx2_qbb__entry__3\">Name of a <span class=\"keyword apiname\">ConnectionInfo</span> object property.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CI-getAttribute_S__table_fxt_cx2_qbb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__2\">Value of a specified <span class=\"keyword apiname\">ConnectionInfo</span> property.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"> // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute("name"));\n gs.info(connectionInfo.getAttribute("connection_url"));\n</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CI-getCredentialAttribute_S\" id=\"CI-getCredentialAttribute_S\">\n <h2 class=\"title topictitle2\" id=\"title_CI-getCredentialAttribute_S\">Scoped ConnectionInfo - getCredentialAttribute()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the value of credential attributes for a specified connection.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__2\">Key-value pair map of credential attributes.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"> // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\n gs.info(connectionInfo.getCredentialAttribute("password")); \n</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CI-getDataMap_S\" id=\"CI-getDataMap_S\">\n <h2 class=\"title topictitle2\" id=\"title_CI-getDataMap_S\">Scoped ConnectionInfo - getDataMap()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the connection attributes as a collection of key-value pairs.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CI-getDataMap_S__table_ext_cx2_qbb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getDataMap_S__table_ext_cx2_qbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CI-getDataMap_S__table_fxt_cx2_qbb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__2\">Key-value pair map of connection attributes.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\"> // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap["name"]);\n gs.info(datamap["connection_url"]);\n</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CI-getExtendedAttributes_S\" id=\"CI-getExtendedAttributes_S\">\n <h2 class=\"title topictitle2\" id=\"title_CI-getExtendedAttributes_S\">Scoped ConnectionInfo - getExtendedAttributes()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the extended attributes as a collection of key-value pairs.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__2\">Key-value pair map of extended attributes.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes["name1"]);\n }\n</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ConnectionInfo - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205458\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205458\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"connection-info-api\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"ConnectionInfo,ConnectionInfo,getAttribute(name),getCredentialAttribute(),getDataMap(),getExtendedAttributes()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ConnectionInfo API enables you to get connection attribute information through the connection and credential alias.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"ConnectionInfo, ConnectionInfo, getAttribute(name), getCredentialAttribute(), getDataMap(), getExtendedAttributes()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\",\n \"page_key\": 41205458,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 3137,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 307\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ConnectionInfo - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_connection-info-api\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_connection-info-api\\\" id=\\\"connection-info-api\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_connection-info-api\\\">ConnectionInfo - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">ConnectionInfo</span> API enables you to get connection attribute\\n information through the connection and credential alias.</p>\\n <p class=\\\"p\\\">You can use this API in scoped applications or within the global scope. In scoped scripts,\\n use the <code class=\\\"ph codeph\\\">sn_cc</code> namespace identifier.</p>\\n <p class=\\\"p\\\">For more information on connections and credentials, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/ConnectionInfo/Concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=r-credentials&version=vancouver&pubname=vancouver-platform-security\\\" class=\\\"xref\\\">Credentials and connection\\n information</a>.</p>\\n <p class=\\\"p\\\">This function retrieves connection attribute information identified by the given connection\\n and credential alias.</p>\\n <div class=\\\"p\\\"><pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var provider = new sn_cc.ConnectionInfoProvider();\\n\\n// get a jdbc connection in the current domain with the alias ID\\n// "6219afbf9f03320021dd7501942e70fc"\\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");\\nif (connectionInfo != null) {\\n // get data map\\n var datamap = connectionInfo.getDataMap();\\n gs.info(datamap["name"]);\\n gs.info(datamap["connection_url"]);\\n\\n // get the same values using getAttribute\\n gs.info(connectionInfo.getAttribute("name"));\\n gs.info(connectionInfo.getAttribute("connection_url"));\\n\\n // get credential attributes\\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\\n gs.info(connectionInfo.getCredentialAttribute("password")); \\n\\n // get extended attributes\\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \\n gs.info(extendedAttributes["name1"]);\\n }\\n\\n // get a jdbc connection in the ACME domain with the alias ID\\n // "cd5923ff9f03320021dd7501942e70bb"\\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\\n "c90d4b084a362312013398f051272c0d");\\n if (connectionInfo != null) {\\n // get data map\\n var datamap = connectionInfo.getDataMap();\\n gs.info(datamap["name"]);\\n }\\n</code></pre></div>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CI-getAttribute_S\\\" id=\\\"CI-getAttribute_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CI-getAttribute_S\\\">Scoped ConnectionInfo - getAttribute(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the value of a <span class=\\\"keyword apiname\\\">ConnectionInfo</span> attribute with the specified\\n property name.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CI-getAttribute_S__table_ext_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getAttribute_S__table_ext_cx2_qbb__entry__3\\\">Name of a <span class=\\\"keyword apiname\\\">ConnectionInfo</span> object property.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CI-getAttribute_S__table_fxt_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getAttribute_S__table_fxt_cx2_qbb__entry__2\\\">Value of a specified <span class=\\\"keyword apiname\\\">ConnectionInfo</span> property.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"> // get the same values using getAttribute\\n gs.info(connectionInfo.getAttribute("name"));\\n gs.info(connectionInfo.getAttribute("connection_url"));\\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CI-getCredentialAttribute_S\\\" id=\\\"CI-getCredentialAttribute_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CI-getCredentialAttribute_S\\\">Scoped ConnectionInfo - getCredentialAttribute()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the value of credential attributes for a specified connection.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getCredentialAttribute_S__table_ext_cx2_qbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getCredentialAttribute_S__table_fxt_cx2_qbb__entry__2\\\">Key-value pair map of credential attributes.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"> // get credential attributes\\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\\n gs.info(connectionInfo.getCredentialAttribute("password")); \\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CI-getDataMap_S\\\" id=\\\"CI-getDataMap_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CI-getDataMap_S\\\">Scoped ConnectionInfo - getDataMap()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the connection attributes as a collection of key-value pairs.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CI-getDataMap_S__table_ext_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getDataMap_S__table_ext_cx2_qbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CI-getDataMap_S__table_fxt_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getDataMap_S__table_fxt_cx2_qbb__entry__2\\\">Key-value pair map of connection attributes.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\"> // get data map\\n var datamap = connectionInfo.getDataMap();\\n gs.info(datamap["name"]);\\n gs.info(datamap["connection_url"]);\\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CI-getExtendedAttributes_S\\\" id=\\\"CI-getExtendedAttributes_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CI-getExtendedAttributes_S\\\">Scoped ConnectionInfo - getExtendedAttributes()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the extended attributes as a collection of key-value pairs.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getExtendedAttributes_S__table_ext_cx2_qbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CI-getExtendedAttributes_S__table_fxt_cx2_qbb__entry__2\\\">Key-value pair map of extended attributes.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// get extended attributes\\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \\n gs.info(extendedAttributes["name1"]);\\n }\\n</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectionInfo - Scoped, Global\n\nThe ConnectionInfo API enables you to get connection attribute\ninformation through the connection and credential alias.\n\nYou can use this API in scoped applications or within the global scope. In scoped scripts,\nuse the `sn_cc` namespace identifier.\n\nFor more information on connections and credentials, see Credentials and connection\ninformation.\n\nThis function retrieves connection attribute information identified by the given connection\nand credential alias.\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n }\n\n```\n\n## Scoped ConnectionInfo - getAttribute(String name)\n\nReturns the value of a ConnectionInfo attribute with the specified\nproperty name.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a ConnectionInfo object property. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Value of a specified ConnectionInfo property. |\n\n### Example\n\n```None\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n```\n\n## Scoped ConnectionInfo - getCredentialAttribute()\n\nReturns the value of credential attributes for a specified connection.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of credential attributes. |\n\n### Example\n\n```None\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n```\n\n## Scoped ConnectionInfo - getDataMap()\n\nReturns the connection attributes as a collection of key-value pairs.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of connection attributes. |\n\n### Example\n\n```None\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n```\n\n## Scoped ConnectionInfo - getExtendedAttributes()\n\nReturns the extended attributes as a collection of key-value pairs.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of extended attributes. |\n\n### Example\n\n```None\n// get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ConnectionInfo - Scoped, Global\ndescription: The ConnectionInfo API enables you to get connection attribute information\n through the connection and credential alias.\nkeywords:\n- ConnectionInfo\n- ConnectionInfo\n- getAttribute(name)\n- getCredentialAttribute()\n- getDataMap()\n- getExtendedAttributes()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectionInfo - Scoped, Global\n\nThe ConnectionInfo API enables you to get connection attribute\ninformation through the connection and credential alias.\n\nYou can use this API in scoped applications or within the global scope. In scoped scripts,\nuse the `sn_cc` namespace identifier.\n\nFor more information on connections and credentials, see Credentials and connection\ninformation.\n\nThis function retrieves connection attribute information identified by the given connection\nand credential alias.\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n }\n\n```\n\n## Scoped ConnectionInfo - getAttribute(String name)\n\nReturns the value of a ConnectionInfo attribute with the specified\nproperty name.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of a ConnectionInfo object property. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Value of a specified ConnectionInfo property. |\n\n### Example\n\n```None\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n```\n\n## Scoped ConnectionInfo - getCredentialAttribute()\n\nReturns the value of credential attributes for a specified connection.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of credential attributes. |\n\n### Example\n\n```None\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n```\n\n## Scoped ConnectionInfo - getDataMap()\n\nReturns the connection attributes as a collection of key-value pairs.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of connection attributes. |\n\n### Example\n\n```None\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n```\n\n## Scoped ConnectionInfo - getExtendedAttributes()\n\nReturns the extended attributes as a collection of key-value pairs.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Object | Key-value pair map of extended attributes. |\n\n### Example\n\n```None\n// get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n```\n"}}},{"rowIdx":1692,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"ConnectionInfoProvider - Scoped, Global"},"description":{"kind":"string","value":"The ConnectionInfoProvider API provides methods to select connection information through the connection alias."},"keywords":{"kind":"list like","value":["ConnectionInfoProvider","ConnectionInfoProvider","ConnectionInfoProvider()","getConnectionInfo()","getConnectionInfoByDomain(String aliasID","String domainID)"],"string":"[\n \"ConnectionInfoProvider\",\n \"ConnectionInfoProvider\",\n \"ConnectionInfoProvider()\",\n \"getConnectionInfo()\",\n \"getConnectionInfoByDomain(String aliasID\",\n \"String domainID)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_connection-info-provider-api\"><article class=\"nested0\" aria-labelledby=\"title_connection-info-provider-api\" id=\"connection-info-provider-api\">\n <h1 class=\"title topictitle1\" id=\"title_connection-info-provider-api\">ConnectionInfoProvider - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">ConnectionInfoProvider</span> API provides methods to select connection\n information through the connection alias.</p>\n <p class=\"p\">You can use this API in scoped applications, or within the global scope. In scoped scripts,\n use the <code class=\"ph codeph\">sn_cc</code> namespace identifier.</p>\n <p class=\"p\">This function retrieves connection information identified by the given connection alias.</p>\n <div class=\"p\"><pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// "6219afbf9f03320021dd7501942e70fc"\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap["name"]);\n gs.info(datamap["connection_url"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute("name"));\n gs.info(connectionInfo.getAttribute("connection_url"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\n gs.info(connectionInfo.getCredentialAttribute("password")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes["name1"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // "cd5923ff9f03320021dd7501942e70bb"\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\n "c90d4b084a362312013398f051272c0d");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap["name"]);\n }\n</code></pre></div>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_CIP-get-connection-infoprovider\" id=\"CIP-get-connection-infoprovider\">\n <h2 class=\"title topictitle2\" id=\"title_CIP-get-connection-infoprovider\">ConnectionInfoProvider - ConnectionInfoProvider()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Selects connection information through the connection alias.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CIP-getConnectionInfo_S\" id=\"CIP-getConnectionInfo_S\">\n <h2 class=\"title topictitle2\" id=\"title_CIP-getConnectionInfo_S\">ConnectionInfoProvider - getConnectionInfo(String aliasID)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Retrieves a ConnectionInfo object identified by the given aliasID in the current\n domain.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__1\">aliasID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__3\">Sys_id of a connection alias.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__1\">ConnectionInfo</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__2\">Information about the connection.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// "6219afbf9f03320021dd7501942e70fc"\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CIP-getConnectionInfoByDomain_S_S\" id=\"CIP-getConnectionInfoByDomain_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_CIP-getConnectionInfoByDomain_S_S\">ConnectionInfoProvider - getConnectionInfoByDomain(String aliasID, String domainID)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Retrieves a ConnectionInfo object identified by the given aliasID for a specific\n domain.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\">aliasID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\">Sys_id of a connection alias.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\">domainID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\">Sys_id of a domain or <kbd class=\"ph userinput\">global</kbd>.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__1\">ConnectionInfo</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__2\">Connection information.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the ACME domain with the alias ID\n // "cd5923ff9f03320021dd7501942e70bb"\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\n "c90d4b084a362312013398f051272c0d");</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">ConnectionInfoProvider - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205461\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205461\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"connection-info-provider-api\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"ConnectionInfoProvider,ConnectionInfoProvider,ConnectionInfoProvider(),getConnectionInfo(),getConnectionInfoByDomain(String aliasID, String domainID)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The ConnectionInfoProvider API provides methods to select connection information through the connection alias.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"ConnectionInfoProvider, ConnectionInfoProvider, ConnectionInfoProvider(), getConnectionInfo(), getConnectionInfoByDomain(String aliasID, String domainID)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\",\n \"page_key\": 41205461,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 2832,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 276\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"ConnectionInfoProvider - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_connection-info-provider-api\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_connection-info-provider-api\\\" id=\\\"connection-info-provider-api\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_connection-info-provider-api\\\">ConnectionInfoProvider - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">ConnectionInfoProvider</span> API provides methods to select connection\\n information through the connection alias.</p>\\n <p class=\\\"p\\\">You can use this API in scoped applications, or within the global scope. In scoped scripts,\\n use the <code class=\\\"ph codeph\\\">sn_cc</code> namespace identifier.</p>\\n <p class=\\\"p\\\">This function retrieves connection information identified by the given connection alias.</p>\\n <div class=\\\"p\\\"><pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var provider = new sn_cc.ConnectionInfoProvider();\\n\\n// get a jdbc connection in the current domain with the alias ID\\n// "6219afbf9f03320021dd7501942e70fc"\\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");\\nif (connectionInfo != null) {\\n // get data map\\n var datamap = connectionInfo.getDataMap();\\n gs.info(datamap["name"]);\\n gs.info(datamap["connection_url"]);\\n\\n // get the same values using getAttribute\\n gs.info(connectionInfo.getAttribute("name"));\\n gs.info(connectionInfo.getAttribute("connection_url"));\\n\\n // get credential attributes\\n gs.info(connectionInfo.getCredentialAttribute("user_name"));\\n gs.info(connectionInfo.getCredentialAttribute("password")); \\n\\n // get extended attributes\\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \\n gs.info(extendedAttributes["name1"]);\\n }\\n\\n // get a jdbc connection in the ACME domain with the alias ID\\n // "cd5923ff9f03320021dd7501942e70bb"\\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\\n "c90d4b084a362312013398f051272c0d");\\n if (connectionInfo != null) {\\n // get data map\\n var datamap = connectionInfo.getDataMap();\\n gs.info(datamap["name"]);\\n }\\n</code></pre></div>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_CIP-get-connection-infoprovider\\\" id=\\\"CIP-get-connection-infoprovider\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CIP-get-connection-infoprovider\\\">ConnectionInfoProvider - ConnectionInfoProvider()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Selects connection information through the connection alias.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-get-connection-infoprovider__table_afx_pp2_qbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CIP-getConnectionInfo_S\\\" id=\\\"CIP-getConnectionInfo_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CIP-getConnectionInfo_S\\\">ConnectionInfoProvider - getConnectionInfo(String aliasID)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Retrieves a ConnectionInfo object identified by the given aliasID in the current\\n domain.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__1\\\">aliasID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfo_S__table_xxn_xq2_qbb__entry__3\\\">Sys_id of a connection alias.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__1\\\">ConnectionInfo</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfo_S__table_yxn_xq2_qbb__entry__2\\\">Information about the connection.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var provider = new sn_cc.ConnectionInfoProvider();\\n\\n// get a jdbc connection in the current domain with the alias ID\\n// "6219afbf9f03320021dd7501942e70fc"\\nvar connectionInfo = provider.getConnectionInfo("6219afbf9f03320021dd7501942e70fc");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CIP-getConnectionInfoByDomain_S_S\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CIP-getConnectionInfoByDomain_S_S\\\">ConnectionInfoProvider - getConnectionInfoByDomain(String aliasID, String domainID)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Retrieves a ConnectionInfo object identified by the given aliasID for a specific\\n domain.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\\\">aliasID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\\\">Sys_id of a connection alias.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__1\\\">domainID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_xxn_xq2_qbb__entry__3\\\">Sys_id of a domain or <kbd class=\\\"ph userinput\\\">global</kbd>.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__1\\\">ConnectionInfo</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CIP-getConnectionInfoByDomain_S_S__table_yxn_xq2_qbb__entry__2\\\">Connection information.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var provider = new sn_cc.ConnectionInfoProvider();\\n\\n// get a jdbc connection in the ACME domain with the alias ID\\n // "cd5923ff9f03320021dd7501942e70bb"\\n connectionInfo = provider.getConnectionInfoByDomain("cd5923ff9f03320021dd7501942e70bb",\\n "c90d4b084a362312013398f051272c0d");</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectionInfoProvider - Scoped, Global\n\nThe ConnectionInfoProvider API provides methods to select connection\ninformation through the connection alias.\n\nYou can use this API in scoped applications, or within the global scope. In scoped scripts,\nuse the `sn_cc` namespace identifier.\n\nThis function retrieves connection information identified by the given connection alias.\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n }\n\n```\n\n## ConnectionInfoProvider - ConnectionInfoProvider()\n\nSelects connection information through the connection alias.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n## ConnectionInfoProvider - getConnectionInfo(String aliasID)\n\nRetrieves a ConnectionInfo object identified by the given aliasID in the current\ndomain.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| aliasID | String | Sys\\_id of a connection alias. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| ConnectionInfo | Information about the connection. |\n\n### Example\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\n```\n\n## ConnectionInfoProvider - getConnectionInfoByDomain(String aliasID, String domainID)\n\nRetrieves a ConnectionInfo object identified by the given aliasID for a specific\ndomain.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| aliasID | String | Sys\\_id of a connection alias. |\n| domainID | String | Sys\\_id of a domain or `global`. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| ConnectionInfo | Connection information. |\n\n### Example\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: ConnectionInfoProvider - Scoped, Global\ndescription: The ConnectionInfoProvider API provides methods to select connection\n information through the connection alias.\nkeywords:\n- ConnectionInfoProvider\n- ConnectionInfoProvider\n- ConnectionInfoProvider()\n- getConnectionInfo()\n- getConnectionInfoByDomain(String aliasID\n- String domainID)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# ConnectionInfoProvider - Scoped, Global\n\nThe ConnectionInfoProvider API provides methods to select connection\ninformation through the connection alias.\n\nYou can use this API in scoped applications, or within the global scope. In scoped scripts,\nuse the `sn_cc` namespace identifier.\n\nThis function retrieves connection information identified by the given connection alias.\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\nif (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n gs.info(datamap[\"connection_url\"]);\n\n // get the same values using getAttribute\n gs.info(connectionInfo.getAttribute(\"name\"));\n gs.info(connectionInfo.getAttribute(\"connection_url\"));\n\n // get credential attributes\n gs.info(connectionInfo.getCredentialAttribute(\"user_name\"));\n gs.info(connectionInfo.getCredentialAttribute(\"password\")); \n\n // get extended attributes\n var extendedAttributes = connectionInfo.getExtendedAttributes(); \n gs.info(extendedAttributes[\"name1\"]);\n }\n\n // get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n if (connectionInfo != null) {\n // get data map\n var datamap = connectionInfo.getDataMap();\n gs.info(datamap[\"name\"]);\n }\n\n```\n\n## ConnectionInfoProvider - ConnectionInfoProvider()\n\nSelects connection information through the connection alias.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\n## ConnectionInfoProvider - getConnectionInfo(String aliasID)\n\nRetrieves a ConnectionInfo object identified by the given aliasID in the current\ndomain.\n\nTable 2. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| aliasID | String | Sys\\_id of a connection alias. |\n\nTable 3. Returns\n| Type | Description |\n| --- | --- |\n| ConnectionInfo | Information about the connection. |\n\n### Example\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the current domain with the alias ID\n// \"6219afbf9f03320021dd7501942e70fc\"\nvar connectionInfo = provider.getConnectionInfo(\"6219afbf9f03320021dd7501942e70fc\");\n```\n\n## ConnectionInfoProvider - getConnectionInfoByDomain(String aliasID, String domainID)\n\nRetrieves a ConnectionInfo object identified by the given aliasID for a specific\ndomain.\n\nTable 4. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| aliasID | String | Sys\\_id of a connection alias. |\n| domainID | String | Sys\\_id of a domain or `global`. |\n\nTable 5. Returns\n| Type | Description |\n| --- | --- |\n| ConnectionInfo | Connection information. |\n\n### Example\n\n```None\nvar provider = new sn_cc.ConnectionInfoProvider();\n\n// get a jdbc connection in the ACME domain with the alias ID\n // \"cd5923ff9f03320021dd7501942e70bb\"\n connectionInfo = provider.getConnectionInfoByDomain(\"cd5923ff9f03320021dd7501942e70bb\",\n \"c90d4b084a362312013398f051272c0d\");\n```\n"}}},{"rowIdx":1693,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Conversation - Scoped"},"description":{"kind":"string","value":"The Conversation API enables you to create or modify Connect conversations."},"keywords":{"kind":"list like","value":["Scoped Conversation","Conversation","Scoped Conversation","get(String sysID)","Conversation","create(String name)","addSubscriber(String sysID)","removeSubscriber(String sysID)","sendMessage(String body","String field)"],"string":"[\n \"Scoped Conversation\",\n \"Conversation\",\n \"Scoped Conversation\",\n \"get(String sysID)\",\n \"Conversation\",\n \"create(String name)\",\n \"addSubscriber(String sysID)\",\n \"removeSubscriber(String sysID)\",\n \"sendMessage(String body\",\n \"String field)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_c_ConversationScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_c_ConversationScopedAPI\" id=\"c_ConversationScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_c_ConversationScopedAPI\">Conversation <span class=\"ph\">- Scoped</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">Conversation</span> API enables you to create or modify Connect\n conversations.</p>\n <p class=\"p\">To use this class in a scoped application, use the <code class=\"ph codeph\">sn_connect</code> namespace\n identifier. The Connect Scriptable APIs plugin (ID: com.glide.connect.scriptable) should be\n enabled to access the <span class=\"keyword apiname\">Conversation</span> API.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_conversation-get-string\" id=\"conversation-get-string\">\n <h2 class=\"title topictitle2\" id=\"title_conversation-get-string\">Scoped Conversation - get(String sysID)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Get an existing Connect conversation by sys_id.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"conversation-get-string__table_zkg_1x5_bbb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-get-string__table_zkg_1x5_bbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-get-string__table_zkg_1x5_bbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-get-string__table_zkg_1x5_bbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-get-string__table_zkg_1x5_bbb__entry__1\">sysID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-get-string__table_zkg_1x5_bbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-get-string__table_zkg_1x5_bbb__entry__3\">The sys_id of the conversation record.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"conversation-get-string__table_alg_1x5_bbb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-get-string__table_alg_1x5_bbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-get-string__table_alg_1x5_bbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-get-string__table_alg_1x5_bbb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-get-string__table_alg_1x5_bbb__entry__2\">Conversation object</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var conversation = sn_connect.Conversation.get("27b9844c1385030034bb58a12244b037");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_conversation-create_String_String\" id=\"conversation-create_String_String\">\n <h2 class=\"title topictitle2\" id=\"title_conversation-create_String_String\">Scoped Conversation - create(String name)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Create a <span class=\"ph\">Connect</span>\n conversation.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"conversation-create_String_String__table_lwg_b4w_cbb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\">name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\">Create a conversation with a specific name.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\">type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\">Include a specific conversation type. The type is determined by the type choice\n list. The base system includes the following type options: <ul class=\"ul\" id=\"conversation-create_String_String__ul_ut2_4df_wbb\">\n <li class=\"li\">connect</li>\n <li class=\"li\">support</li>\n <li class=\"li\">group</li>\n <li class=\"li\">peer</li>\n <li class=\"li\">qanda</li>\n <li class=\"li\">team</li>\n </ul></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"conversation-create_String_String__table_mwg_b4w_cbb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-create_String_String__table_mwg_b4w_cbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-create_String_String__table_mwg_b4w_cbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_mwg_b4w_cbb__entry__1\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-create_String_String__table_mwg_b4w_cbb__entry__2\">Scriptable Conversation</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var conversation = sn_connect.Conversation.create({\n name: "Hello world",\n type: "connect"\n});</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_conversation-addSubscriber_string\" id=\"conversation-addSubscriber_string\">\n <h2 class=\"title topictitle2\" id=\"title_conversation-addSubscriber_string\">Scoped Conversation - addSubscriber(String sysID)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Add a user to a conversation.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"conversation-addSubscriber_string__table_e3k_bmx_cbb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__1\">sysID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__3\">Sys_ID of the user you want to add to a conversation.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"conversation-addSubscriber_string__table_f3k_bmx_cbb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");\nconversation.addSubscriber("a8f98bb0eb32010045e1a5115206fe3a");</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_conversation-removeSubscriber_string\" id=\"conversation-removeSubscriber_string\">\n <h2 class=\"title topictitle2\" id=\"title_conversation-removeSubscriber_string\">Scoped Conversation - removeSubscriber(String sysID)</h2>\n \n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Remove a user from a conversation.</p>\n <section class=\"section\">\n \n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__1\">SysID</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__3\">The sys_id of the user you want to remove from a conversation.</td>\n </tr>\n </tbody></table></div>\n \n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"conversation-removeSubscriber_string__table_f3k_bmx_cbb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n \n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");\nconversation.removeSubscriber("a8f98bb0eb32010045e1a5115206fe3a");</code></pre>\n </div>\n </div>\n \n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_conversation-sendMessage_String_String\" id=\"conversation-sendMessage_String_String\">\n <h2 class=\"title topictitle2\" id=\"title_conversation-sendMessage_String_String\">Scoped Conversation - sendMessage(String body, String field)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Send a message to a conversation.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\">Body</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\">The main text of the message.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\">Field</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\">The field you want the message to appear as. Only use this option if adding a\n message to a record conversation. Choose from work_notes, comments, or system. Using\n the field system treats the message as a system message.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"conversation-sendMessage_String_String__table_lcw_pmv_2bb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var conversation = sn_connect.Conversation.get("2064fa3919010300964f5270e9840fbb");\nconversation.sendMessage({body: "Hello world", field: "work_notes"});</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Conversation - Scoped</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205465\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205465\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_ConversationScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Scoped Conversation,Conversation,Scoped Conversation,get(String sysID),Conversation,create(String name),addSubscriber(String sysID),removeSubscriber(String sysID),sendMessage(String body, String field)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The Conversation API enables you to create or modify Connect conversations.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Scoped Conversation, Conversation, Scoped Conversation, get(String sysID), Conversation, create(String name), addSubscriber(String sysID), removeSubscriber(String sysID), sendMessage(String body, String field)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\",\n \"page_key\": 41205465,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 2328,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 274\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Conversation - Scoped\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_c_ConversationScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_ConversationScopedAPI\\\" id=\\\"c_ConversationScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_ConversationScopedAPI\\\">Conversation <span class=\\\"ph\\\">- Scoped</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">Conversation</span> API enables you to create or modify Connect\\n conversations.</p>\\n <p class=\\\"p\\\">To use this class in a scoped application, use the <code class=\\\"ph codeph\\\">sn_connect</code> namespace\\n identifier. The Connect Scriptable APIs plugin (ID: com.glide.connect.scriptable) should be\\n enabled to access the <span class=\\\"keyword apiname\\\">Conversation</span> API.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_conversation-get-string\\\" id=\\\"conversation-get-string\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_conversation-get-string\\\">Scoped Conversation - get(String sysID)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Get an existing Connect conversation by sys_id.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"conversation-get-string__table_zkg_1x5_bbb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__1\\\">sysID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-get-string__table_zkg_1x5_bbb__entry__3\\\">The sys_id of the conversation record.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"conversation-get-string__table_alg_1x5_bbb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-get-string__table_alg_1x5_bbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-get-string__table_alg_1x5_bbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-get-string__table_alg_1x5_bbb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-get-string__table_alg_1x5_bbb__entry__2\\\">Conversation object</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var conversation = sn_connect.Conversation.get("27b9844c1385030034bb58a12244b037");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_conversation-create_String_String\\\" id=\\\"conversation-create_String_String\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_conversation-create_String_String\\\">Scoped Conversation - create(String name)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Create a <span class=\\\"ph\\\">Connect</span>\\n conversation.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"conversation-create_String_String__table_lwg_b4w_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\\\">name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\\\">Create a conversation with a specific name.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__1\\\">type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_lwg_b4w_cbb__entry__3\\\">Include a specific conversation type. The type is determined by the type choice\\n list. The base system includes the following type options: <ul class=\\\"ul\\\" id=\\\"conversation-create_String_String__ul_ut2_4df_wbb\\\">\\n <li class=\\\"li\\\">connect</li>\\n <li class=\\\"li\\\">support</li>\\n <li class=\\\"li\\\">group</li>\\n <li class=\\\"li\\\">peer</li>\\n <li class=\\\"li\\\">qanda</li>\\n <li class=\\\"li\\\">team</li>\\n </ul></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"conversation-create_String_String__table_mwg_b4w_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-create_String_String__table_mwg_b4w_cbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-create_String_String__table_mwg_b4w_cbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_mwg_b4w_cbb__entry__1\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-create_String_String__table_mwg_b4w_cbb__entry__2\\\">Scriptable Conversation</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var conversation = sn_connect.Conversation.create({\\n name: "Hello world",\\n type: "connect"\\n});</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_conversation-addSubscriber_string\\\" id=\\\"conversation-addSubscriber_string\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_conversation-addSubscriber_string\\\">Scoped Conversation - addSubscriber(String sysID)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Add a user to a conversation.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__1\\\">sysID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__3\\\">Sys_ID of the user you want to add to a conversation.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"conversation-addSubscriber_string__table_f3k_bmx_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");\\nconversation.addSubscriber("a8f98bb0eb32010045e1a5115206fe3a");</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_conversation-removeSubscriber_string\\\" id=\\\"conversation-removeSubscriber_string\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_conversation-removeSubscriber_string\\\">Scoped Conversation - removeSubscriber(String sysID)</h2>\\n \\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Remove a user from a conversation.</p>\\n <section class=\\\"section\\\">\\n \\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__1\\\">SysID</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__3\\\">The sys_id of the user you want to remove from a conversation.</td>\\n </tr>\\n </tbody></table></div>\\n \\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"conversation-removeSubscriber_string__table_f3k_bmx_cbb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n \\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");\\nconversation.removeSubscriber("a8f98bb0eb32010045e1a5115206fe3a");</code></pre>\\n </div>\\n </div>\\n \\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_conversation-sendMessage_String_String\\\" id=\\\"conversation-sendMessage_String_String\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_conversation-sendMessage_String_String\\\">Scoped Conversation - sendMessage(String body, String field)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Send a message to a conversation.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\\\">Body</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\\\">The main text of the message.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__1\\\">Field</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3\\\">The field you want the message to appear as. Only use this option if adding a\\n message to a record conversation. Choose from work_notes, comments, or system. Using\\n the field system treats the message as a system message.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"conversation-sendMessage_String_String__table_lcw_pmv_2bb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var conversation = sn_connect.Conversation.get("2064fa3919010300964f5270e9840fbb");\\nconversation.sendMessage({body: "Hello world", field: "work_notes"});</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Conversation - Scoped\n\nThe Conversation API enables you to create or modify Connect\nconversations.\n\nTo use this class in a scoped application, use the `sn_connect` namespace\nidentifier. The Connect Scriptable APIs plugin (ID: com.glide.connect.scriptable) should be\nenabled to access the Conversation API.\n\n## Scoped Conversation - get(String sysID)\n\nGet an existing Connect conversation by sys\\_id.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| sysID | String | The sys\\_id of the conversation record. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Conversation object |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"27b9844c1385030034bb58a12244b037\");\n```\n\n## Scoped Conversation - create(String name)\n\nCreate a Connect\nconversation.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Create a conversation with a specific name. |\n| type | String | Include a specific conversation type. The type is determined by the type choice list. The base system includes the following type options: * connect * support * group * peer * qanda * team |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Scriptable Conversation |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.create({\n name: \"Hello world\",\n type: \"connect\"\n});\n```\n\n## Scoped Conversation - addSubscriber(String sysID)\n\nAdd a user to a conversation.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| sysID | String | Sys\\_ID of the user you want to add to a conversation. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"7caf49111309030034bb58a12244b06c\");\nconversation.addSubscriber(\"a8f98bb0eb32010045e1a5115206fe3a\");\n```\n\n## Scoped Conversation - removeSubscriber(String sysID)\n\nRemove a user from a conversation.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| SysID | String | The sys\\_id of the user you want to remove from a conversation. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"7caf49111309030034bb58a12244b06c\");\nconversation.removeSubscriber(\"a8f98bb0eb32010045e1a5115206fe3a\");\n```\n\n## Scoped Conversation - sendMessage(String body, String field)\n\nSend a message to a conversation.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| Body | String | The main text of the message. |\n| Field | String | The field you want the message to appear as. Only use this option if adding a message to a record conversation. Choose from work\\_notes, comments, or system. Using the field system treats the message as a system message. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"2064fa3919010300964f5270e9840fbb\");\nconversation.sendMessage({body: \"Hello world\", field: \"work_notes\"});\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: Conversation - Scoped\ndescription: The Conversation API enables you to create or modify Connect conversations.\nkeywords:\n- Scoped Conversation\n- Conversation\n- Scoped Conversation\n- get(String sysID)\n- Conversation\n- create(String name)\n- addSubscriber(String sysID)\n- removeSubscriber(String sysID)\n- sendMessage(String body\n- String field)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Conversation - Scoped\n\nThe Conversation API enables you to create or modify Connect\nconversations.\n\nTo use this class in a scoped application, use the `sn_connect` namespace\nidentifier. The Connect Scriptable APIs plugin (ID: com.glide.connect.scriptable) should be\nenabled to access the Conversation API.\n\n## Scoped Conversation - get(String sysID)\n\nGet an existing Connect conversation by sys\\_id.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| sysID | String | The sys\\_id of the conversation record. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| Object | Conversation object |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"27b9844c1385030034bb58a12244b037\");\n```\n\n## Scoped Conversation - create(String name)\n\nCreate a Connect\nconversation.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Create a conversation with a specific name. |\n| type | String | Include a specific conversation type. The type is determined by the type choice list. The base system includes the following type options: * connect * support * group * peer * qanda * team |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Object | Scriptable Conversation |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.create({\n name: \"Hello world\",\n type: \"connect\"\n});\n```\n\n## Scoped Conversation - addSubscriber(String sysID)\n\nAdd a user to a conversation.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| sysID | String | Sys\\_ID of the user you want to add to a conversation. |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"7caf49111309030034bb58a12244b06c\");\nconversation.addSubscriber(\"a8f98bb0eb32010045e1a5115206fe3a\");\n```\n\n## Scoped Conversation - removeSubscriber(String sysID)\n\nRemove a user from a conversation.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| SysID | String | The sys\\_id of the user you want to remove from a conversation. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"7caf49111309030034bb58a12244b06c\");\nconversation.removeSubscriber(\"a8f98bb0eb32010045e1a5115206fe3a\");\n```\n\n## Scoped Conversation - sendMessage(String body, String field)\n\nSend a message to a conversation.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| Body | String | The main text of the message. |\n| Field | String | The field you want the message to appear as. Only use this option if adding a message to a record conversation. Choose from work\\_notes, comments, or system. Using the field system treats the message as a system message. |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\n```None\nvar conversation = sn_connect.Conversation.get(\"2064fa3919010300964f5270e9840fbb\");\nconversation.sendMessage({body: \"Hello world\", field: \"work_notes\"});\n```\n"}}},{"rowIdx":1694,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"CostPlanBatchOperations - Global"},"description":{"kind":"string","value":"Provides methods that enable the creation of a large number of cost plan records for demands and projects using batch processing. Use this API instead of GlideRecord to more efficiently create multiple cost plan records."},"keywords":{"kind":"list like","value":["Create cost plans","batch cost plans","CostPlanBatchOperations","CostPlanBatchOperations","add(Object costPlan)","CostPlanBatchOperations","clear()"],"string":"[\n \"Create cost plans\",\n \"batch cost plans\",\n \"CostPlanBatchOperations\",\n \"CostPlanBatchOperations\",\n \"add(Object costPlan)\",\n \"CostPlanBatchOperations\",\n \"clear()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_CostPlanBatchOperationsAPI\"><article class=\"nested0\" aria-labelledby=\"title_CostPlanBatchOperationsAPI\" id=\"CostPlanBatchOperationsAPI\">\n <h1 class=\"title topictitle1\" id=\"title_CostPlanBatchOperationsAPI\">CostPlanBatchOperations <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">Provides methods that enable the creation of a large number of cost plan records for\n demands and projects using batch processing. Use this API instead of\n <span class=\"keyword apiname\">GlideRecord</span> to more efficiently create multiple cost plan\n records.</p>\n <p class=\"p\">Use the <span class=\"keyword apiname\">CostPlanBatchOperations.add()</span> method to add any number of cost\n plans to a batch queue. Once you have added all the required cost plans, use the\n <span class=\"keyword apiname\">CostPlanBatchOperations.process()</span> method to actually create/insert the\n cost plans in your instance. Until you call the\n <span class=\"keyword apiname\">CostPlanBatchOperations.process()</span> method, the add requests remain in the\n batch queue (they are not yet added to your instance). If for some reason you need to remove\n all of the cost plans in the batch queue, use the\n <span class=\"keyword apiname\">CostPlanBatchOperations.clear()</span> method.</p>\n <p class=\"p\">To use this API you must activate the com.snc.financial_planning_pmo plugin.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CostPlanBatch-add_A\" id=\"CostPlanBatch-add_A\">\n <h2 class=\"title topictitle2\" id=\"title_CostPlanBatch-add_A\">CostPlanBatchOperations - add(Object costPlan)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Adds one or more cost plans to a specified task (project or demand). Use this method\n when you want to create multiple cost plans.</p>\n <section class=\"section\">\n <div class=\"p\">Once processed, the cost plans are inserted into the specified project or demand. You can\n then view and modify them within your instance. For additional information, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=t_CreateAProjectCostPlan&version=vancouver&pubname=vancouver-it-business-management\" class=\"xref\">Create a project cost plan</a> and\n <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=t_CreateADemandCostPlan&version=vancouver&pubname=vancouver-it-business-management\" class=\"xref\">Create a demand cost\n plan</a>.<div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This method only defines the cost plans to add to your instance. The\n cost plans are not inserted into your instance until the\n <span class=\"keyword apiname\">costPlanBatchOperations.process()</span> is called.</div></div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CostPlanBatch-add_A__table_ebg_mhf_kjb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">One or more objects or an array of objects that describe each of the cost plans\n to add to an existing task.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Name of the cost plan.<p class=\"p\">Maximum length: 130 characters</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.task</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Sys_id of the project or demand to associate with this cost plan. You can\n locate this value in one of the following tables:<ul class=\"ul\" id=\"CostPlanBatch-add_A__ul_ahs_vwj_4jb\">\n <li class=\"li\">Project [pm_project]</li>\n <li class=\"li\">Project Task [pm_project_task]</li>\n <li class=\"li\">Demand [dmn_demand]</li>\n </ul></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.unit_cost</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Cost of a single unit of the specified resource.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.resource_type</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Sys_id of the record that defines the cost type associated with this cost plan.\n The available values for this parameter are defined in the Cost Type Definition\n [resource_type_definition] table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.start_fiscal_period</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Sys_id of the record that defines the starting fiscal period to associate with\n this cost plan. The available values for this parameter are defined in the Fiscal\n period [fiscal_period] table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.end_fiscal_period</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Sys_id of the record that defines the ending fiscal period to associate with\n this cost plan. The available values for this parameter are defined in the Fiscal\n period [fiscal_period] table.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\">costPlan.<optional></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\">Varied</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\">Optional. You can pass in additional parameters to add to a cost plan. The\n available parameters depend on the type of cost plan that you are creating.<p class=\"p\">Refer\n to the Cost Plan [cost_plan] table for the list of additional parameters that you\n can pass.</p></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CostPlanBatch-add_A__table_fbg_mhf_kjb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example shows how to add a simple batched cost plan.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CostPlanBatch-clear\" id=\"CostPlanBatch-clear\">\n <h2 class=\"title topictitle2\" id=\"title_CostPlanBatch-clear\">CostPlanBatchOperations - clear()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Removes all cost plan objects that were added using the\n <span class=\"keyword apiname\">CostPlanBatchOperations.add()</span> method.</p>\n <section class=\"section\">\n <div class=\"note note note_note\"><span class=\"note__title\">Note:</span> This method only works for cost plans that have been added. Once a cost plan is\n processed, this method cannot remove it. Processed cost plans must be removed manually\n through the UI.</div>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CostPlanBatch-clear__table_ovv_q24_kjb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CostPlanBatch-clear__table_pvv_q24_kjb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example shows how to clear the batch queue after adding cost plans.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\ncostPlanBatchOperations.clear();</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_CostPlanBatch-process\" id=\"CostPlanBatch-process\">\n <h2 class=\"title topictitle2\" id=\"title_CostPlanBatch-process\">CostPlanBatchOperations - process()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Processes all of the cost plans that were added using the\n <span class=\"keyword apiname\">CostPlanBatchOperations.add()</span> method and creates corresponding cost plans\n and relevant rollups.</p>\n <section class=\"section\">\n <p class=\"p\">Once the cost plans are successfully processed, the cost plan queue is cleared.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"CostPlanBatch-process__table_ej2_dh4_kjb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"CostPlanBatch-process__table_fj2_dh4_kjb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__2\">Sys ID for each generated cost plan.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example shows how to process a simple batched cost plan.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">CostPlanBatchOperations - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205468\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205468\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"CostPlanBatchOperationsAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Create cost plans,batch cost plans,CostPlanBatchOperations,CostPlanBatchOperations,add(Object costPlan),CostPlanBatchOperations,clear()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"Provides methods that enable the creation of a large number of cost plan records for demands and projects using batch processing. Use this API instead of GlideRecord to more efficiently create multiple cost plan records.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Create cost plans, batch cost plans, CostPlanBatchOperations, CostPlanBatchOperations, add(Object costPlan), CostPlanBatchOperations, clear()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\",\n \"page_key\": 41205468,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 6295,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 778\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"CostPlanBatchOperations - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_CostPlanBatchOperationsAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_CostPlanBatchOperationsAPI\\\" id=\\\"CostPlanBatchOperationsAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_CostPlanBatchOperationsAPI\\\">CostPlanBatchOperations <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">Provides methods that enable the creation of a large number of cost plan records for\\n demands and projects using batch processing. Use this API instead of\\n <span class=\\\"keyword apiname\\\">GlideRecord</span> to more efficiently create multiple cost plan\\n records.</p>\\n <p class=\\\"p\\\">Use the <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.add()</span> method to add any number of cost\\n plans to a batch queue. Once you have added all the required cost plans, use the\\n <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.process()</span> method to actually create/insert the\\n cost plans in your instance. Until you call the\\n <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.process()</span> method, the add requests remain in the\\n batch queue (they are not yet added to your instance). If for some reason you need to remove\\n all of the cost plans in the batch queue, use the\\n <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.clear()</span> method.</p>\\n <p class=\\\"p\\\">To use this API you must activate the com.snc.financial_planning_pmo plugin.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CostPlanBatch-add_A\\\" id=\\\"CostPlanBatch-add_A\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CostPlanBatch-add_A\\\">CostPlanBatchOperations - add(Object costPlan)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Adds one or more cost plans to a specified task (project or demand). Use this method\\n when you want to create multiple cost plans.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"p\\\">Once processed, the cost plans are inserted into the specified project or demand. You can\\n then view and modify them within your instance. For additional information, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=t_CreateAProjectCostPlan&version=vancouver&pubname=vancouver-it-business-management\\\" class=\\\"xref\\\">Create a project cost plan</a> and\\n <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/CostPlanBatchOperations/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=t_CreateADemandCostPlan&version=vancouver&pubname=vancouver-it-business-management\\\" class=\\\"xref\\\">Create a demand cost\\n plan</a>.<div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This method only defines the cost plans to add to your instance. The\\n cost plans are not inserted into your instance until the\\n <span class=\\\"keyword apiname\\\">costPlanBatchOperations.process()</span> is called.</div></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">One or more objects or an array of objects that describe each of the cost plans\\n to add to an existing task.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Name of the cost plan.<p class=\\\"p\\\">Maximum length: 130 characters</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.task</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Sys_id of the project or demand to associate with this cost plan. You can\\n locate this value in one of the following tables:<ul class=\\\"ul\\\" id=\\\"CostPlanBatch-add_A__ul_ahs_vwj_4jb\\\">\\n <li class=\\\"li\\\">Project [pm_project]</li>\\n <li class=\\\"li\\\">Project Task [pm_project_task]</li>\\n <li class=\\\"li\\\">Demand [dmn_demand]</li>\\n </ul></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.unit_cost</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Cost of a single unit of the specified resource.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.resource_type</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Sys_id of the record that defines the cost type associated with this cost plan.\\n The available values for this parameter are defined in the Cost Type Definition\\n [resource_type_definition] table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.start_fiscal_period</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Sys_id of the record that defines the starting fiscal period to associate with\\n this cost plan. The available values for this parameter are defined in the Fiscal\\n period [fiscal_period] table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.end_fiscal_period</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Sys_id of the record that defines the ending fiscal period to associate with\\n this cost plan. The available values for this parameter are defined in the Fiscal\\n period [fiscal_period] table.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__1\\\">costPlan.<optional></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__2\\\">Varied</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_ebg_mhf_kjb__entry__3\\\">Optional. You can pass in additional parameters to add to a cost plan. The\\n available parameters depend on the type of cost plan that you are creating.<p class=\\\"p\\\">Refer\\n to the Cost Plan [cost_plan] table for the list of additional parameters that you\\n can pass.</p></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CostPlanBatch-add_A__table_fbg_mhf_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-add_A__table_fbg_mhf_kjb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example shows how to add a simple batched cost plan.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">//Define Array of Cost Plan records in JSON format\\nvar costPlanRecords= [];\\ncostPlanRecords.push({\\n name:'Capital Expense',\\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\\n unit_cost:1000.00, //decimal \\n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \\n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \\n quantity:1 // Optional cost plan record attributes\\n});\\n \\nvar costPlanBatchOperations = new CostPlanBatchOperations();\\ncostPlanBatchOperations.add(costPlanRecords);\\nvar costPlanSysIds = costPlanBatchOperations.process();\\n\\n</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CostPlanBatch-clear\\\" id=\\\"CostPlanBatch-clear\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CostPlanBatch-clear\\\">CostPlanBatchOperations - clear()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Removes all cost plan objects that were added using the\\n <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.add()</span> method.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"note note note_note\\\"><span class=\\\"note__title\\\">Note:</span> This method only works for cost plans that have been added. Once a cost plan is\\n processed, this method cannot remove it. Processed cost plans must be removed manually\\n through the UI.</div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CostPlanBatch-clear__table_ovv_q24_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-clear__table_ovv_q24_kjb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CostPlanBatch-clear__table_pvv_q24_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-clear__table_pvv_q24_kjb__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example shows how to clear the batch queue after adding cost plans.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">//Define Array of Cost Plan records in JSON format\\nvar costPlanRecords= [];\\ncostPlanRecords.push({\\n name:'Capital Expense',\\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\\n unit_cost:1000.00, //decimal \\n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \\n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \\n quantity:1 // Optional cost plan record attributes\\n});\\n \\nvar costPlanBatchOperations = new CostPlanBatchOperations();\\ncostPlanBatchOperations.add(costPlanRecords);\\nvar costPlanSysIds = costPlanBatchOperations.process();\\ncostPlanBatchOperations.clear();</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_CostPlanBatch-process\\\" id=\\\"CostPlanBatch-process\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_CostPlanBatch-process\\\">CostPlanBatchOperations - process()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Processes all of the cost plans that were added using the\\n <span class=\\\"keyword apiname\\\">CostPlanBatchOperations.add()</span> method and creates corresponding cost plans\\n and relevant rollups.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Once the cost plans are successfully processed, the cost plan queue is cleared.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"CostPlanBatch-process__table_ej2_dh4_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-process__table_ej2_dh4_kjb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"CostPlanBatch-process__table_fj2_dh4_kjb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"CostPlanBatch-process__table_fj2_dh4_kjb__entry__2\\\">Sys ID for each generated cost plan.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example shows how to process a simple batched cost plan.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">//Define Array of Cost Plan records in JSON format\\nvar costPlanRecords= [];\\ncostPlanRecords.push({\\n name:'Capital Expense',\\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\\n unit_cost:1000.00, //decimal \\n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \\n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \\n quantity:1 // Optional cost plan record attributes\\n});\\n \\nvar costPlanBatchOperations = new CostPlanBatchOperations();\\ncostPlanBatchOperations.add(costPlanRecords);\\nvar costPlanSysIds = costPlanBatchOperations.process();\\n\\n</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# CostPlanBatchOperations - Global\n\nProvides methods that enable the creation of a large number of cost plan records for\ndemands and projects using batch processing. Use this API instead of\nGlideRecord to more efficiently create multiple cost plan\nrecords.\n\nUse the CostPlanBatchOperations.add() method to add any number of cost\nplans to a batch queue. Once you have added all the required cost plans, use the\nCostPlanBatchOperations.process() method to actually create/insert the\ncost plans in your instance. Until you call the\nCostPlanBatchOperations.process() method, the add requests remain in the\nbatch queue (they are not yet added to your instance). If for some reason you need to remove\nall of the cost plans in the batch queue, use the\nCostPlanBatchOperations.clear() method.\n\nTo use this API you must activate the com.snc.financial\\_planning\\_pmo plugin.\n\n## CostPlanBatchOperations - add(Object costPlan)\n\nAdds one or more cost plans to a specified task (project or demand). Use this method\nwhen you want to create multiple cost plans.\n\nOnce processed, the cost plans are inserted into the specified project or demand. You can\nthen view and modify them within your instance. For additional information, see Create a project cost plan and\nCreate a demand cost\nplan.Note: This method only defines the cost plans to add to your instance. The\ncost plans are not inserted into your instance until the\ncostPlanBatchOperations.process() is called.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| costPlan | Object | One or more objects or an array of objects that describe each of the cost plans to add to an existing task. |\n| costPlan.name | String | Name of the cost plan. Maximum length: 130 characters |\n| costPlan.task | String | Sys\\_id of the project or demand to associate with this cost plan. You can locate this value in one of the following tables: * Project [pm\\_project] * Project Task [pm\\_project\\_task] * Demand [dmn\\_demand] |\n| costPlan.unit\\_cost | Number | Cost of a single unit of the specified resource. |\n| costPlan.resource\\_type | String | Sys\\_id of the record that defines the cost type associated with this cost plan. The available values for this parameter are defined in the Cost Type Definition [resource\\_type\\_definition] table. |\n| costPlan.start\\_fiscal\\_period | String | Sys\\_id of the record that defines the starting fiscal period to associate with this cost plan. The available values for this parameter are defined in the Fiscal period [fiscal\\_period] table. |\n| costPlan.end\\_fiscal\\_period | String | Sys\\_id of the record that defines the ending fiscal period to associate with this cost plan. The available values for this parameter are defined in the Fiscal period [fiscal\\_period] table. |\n| costPlan.<optional> | Varied | Optional. You can pass in additional parameters to add to a cost plan. The available parameters depend on the type of cost plan that you are creating. Refer to the Cost Plan [cost\\_plan] table for the list of additional parameters that you can pass. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nThis example shows how to add a simple batched cost plan.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n```\n\n## CostPlanBatchOperations - clear()\n\nRemoves all cost plan objects that were added using the\nCostPlanBatchOperations.add() method.\n\nNote: This method only works for cost plans that have been added. Once a cost plan is\nprocessed, this method cannot remove it. Processed cost plans must be removed manually\nthrough the UI.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nThis example shows how to clear the batch queue after adding cost plans.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\ncostPlanBatchOperations.clear();\n```\n\n## CostPlanBatchOperations - process()\n\nProcesses all of the cost plans that were added using the\nCostPlanBatchOperations.add() method and creates corresponding cost plans\nand relevant rollups.\n\nOnce the cost plans are successfully processed, the cost plan queue is cleared.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Array | Sys ID for each generated cost plan. |\n\n### Example\n\nThis example shows how to process a simple batched cost plan.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: CostPlanBatchOperations - Global\ndescription: Provides methods that enable the creation of a large number of cost plan\n records for demands and projects using batch processing. Use this API instead of\n GlideRecord to more efficiently create multiple cost plan records.\nkeywords:\n- Create cost plans\n- batch cost plans\n- CostPlanBatchOperations\n- CostPlanBatchOperations\n- add(Object costPlan)\n- CostPlanBatchOperations\n- clear()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# CostPlanBatchOperations - Global\n\nProvides methods that enable the creation of a large number of cost plan records for\ndemands and projects using batch processing. Use this API instead of\nGlideRecord to more efficiently create multiple cost plan\nrecords.\n\nUse the CostPlanBatchOperations.add() method to add any number of cost\nplans to a batch queue. Once you have added all the required cost plans, use the\nCostPlanBatchOperations.process() method to actually create/insert the\ncost plans in your instance. Until you call the\nCostPlanBatchOperations.process() method, the add requests remain in the\nbatch queue (they are not yet added to your instance). If for some reason you need to remove\nall of the cost plans in the batch queue, use the\nCostPlanBatchOperations.clear() method.\n\nTo use this API you must activate the com.snc.financial\\_planning\\_pmo plugin.\n\n## CostPlanBatchOperations - add(Object costPlan)\n\nAdds one or more cost plans to a specified task (project or demand). Use this method\nwhen you want to create multiple cost plans.\n\nOnce processed, the cost plans are inserted into the specified project or demand. You can\nthen view and modify them within your instance. For additional information, see Create a project cost plan and\nCreate a demand cost\nplan.Note: This method only defines the cost plans to add to your instance. The\ncost plans are not inserted into your instance until the\ncostPlanBatchOperations.process() is called.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| costPlan | Object | One or more objects or an array of objects that describe each of the cost plans to add to an existing task. |\n| costPlan.name | String | Name of the cost plan. Maximum length: 130 characters |\n| costPlan.task | String | Sys\\_id of the project or demand to associate with this cost plan. You can locate this value in one of the following tables: * Project [pm\\_project] * Project Task [pm\\_project\\_task] * Demand [dmn\\_demand] |\n| costPlan.unit\\_cost | Number | Cost of a single unit of the specified resource. |\n| costPlan.resource\\_type | String | Sys\\_id of the record that defines the cost type associated with this cost plan. The available values for this parameter are defined in the Cost Type Definition [resource\\_type\\_definition] table. |\n| costPlan.start\\_fiscal\\_period | String | Sys\\_id of the record that defines the starting fiscal period to associate with this cost plan. The available values for this parameter are defined in the Fiscal period [fiscal\\_period] table. |\n| costPlan.end\\_fiscal\\_period | String | Sys\\_id of the record that defines the ending fiscal period to associate with this cost plan. The available values for this parameter are defined in the Fiscal period [fiscal\\_period] table. |\n| costPlan.<optional> | Varied | Optional. You can pass in additional parameters to add to a cost plan. The available parameters depend on the type of cost plan that you are creating. Refer to the Cost Plan [cost\\_plan] table for the list of additional parameters that you can pass. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nThis example shows how to add a simple batched cost plan.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n```\n\n## CostPlanBatchOperations - clear()\n\nRemoves all cost plan objects that were added using the\nCostPlanBatchOperations.add() method.\n\nNote: This method only works for cost plans that have been added. Once a cost plan is\nprocessed, this method cannot remove it. Processed cost plans must be removed manually\nthrough the UI.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n### Example\n\nThis example shows how to clear the batch queue after adding cost plans.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\ncostPlanBatchOperations.clear();\n```\n\n## CostPlanBatchOperations - process()\n\nProcesses all of the cost plans that were added using the\nCostPlanBatchOperations.add() method and creates corresponding cost plans\nand relevant rollups.\n\nOnce the cost plans are successfully processed, the cost plan queue is cleared.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| Array | Sys ID for each generated cost plan. |\n\n### Example\n\nThis example shows how to process a simple batched cost plan.\n\n```None\n//Define Array of Cost Plan records in JSON format\nvar costPlanRecords= [];\ncostPlanRecords.push({\n name:'Capital Expense',\n task:'f7a36d1bdb58001025c85a35dc96193a', // sys_id of the task\n unit_cost:1000.00, //decimal \n resource_type:'a546eaf79330120064f572edb67ffb70', // sys_id of the cost type definition\n start_fiscal_period:'091b6e60cb111200f2de77a4634c9c2e', // sys_id of the start fiscal period record \n end_fiscal_period:'0d1b6e60cb111200f2de77a4634c9c2f',// sys_id of the end fiscal period record \n quantity:1 // Optional cost plan record attributes\n});\n \nvar costPlanBatchOperations = new CostPlanBatchOperations();\ncostPlanBatchOperations.add(costPlanRecords);\nvar costPlanSysIds = costPlanBatchOperations.process();\n\n```\n"}}},{"rowIdx":1695,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"CriteriaEvaluator - Global"},"description":{"kind":"string","value":"Implements a general-purpose criteria evaluator."},"keywords":{"kind":"list like","value":["CriteriaEvaluator API","CriteriaEvaluator","addCriterion(String lhComparand","String operator","String rhComparand)","evaluate(Object lhValues","String rhValues","Boolean any)"],"string":"[\n \"CriteriaEvaluator API\",\n \"CriteriaEvaluator\",\n \"addCriterion(String lhComparand\",\n \"String operator\",\n \"String rhComparand)\",\n \"evaluate(Object lhValues\",\n \"String rhValues\",\n \"Boolean any)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\"main\"><article role=\"article\" class=\"dita\" aria-labelledby=\"title_c_CriteriaEvaluatorAPI\"><article class=\"nested0\" aria-labelledby=\"title_c_CriteriaEvaluatorAPI\" id=\"c_CriteriaEvaluatorAPI\">\n <h1 class=\"title topictitle1\" id=\"title_c_CriteriaEvaluatorAPI\">CriteriaEvaluator <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">Implements a general-purpose criteria evaluator.</p>\n <p class=\"p\">The general use pattern is to construct the class, add as many criteria as needed, then\n evaluate.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CE-addCriterion_S_S_S\" id=\"r_CE-addCriterion_S_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_r_CE-addCriterion_S_S_S\">CriteriaEvaluator - addCriterion(String lhComparand, String operator, String\n rhComparand)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Adds the criteria to be evaluated.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\">lhComparand</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\">The left hand comparand. Must be a named value in the left hand values input\n into <span class=\"keyword apiname\">evaluate()</span>.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\">operator</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\">The operator. Must be one of: equals, starts with, contains, does not contain,\n ends with, or regex matches.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\">rhComparand</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\">The right hand comparand. Can be evaluated either as one of the right hand\n values input to <span class=\"keyword apiname\">evaluate()</span> or as a literal string.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__1\">void</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__2\"></td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_r_CE-evaluate_O_S_B\" id=\"r_CE-evaluate_O_S_B\">\n <h2 class=\"title topictitle2\" id=\"title_r_CE-evaluate_O_S_B\">CriteriaEvaluator - evaluate(Object lhValues, String rhValues, Boolean any)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Evaluates the criteria.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\">lhValues</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\">A hashmap of name-value pairs to evaluate the left hand comparands of the\n criteria.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\">rhValues</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\">Optional right hand values to use instead of the literal value in evaluating\n the right hand comparands.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\">any</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\">If true, any criterion matching suffices for a true result. If false, all\n criteria must match for a true result.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__1\">Boolean</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__2\">True if the supplied values satisfy the criteria, false otherwise.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">CriteriaEvaluator - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205471\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205471\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"c_CriteriaEvaluatorAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"CriteriaEvaluator API,CriteriaEvaluator,addCriterion(String lhComparand, String operator, String rhComparand),evaluate(Object lhValues, String rhValues, Boolean any)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"Implements a general-purpose criteria evaluator.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"CriteriaEvaluator API, CriteriaEvaluator, addCriterion(String lhComparand, String operator, String rhComparand), evaluate(Object lhValues, String rhValues, Boolean any)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\",\n \"page_key\": 41205471,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 1320,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 185\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"CriteriaEvaluator - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"dita\\\" aria-labelledby=\\\"title_c_CriteriaEvaluatorAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_c_CriteriaEvaluatorAPI\\\" id=\\\"c_CriteriaEvaluatorAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_c_CriteriaEvaluatorAPI\\\">CriteriaEvaluator <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">Implements a general-purpose criteria evaluator.</p>\\n <p class=\\\"p\\\">The general use pattern is to construct the class, add as many criteria as needed, then\\n evaluate.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CE-addCriterion_S_S_S\\\" id=\\\"r_CE-addCriterion_S_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CE-addCriterion_S_S_S\\\">CriteriaEvaluator - addCriterion(String lhComparand, String operator, String\\n rhComparand)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Adds the criteria to be evaluated.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\\\">lhComparand</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\\\">The left hand comparand. Must be a named value in the left hand values input\\n into <span class=\\\"keyword apiname\\\">evaluate()</span>.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\\\">operator</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\\\">The operator. Must be one of: equals, starts with, contains, does not contain,\\n ends with, or regex matches.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__1\\\">rhComparand</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_vtj_t2d_pt__entry__3\\\">The right hand comparand. Can be evaluated either as one of the right hand\\n values input to <span class=\\\"keyword apiname\\\">evaluate()</span> or as a literal string.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__1\\\">void</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-addCriterion_S_S_S__table_wtj_t2d_pt__entry__2\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_r_CE-evaluate_O_S_B\\\" id=\\\"r_CE-evaluate_O_S_B\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_r_CE-evaluate_O_S_B\\\">CriteriaEvaluator - evaluate(Object lhValues, String rhValues, Boolean any)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Evaluates the criteria.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\\\">lhValues</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\\\">A hashmap of name-value pairs to evaluate the left hand comparands of the\\n criteria.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\\\">rhValues</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\\\">Optional right hand values to use instead of the literal value in evaluating\\n the right hand comparands.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__1\\\">any</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__2\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_ydl_sfd_pt__entry__3\\\">If true, any criterion matching suffices for a true result. If false, all\\n criteria must match for a true result.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__1\\\">Boolean</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"r_CE-evaluate_O_S_B__table_zdl_sfd_pt__entry__2\\\">True if the supplied values satisfy the criteria, false otherwise.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# CriteriaEvaluator - Global\n\nImplements a general-purpose criteria evaluator.\n\nThe general use pattern is to construct the class, add as many criteria as needed, then\nevaluate.\n\n## CriteriaEvaluator - addCriterion(String lhComparand, String operator, String rhComparand)\n\nAdds the criteria to be evaluated.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| lhComparand | String | The left hand comparand. Must be a named value in the left hand values input into evaluate(). |\n| operator | String | The operator. Must be one of: equals, starts with, contains, does not contain, ends with, or regex matches. |\n| rhComparand | String | The right hand comparand. Can be evaluated either as one of the right hand values input to evaluate() or as a literal string. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## CriteriaEvaluator - evaluate(Object lhValues, String rhValues, Boolean any)\n\nEvaluates the criteria.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| lhValues | Object | A hashmap of name-value pairs to evaluate the left hand comparands of the criteria. |\n| rhValues | String | Optional right hand values to use instead of the literal value in evaluating the right hand comparands. |\n| any | Boolean | If true, any criterion matching suffices for a true result. If false, all criteria must match for a true result. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the supplied values satisfy the criteria, false otherwise. |\n"},"rich_text":{"kind":"string","value":"---\ntitle: CriteriaEvaluator - Global\ndescription: Implements a general-purpose criteria evaluator.\nkeywords:\n- CriteriaEvaluator API\n- CriteriaEvaluator\n- addCriterion(String lhComparand\n- String operator\n- String rhComparand)\n- evaluate(Object lhValues\n- String rhValues\n- Boolean any)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# CriteriaEvaluator - Global\n\nImplements a general-purpose criteria evaluator.\n\nThe general use pattern is to construct the class, add as many criteria as needed, then\nevaluate.\n\n## CriteriaEvaluator - addCriterion(String lhComparand, String operator, String rhComparand)\n\nAdds the criteria to be evaluated.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| lhComparand | String | The left hand comparand. Must be a named value in the left hand values input into evaluate(). |\n| operator | String | The operator. Must be one of: equals, starts with, contains, does not contain, ends with, or regex matches. |\n| rhComparand | String | The right hand comparand. Can be evaluated either as one of the right hand values input to evaluate() or as a literal string. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| void | |\n\n## CriteriaEvaluator - evaluate(Object lhValues, String rhValues, Boolean any)\n\nEvaluates the criteria.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| lhValues | Object | A hashmap of name-value pairs to evaluate the left hand comparands of the criteria. |\n| rhValues | String | Optional right hand values to use instead of the literal value in evaluating the right hand comparands. |\n| any | Boolean | If true, any criterion matching suffices for a true result. If false, all criteria must match for a true result. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| Boolean | True if the supplied values satisfy the criteria, false otherwise. |\n"}}},{"rowIdx":1696,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"DCManager - Global"},"description":{"kind":"string","value":"The DCManager API enables you to group data by type."},"keywords":{"kind":"list like","value":[],"string":"[]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_DCManagerAPIGlobal\"><article class=\"nested0\" aria-labelledby=\"title_DCManagerAPIGlobal\" id=\"DCManagerAPIGlobal\">\n <h1 class=\"title topictitle1\" id=\"title_DCManagerAPIGlobal\">DCManager <span class=\"ph\"> - Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">DCManager API</span> enables you to group data by type.</p>\n <div class=\"p\">With the <span class=\"keyword apiname\">DCManager API</span>, you can: <ul class=\"ul\" id=\"DCManagerAPIGlobal__ul_fnm_qrm_xnb\">\n <li class=\"li\">Assign data classifications to existing dictionary entries.</li>\n <li class=\"li\">Look up the data classifications for specific dictionary entries.</li>\n <li class=\"li\">Remove all data classifications associated with specific dictionary entries.</li>\n <li class=\"li\">Retrieve a list of all data classifications available in the current domain.</li>\n </ul></div>\n <p class=\"p\">This API requires the Data Classification [com.glide.data_classification]\n plugin.</p>\n <p class=\"p\">For more information, see <a data-bundleid=\"vancouver-api-reference\" data-navpath=\"app-store/dev_portal/API_reference/DCManager/concept//csh\" href=\"https://servicenow-be-prod.servicenow.com/csh?topicname=data-classification&version=vancouver&pubname=vancouver-platform-security\" class=\"xref\">Data Classification</a>.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DCM-classify_S_S\" id=\"DCM-classify_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_DCM-classify_S_S\">DCManager - classify(String dictEntries, String dataClasses)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Assigns pre-defined or user-defined data classifications\n to existing dictionary entries.</span></p>\n <section class=\"section\">\n <p class=\"p\"><span class=\"ph\">Requires the admin or data_classification_admin\n role.</span></p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DCM-classify_S_S__table_wkc_j5c_snb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\">dictEntries</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\"><span class=\"ph\">The sys_ids of the records you want to classify. The\n sys_ids are from the Dictionary [sys_dictionary] table. Entered as a comma-separated list\n enclosed in a string.</span></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\">dataClasses</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\"><span class=\"ph\">The sys_ids of the data classifications you want to assign. The\n sys_ids are from the Data Classification [data_classification] table. Entered as a\n comma-separated list enclosed in a string.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DCM-classify_S_S__table_xkc_j5c_snb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-classify_S_S__table_xkc_j5c_snb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-classify_S_S__table_xkc_j5c_snb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_xkc_j5c_snb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-classify_S_S__table_xkc_j5c_snb__entry__2\"><span class=\"ph\">Message describing the result of the operation.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\"><span class=\"ph\">This example finds records containing social security\n numbers and classifies the records as confidential.</span></p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dcm = new SNC.DCManager();\nvar confidentialClass = {};\nvar ssnFields = [];\nvar dataClasses = JSON.parse(dcm.getAllDataClasses());\n\n// Get the Confidential data class record\ndataClasses.forEach(function (dataClass) {\n if (dataClass.name == "Confidential")\n confidentialClass = dataClass;\n});\n\n// Find fields that seem to be strong social security numbers\nvar dictionaryGR = new GlideRecord("sys_dictionary");\ndictionaryGR.addQuery("element", "ssn").addOrCondition("element", "social_security_number");\ndictionaryGR.query();\nwhile (dictionaryGR.next())\n ssnFields.push(dictionaryGR.getUniqueValue());\n\n// Classify any found entries as Confidential\nif (ssnFields.length > 0)\n dcm.classify(ssnFields.join(), confidentialClass.sys_id);\n</code></pre>\n <div class=\"p\">Output:<pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"Successfully stored the data classification configurations"</code></pre></div>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DCM-clearClassification_S\" id=\"DCM-clearClassification_S\">\n <h2 class=\"title topictitle2\" id=\"title_DCM-clearClassification_S\">DCManager - clearClassification(String dictEntries)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Removes all data classifications for the specified\n dictionary entries.</span></p>\n <section class=\"section\">\n <p class=\"p\"><span class=\"ph\">Requires the admin or data_classification_admin\n role.</span></p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DCM-clearClassification_S__table_jls_l5c_snb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__1\">dictEntries</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-clearClassification_S__table_jls_l5c_snb__entry__3\"><span class=\"ph\">The sys_ids of the records you want to remove\n classifications from. The sys_ids are from the Dictionary [sys_dictionary] table. Entered\n as a comma-separated list enclosed in a string.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DCM-clearClassification_S__table_kls_l5c_snb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-clearClassification_S__table_kls_l5c_snb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-clearClassification_S__table_kls_l5c_snb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-clearClassification_S__table_kls_l5c_snb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-clearClassification_S__table_kls_l5c_snb__entry__2\"><span class=\"ph\">Message describing the result of the operation.</span></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example removes the data classification for a dictionary entry.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dcm = new SNC.DCManager();\ngs.info(dcm.clearClassification("445de0a6dba30300efc57416bf9619b0"));\n</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"Classifications removed for the specified dictionary entries"</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DCM-getAllDataClasses\" id=\"DCM-getAllDataClasses\">\n <h2 class=\"title topictitle2\" id=\"title_DCM-getAllDataClasses\">DCManager - getAllDataClasses()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Returns a list of all data classifications\n available in the current domain.</span></p>\n <section class=\"section\">\n <p class=\"p\"><span class=\"ph\">Requires the admin, data_classification_admin, or\n data_classification_auditor role.</span></p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DCM-getAllDataClasses__table_qyt_m5c_snb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DCM-getAllDataClasses__table_ryt_m5c_snb\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\"><p class=\"p\">Result of the request. Returns the sys_id and name for each available data\n classification. If there are no data classifications, it returns an empty\n array.</p>\n <p class=\"p\"><span class=\"ph\">Data classifications can be organized into parent-child\n relationships. If there are parent data classifications, they are identified in the\n result.</span></p>\n <p class=\"p\">Data type: Array</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "parent": {Object},\n "sys_id": "String",\n "name": "String"\n }\n]</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array>.parent</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Entry for a parent data classification.<p class=\"p\">Data type:\n Object</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"parent": {\n "sys_id": "String",\n "name": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array>.parent.sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Sys_id of the parent data classification from the Data Classification\n [data_classification] table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array>.parent.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Name of the parent data classification.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array>.sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Sys_id of the data classification from the Data Classification\n [data_classification] table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\"><Array>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\">Name of the data classification.<p class=\"p\">Data type: String</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example retrieves a list of all available data classifications.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dcm = new SNC.DCManager();\ngs.info(dcm.getAllDataClasses());\n</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">[\n {\n "parent": {\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\n "name": "Confidential"\n },\n "sys_id": "348107b951d71010f877f3f178e7dd0d",\n "name": "Personally identifiable information"\n },\n {\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\n "name": "Confidential"\n },\n {\n "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",\n "name": "Restricted"\n },\n {\n "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",\n "name": "Internal"\n },\n {\n "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",\n "name": "Public"\n }\n]</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DCM-getClassification_S\" id=\"DCM-getClassification_S\">\n <h2 class=\"title topictitle2\" id=\"title_DCM-getClassification_S\">DCManager - getClassification(String dictEntries)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\"><span class=\"ph\">Retrieves all data classifications for the specified\n dictionary entries.</span></p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DCM-getClassification_S__table_mfh_k5c_snb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col style=\"width:16.666666666666664%\"/><col style=\"width:16.666666666666664%\"/><col style=\"width:66.66666666666666%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__1\">dictEntries</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_mfh_k5c_snb__entry__3\"><span class=\"ph\">The sys_ids of the records you want to retrieve\n classifications for. The sys_ids are from the Dictionary [sys_dictionary] table. Entered as\n a comma-separated list enclosed in a string.</span></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DCM-getClassification_S__table_nfh_k5c_snb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col style=\"width:25%\"/><col style=\"width:75%\"/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\"><p class=\"p\">JSON object containing each dictionary entry's sys_id with an array of its\n associated data classes. If there are no associated data classifications, it\n returns a message describing the result of the operation.</p>\n <p class=\"p\"><span class=\"ph\">Data classifications can be organized into parent-child\n relationships. If there are parent data classifications, they are identified in the\n result.</span></p>\n <p class=\"p\">Data type: Object</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n <sys_dictionary_sys_id>: [\n {\n "parent": {Object},\n "sys_id": "String",\n "name": "String"\n }\n ]\n}\n</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object>.parent</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Entry for a parent data classification.<p class=\"p\">Data type:\n Object</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">"parent": {\n "sys_id": "String",\n "name": "String"\n}</code></pre></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object>.parent.sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Sys_id of the parent data classification from the Data Classification\n [data_classification] table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object>.parent.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Name of the parent data classification.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object>.sys_id</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Sys_id of the data classification from the Data Classification\n [data_classification] table.<p class=\"p\">Data type: String</p></td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\"><Object>.name</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\">Name of the data classification.<p class=\"p\">Data type: String</p></td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <p class=\"p\">This example retrieves the data classifications for a dictionary entry.</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dcm = new SNC.DCManager();\ngs.info(dcm.getClassification("445de0a6dba30300efc57416bf9619b0"));\n</code></pre>\n <p class=\"p\">Output:</p>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">{\n "445de0a6dba30300efc57416bf9619b0": [\n {\n "parent": {\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\n "name": "Confidential"\n },\n "sys_id": "348107b951d71010f877f3f178e7dd0d",\n "name": "Personally identifiable information"\n }\n ]\n}</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">DCManager - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205477\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205477\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"DCManagerAPIGlobal\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": null,\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The DCManager API enables you to group data by type.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": null,\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\",\n \"page_key\": 41205477,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 6873,\n \"img_count\": 0,\n \"read_time\": 3,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 765\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"DCManager - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_DCManagerAPIGlobal\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_DCManagerAPIGlobal\\\" id=\\\"DCManagerAPIGlobal\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_DCManagerAPIGlobal\\\">DCManager <span class=\\\"ph\\\"> - Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">DCManager API</span> enables you to group data by type.</p>\\n <div class=\\\"p\\\">With the <span class=\\\"keyword apiname\\\">DCManager API</span>, you can: <ul class=\\\"ul\\\" id=\\\"DCManagerAPIGlobal__ul_fnm_qrm_xnb\\\">\\n <li class=\\\"li\\\">Assign data classifications to existing dictionary entries.</li>\\n <li class=\\\"li\\\">Look up the data classifications for specific dictionary entries.</li>\\n <li class=\\\"li\\\">Remove all data classifications associated with specific dictionary entries.</li>\\n <li class=\\\"li\\\">Retrieve a list of all data classifications available in the current domain.</li>\\n </ul></div>\\n <p class=\\\"p\\\">This API requires the Data Classification [com.glide.data_classification]\\n plugin.</p>\\n <p class=\\\"p\\\">For more information, see <a data-bundleid=\\\"vancouver-api-reference\\\" data-navpath=\\\"app-store/dev_portal/API_reference/DCManager/concept//csh\\\" href=\\\"https://servicenow-be-prod.servicenow.com/csh?topicname=data-classification&version=vancouver&pubname=vancouver-platform-security\\\" class=\\\"xref\\\">Data Classification</a>.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DCM-classify_S_S\\\" id=\\\"DCM-classify_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DCM-classify_S_S\\\">DCManager - classify(String dictEntries, String dataClasses)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Assigns pre-defined or user-defined data classifications\\n to existing dictionary entries.</span></p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">Requires the admin or data_classification_admin\\n role.</span></p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DCM-classify_S_S__table_wkc_j5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\\\">dictEntries</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\\\"><span class=\\\"ph\\\">The sys_ids of the records you want to classify. The\\n sys_ids are from the Dictionary [sys_dictionary] table. Entered as a comma-separated list\\n enclosed in a string.</span></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__1\\\">dataClasses</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_wkc_j5c_snb__entry__3\\\"><span class=\\\"ph\\\">The sys_ids of the data classifications you want to assign. The\\n sys_ids are from the Data Classification [data_classification] table. Entered as a\\n comma-separated list enclosed in a string.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DCM-classify_S_S__table_xkc_j5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-classify_S_S__table_xkc_j5c_snb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-classify_S_S__table_xkc_j5c_snb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_xkc_j5c_snb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-classify_S_S__table_xkc_j5c_snb__entry__2\\\"><span class=\\\"ph\\\">Message describing the result of the operation.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">This example finds records containing social security\\n numbers and classifies the records as confidential.</span></p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dcm = new SNC.DCManager();\\nvar confidentialClass = {};\\nvar ssnFields = [];\\nvar dataClasses = JSON.parse(dcm.getAllDataClasses());\\n\\n// Get the Confidential data class record\\ndataClasses.forEach(function (dataClass) {\\n if (dataClass.name == "Confidential")\\n confidentialClass = dataClass;\\n});\\n\\n// Find fields that seem to be strong social security numbers\\nvar dictionaryGR = new GlideRecord("sys_dictionary");\\ndictionaryGR.addQuery("element", "ssn").addOrCondition("element", "social_security_number");\\ndictionaryGR.query();\\nwhile (dictionaryGR.next())\\n ssnFields.push(dictionaryGR.getUniqueValue());\\n\\n// Classify any found entries as Confidential\\nif (ssnFields.length > 0)\\n dcm.classify(ssnFields.join(), confidentialClass.sys_id);\\n</code></pre>\\n <div class=\\\"p\\\">Output:<pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"Successfully stored the data classification configurations"</code></pre></div>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DCM-clearClassification_S\\\" id=\\\"DCM-clearClassification_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DCM-clearClassification_S\\\">DCManager - clearClassification(String dictEntries)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Removes all data classifications for the specified\\n dictionary entries.</span></p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">Requires the admin or data_classification_admin\\n role.</span></p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DCM-clearClassification_S__table_jls_l5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__1\\\">dictEntries</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-clearClassification_S__table_jls_l5c_snb__entry__3\\\"><span class=\\\"ph\\\">The sys_ids of the records you want to remove\\n classifications from. The sys_ids are from the Dictionary [sys_dictionary] table. Entered\\n as a comma-separated list enclosed in a string.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DCM-clearClassification_S__table_kls_l5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-clearClassification_S__table_kls_l5c_snb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-clearClassification_S__table_kls_l5c_snb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-clearClassification_S__table_kls_l5c_snb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-clearClassification_S__table_kls_l5c_snb__entry__2\\\"><span class=\\\"ph\\\">Message describing the result of the operation.</span></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example removes the data classification for a dictionary entry.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dcm = new SNC.DCManager();\\ngs.info(dcm.clearClassification("445de0a6dba30300efc57416bf9619b0"));\\n</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"Classifications removed for the specified dictionary entries"</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DCM-getAllDataClasses\\\" id=\\\"DCM-getAllDataClasses\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DCM-getAllDataClasses\\\">DCManager - getAllDataClasses()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Returns a list of all data classifications\\n available in the current domain.</span></p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">Requires the admin, data_classification_admin, or\\n data_classification_auditor role.</span></p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_qyt_m5c_snb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\"><p class=\\\"p\\\">Result of the request. Returns the sys_id and name for each available data\\n classification. If there are no data classifications, it returns an empty\\n array.</p>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">Data classifications can be organized into parent-child\\n relationships. If there are parent data classifications, they are identified in the\\n result.</span></p>\\n <p class=\\\"p\\\">Data type: Array</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "parent": {Object},\\n "sys_id": "String",\\n "name": "String"\\n }\\n]</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array>.parent</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Entry for a parent data classification.<p class=\\\"p\\\">Data type:\\n Object</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"parent": {\\n "sys_id": "String",\\n "name": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array>.parent.sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Sys_id of the parent data classification from the Data Classification\\n [data_classification] table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array>.parent.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Name of the parent data classification.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array>.sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Sys_id of the data classification from the Data Classification\\n [data_classification] table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__1\\\"><Array>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getAllDataClasses__table_ryt_m5c_snb__entry__2\\\">Name of the data classification.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example retrieves a list of all available data classifications.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dcm = new SNC.DCManager();\\ngs.info(dcm.getAllDataClasses());\\n</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">[\\n {\\n "parent": {\\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\\n "name": "Confidential"\\n },\\n "sys_id": "348107b951d71010f877f3f178e7dd0d",\\n "name": "Personally identifiable information"\\n },\\n {\\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\\n "name": "Confidential"\\n },\\n {\\n "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",\\n "name": "Restricted"\\n },\\n {\\n "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",\\n "name": "Internal"\\n },\\n {\\n "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",\\n "name": "Public"\\n }\\n]</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DCM-getClassification_S\\\" id=\\\"DCM-getClassification_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DCM-getClassification_S\\\">DCManager - getClassification(String dictEntries)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\"><span class=\\\"ph\\\">Retrieves all data classifications for the specified\\n dictionary entries.</span></p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DCM-getClassification_S__table_mfh_k5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:16.666666666666664%\\\"/><col style=\\\"width:66.66666666666666%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__1\\\">dictEntries</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_mfh_k5c_snb__entry__3\\\"><span class=\\\"ph\\\">The sys_ids of the records you want to retrieve\\n classifications for. The sys_ids are from the Dictionary [sys_dictionary] table. Entered as\\n a comma-separated list enclosed in a string.</span></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DCM-getClassification_S__table_nfh_k5c_snb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col style=\\\"width:25%\\\"/><col style=\\\"width:75%\\\"/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\"><p class=\\\"p\\\">JSON object containing each dictionary entry's sys_id with an array of its\\n associated data classes. If there are no associated data classifications, it\\n returns a message describing the result of the operation.</p>\\n <p class=\\\"p\\\"><span class=\\\"ph\\\">Data classifications can be organized into parent-child\\n relationships. If there are parent data classifications, they are identified in the\\n result.</span></p>\\n <p class=\\\"p\\\">Data type: Object</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n <sys_dictionary_sys_id>: [\\n {\\n "parent": {Object},\\n "sys_id": "String",\\n "name": "String"\\n }\\n ]\\n}\\n</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object>.parent</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Entry for a parent data classification.<p class=\\\"p\\\">Data type:\\n Object</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">"parent": {\\n "sys_id": "String",\\n "name": "String"\\n}</code></pre></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object>.parent.sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Sys_id of the parent data classification from the Data Classification\\n [data_classification] table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object>.parent.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Name of the parent data classification.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object>.sys_id</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Sys_id of the data classification from the Data Classification\\n [data_classification] table.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__1\\\"><Object>.name</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DCM-getClassification_S__table_nfh_k5c_snb__entry__2\\\">Name of the data classification.<p class=\\\"p\\\">Data type: String</p></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <p class=\\\"p\\\">This example retrieves the data classifications for a dictionary entry.</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dcm = new SNC.DCManager();\\ngs.info(dcm.getClassification("445de0a6dba30300efc57416bf9619b0"));\\n</code></pre>\\n <p class=\\\"p\\\">Output:</p>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">{\\n "445de0a6dba30300efc57416bf9619b0": [\\n {\\n "parent": {\\n "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",\\n "name": "Confidential"\\n },\\n "sys_id": "348107b951d71010f877f3f178e7dd0d",\\n "name": "Personally identifiable information"\\n }\\n ]\\n}</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DCManager - Global\n\nThe DCManager API enables you to group data by type.\n\nWith the DCManager API, you can:\n\n* Assign data classifications to existing dictionary entries.\n* Look up the data classifications for specific dictionary entries.\n* Remove all data classifications associated with specific dictionary entries.\n* Retrieve a list of all data classifications available in the current domain.\n\nThis API requires the Data Classification [com.glide.data\\_classification]\nplugin.\n\nFor more information, see Data Classification.\n\n## DCManager - classify(String dictEntries, String dataClasses)\n\nAssigns pre-defined or user-defined data classifications\nto existing dictionary entries.\n\nRequires the admin or data\\_classification\\_admin\nrole.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to classify. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n| dataClasses | String | The sys\\_ids of the data classifications you want to assign. The sys\\_ids are from the Data Classification [data\\_classification] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Message describing the result of the operation. |\n\n### Example\n\nThis example finds records containing social security\nnumbers and classifies the records as confidential.\n\n```None\nvar dcm = new SNC.DCManager();\nvar confidentialClass = {};\nvar ssnFields = [];\nvar dataClasses = JSON.parse(dcm.getAllDataClasses());\n\n// Get the Confidential data class record\ndataClasses.forEach(function (dataClass) {\n if (dataClass.name == \"Confidential\")\n confidentialClass = dataClass;\n});\n\n// Find fields that seem to be strong social security numbers\nvar dictionaryGR = new GlideRecord(\"sys_dictionary\");\ndictionaryGR.addQuery(\"element\", \"ssn\").addOrCondition(\"element\", \"social_security_number\");\ndictionaryGR.query();\nwhile (dictionaryGR.next())\n ssnFields.push(dictionaryGR.getUniqueValue());\n\n// Classify any found entries as Confidential\nif (ssnFields.length > 0)\n dcm.classify(ssnFields.join(), confidentialClass.sys_id);\n\n```\nOutput:\n```None\n\"Successfully stored the data classification configurations\"\n```\n\n## DCManager - clearClassification(String dictEntries)\n\nRemoves all data classifications for the specified\ndictionary entries.\n\nRequires the admin or data\\_classification\\_admin\nrole.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to remove classifications from. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | Message describing the result of the operation. |\n\n### Example\n\nThis example removes the data classification for a dictionary entry.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.clearClassification(\"445de0a6dba30300efc57416bf9619b0\"));\n\n```\n\nOutput:\n\n```None\n\"Classifications removed for the specified dictionary entries\"\n```\n\n## DCManager - getAllDataClasses()\n\nReturns a list of all data classifications\navailable in the current domain.\n\nRequires the admin, data\\_classification\\_admin, or\ndata\\_classification\\_auditor role.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| <Array> | Result of the request. Returns the sys\\_id and name for each available data classification. If there are no data classifications, it returns an empty array. Data classifications can be organized into parent-child relationships. If there are parent data classifications, they are identified in the result. Data type: Array ```None [ { \"parent\": {Object}, \"sys_id\": \"String\", \"name\": \"String\" } ] ``` |\n| <Array>.parent | Entry for a parent data classification. Data type: Object ```None \"parent\": { \"sys_id\": \"String\", \"name\": \"String\" } ``` |\n| <Array>.parent.sys\\_id | Sys\\_id of the parent data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Array>.parent.name | Name of the parent data classification. Data type: String |\n| <Array>.sys\\_id | Sys\\_id of the data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Array>.name | Name of the data classification. Data type: String |\n\n### Example\n\nThis example retrieves a list of all available data classifications.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.getAllDataClasses());\n\n```\n\nOutput:\n\n```None\n[\n {\n \"parent\": {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n \"sys_id\": \"348107b951d71010f877f3f178e7dd0d\",\n \"name\": \"Personally identifiable information\"\n },\n {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n {\n \"sys_id\": \"59b7070b73fc1010ae8dd21efaf6a764\",\n \"name\": \"Restricted\"\n },\n {\n \"sys_id\": \"11d60fc773fc1010ae8dd21efaf6a744\",\n \"name\": \"Internal\"\n },\n {\n \"sys_id\": \"f5b4cf4773fc1010ae8dd21efaf6a766\",\n \"name\": \"Public\"\n }\n]\n```\n\n## DCManager - getClassification(String dictEntries)\n\nRetrieves all data classifications for the specified\ndictionary entries.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to retrieve classifications for. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| <Object> | JSON object containing each dictionary entry's sys\\_id with an array of its associated data classes. If there are no associated data classifications, it returns a message describing the result of the operation. Data classifications can be organized into parent-child relationships. If there are parent data classifications, they are identified in the result. Data type: Object ```None { <sys_dictionary_sys_id>: [ { \"parent\": {Object}, \"sys_id\": \"String\", \"name\": \"String\" } ] } ``` |\n| <Object>.parent | Entry for a parent data classification. Data type: Object ```None \"parent\": { \"sys_id\": \"String\", \"name\": \"String\" } ``` |\n| <Object>.parent.sys\\_id | Sys\\_id of the parent data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Object>.parent.name | Name of the parent data classification. Data type: String |\n| <Object>.sys\\_id | Sys\\_id of the data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Object>.name | Name of the data classification. Data type: String |\n\n### Example\n\nThis example retrieves the data classifications for a dictionary entry.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.getClassification(\"445de0a6dba30300efc57416bf9619b0\"));\n\n```\n\nOutput:\n\n```None\n{\n \"445de0a6dba30300efc57416bf9619b0\": [\n {\n \"parent\": {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n \"sys_id\": \"348107b951d71010f877f3f178e7dd0d\",\n \"name\": \"Personally identifiable information\"\n }\n ]\n}\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: DCManager - Global\ndescription: The DCManager API enables you to group data by type.\nkeywords: []\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DCManager - Global\n\nThe DCManager API enables you to group data by type.\n\nWith the DCManager API, you can:\n\n* Assign data classifications to existing dictionary entries.\n* Look up the data classifications for specific dictionary entries.\n* Remove all data classifications associated with specific dictionary entries.\n* Retrieve a list of all data classifications available in the current domain.\n\nThis API requires the Data Classification [com.glide.data\\_classification]\nplugin.\n\nFor more information, see Data Classification.\n\n## DCManager - classify(String dictEntries, String dataClasses)\n\nAssigns pre-defined or user-defined data classifications\nto existing dictionary entries.\n\nRequires the admin or data\\_classification\\_admin\nrole.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to classify. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n| dataClasses | String | The sys\\_ids of the data classifications you want to assign. The sys\\_ids are from the Data Classification [data\\_classification] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | Message describing the result of the operation. |\n\n### Example\n\nThis example finds records containing social security\nnumbers and classifies the records as confidential.\n\n```None\nvar dcm = new SNC.DCManager();\nvar confidentialClass = {};\nvar ssnFields = [];\nvar dataClasses = JSON.parse(dcm.getAllDataClasses());\n\n// Get the Confidential data class record\ndataClasses.forEach(function (dataClass) {\n if (dataClass.name == \"Confidential\")\n confidentialClass = dataClass;\n});\n\n// Find fields that seem to be strong social security numbers\nvar dictionaryGR = new GlideRecord(\"sys_dictionary\");\ndictionaryGR.addQuery(\"element\", \"ssn\").addOrCondition(\"element\", \"social_security_number\");\ndictionaryGR.query();\nwhile (dictionaryGR.next())\n ssnFields.push(dictionaryGR.getUniqueValue());\n\n// Classify any found entries as Confidential\nif (ssnFields.length > 0)\n dcm.classify(ssnFields.join(), confidentialClass.sys_id);\n\n```\nOutput:\n```None\n\"Successfully stored the data classification configurations\"\n```\n\n## DCManager - clearClassification(String dictEntries)\n\nRemoves all data classifications for the specified\ndictionary entries.\n\nRequires the admin or data\\_classification\\_admin\nrole.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to remove classifications from. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | Message describing the result of the operation. |\n\n### Example\n\nThis example removes the data classification for a dictionary entry.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.clearClassification(\"445de0a6dba30300efc57416bf9619b0\"));\n\n```\n\nOutput:\n\n```None\n\"Classifications removed for the specified dictionary entries\"\n```\n\n## DCManager - getAllDataClasses()\n\nReturns a list of all data classifications\navailable in the current domain.\n\nRequires the admin, data\\_classification\\_admin, or\ndata\\_classification\\_auditor role.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| <Array> | Result of the request. Returns the sys\\_id and name for each available data classification. If there are no data classifications, it returns an empty array. Data classifications can be organized into parent-child relationships. If there are parent data classifications, they are identified in the result. Data type: Array ```None [ { \"parent\": {Object}, \"sys_id\": \"String\", \"name\": \"String\" } ] ``` |\n| <Array>.parent | Entry for a parent data classification. Data type: Object ```None \"parent\": { \"sys_id\": \"String\", \"name\": \"String\" } ``` |\n| <Array>.parent.sys\\_id | Sys\\_id of the parent data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Array>.parent.name | Name of the parent data classification. Data type: String |\n| <Array>.sys\\_id | Sys\\_id of the data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Array>.name | Name of the data classification. Data type: String |\n\n### Example\n\nThis example retrieves a list of all available data classifications.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.getAllDataClasses());\n\n```\n\nOutput:\n\n```None\n[\n {\n \"parent\": {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n \"sys_id\": \"348107b951d71010f877f3f178e7dd0d\",\n \"name\": \"Personally identifiable information\"\n },\n {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n {\n \"sys_id\": \"59b7070b73fc1010ae8dd21efaf6a764\",\n \"name\": \"Restricted\"\n },\n {\n \"sys_id\": \"11d60fc773fc1010ae8dd21efaf6a744\",\n \"name\": \"Internal\"\n },\n {\n \"sys_id\": \"f5b4cf4773fc1010ae8dd21efaf6a766\",\n \"name\": \"Public\"\n }\n]\n```\n\n## DCManager - getClassification(String dictEntries)\n\nRetrieves all data classifications for the specified\ndictionary entries.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| dictEntries | String | The sys\\_ids of the records you want to retrieve classifications for. The sys\\_ids are from the Dictionary [sys\\_dictionary] table. Entered as a comma-separated list enclosed in a string. |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| <Object> | JSON object containing each dictionary entry's sys\\_id with an array of its associated data classes. If there are no associated data classifications, it returns a message describing the result of the operation. Data classifications can be organized into parent-child relationships. If there are parent data classifications, they are identified in the result. Data type: Object ```None { <sys_dictionary_sys_id>: [ { \"parent\": {Object}, \"sys_id\": \"String\", \"name\": \"String\" } ] } ``` |\n| <Object>.parent | Entry for a parent data classification. Data type: Object ```None \"parent\": { \"sys_id\": \"String\", \"name\": \"String\" } ``` |\n| <Object>.parent.sys\\_id | Sys\\_id of the parent data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Object>.parent.name | Name of the parent data classification. Data type: String |\n| <Object>.sys\\_id | Sys\\_id of the data classification from the Data Classification [data\\_classification] table. Data type: String |\n| <Object>.name | Name of the data classification. Data type: String |\n\n### Example\n\nThis example retrieves the data classifications for a dictionary entry.\n\n```None\nvar dcm = new SNC.DCManager();\ngs.info(dcm.getClassification(\"445de0a6dba30300efc57416bf9619b0\"));\n\n```\n\nOutput:\n\n```None\n{\n \"445de0a6dba30300efc57416bf9619b0\": [\n {\n \"parent\": {\n \"sys_id\": \"a9670fc773fc1010ae8dd21efaf6a735\",\n \"name\": \"Confidential\"\n },\n \"sys_id\": \"348107b951d71010f877f3f178e7dd0d\",\n \"name\": \"Personally identifiable information\"\n }\n ]\n}\n```\n"}}},{"rowIdx":1697,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"DSCScriptableAPI - Global"},"description":{"kind":"string","value":"The DSCScriptableAPI provides methods for checking the health of your domain configuration for an instance."},"keywords":{"kind":"list like","value":["DSCScriptableAPI","DSCScriptableAPI","chkDataInvalidDomainForTables()","chkDataInvalidPathForTables()","DSCScriptableAPI","DSCScriptableAPI()"],"string":"[\n \"DSCScriptableAPI\",\n \"DSCScriptableAPI\",\n \"chkDataInvalidDomainForTables()\",\n \"chkDataInvalidPathForTables()\",\n \"DSCScriptableAPI\",\n \"DSCScriptableAPI()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_DSCScriptableAPI\"><article class=\"nested0\" aria-labelledby=\"title_DSCScriptableAPI\" id=\"DSCScriptableAPI\">\n <h1 class=\"title topictitle1\" id=\"title_DSCScriptableAPI\">DSCScriptableAPI <span class=\"ph\">- Global</span></h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">DSCScriptableAPI</span> provides methods for checking the health of\n your domain configuration for an instance.</p>\n <p class=\"p\">The <span class=\"keyword apiname\">DSCScriptableAPI</span> is part of the Domain Separation Center dashboard and\n is available in the <code class=\"ph codeph\">SNC</code> global namespace.</p>\n <p class=\"p\">The com.glide.domain.msp_extensions.installer plugin must be activated for Domain Separation\n Center dashboard availability.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DSCS-chkDataInvalidDomainForTables_S\" id=\"DSCS-chkDataInvalidDomainForTables_S\">\n <h2 class=\"title topictitle2\" id=\"title_DSCS-chkDataInvalidDomainForTables_S\">DSCScriptableAPI - chkDataInvalidDomainForTables(String tableNames)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Checks a list of comma-separated tables for invalid domains.</p>\n <section class=\"section\">\n <p class=\"p\">View records that reference invalid domains in the Domain Log [syslog_domain] table.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__1\">tableNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__3\">Comma-separated list of table names.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__2\">GUID of any invalid references; OK otherwise</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidDomainForTables('task, sys_user');</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DSCS-chkDataInvalidPathForTables_S\" id=\"DSCS-chkDataInvalidPathForTables_S\">\n <h2 class=\"title topictitle2\" id=\"title_DSCS-chkDataInvalidPathForTables_S\">DSCScriptableAPI - chkDataInvalidPathForTables(String tableNames)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Checks a list of comma-separated tables for invalid domain paths.</p>\n <section class=\"section\">\n <p class=\"p\">Records that have an invalid domain path are logged in the syslog_domain table.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__1\">tableNames</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__3\">Comma-separated list of table names.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__2\">GUID if there are invalid paths; OK otherwise</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidPathForTables('task, sys_user');</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_DSCS-DSCScriptableAPI\" id=\"DSCS-DSCScriptableAPI\">\n <h2 class=\"title topictitle2\" id=\"title_DSCS-DSCScriptableAPI\">DSCScriptableAPI - DSCScriptableAPI()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Instantiates a new DSCScriptable object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">DSCScriptableAPI - Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205484\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205484\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"DSCScriptableAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"DSCScriptableAPI,DSCScriptableAPI,chkDataInvalidDomainForTables(),chkDataInvalidPathForTables(),DSCScriptableAPI,DSCScriptableAPI()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The DSCScriptableAPI provides methods for checking the health of your domain configuration for an instance.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"DSCScriptableAPI, DSCScriptableAPI, chkDataInvalidDomainForTables(), chkDataInvalidPathForTables(), DSCScriptableAPI, DSCScriptableAPI()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\",\n \"page_key\": 41205484,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 1334,\n \"img_count\": 0,\n \"read_time\": 1,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 158\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"DSCScriptableAPI - Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_DSCScriptableAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_DSCScriptableAPI\\\" id=\\\"DSCScriptableAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_DSCScriptableAPI\\\">DSCScriptableAPI <span class=\\\"ph\\\">- Global</span></h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">DSCScriptableAPI</span> provides methods for checking the health of\\n your domain configuration for an instance.</p>\\n <p class=\\\"p\\\">The <span class=\\\"keyword apiname\\\">DSCScriptableAPI</span> is part of the Domain Separation Center dashboard and\\n is available in the <code class=\\\"ph codeph\\\">SNC</code> global namespace.</p>\\n <p class=\\\"p\\\">The com.glide.domain.msp_extensions.installer plugin must be activated for Domain Separation\\n Center dashboard availability.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DSCS-chkDataInvalidDomainForTables_S\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DSCS-chkDataInvalidDomainForTables_S\\\">DSCScriptableAPI - chkDataInvalidDomainForTables(String tableNames)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Checks a list of comma-separated tables for invalid domains.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">View records that reference invalid domains in the Domain Log [syslog_domain] table.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__1\\\">tableNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidDomainForTables_S__table_w53_4g1_5hb__entry__3\\\">Comma-separated list of table names.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidDomainForTables_S__table_x53_4g1_5hb__entry__2\\\">GUID of any invalid references; OK otherwise</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dsc = new SNC.DSCScriptableAPI();\\ndsc.chkDataInvalidDomainForTables('task, sys_user');</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DSCS-chkDataInvalidPathForTables_S\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DSCS-chkDataInvalidPathForTables_S\\\">DSCScriptableAPI - chkDataInvalidPathForTables(String tableNames)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Checks a list of comma-separated tables for invalid domain paths.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Records that have an invalid domain path are logged in the syslog_domain table.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__1\\\">tableNames</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidPathForTables_S__table_jbp_xh1_5hb__entry__3\\\">Comma-separated list of table names.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-chkDataInvalidPathForTables_S__table_kbp_xh1_5hb__entry__2\\\">GUID if there are invalid paths; OK otherwise</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dsc = new SNC.DSCScriptableAPI();\\ndsc.chkDataInvalidPathForTables('task, sys_user');</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_DSCS-DSCScriptableAPI\\\" id=\\\"DSCS-DSCScriptableAPI\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DSCS-DSCScriptableAPI\\\">DSCScriptableAPI - DSCScriptableAPI()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Instantiates a new DSCScriptable object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DSCS-DSCScriptableAPI__table_rxy_tj1_5hb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DSCScriptableAPI - Global\n\nThe DSCScriptableAPI provides methods for checking the health of\nyour domain configuration for an instance.\n\nThe DSCScriptableAPI is part of the Domain Separation Center dashboard and\nis available in the `SNC` global namespace.\n\nThe com.glide.domain.msp\\_extensions.installer plugin must be activated for Domain Separation\nCenter dashboard availability.\n\n## DSCScriptableAPI - chkDataInvalidDomainForTables(String tableNames)\n\nChecks a list of comma-separated tables for invalid domains.\n\nView records that reference invalid domains in the Domain Log [syslog\\_domain] table.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableNames | String | Comma-separated list of table names. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | GUID of any invalid references; OK otherwise |\n\n### Example\n\n```None\nvar dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidDomainForTables('task, sys_user');\n```\n\n## DSCScriptableAPI - chkDataInvalidPathForTables(String tableNames)\n\nChecks a list of comma-separated tables for invalid domain paths.\n\nRecords that have an invalid domain path are logged in the syslog\\_domain table.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableNames | String | Comma-separated list of table names. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | GUID if there are invalid paths; OK otherwise |\n\n### Example\n\n```None\nvar dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidPathForTables('task, sys_user');\n```\n\n## DSCScriptableAPI - DSCScriptableAPI()\n\nInstantiates a new DSCScriptable object.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n"},"rich_text":{"kind":"string","value":"---\ntitle: DSCScriptableAPI - Global\ndescription: The DSCScriptableAPI provides methods for checking the health of your\n domain configuration for an instance.\nkeywords:\n- DSCScriptableAPI\n- DSCScriptableAPI\n- chkDataInvalidDomainForTables()\n- chkDataInvalidPathForTables()\n- DSCScriptableAPI\n- DSCScriptableAPI()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DSCScriptableAPI - Global\n\nThe DSCScriptableAPI provides methods for checking the health of\nyour domain configuration for an instance.\n\nThe DSCScriptableAPI is part of the Domain Separation Center dashboard and\nis available in the `SNC` global namespace.\n\nThe com.glide.domain.msp\\_extensions.installer plugin must be activated for Domain Separation\nCenter dashboard availability.\n\n## DSCScriptableAPI - chkDataInvalidDomainForTables(String tableNames)\n\nChecks a list of comma-separated tables for invalid domains.\n\nView records that reference invalid domains in the Domain Log [syslog\\_domain] table.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableNames | String | Comma-separated list of table names. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| String | GUID of any invalid references; OK otherwise |\n\n### Example\n\n```None\nvar dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidDomainForTables('task, sys_user');\n```\n\n## DSCScriptableAPI - chkDataInvalidPathForTables(String tableNames)\n\nChecks a list of comma-separated tables for invalid domain paths.\n\nRecords that have an invalid domain path are logged in the syslog\\_domain table.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| tableNames | String | Comma-separated list of table names. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | GUID if there are invalid paths; OK otherwise |\n\n### Example\n\n```None\nvar dsc = new SNC.DSCScriptableAPI();\ndsc.chkDataInvalidPathForTables('task, sys_user');\n```\n\n## DSCScriptableAPI - DSCScriptableAPI()\n\nInstantiates a new DSCScriptable object.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n"}}},{"rowIdx":1698,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"DataBuilder - Scoped, Global"},"description":{"kind":"string","value":"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values."},"keywords":{"kind":"list like","value":["Scoped DataBuilder","Scoped DataBuilder","add(GlideDateTime start","Array value)","add(GlideDateTime start Number value)","DataBuilder(String table","String subject","String metric)"],"string":"[\n \"Scoped DataBuilder\",\n \"Scoped DataBuilder\",\n \"add(GlideDateTime start\",\n \"Array value)\",\n \"add(GlideDateTime start Number value)\",\n \"DataBuilder(String table\",\n \"String subject\",\n \"String metric)\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_DataBuilderScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_DataBuilderScopedAPI\" id=\"DataBuilderScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_DataBuilderScopedAPI\">DataBuilder - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">The <span class=\"keyword apiname\">DataBuilder</span> class creates a series of data points for a metric. Use the <span class=\"keyword apiname\">sn_clotho.Client.put()</span> method to save the values.</p>\n <p class=\"p\">You can use this class in scoped and global server scripts. When using the <span class=\"keyword apiname\">DataBuilder</span> class, use the <code class=\"ph codeph\">sn_clotho</code> namespace identifier.</p>\n <p class=\"p\">This class is part of the <span class=\"ph\">MetricBase</span> application.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SDB-add_GDT_A\" id=\"SDB-add_GDT_A\">\n <h2 class=\"title topictitle2\" id=\"title_SDB-add_GDT_A\">Scoped DataBuilder - add(GlideDateTime start, Array value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Add a series of data points to the DataBuilder object. Each data point is a time stamp\n and a value.</p>\n <section class=\"section\">\n <p class=\"p\">Uses the start parameter and the retention policy collection period to calculate the time\n stamp for each value in the array. The first value has the start parameter as the time\n stamp. This method does not save the data in the MetricBase database. Use the\n <span class=\"keyword apiname\">sn_clotho.Client.put()</span> method to save the values.</p>\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SDB-add_GDT_A__table_xy1_c1m_31b\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\">start</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\">GlideDateTime</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\">The time stamp for the first data point. Subsequent time stamps are calculated\n using the retention policy collection period.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\">An array of numbers.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SDB-add_GDT_A__table_yy1_c1m_31b\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__1\">DataBuilder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__2\">The same DataBuilder object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">\nvar points = [7,0.5,273];\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, points);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_SDB-add_GDT_N\" id=\"SDB-add_GDT_N\">\n <h2 class=\"title topictitle2\" id=\"title_SDB-add_GDT_N\">Scoped DataBuilder - add(GlideDateTime start, Number value)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Add a data point to the DataBuilder object. Each data point is a time stamp and a\n value. This method does not save the data point in the metric. Use the\n <span class=\"keyword apiname\">sn_clotho.Client.put()</span> method to save the values.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SDB-add_GDT_N__table_r1w_2vl_31b\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\">start</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\">GlideDateTime</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\">The time stamp for the data point.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\">value</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\">The value of the data point.</td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"SDB-add_GDT_N__table_s1w_2vl_31b\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__1\">DataBuilder</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__2\">The DataBuilder object.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, 0.6);</code></pre>\n </div>\n </div>\n</article><article class=\"topic reference nested1 api-constructor\" aria-labelledby=\"title_SDB-DataBuilder_S_S_S\" id=\"SDB-DataBuilder_S_S_S\">\n <h2 class=\"title topictitle2\" id=\"title_SDB-DataBuilder_S_S_S\">Scoped DataBuilder - DataBuilder(Object glideRecord, String subject, String metric)</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Creates an instance of the DataBuilder class.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\">glideRecord</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\">Object</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\">GlideRecord from which to obtain the domain.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\">subject</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\">The sys_id of the GlideRecord associated with this series.</td>\n </tr>\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\">metric</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\">The field name of the metric.</td>\n </tr>\n </tbody></table></div>\n </section>\n <div class=\"example\"><div class=\"tasklabel\"><h3 class=\"sectiontitle tasklabel\">Example</h3></div>\n <pre class=\"prettyprint language-plaintext\"><code class=\"pre codeblock language-plaintext\">// Where cpu_percentage is the name of the metric\n var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');</code></pre>\n </div>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">DataBuilder - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205488\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205488\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"DataBuilderScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Scoped DataBuilder,Scoped DataBuilder,add(GlideDateTime start, Array value),add(GlideDateTime start Number value),DataBuilder(String table, String subject, String metric)\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Scoped DataBuilder, Scoped DataBuilder, add(GlideDateTime start, Array value), add(GlideDateTime start Number value), DataBuilder(String table, String subject, String metric)\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\",\n \"page_key\": 41205488,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 2377,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 347\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"DataBuilder - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_DataBuilderScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_DataBuilderScopedAPI\\\" id=\\\"DataBuilderScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_DataBuilderScopedAPI\\\">DataBuilder - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">The <span class=\\\"keyword apiname\\\">DataBuilder</span> class creates a series of data points for a metric. Use the <span class=\\\"keyword apiname\\\">sn_clotho.Client.put()</span> method to save the values.</p>\\n <p class=\\\"p\\\">You can use this class in scoped and global server scripts. When using the <span class=\\\"keyword apiname\\\">DataBuilder</span> class, use the <code class=\\\"ph codeph\\\">sn_clotho</code> namespace identifier.</p>\\n <p class=\\\"p\\\">This class is part of the <span class=\\\"ph\\\">MetricBase</span> application.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SDB-add_GDT_A\\\" id=\\\"SDB-add_GDT_A\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SDB-add_GDT_A\\\">Scoped DataBuilder - add(GlideDateTime start, Array value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Add a series of data points to the DataBuilder object. Each data point is a time stamp\\n and a value.</p>\\n <section class=\\\"section\\\">\\n <p class=\\\"p\\\">Uses the start parameter and the retention policy collection period to calculate the time\\n stamp for each value in the array. The first value has the start parameter as the time\\n stamp. This method does not save the data in the MetricBase database. Use the\\n <span class=\\\"keyword apiname\\\">sn_clotho.Client.put()</span> method to save the values.</p>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SDB-add_GDT_A__table_xy1_c1m_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\\\">start</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\\\">GlideDateTime</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\\\">The time stamp for the first data point. Subsequent time stamps are calculated\\n using the retention policy collection period.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__2\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_xy1_c1m_31b__entry__3\\\">An array of numbers.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SDB-add_GDT_A__table_yy1_c1m_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__1\\\">DataBuilder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_A__table_yy1_c1m_31b__entry__2\\\">The same DataBuilder object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">\\nvar points = [7,0.5,273];\\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\\n// this creates a GlideDateTime object set to the current date and time\\nvar time = new GlideDateTime();\\ndataBuilder.add(time, points);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_SDB-add_GDT_N\\\" id=\\\"SDB-add_GDT_N\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SDB-add_GDT_N\\\">Scoped DataBuilder - add(GlideDateTime start, Number value)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Add a data point to the DataBuilder object. Each data point is a time stamp and a\\n value. This method does not save the data point in the metric. Use the\\n <span class=\\\"keyword apiname\\\">sn_clotho.Client.put()</span> method to save the values.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SDB-add_GDT_N__table_r1w_2vl_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\\\">start</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\\\">GlideDateTime</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\\\">The time stamp for the data point.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__1\\\">value</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__2\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_r1w_2vl_31b__entry__3\\\">The value of the data point.</td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"SDB-add_GDT_N__table_s1w_2vl_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__1\\\">DataBuilder</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-add_GDT_N__table_s1w_2vl_31b__entry__2\\\">The DataBuilder object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\\n// this creates a GlideDateTime object set to the current date and time\\nvar time = new GlideDateTime();\\ndataBuilder.add(time, 0.6);</code></pre>\\n </div>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-constructor\\\" aria-labelledby=\\\"title_SDB-DataBuilder_S_S_S\\\" id=\\\"SDB-DataBuilder_S_S_S\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_SDB-DataBuilder_S_S_S\\\">Scoped DataBuilder - DataBuilder(Object glideRecord, String subject, String metric)</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Creates an instance of the DataBuilder class.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\\\">glideRecord</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\\\">Object</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\\\">GlideRecord from which to obtain the domain.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\\\">subject</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\\\">The sys_id of the GlideRecord associated with this series.</td>\\n </tr>\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__1\\\">metric</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__2\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"SDB-DataBuilder_S_S_S__table_yjn_kgf_31b__entry__3\\\">The field name of the metric.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n <div class=\\\"example\\\"><div class=\\\"tasklabel\\\"><h3 class=\\\"sectiontitle tasklabel\\\">Example</h3></div>\\n <pre class=\\\"prettyprint language-plaintext\\\"><code class=\\\"pre codeblock language-plaintext\\\">// Where cpu_percentage is the name of the metric\\n var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');</code></pre>\\n </div>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DataBuilder - Scoped, Global\n\nThe DataBuilder class creates a series of data points for a metric. Use the sn\\_clotho.Client.put() method to save the values.\n\nYou can use this class in scoped and global server scripts. When using the DataBuilder class, use the `sn_clotho` namespace identifier.\n\nThis class is part of the MetricBase application.\n\n## Scoped DataBuilder - add(GlideDateTime start, Array value)\n\nAdd a series of data points to the DataBuilder object. Each data point is a time stamp\nand a value.\n\nUses the start parameter and the retention policy collection period to calculate the time\nstamp for each value in the array. The first value has the start parameter as the time\nstamp. This method does not save the data in the MetricBase database. Use the\nsn\\_clotho.Client.put() method to save the values.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| start | GlideDateTime | The time stamp for the first data point. Subsequent time stamps are calculated using the retention policy collection period. |\n| value | Array | An array of numbers. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| DataBuilder | The same DataBuilder object. |\n\n### Example\n\n```None\n\nvar points = [7,0.5,273];\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, points);\n```\n\n## Scoped DataBuilder - add(GlideDateTime start, Number value)\n\nAdd a data point to the DataBuilder object. Each data point is a time stamp and a\nvalue. This method does not save the data point in the metric. Use the\nsn\\_clotho.Client.put() method to save the values.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| start | GlideDateTime | The time stamp for the data point. |\n| value | Number | The value of the data point. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| DataBuilder | The DataBuilder object. |\n\n### Example\n\n```None\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, 0.6);\n```\n\n## Scoped DataBuilder - DataBuilder(Object glideRecord, String subject, String metric)\n\nCreates an instance of the DataBuilder class.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| glideRecord | Object | GlideRecord from which to obtain the domain. |\n| subject | String | The sys\\_id of the GlideRecord associated with this series. |\n| metric | String | The field name of the metric. |\n\n### Example\n\n```None\n// Where cpu_percentage is the name of the metric\n var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n```\n"},"rich_text":{"kind":"string","value":"---\ntitle: DataBuilder - Scoped, Global\ndescription: The DataBuilder class creates a series of data points for a metric. Use\n the sn_clotho.Client.put() method to save the values.\nkeywords:\n- Scoped DataBuilder\n- Scoped DataBuilder\n- add(GlideDateTime start\n- Array value)\n- add(GlideDateTime start Number value)\n- DataBuilder(String table\n- String subject\n- String metric)\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# DataBuilder - Scoped, Global\n\nThe DataBuilder class creates a series of data points for a metric. Use the sn\\_clotho.Client.put() method to save the values.\n\nYou can use this class in scoped and global server scripts. When using the DataBuilder class, use the `sn_clotho` namespace identifier.\n\nThis class is part of the MetricBase application.\n\n## Scoped DataBuilder - add(GlideDateTime start, Array value)\n\nAdd a series of data points to the DataBuilder object. Each data point is a time stamp\nand a value.\n\nUses the start parameter and the retention policy collection period to calculate the time\nstamp for each value in the array. The first value has the start parameter as the time\nstamp. This method does not save the data in the MetricBase database. Use the\nsn\\_clotho.Client.put() method to save the values.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| start | GlideDateTime | The time stamp for the first data point. Subsequent time stamps are calculated using the retention policy collection period. |\n| value | Array | An array of numbers. |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| DataBuilder | The same DataBuilder object. |\n\n### Example\n\n```None\n\nvar points = [7,0.5,273];\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, points);\n```\n\n## Scoped DataBuilder - add(GlideDateTime start, Number value)\n\nAdd a data point to the DataBuilder object. Each data point is a time stamp and a\nvalue. This method does not save the data point in the metric. Use the\nsn\\_clotho.Client.put() method to save the values.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| start | GlideDateTime | The time stamp for the data point. |\n| value | Number | The value of the data point. |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| DataBuilder | The DataBuilder object. |\n\n### Example\n\n```None\nvar dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n// this creates a GlideDateTime object set to the current date and time\nvar time = new GlideDateTime();\ndataBuilder.add(time, 0.6);\n```\n\n## Scoped DataBuilder - DataBuilder(Object glideRecord, String subject, String metric)\n\nCreates an instance of the DataBuilder class.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| glideRecord | Object | GlideRecord from which to obtain the domain. |\n| subject | String | The sys\\_id of the GlideRecord associated with this series. |\n| metric | String | The field name of the metric. |\n\n### Example\n\n```None\n// Where cpu_percentage is the name of the metric\n var dataBuilder = new sn_clotho.DataBuilder(now_GR, 'cpu_percentage');\n```\n"}}},{"rowIdx":1699,"cells":{"loc":{"kind":"string","value":"https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html"},"api":{"kind":"string","value":"https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html"},"lastmod":{"kind":"string","value":"2025-05-06"},"changefreq":{"kind":"string","value":"daily"},"priority":{"kind":"number","value":0.5,"string":"0.5"},"sitemappart":{"kind":"string","value":"3.xml"},"locale":{"kind":"string","value":"en-US"},"bundle":{"kind":"string","value":"vancouver-api-reference"},"page_id":{"kind":"string","value":"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html"},"release":{"kind":"string","value":"vancouver"},"title":{"kind":"string","value":"Data - Scoped, Global"},"description":{"kind":"string","value":"A Data object contains the results of transform performed by a sn_clotho.Client.transform() method."},"keywords":{"kind":"list like","value":["Data","Scoped Data","getEnd()","Scoped DATA","getLabel()","getMetricName()","getPeriod()","getStart()","getSubject()","getTableName()","getValues()","size()"],"string":"[\n \"Data\",\n \"Scoped Data\",\n \"getEnd()\",\n \"Scoped DATA\",\n \"getLabel()\",\n \"getMetricName()\",\n \"getPeriod()\",\n \"getStart()\",\n \"getSubject()\",\n \"getTableName()\",\n \"getValues()\",\n \"size()\"\n]","isConversational":false},"breadcrumbs":{"kind":"list like","value":["API implementation and reference","API reference","Server API reference"],"string":"[\n \"API implementation and reference\",\n \"API reference\",\n \"Server API reference\"\n]","isConversational":false},"html_content":{"kind":"string","value":"<article class=\"hascomments\" data-page=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\" id=\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\"><div class=\"wm\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\"api-class\"><main role=\"main\"><article role=\"article\" class=\"api-class dita\" aria-labelledby=\"title_DataScopedAPI\"><article class=\"nested0\" aria-labelledby=\"title_DataScopedAPI\" id=\"DataScopedAPI\">\n <h1 class=\"title topictitle1\" id=\"title_DataScopedAPI\">Data - Scoped, Global</h1>\n \n \n <div class=\"body conbody\"><p class=\"shortdesc\">A Data object contains the results of transform performed by a\n <span class=\"keyword apiname\">sn_clotho.Client.transform()</span> method.</p>\n <p class=\"p\">Do not use a constructor to create an instance of this class, instead use the object returned\n by the <span class=\"keyword apiname\">sn_clotho.Client.transform()</span> method.</p>\n <p class=\"p\">The <span class=\"keyword apiname\">Data</span> class can be used in scoped and global server scripts. When using\n the <span class=\"keyword apiname\">Data</span> class, use the <code class=\"ph codeph\">sn_clotho</code> namespace\n identifier.</p>\n <p class=\"p\">This class is part of the <span class=\"ph\">MetricBase</span> application.</p>\n </div>\n<nav role=\"navigation\"></nav><nav role=\"navigation\" class=\"tasksNavigation\"></nav><nav role=\"navigation\" class=\"related-links\"></nav><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getEnd\" id=\"DATAS-getEnd\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getEnd\">Scoped Data - getEnd()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the end time for data in the Data object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getEnd__table_pb2_1jk_mbb\"><caption><span class=\"table--title-label\">Table 1. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getEnd__table_pb2_1jk_mbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getEnd__table_qb2_1jk_mbb\"><caption><span class=\"table--title-label\">Table 2. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getEnd__table_qb2_1jk_mbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getEnd__table_qb2_1jk_mbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getEnd__table_qb2_1jk_mbb__entry__1\">GlideDateTime</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getEnd__table_qb2_1jk_mbb__entry__2\">The end of the time period.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getLabel\" id=\"DATAS-getLabel\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getLabel\">Scoped Data - getLabel()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the label assigned by the <span class=\"keyword apiname\">\n sn_clotho.ClothoTransform.label()</span> method.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getLabel__table_b1x_5fz_31b\"><caption><span class=\"table--title-label\">Table 3. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getLabel__table_b1x_5fz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getLabel__table_b1x_5fz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getLabel__table_b1x_5fz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getLabel__table_b1x_5fz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getLabel__table_b1x_5fz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getLabel__table_b1x_5fz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getLabel__table_c1x_5fz_31b\"><caption><span class=\"table--title-label\">Table 4. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getLabel__table_c1x_5fz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getLabel__table_c1x_5fz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getLabel__table_c1x_5fz_31b__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getLabel__table_c1x_5fz_31b__entry__2\">The label assigned to the data.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getMetricName\" id=\"DATAS-getMetricName\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getMetricName\">Scoped Data - getMetricName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the name of the metric of the data series. Returns null when the data object is\n associated with multiple data series.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getMetricName__table_ey4_f3z_31b\"><caption><span class=\"table--title-label\">Table 5. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getMetricName__table_ey4_f3z_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getMetricName__table_fy4_f3z_31b\"><caption><span class=\"table--title-label\">Table 6. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getMetricName__table_fy4_f3z_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getMetricName__table_fy4_f3z_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getMetricName__table_fy4_f3z_31b__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getMetricName__table_fy4_f3z_31b__entry__2\">Name of the metric field. Returns null when the data object is associated with\n multiple data series.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getPeriod\" id=\"DATAS-getPeriod\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getPeriod\">Scoped Data - getPeriod()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the time period in milliseconds.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getPeriod__table_tmp_sjk_mbb\"><caption><span class=\"table--title-label\">Table 7. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getPeriod__table_ump_sjk_mbb\"><caption><span class=\"table--title-label\">Table 8. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getPeriod__table_ump_sjk_mbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getPeriod__table_ump_sjk_mbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getPeriod__table_ump_sjk_mbb__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getPeriod__table_ump_sjk_mbb__entry__2\">The elapsed time in seconds.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getStart\" id=\"DATAS-getStart\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getStart\">Scoped Data - getStart()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the start time for data in the Data object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getStart__table_lr2_f3k_mbb\"><caption><span class=\"table--title-label\">Table 9. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getStart__table_lr2_f3k_mbb__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getStart__table_lr2_f3k_mbb__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getStart__table_lr2_f3k_mbb__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getStart__table_lr2_f3k_mbb__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getStart__table_lr2_f3k_mbb__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getStart__table_lr2_f3k_mbb__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getStart__table_mr2_f3k_mbb\"><caption><span class=\"table--title-label\">Table 10. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getStart__table_mr2_f3k_mbb__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getStart__table_mr2_f3k_mbb__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getStart__table_mr2_f3k_mbb__entry__1\">GlideDateTime</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getStart__table_mr2_f3k_mbb__entry__2\">The time for the first data point.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getSubject\" id=\"DATAS-getSubject\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getSubject\">Scoped Data - getSubject()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the subject of the data series. Returns null when the data object is associated\n with multiple data series.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getSubject__table_zyg_lhz_31b\"><caption><span class=\"table--title-label\">Table 11. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getSubject__table_zyg_lhz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getSubject__table_zyg_lhz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getSubject__table_zyg_lhz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getSubject__table_zyg_lhz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getSubject__table_zyg_lhz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getSubject__table_zyg_lhz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getSubject__table_azg_lhz_31b\"><caption><span class=\"table--title-label\">Table 12. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getSubject__table_azg_lhz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getSubject__table_azg_lhz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getSubject__table_azg_lhz_31b__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getSubject__table_azg_lhz_31b__entry__2\">The subject field value of the subject GlideRecord. This is generally the\n sys_id of the subject GlideRecord.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getTableName\" id=\"DATAS-getTableName\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getTableName\">Scoped Data - getTableName()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the name of the table assigned in the DataSelector class constructor. Returns\n null when the data object is associated with multiple data series.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getTableName__table_kkg_4gz_31b\"><caption><span class=\"table--title-label\">Table 13. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getTableName__table_kkg_4gz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getTableName__table_kkg_4gz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getTableName__table_kkg_4gz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getTableName__table_kkg_4gz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getTableName__table_kkg_4gz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getTableName__table_kkg_4gz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getTableName__table_lkg_4gz_31b\"><caption><span class=\"table--title-label\">Table 14. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getTableName__table_lkg_4gz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getTableName__table_lkg_4gz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getTableName__table_lkg_4gz_31b__entry__1\">String</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getTableName__table_lkg_4gz_31b__entry__2\">Table name. Returns null when the data object is associated with multiple data\n series.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-getValues\" id=\"DATAS-getValues\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-getValues\">Scoped Data - getValues()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns an array of values.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-getValues__table_ex2_cjz_31b\"><caption><span class=\"table--title-label\">Table 15. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getValues__table_ex2_cjz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getValues__table_ex2_cjz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getValues__table_ex2_cjz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getValues__table_ex2_cjz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getValues__table_ex2_cjz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getValues__table_ex2_cjz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-getValues__table_fx2_cjz_31b\"><caption><span class=\"table--title-label\">Table 16. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getValues__table_fx2_cjz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-getValues__table_fx2_cjz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getValues__table_fx2_cjz_31b__entry__1\">Array</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-getValues__table_fx2_cjz_31b__entry__2\">An array of numbers.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article><article class=\"topic reference nested1 api-method\" aria-labelledby=\"title_DATAS-size\" id=\"DATAS-size\">\n <h2 class=\"title topictitle2\" id=\"title_DATAS-size\">Scoped Data - size()</h2>\n \n \n <div class=\"body refbody\"><p class=\"shortdesc\">Returns the number of values in the Data object.</p>\n <section class=\"section\">\n <div class=\"table-wrap\"><table count-columns=\"3\" class=\"table parameters frame-all\" id=\"DATAS-size__table_zmy_2kz_31b\"><caption><span class=\"table--title-label\">Table 17. </span><span class=\"title\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-size__table_zmy_2kz_31b__entry__1\">Name</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-size__table_zmy_2kz_31b__entry__2\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-size__table_zmy_2kz_31b__entry__3\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-size__table_zmy_2kz_31b__entry__1\">None</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-size__table_zmy_2kz_31b__entry__2\"></td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-size__table_zmy_2kz_31b__entry__3\"></td>\n </tr>\n </tbody></table></div>\n <div class=\"table-wrap\"><table count-columns=\"2\" class=\"table returns frame-all\" id=\"DATAS-size__table_any_2kz_31b\"><caption><span class=\"table--title-label\">Table 18. </span><span class=\"title\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\"thead\">\n <tr class=\"row\">\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-size__table_any_2kz_31b__entry__1\">Type</th>\n <th class=\"entry colsep-1 rowsep-1\" id=\"DATAS-size__table_any_2kz_31b__entry__2\">Description</th>\n </tr>\n </thead><tbody class=\"tbody\">\n <tr class=\"row\">\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-size__table_any_2kz_31b__entry__1\">Number</td>\n <td class=\"entry colsep-1 rowsep-1\" headers=\"DATAS-size__table_any_2kz_31b__entry__2\">The number of values in the object.</td>\n </tr>\n </tbody></table></div>\n </section>\n </div>\n</article></article></article></main></body></article>"},"page_content":{"kind":"string","value":"{\n \"attachments\": {\n \"all_attachments\": null,\n \"topic_attachments\": []\n },\n \"available_languages\": [\n \"dede\",\n \"enus\",\n \"frfr\",\n \"jajp\",\n \"kokr\",\n \"ptbr\"\n ],\n \"breadcrumbs\": [\n {\n \"title\": \"API implementation and reference\",\n \"topic_id\": \"build/applications/concept/api-implementation-reference.html\"\n },\n {\n \"title\": \"API reference\",\n \"topic_id\": \"build/applications/concept/api-reference.html\"\n },\n {\n \"title\": \"Server API reference\",\n \"topic_id\": \"build/applications/concept/api-server.html\"\n }\n ],\n \"breadcrumbs_html\": \"<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference\\\">Vancouver API Reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-implementation-reference.html\\\">API implementation and reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-reference.html\\\">API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<a href=\\\"https://servicenow-be-prod.servicenow.com/bundle/vancouver-api-reference/page/build/applications/concept/api-server.html\\\">Server API reference</a>\\n<span><i class=\\\"fa fa-angle-right\\\"></i>\\n</span>\\n<span class=\\\"active\\\">Data - Scoped, Global</span>\",\n \"bundle_id\": \"vancouver-api-reference\",\n \"bundle_key\": 1400,\n \"bundle_landing_page\": \"build/applications/concept/api-implementation-reference.html\",\n \"bundle_subtitle\": null,\n \"bundle_title\": \"Vancouver API Reference\",\n \"canonical_link\": \"https://www.servicenow.com/docs/bundle/yokohama-api-reference/page/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\",\n \"dates\": {\n \"Added on\": \"2025-04-03T16:59:21.208471Z\",\n \"Created on\": \"2023-08-03T00:00:00Z\",\n \"Initial upload\": \"2023-07-07T23:34:31.043398Z\",\n \"Updated on\": \"2023-08-03T00:00:00Z\"\n },\n \"dislike_url\": \"https://servicenow-be-prod.servicenow.com/dislike/41205492\",\n \"dislikes\": 0,\n \"es_archived_content\": false,\n \"is_in_fav\": false,\n \"is_liked\": null,\n \"is_watched\": false,\n \"keywords\": [\n \" vancouver vancouver\"\n ],\n \"labels\": [\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"vancouver\",\n \"navtitle\": \"Vancouver\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"versions\",\n \"subjectheadNavtitle\": \"Versions\",\n \"visibility\": \"show-facet\"\n },\n {\n \"aliases\": [],\n \"hidden\": false,\n \"isSubjectHead\": false,\n \"key\": \"apiref\",\n \"navtitle\": \"API reference\",\n \"outputclasses\": [],\n \"subjectHeadId\": \"products\",\n \"subjectheadNavtitle\": \"Products\",\n \"visibility\": \"show-facet\"\n }\n ],\n \"labels_text\": \"Versions > Vancouver; Products > API implementation and reference > API reference\",\n \"like_url\": \"https://servicenow-be-prod.servicenow.com/like/41205492\",\n \"likes\": 0,\n \"metadata\": {\n \"AI Search\": null,\n \"AI Search Assist\": null,\n \"Application Insights\": null,\n \"Capabilities\": null,\n \"Code Signing\": null,\n \"Contextual Search\": null,\n \"DC.contributor\": null,\n \"DC.coverage\": null,\n \"DC.creator\": \"ServiceNow\",\n \"DC.date.created\": \"2023-08-03\",\n \"DC.date.modified\": \"2023-08-03\",\n \"DC.format\": \"HTML5\",\n \"DC.identifier\": \"DataScopedAPI\",\n \"DC.language\": null,\n \"DC.relation\": \"../../../../../build/applications/concept/api-server.html\",\n \"DC.rights.owner\": \"(C) Copyright 2025\",\n \"DC.subject\": \"Data,Scoped Data,getEnd(),Scoped DATA,getLabel(),getMetricName(),getPeriod(),getStart(),getSubject(),getTableName(),getValues(),size()\",\n \"DC.type\": \"dita\",\n \"Data Discovery\": null,\n \"Data Policy\": null,\n \"Data Privacy\": null,\n \"Discovery\": null,\n \"External Content for AI Search\": null,\n \"Field Administration\": null,\n \"Field Normalization\": null,\n \"Key Management Framework\": null,\n \"Localization Framework\": null,\n \"Now Platform\": null,\n \"PlatSec\": null,\n \"Platform\": null,\n \"Platform Administration\": null,\n \"Platform Performance\": null,\n \"Platform Privacy\": null,\n \"Proactive Triggers\": null,\n \"Process Optimization\": null,\n \"RN doc editing record number\": null,\n \"Search Administration\": null,\n \"Secrets Management\": null,\n \"ServiceNow AI Platform\": null,\n \"State Model\": null,\n \"Subscription Management\": null,\n \"Task Communications Management\": null,\n \"Timeline Visualizations\": null,\n \"User Administration\": null,\n \"User Experience Analytics\": null,\n \"Zing\": null,\n \"ai-now-assist\": null,\n \"app-name\": null,\n \"app_route\": null,\n \"azureapimanagemen\": null,\n \"change-completed\": null,\n \"change-item\": null,\n \"change-request-id\": null,\n \"change-request-reference\": null,\n \"com.glide.embedded_help.category\": null,\n \"component\": null,\n \"copyright\": \"(C) Copyright 2025\",\n \"crossroads\": null,\n \"data\": null,\n \"description\": \"A Data object contains the results of transform performed by a sn_clotho.Client.transform() method.\",\n \"dominant_bundle\": \"yokohama-api-reference\",\n \"erp-canvas-video\": null,\n \"fsm-mobile\": null,\n \"fsm-route\": null,\n \"fsm-sched-opt\": null,\n \"fsm-wrk-order\": null,\n \"genai-round-7\": null,\n \"generator\": \"DITA-OT\",\n \"glossPartOfSpeech\": null,\n \"glossStatus\": null,\n \"guided setup\": null,\n \"guided tours\": null,\n \"keywords\": \"Data, Scoped Data, getEnd(), Scoped DATA, getLabel(), getMetricName(), getPeriod(), getStart(), getSubject(), getTableName(), getValues(), size()\",\n \"min-toc\": null,\n \"mini\": null,\n \"mini-to truec\": null,\n \"mini-toc\": \"yes\",\n \"mini_toc\": null,\n \"minitoc\": null,\n \"modification\": null,\n \"now-assist-app-gen-video\": null,\n \"order\": null,\n \"page-type\": null,\n \"page-type \": null,\n \"prodname\": null,\n \"product\": null,\n \"product_name\": null,\n \"release\": null,\n \"resourceID\": null,\n \"roles\": null,\n \"route_page\": null,\n \"route_params_listId\": null,\n \"route_params_table\": null,\n \"route_params_type\": null,\n \"route_type\": null,\n \"setconfigurationproperties\": null,\n \"topic\": null,\n \"translation-type\": \"source\",\n \"version\": null,\n \"workflow\": \"Creator\",\n \"workplace-srvc-delvry-ditamap\": null\n },\n \"page_id\": \"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\",\n \"page_key\": 41205492,\n \"preprocessed_PDF\": \"https://downloads.docs.servicenow.com/pdf/enus/servicenow-vancouver-api-reference-enus.pdf\",\n \"rating\": null,\n \"read_time_data\": {\n \"char_count\": 2188,\n \"img_count\": 0,\n \"read_time\": 2,\n \"video_links\": [\n \"\"\n ],\n \"word_count\": 332\n },\n \"related_links\": [],\n \"search_title\": null,\n \"title\": \"Data - Scoped, Global\",\n \"topic_cluster\": {\n \"clustered_by\": {\n \"enabled\": true,\n \"primary_key\": \"versions\",\n \"primary_sort\": \"top-down\",\n \"type\": \"subjecthead\"\n },\n \"clustered_labels\": [\n \"versions\"\n ],\n \"clustered_topics\": [\n {\n \"bundle_id\": \"zurich-api-reference\",\n \"clustering_title\": \"Zurich\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\"\n },\n {\n \"bundle_id\": \"yokohama-api-reference\",\n \"clustering_title\": \"Yokohama\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\"\n },\n {\n \"bundle_id\": \"xanadu-api-reference\",\n \"clustering_title\": \"Xanadu\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\"\n },\n {\n \"bundle_id\": \"washingtondc-api-reference\",\n \"clustering_title\": \"Washington DC\",\n \"es_archived_content\": false,\n \"page_id\": \"app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\"\n }\n ],\n \"clustering_title\": \"Vancouver\"\n },\n \"topic_html\": \"<article class=\\\"hascomments\\\" data-page=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\\\" id=\\\"bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html\\\"><div class=\\\"wm\\\">The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.</div><body class=\\\"api-class\\\"><main role=\\\"main\\\"><article role=\\\"article\\\" class=\\\"api-class dita\\\" aria-labelledby=\\\"title_DataScopedAPI\\\"><article class=\\\"nested0\\\" aria-labelledby=\\\"title_DataScopedAPI\\\" id=\\\"DataScopedAPI\\\">\\n <h1 class=\\\"title topictitle1\\\" id=\\\"title_DataScopedAPI\\\">Data - Scoped, Global</h1>\\n \\n \\n <div class=\\\"body conbody\\\"><p class=\\\"shortdesc\\\">A Data object contains the results of transform performed by a\\n <span class=\\\"keyword apiname\\\">sn_clotho.Client.transform()</span> method.</p>\\n <p class=\\\"p\\\">Do not use a constructor to create an instance of this class, instead use the object returned\\n by the <span class=\\\"keyword apiname\\\">sn_clotho.Client.transform()</span> method.</p>\\n <p class=\\\"p\\\">The <span class=\\\"keyword apiname\\\">Data</span> class can be used in scoped and global server scripts. When using\\n the <span class=\\\"keyword apiname\\\">Data</span> class, use the <code class=\\\"ph codeph\\\">sn_clotho</code> namespace\\n identifier.</p>\\n <p class=\\\"p\\\">This class is part of the <span class=\\\"ph\\\">MetricBase</span> application.</p>\\n </div>\\n<nav role=\\\"navigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"tasksNavigation\\\"></nav><nav role=\\\"navigation\\\" class=\\\"related-links\\\"></nav><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getEnd\\\" id=\\\"DATAS-getEnd\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getEnd\\\">Scoped Data - getEnd()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the end time for data in the Data object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getEnd__table_pb2_1jk_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 1. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getEnd__table_pb2_1jk_mbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getEnd__table_qb2_1jk_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 2. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getEnd__table_qb2_1jk_mbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getEnd__table_qb2_1jk_mbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getEnd__table_qb2_1jk_mbb__entry__1\\\">GlideDateTime</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getEnd__table_qb2_1jk_mbb__entry__2\\\">The end of the time period.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getLabel\\\" id=\\\"DATAS-getLabel\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getLabel\\\">Scoped Data - getLabel()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the label assigned by the <span class=\\\"keyword apiname\\\">\\n sn_clotho.ClothoTransform.label()</span> method.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getLabel__table_b1x_5fz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 3. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getLabel__table_b1x_5fz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getLabel__table_c1x_5fz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 4. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getLabel__table_c1x_5fz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getLabel__table_c1x_5fz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getLabel__table_c1x_5fz_31b__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getLabel__table_c1x_5fz_31b__entry__2\\\">The label assigned to the data.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getMetricName\\\" id=\\\"DATAS-getMetricName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getMetricName\\\">Scoped Data - getMetricName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the name of the metric of the data series. Returns null when the data object is\\n associated with multiple data series.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getMetricName__table_ey4_f3z_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 5. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getMetricName__table_ey4_f3z_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getMetricName__table_fy4_f3z_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 6. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getMetricName__table_fy4_f3z_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getMetricName__table_fy4_f3z_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getMetricName__table_fy4_f3z_31b__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getMetricName__table_fy4_f3z_31b__entry__2\\\">Name of the metric field. Returns null when the data object is associated with\\n multiple data series.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getPeriod\\\" id=\\\"DATAS-getPeriod\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getPeriod\\\">Scoped Data - getPeriod()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the time period in milliseconds.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getPeriod__table_tmp_sjk_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 7. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getPeriod__table_tmp_sjk_mbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getPeriod__table_ump_sjk_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 8. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getPeriod__table_ump_sjk_mbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getPeriod__table_ump_sjk_mbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getPeriod__table_ump_sjk_mbb__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getPeriod__table_ump_sjk_mbb__entry__2\\\">The elapsed time in seconds.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getStart\\\" id=\\\"DATAS-getStart\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getStart\\\">Scoped Data - getStart()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the start time for data in the Data object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getStart__table_lr2_f3k_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 9. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getStart__table_lr2_f3k_mbb__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getStart__table_mr2_f3k_mbb\\\"><caption><span class=\\\"table--title-label\\\">Table 10. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getStart__table_mr2_f3k_mbb__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getStart__table_mr2_f3k_mbb__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getStart__table_mr2_f3k_mbb__entry__1\\\">GlideDateTime</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getStart__table_mr2_f3k_mbb__entry__2\\\">The time for the first data point.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getSubject\\\" id=\\\"DATAS-getSubject\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getSubject\\\">Scoped Data - getSubject()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the subject of the data series. Returns null when the data object is associated\\n with multiple data series.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getSubject__table_zyg_lhz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 11. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getSubject__table_zyg_lhz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getSubject__table_azg_lhz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 12. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getSubject__table_azg_lhz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getSubject__table_azg_lhz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getSubject__table_azg_lhz_31b__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getSubject__table_azg_lhz_31b__entry__2\\\">The subject field value of the subject GlideRecord. This is generally the\\n sys_id of the subject GlideRecord.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getTableName\\\" id=\\\"DATAS-getTableName\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getTableName\\\">Scoped Data - getTableName()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the name of the table assigned in the DataSelector class constructor. Returns\\n null when the data object is associated with multiple data series.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getTableName__table_kkg_4gz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 13. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getTableName__table_kkg_4gz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getTableName__table_lkg_4gz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 14. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getTableName__table_lkg_4gz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getTableName__table_lkg_4gz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getTableName__table_lkg_4gz_31b__entry__1\\\">String</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getTableName__table_lkg_4gz_31b__entry__2\\\">Table name. Returns null when the data object is associated with multiple data\\n series.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-getValues\\\" id=\\\"DATAS-getValues\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-getValues\\\">Scoped Data - getValues()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns an array of values.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-getValues__table_ex2_cjz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 15. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getValues__table_ex2_cjz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-getValues__table_fx2_cjz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 16. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getValues__table_fx2_cjz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-getValues__table_fx2_cjz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getValues__table_fx2_cjz_31b__entry__1\\\">Array</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-getValues__table_fx2_cjz_31b__entry__2\\\">An array of numbers.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article><article class=\\\"topic reference nested1 api-method\\\" aria-labelledby=\\\"title_DATAS-size\\\" id=\\\"DATAS-size\\\">\\n <h2 class=\\\"title topictitle2\\\" id=\\\"title_DATAS-size\\\">Scoped Data - size()</h2>\\n \\n \\n <div class=\\\"body refbody\\\"><p class=\\\"shortdesc\\\">Returns the number of values in the Data object.</p>\\n <section class=\\\"section\\\">\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"3\\\" class=\\\"table parameters frame-all\\\" id=\\\"DATAS-size__table_zmy_2kz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 17. </span><span class=\\\"title\\\">Parameters</span></caption><colgroup><col/><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-size__table_zmy_2kz_31b__entry__1\\\">Name</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-size__table_zmy_2kz_31b__entry__2\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-size__table_zmy_2kz_31b__entry__3\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-size__table_zmy_2kz_31b__entry__1\\\">None</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-size__table_zmy_2kz_31b__entry__2\\\"></td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-size__table_zmy_2kz_31b__entry__3\\\"></td>\\n </tr>\\n </tbody></table></div>\\n <div class=\\\"table-wrap\\\"><table count-columns=\\\"2\\\" class=\\\"table returns frame-all\\\" id=\\\"DATAS-size__table_any_2kz_31b\\\"><caption><span class=\\\"table--title-label\\\">Table 18. </span><span class=\\\"title\\\">Returns</span></caption><colgroup><col/><col/></colgroup><thead class=\\\"thead\\\">\\n <tr class=\\\"row\\\">\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-size__table_any_2kz_31b__entry__1\\\">Type</th>\\n <th class=\\\"entry colsep-1 rowsep-1\\\" id=\\\"DATAS-size__table_any_2kz_31b__entry__2\\\">Description</th>\\n </tr>\\n </thead><tbody class=\\\"tbody\\\">\\n <tr class=\\\"row\\\">\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-size__table_any_2kz_31b__entry__1\\\">Number</td>\\n <td class=\\\"entry colsep-1 rowsep-1\\\" headers=\\\"DATAS-size__table_any_2kz_31b__entry__2\\\">The number of values in the object.</td>\\n </tr>\\n </tbody></table></div>\\n </section>\\n </div>\\n</article></article></article></main></body></article>\",\n \"topic_language\": \"enus\",\n \"views\": 0,\n \"your_rating\": null\n}"},"clean_text":{"kind":"string","value":"The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Data - Scoped, Global\n\nA Data object contains the results of transform performed by a\nsn\\_clotho.Client.transform() method.\n\nDo not use a constructor to create an instance of this class, instead use the object returned\nby the sn\\_clotho.Client.transform() method.\n\nThe Data class can be used in scoped and global server scripts. When using\nthe Data class, use the `sn_clotho` namespace\nidentifier.\n\nThis class is part of the MetricBase application.\n\n## Scoped Data - getEnd()\n\nReturns the end time for data in the Data object.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| GlideDateTime | The end of the time period. |\n\n## Scoped Data - getLabel()\n\nReturns the label assigned by the \nsn\\_clotho.ClothoTransform.label() method.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | The label assigned to the data. |\n\n## Scoped Data - getMetricName()\n\nReturns the name of the metric of the data series. Returns null when the data object is\nassociated with multiple data series.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the metric field. Returns null when the data object is associated with multiple data series. |\n\n## Scoped Data - getPeriod()\n\nReturns the time period in milliseconds.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Number | The elapsed time in seconds. |\n\n## Scoped Data - getStart()\n\nReturns the start time for data in the Data object.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| GlideDateTime | The time for the first data point. |\n\n## Scoped Data - getSubject()\n\nReturns the subject of the data series. Returns null when the data object is associated\nwith multiple data series.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | The subject field value of the subject GlideRecord. This is generally the sys\\_id of the subject GlideRecord. |\n\n## Scoped Data - getTableName()\n\nReturns the name of the table assigned in the DataSelector class constructor. Returns\nnull when the data object is associated with multiple data series.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| String | Table name. Returns null when the data object is associated with multiple data series. |\n\n## Scoped Data - getValues()\n\nReturns an array of values.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Array | An array of numbers. |\n\n## Scoped Data - size()\n\nReturns the number of values in the Data object.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Number | The number of values in the object. |\n"},"rich_text":{"kind":"string","value":"---\ntitle: Data - Scoped, Global\ndescription: A Data object contains the results of transform performed by a sn_clotho.Client.transform()\n method.\nkeywords:\n- Data\n- Scoped Data\n- getEnd()\n- Scoped DATA\n- getLabel()\n- getMetricName()\n- getPeriod()\n- getStart()\n- getSubject()\n- getTableName()\n- getValues()\n- size()\nbreadcrumbs:\n- API implementation and reference\n- API reference\n- Server API reference\n---\n\nThe Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.\n# Data - Scoped, Global\n\nA Data object contains the results of transform performed by a\nsn\\_clotho.Client.transform() method.\n\nDo not use a constructor to create an instance of this class, instead use the object returned\nby the sn\\_clotho.Client.transform() method.\n\nThe Data class can be used in scoped and global server scripts. When using\nthe Data class, use the `sn_clotho` namespace\nidentifier.\n\nThis class is part of the MetricBase application.\n\n## Scoped Data - getEnd()\n\nReturns the end time for data in the Data object.\n\nTable 1. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 2. Returns\n| Type | Description |\n| --- | --- |\n| GlideDateTime | The end of the time period. |\n\n## Scoped Data - getLabel()\n\nReturns the label assigned by the \nsn\\_clotho.ClothoTransform.label() method.\n\nTable 3. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 4. Returns\n| Type | Description |\n| --- | --- |\n| String | The label assigned to the data. |\n\n## Scoped Data - getMetricName()\n\nReturns the name of the metric of the data series. Returns null when the data object is\nassociated with multiple data series.\n\nTable 5. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 6. Returns\n| Type | Description |\n| --- | --- |\n| String | Name of the metric field. Returns null when the data object is associated with multiple data series. |\n\n## Scoped Data - getPeriod()\n\nReturns the time period in milliseconds.\n\nTable 7. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 8. Returns\n| Type | Description |\n| --- | --- |\n| Number | The elapsed time in seconds. |\n\n## Scoped Data - getStart()\n\nReturns the start time for data in the Data object.\n\nTable 9. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 10. Returns\n| Type | Description |\n| --- | --- |\n| GlideDateTime | The time for the first data point. |\n\n## Scoped Data - getSubject()\n\nReturns the subject of the data series. Returns null when the data object is associated\nwith multiple data series.\n\nTable 11. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 12. Returns\n| Type | Description |\n| --- | --- |\n| String | The subject field value of the subject GlideRecord. This is generally the sys\\_id of the subject GlideRecord. |\n\n## Scoped Data - getTableName()\n\nReturns the name of the table assigned in the DataSelector class constructor. Returns\nnull when the data object is associated with multiple data series.\n\nTable 13. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 14. Returns\n| Type | Description |\n| --- | --- |\n| String | Table name. Returns null when the data object is associated with multiple data series. |\n\n## Scoped Data - getValues()\n\nReturns an array of values.\n\nTable 15. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 16. Returns\n| Type | Description |\n| --- | --- |\n| Array | An array of numbers. |\n\n## Scoped Data - size()\n\nReturns the number of values in the Data object.\n\nTable 17. Parameters\n| Name | Type | Description |\n| --- | --- | --- |\n| None | | |\n\nTable 18. Returns\n| Type | Description |\n| --- | --- |\n| Number | The number of values in the object. |\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":16,"numItemsPerPage":100,"numTotalItems":60967,"offset":1600,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4NjI3NzY5OSwianRpIjoiNWViNjlkNzUtY2VmNC00NWI4LTgyMGEtODgxOGNlZjYyN2IyIiwic3ViIjoiL2RhdGFzZXRzL1NlcnZpY2VOb3ctQUkvc2VydmljZW5vdy1kb2NzIiwiZXhwIjoxNzg2MjgxMjk5LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.PXdermDhVnksk9yC3kx3kHOds_eGRURAcDbK1jw2kDV3LukwUK7ujI2BhUorA9ztXRPMyuvlAw2Cjlx0NcUfBQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":60967,"numBytesParquet":444661170},{"config":"default","split":"train_chunks","numRows":287271,"numBytesParquet":525744610}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
loc string | api string | lastmod string | changefreq string | priority float64 | sitemappart string | locale string | bundle string | page_id string | release string | title string | description string | keywords list | breadcrumbs list | html_content string | page_content dict | clean_text string | rich_text string |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-overview.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-overview.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-overview.html | vancouver | Exploring Account Lifecycle Events | The Account Lifecycle Events application provides a structured, onboarding experience for technology industry providers. | [] | [
"Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-overview.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-overview.html"><div class="wm">The Vancouver release is no lo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Exploring Account Lifecycle Events
The Account Lifecycle Events application provides a structured, onboarding experience for technology industry pr... | ---
title: Exploring Account Lifecycle Events
description: The Account Lifecycle Events application provides a structured, onboarding
experience for technology industry providers.
keywords: []
breadcrumbs:
- Account Lifecycle Events
---
The Vancouver release is no longer supported. As such, the product documentation... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-pad.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-pad.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-pad.html | vancouver | Configure playbook using Process Automation Designer | Use the Process Automation Designer to configure the Account Lifecycle Events playbook. | [] | [
"Account Lifecycle Events",
"Configuring Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-pad.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-pad.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Configure playbook using Process Automation Designer
Use the Process Automation Designer to configure the Account Lifecycle Events playbook.
In Pr... | ---
title: Configure playbook using Process Automation Designer
description: Use the Process Automation Designer to configure the Account Lifecycle
Events playbook.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Configuring Account Lifecycle Events
---
The Vancouver release is no longer supported. As such, t... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-playbook-overview.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-playbook-overview.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-playbook-overview.html | vancouver | About the Account Lifecycle Events playbook | The Account Lifecycle Events application enables technology industry providers to define a structured, repeatable, onboarding experience. The Account Lifecycle Events application enables collaboration, transparency, and insight for both internal staff members and external customers involved in the onboarding process. | [] | [
"Account Lifecycle Events",
"Exploring Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-playbook-overview.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-playbook-overview.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# About the Account Lifecycle Events playbook
The Account Lifecycle Events application enables technology industry providers to define a structured, ... | ---
title: About the Account Lifecycle Events playbook
description: The Account Lifecycle Events application enables technology industry
providers to define a structured, repeatable, onboarding experience. The Account
Lifecycle Events application enables collaboration, transparency, and insight for
both internal ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-use-playbook.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-use-playbook.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-use-playbook.html | vancouver | Using the Account Lifecycle Events playbook | The Account Lifecycle Events playbook provides a simplified experience to import, stage, manage, and publish account data. | [] | [
"Account Lifecycle Events",
"Using Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-use-playbook.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-use-playbook.html"><div class="wm">The Vancouver release ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Using the Account Lifecycle Events playbook
The Account Lifecycle Events playbook provides a simplified experience to import, stage, manage, and pu... | ---
title: Using the Account Lifecycle Events playbook
description: The Account Lifecycle Events playbook provides a simplified experience
to import, stage, manage, and publish account data.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Using Account Lifecycle Events
---
The Vancouver release is no longer s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-use.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-use.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-use.html | vancouver | Using Account Lifecycle Events | The Account Lifecycle Events application provides service providers with a structured, repeatable, onboarding experience for their customers, and process transparency to internal and external teams. The onboarding playbook is a starting point that can be configured to meet business requirements. | [] | [
"Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-use.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-use.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Using Account Lifecycle Events
The Account Lifecycle Events application provides service providers with a structured, repeatable, onboarding experi... | ---
title: Using Account Lifecycle Events
description: The Account Lifecycle Events application provides service providers with
a structured, repeatable, onboarding experience for their customers, and process
transparency to internal and external teams. The onboarding playbook is a starting
point that can be conf... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-user-personas.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/concept/account-lifecycle-user-personas.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/concept/account-lifecycle-user-personas.html | vancouver | Account Lifecycle Events users and roles | An overview of the tasks that can be performed by the different Account Lifecycle Events users and their required roles and user criteria. | [] | [
"Account Lifecycle Events",
"Exploring Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-user-personas.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/concept/account-lifecycle-user-personas.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Account Lifecycle Events users and roles
An overview of the tasks that can be performed by the different Account Lifecycle Events users and their r... | ---
title: Account Lifecycle Events users and roles
description: An overview of the tasks that can be performed by the different Account
Lifecycle Events users and their required roles and user criteria.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Exploring Account Lifecycle Events
---
The Vancouver relea... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/reference/account-lifecycle-reference.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/reference/account-lifecycle-reference.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/reference/account-lifecycle-reference.html | vancouver | Account Lifecycle Events reference | Reference topics provide additional information about Account Lifecycle Events application. | [] | [
"Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/reference/account-lifecycle-reference.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/reference/account-lifecycle-reference.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Account Lifecycle Events reference
Reference topics provide additional information about Account Lifecycle Events application.
| ---
title: Account Lifecycle Events reference
description: Reference topics provide additional information about Account Lifecycle
Events application.
keywords: []
breadcrumbs:
- Account Lifecycle Events
---
The Vancouver release is no longer supported. As such, the product documentation and release notes are provid... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-activate.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-activate.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-activate.html | vancouver | Activate Account Lifecycle Events | The Account Lifecycle Events (com.sn_acct_lc) plugin is available as a separate subscription. This plugin activates related plugins, if they aren’t already active. | [] | [
"Account Lifecycle Events",
"Configuring Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-activate.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-activate.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Activate Account Lifecycle Events
The Account Lifecycle Events (com.sn\_acct\_lc) plugin is available as a separate subscription. This plugin activ... | ---
title: Activate Account Lifecycle Events
description: "The Account Lifecycle Events (com.sn_acct_lc) plugin is available as\
\ a separate subscription. This plugin activates related plugins, if they aren\u2019\
t already active."
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Configuring Account Lifecyc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-backup.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-backup.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-backup.html | vancouver | Run scheduled job to back up staging table | You can take a backup of the data on the staging table at periodic intervals. | [] | [
"Account Lifecycle Events",
"Account Lifecycle Events reference"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-backup.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-backup.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Run scheduled job to back up staging table
You can take a backup of the data on the staging table at periodic intervals.
## Before you begin
Role... | ---
title: Run scheduled job to back up staging table
description: You can take a backup of the data on the staging table at periodic intervals.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Account Lifecycle Events reference
---
The Vancouver release is no longer supported. As such, the product documentation... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-configure-simple.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-configure-simple.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-configure-simple.html | vancouver | Configure simple Account Lifecycle Events playbook tasks | You can configure simple playbook tasks using the Process Automation Designer. | [] | [
"Account Lifecycle Events",
"Configuring Account Lifecycle Events",
"Configure playbook using Process Automation Designer"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-configure-simple.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-configure-simple.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Configure simple Account Lifecycle Events playbook tasks
You can configure simple playbook tasks using the Process Automation Designer.
## Before ... | ---
title: Configure simple Account Lifecycle Events playbook tasks
description: You can configure simple playbook tasks using the Process Automation
Designer.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Configuring Account Lifecycle Events
- Configure playbook using Process Automation Designer
---
The Va... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-create-case.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-create-case.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-create-case.html | vancouver | Create an account onboarding case | When the customer service agent creates an account, an account onboarding case is generated. | [] | [
"Account Lifecycle Events",
"Using Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-create-case.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-create-case.html"><div class="wm">The Vancouver release is no lo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Create an account onboarding case
When the customer service agent creates an account, an account onboarding case is generated.
## Before you begin... | ---
title: Create an account onboarding case
description: When the customer service agent creates an account, an account onboarding
case is generated.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Using Account Lifecycle Events
---
The Vancouver release is no longer supported. As such, the product documenta... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-import-data.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-import-data.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-import-data.html | vancouver | Import data into the Account Lifecycle Events playbook | As part of the Account Lifecycle Events process, you can import, configure, and publish data. | [] | [
"Account Lifecycle Events",
"Using Account Lifecycle Events",
"Using the Account Lifecycle Events playbook"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-import-data.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-import-data.html"><div class="wm">The Vancouver release is no lo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Import data into the Account Lifecycle Events playbook
As part of the Account Lifecycle Events process, you can import, configure, and publish data... | ---
title: Import data into the Account Lifecycle Events playbook
description: As part of the Account Lifecycle Events process, you can import, configure,
and publish data.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Using Account Lifecycle Events
- Using the Account Lifecycle Events playbook
---
The Vanc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-validate-script.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-acct-lifecycle-events/page/product/tmt-account-lifecycle/task/account-lifecycle-validate-script.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-acct-lifecycle-events | product/tmt-account-lifecycle/task/account-lifecycle-validate-script.html | vancouver | Configure the validation script | Use the DataImportValidationConfig script include to configure the validation rules for the staging table. | [] | [
"Account Lifecycle Events",
"Configuring Account Lifecycle Events"
] | <article class="hascomments" data-page="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-validate-script.html" id="bundle:vancouver-acct-lifecycle-events/enus/product/tmt-account-lifecycle/task/account-lifecycle-validate-script.html"><div class="wm">The Vancouver release ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "Account Lifecycle Events",
"topic_id": "product/tmt-account-lifecycle/concept/account-l... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Configure the validation script
Use the `DataImportValidationConfig` script include to configure the validation rules for the staging table.
## Be... | ---
title: Configure the validation script
description: Use the DataImportValidationConfig script include to configure the validation
rules for the staging table.
keywords: []
breadcrumbs:
- Account Lifecycle Events
- Configuring Account Lifecycle Events
---
The Vancouver release is no longer supported. As such, the... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/administer/security/concept/c_OAuthProviderAndScope.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/administer/security/concept/c_OAuthProviderAndScope.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | administer/security/concept/c_OAuthProviderAndScope.html | vancouver | OAuth profiles and scopes | In the OAuth provider scenario, profiles and scopes specify the grant type, authorization type, and level of access. | [
"OAuth",
"provider",
"scope"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Outbound REST authentication",
"Configure a REST message with OAuth",
"Use a third-party OAuth provider"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/administer/security/concept/c_OAuthProviderAndScope.html" id="bundle:vancouver-api-reference/enus/administer/security/concept/c_OAuthProviderAndScope.html"><div class="wm">The Vancouver release is no longer supported. As such, the product docum... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# OAuth profiles and scopes
In the OAuth provider scenario, profiles and scopes specify the grant type,
authorization type, and level of access.
In ... | ---
title: OAuth profiles and scopes
description: In the OAuth provider scenario, profiles and scopes specify the grant
type, authorization type, and level of access.
keywords:
- OAuth
- provider
- scope
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web services
- Outb... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/administer/security/task/t_SpecifyAnOAuthProfile.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/administer/security/task/t_SpecifyAnOAuthProfile.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | administer/security/task/t_SpecifyAnOAuthProfile.html | vancouver | Specify an OAuth profile | An OAuth profile includes the grant type that the third-party OAuth provider needs to obtain access to the restricted resource. | [
"OAuth",
"profile"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Outbound REST authentication",
"Configure a REST message with OAuth",
"Use a third-party OAuth provider",
"OAuth profiles and scopes"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/administer/security/task/t_SpecifyAnOAuthProfile.html" id="bundle:vancouver-api-reference/enus/administer/security/task/t_SpecifyAnOAuthProfile.html"><div class="wm">The Vancouver release is no longer supported. As such, the product documentati... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Specify an OAuth profile
An OAuth profile includes the grant type that
the third-party OAuth provider needs to obtain access to the restricted
reso... | ---
title: Specify an OAuth profile
description: An OAuth profile includes the grant type that the third-party OAuth provider
needs to obtain access to the restricted resource.
keywords:
- OAuth
- profile
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web services
- Out... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/administer/security/task/t_SpecifyAnOAuthScope.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/administer/security/task/t_SpecifyAnOAuthScope.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | administer/security/task/t_SpecifyAnOAuthScope.html | vancouver | Specify an OAuth scope | Specify the OAuth scopes that you get from the provider. Scopes can be any level of access specified by the provider, such as read, write, or any string, including a URL. | [
"OAuth",
"scope"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Outbound REST authentication",
"Configure a REST message with OAuth",
"Use a third-party OAuth provider",
"OAuth profiles and scopes"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/administer/security/task/t_SpecifyAnOAuthScope.html" id="bundle:vancouver-api-reference/enus/administer/security/task/t_SpecifyAnOAuthScope.html"><div class="wm">The Vancouver release is no longer supported. As such, the product documentation a... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Specify an OAuth scope
Specify the OAuth scopes that you get from the provider. Scopes can be any level of
access specified by the provider, such a... | ---
title: Specify an OAuth scope
description: Specify the OAuth scopes that you get from the provider. Scopes can be
any level of access specified by the provider, such as read, write, or any string,
including a URL.
keywords:
- OAuth
- scope
breadcrumbs:
- API implementation and reference
- API implementation
- W... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/administer/security/task/t_UseAThirdPartyOAuthProvider.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/administer/security/task/t_UseAThirdPartyOAuthProvider.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | administer/security/task/t_UseAThirdPartyOAuthProvider.html | vancouver | Use a third-party OAuth provider | Each client application must register with the instance to participate in OAuth authorization. | [
"OAuth",
"third-party provider scenario"
] | [
"API implementation and reference",
"API implementation",
"Web services",
"Outbound web services",
"Outbound REST web service",
"Outbound REST authentication",
"Configure a REST message with OAuth"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/administer/security/task/t_UseAThirdPartyOAuthProvider.html" id="bundle:vancouver-api-reference/enus/administer/security/task/t_UseAThirdPartyOAuthProvider.html"><div class="wm">The Vancouver release is no longer supported. As such, the product... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Use a third-party OAuth provider
Each client application must register with the instance to participate in OAuth
authorization.
## Before you begi... | ---
title: Use a third-party OAuth provider
description: Each client application must register with the instance to participate
in OAuth authorization.
keywords:
- OAuth
- third-party provider scenario
breadcrumbs:
- API implementation and reference
- API implementation
- Web services
- Outbound web services
- Outbou... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/APCHandler/concept/c_APCHandlerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/APCHandler/concept/c_APCHandlerAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/APCHandler/concept/c_APCHandlerAPI.html | vancouver | APCHandler - Global | Handles SNMP classification and identification for UPSs, environmental monitors, and PDUs made by APC. | [
"APCHandler API",
"APCHandler",
"classifyAndIdentify()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/APCHandler/concept/c_APCHandlerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/APCHandler/concept/c_APCHandlerAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# APCHandler - Global
Handles SNMP classification and identification for UPSs, environmental monitors, and
PDUs made by APC.
Use this API for SNMP c... | ---
title: APCHandler - Global
description: Handles SNMP classification and identification for UPSs, environmental
monitors, and PDUs made by APC.
keywords:
- APCHandler API
- APCHandler
- classifyAndIdentify()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractDBObject/concept/c_AbstractDBObject.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractDBObject/concept/c_AbstractDBObject.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AbstractDBObject/concept/c_AbstractDBObject.html | vancouver | AbstractDBObject - Global | The AbstractDBObject API provides common methods for classes based on records in the database. | [
"AbstractDBObject API",
"AbstractDBObject",
"isValid()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractDBObject/concept/c_AbstractDBObject.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractDBObject/concept/c_AbstractDBObject.html"><div class="wm">The Vancouver rele... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AbstractDBObject - Global
The AbstractDBObject API provides common methods for classes based on
records in the database.
Use this script include a... | ---
title: AbstractDBObject - Global
description: The AbstractDBObject API provides common methods for classes based on
records in the database.
keywords:
- AbstractDBObject API
- AbstractDBObject
- isValid()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver rel... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractReconciler/concept/c_AbstractReconciler.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractReconciler/concept/c_AbstractReconciler.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AbstractReconciler/concept/c_AbstractReconciler.html | vancouver | AbstractReconciler - Global | Use this script include as a base class to create your own Discovery reconciler. | [
"AbstractReconciler API",
"AbstractReconciler",
"getReconciliationField()",
"getReconciliationKey()",
"hasChanged()",
"markAbsent()",
"markPresent()",
"process()",
"readDatabaseFields()",
"readDiscovered()",
"resolveReferenceFields()",
"setDatabaseFields()",
"setup()",
"track(String sys_id... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractReconciler/concept/c_AbstractReconciler.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractReconciler/concept/c_AbstractReconciler.html"><div class="wm">The Vancou... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AbstractReconciler - Global
Use this script include as a base class to create your own Discovery
reconciler.
This is an abstract base class for re... | ---
title: AbstractReconciler - Global
description: Use this script include as a base class to create your own Discovery
reconciler.
keywords:
- AbstractReconciler API
- AbstractReconciler
- getReconciliationField()
- getReconciliationKey()
- hasChanged()
- markAbsent()
- markPresent()
- process()
- readDatabaseField... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractScriptProcessor/concept/c_AbstractScriptProcessorAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractScriptProcessor/concept/c_AbstractScriptProcessorAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AbstractScriptProcessor/concept/c_AbstractScriptProcessorAPI.html | vancouver | AbstractScriptProcessor - Global | The AbstractScriptProcessor API is a base JavaScript processor class that other JavaScript processors extend. | [
"AbstractScriptProcessor API",
"AbstractScriptProcessor",
"initialize(String request",
"String response",
"String process)",
"process()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractScriptProcessor/concept/c_AbstractScriptProcessorAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractScriptProcessor/concept/c_AbstractScriptProcessorAPI.html">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AbstractScriptProcessor - Global
The AbstractScriptProcessor API is a base JavaScript processor class
that other JavaScript processors extend.
Ext... | ---
title: AbstractScriptProcessor - Global
description: The AbstractScriptProcessor API is a base JavaScript processor class
that other JavaScript processors extend.
keywords:
- AbstractScriptProcessor API
- AbstractScriptProcessor
- initialize(String request
- String response
- String process)
- process()
breadcrum... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractTimelineSchedulePage/concept/c_AbstractTimelineSchedulePage.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AbstractTimelineSchedulePage/concept/c_AbstractTimelineSchedulePage.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AbstractTimelineSchedulePage/concept/c_AbstractTimelineSchedulePage.html | vancouver | AbstractTimeLineSchedulePage - Global | The AbstractTimeLineSchedulePage API is a helper class to facilitate working with the data displayed on timelines. | [
"put the class name here",
"GlideElement",
"Scoped GlideElement",
"AbstractTimelineSchedulePage",
"add()",
"addSeparator()",
"elementMoveX()",
"elementMoveY()",
"elementMoveXY()",
"elementSuccessor()",
"elementTimeAdjustStart()",
"elementTimeAdjustEnd()",
"getItems()",
"inputBox()",
"ite... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractTimelineSchedulePage/concept/c_AbstractTimelineSchedulePage.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AbstractTimelineSchedulePage/concept/c_AbstractTimelineSched... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AbstractTimeLineSchedulePage - Global
The AbstractTimeLineSchedulePage API is a helper class to facilitate
working with the data displayed on timel... | ---
title: AbstractTimeLineSchedulePage - Global
description: The AbstractTimeLineSchedulePage API is a helper class to facilitate
working with the data displayed on timelines.
keywords:
- put the class name here
- GlideElement
- Scoped GlideElement
- AbstractTimelineSchedulePage
- add()
- addSeparator()
- elementMov... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AccAgentsAPI/concept/AccAgentsAPIAPIScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AccAgentsAPI/concept/AccAgentsAPIAPIScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AccAgentsAPI/concept/AccAgentsAPIAPIScoped.html | vancouver | AccAgentsAPI - Scoped | The AccAgentsAPI script include enables you to perform management actions on available agents. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AccAgentsAPI/concept/AccAgentsAPIAPIScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AccAgentsAPI/concept/AccAgentsAPIAPIScoped.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AccAgentsAPI - Scoped
The AccAgentsAPI script include enables you to perform management
actions on available agents.
This script include requires ... | ---
title: AccAgentsAPI - Scoped
description: The AccAgentsAPI script include enables you to perform management actions
on available agents.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product docum... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AccCheckDefsAPI/concept/AccCheckDefsAPIAPIScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AccCheckDefsAPI/concept/AccCheckDefsAPIAPIScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AccCheckDefsAPI/concept/AccCheckDefsAPIAPIScoped.html | vancouver | AccCheckDefsAPI - Scoped | The AccCheckDefsAPI script include enables managing check definitions and associated parameters. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AccCheckDefsAPI/concept/AccCheckDefsAPIAPIScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AccCheckDefsAPI/concept/AccCheckDefsAPIAPIScoped.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AccCheckDefsAPI - Scoped
The AccCheckDefsAPI script include enables managing check
definitions and associated parameters.
This script include requ... | ---
title: AccCheckDefsAPI - Scoped
description: The AccCheckDefsAPI script include enables managing check definitions
and associated parameters.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Action/concept/ActionAPIBoth.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Action/concept/ActionAPIBoth.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Action/concept/ActionAPIBoth.html | vancouver | action - Scoped, Global | The action API enables handling data for URLs in a UI action script. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Action/concept/ActionAPIBoth.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Action/concept/ActionAPIBoth.html"><div class="wm">The Vancouver release is no longer supported. As... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# action - Scoped, Global
The action API enables handling data for URLs in a UI action
script.
Use the action API to configure UI actions with which... | ---
title: action - Scoped, Global
description: The action API enables handling data for URLs in a UI action script.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ActivityHistoryRecord/concept/c_ActivityHistoryRecordAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ActivityHistoryRecord/concept/c_ActivityHistoryRecordAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ActivityHistoryRecord/concept/c_ActivityHistoryRecordAPI.html | vancouver | ActivityHistoryRecord - Global | A data object that is a member of the WorkflowModelManager class; ActivityHistoryRecord methods facilitate interacting with the WorkflowModelManager object. | [
"ActivityHistoryRecord",
"GlideElement",
"Scoped GlideElement",
"addArrivedActivityToJoin()",
"addJoinFromActivityIds()",
"addTransition()",
"debugDump()",
"doesJoinContainActivity()",
"getLogString()",
"getSatisfiedJoinActivities()",
"getTransitionCount()",
"getUnSatisfiedJoinActivities()",
... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ActivityHistoryRecord/concept/c_ActivityHistoryRecordAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ActivityHistoryRecord/concept/c_ActivityHistoryRecordAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ActivityHistoryRecord - Global
A data object that is a member of the WorkflowModelManager class;
ActivityHistoryRecord methods facilitate interacti... | ---
title: ActivityHistoryRecord - Global
description: A data object that is a member of the WorkflowModelManager class; ActivityHistoryRecord
methods facilitate interacting with the WorkflowModelManager object.
keywords:
- ActivityHistoryRecord
- GlideElement
- Scoped GlideElement
- addArrivedActivityToJoin()
- addJ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Agent/concept/c_AgentAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Agent/concept/c_AgentAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Agent/concept/c_AgentAPI.html | vancouver | Agent - Global | Provides methods for getting or setting agent presence and channel availability. | [
"Agent",
"Advanced Work Assignment (AWA)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Agent/concept/c_AgentAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Agent/concept/c_AgentAPI.html"><div class="wm">The Vancouver release is no longer supported. As such, t... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Agent - Global
Provides methods for getting or setting agent presence and channel
availability.
The Agent API is provided within the sn\_awa
names... | ---
title: Agent - Global
description: Provides methods for getting or setting agent presence and channel availability.
keywords:
- Agent
- Advanced Work Assignment (AWA)
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, th... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AgentMetrics/concept/c_AgentMetricsAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AgentMetrics/concept/c_AgentMetricsAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AgentMetrics/concept/c_AgentMetricsAPI.html | vancouver | AgentMetrics - Global | Processes inbound MID server metrics. | [
"AgentMetrics API",
"AgentMetrics",
"AgentMetrics()",
"handleCounter(String metric",
"String name",
"String midId)",
"handleMemory(String metric",
"String name",
"String midId)",
"handleRGR(String metric",
"String name",
"String midId)",
"handleScalar(String metric",
"String name",
"Stri... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AgentMetrics/concept/c_AgentMetricsAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AgentMetrics/concept/c_AgentMetricsAPI.html"><div class="wm">The Vancouver release is no ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AgentMetrics - Global
Processes inbound MID server metrics.
Updates these tables.
* ECC Agent Counter Metric
* ECC Agent Memory Metric
* ECC Agen... | ---
title: AgentMetrics - Global
description: Processes inbound MID server metrics.
keywords:
- AgentMetrics API
- AgentMetrics
- AgentMetrics()
- handleCounter(String metric
- String name
- String midId)
- handleMemory(String metric
- String name
- String midId)
- handleRGR(String metric
- String name
- String midId)
... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AgentNowHandler/concept/AgentNowHandlerAPIScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AgentNowHandler/concept/AgentNowHandlerAPIScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AgentNowHandler/concept/AgentNowHandlerAPIScoped.html | vancouver | AgentNowHandler - Scoped | The AgentNowHandler script include enables running check definitions on demand, checking the status of on demand executions and test check executions and for stopping background checks that were executed on demand. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AgentNowHandler/concept/AgentNowHandlerAPIScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AgentNowHandler/concept/AgentNowHandlerAPIScoped.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AgentNowHandler - Scoped
The AgentNowHandler script include enables running check definitions
on demand, checking the status of on demand execution... | ---
title: AgentNowHandler - Scoped
description: The AgentNowHandler script include enables running check definitions
on demand, checking the status of on demand executions and test check executions
and for stopping background checks that were executed on demand.
keywords: []
breadcrumbs:
- API implementation and r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ApcPduOutletReconciler/concept/c_ApcPduOutletReconcilerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ApcPduOutletReconciler/concept/c_ApcPduOutletReconcilerAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ApcPduOutletReconciler/concept/c_ApcPduOutletReconcilerAPI.html | vancouver | ApcPduOutletReconciler - Global | Reconciles outlets for power distribution units. | [
"ApcPduOutletReconciler API",
"ApcPduOutletReconciler",
"getReconcilationField()",
"getReconcilationKey()",
"hasChanged()",
"readDatabaseFields()",
"readDiscovered()",
"setDatabaseFields()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ApcPduOutletReconciler/concept/c_ApcPduOutletReconcilerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ApcPduOutletReconciler/concept/c_ApcPduOutletReconcilerAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ApcPduOutletReconciler - Global
Reconciles outlets for power distribution units.
Use this API for SNMP-related discovery.
## ApcPduOutletReconcil... | ---
title: ApcPduOutletReconciler - Global
description: Reconciles outlets for power distribution units.
keywords:
- ApcPduOutletReconciler API
- ApcPduOutletReconciler
- getReconcilationField()
- getReconcilationKey()
- hasChanged()
- readDatabaseFields()
- readDiscovered()
- setDatabaseFields()
breadcrumbs:
- API imp... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ArrayUtil/concept/c_ArrayUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ArrayUtil/concept/c_ArrayUtilAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ArrayUtil/concept/c_ArrayUtilAPI.html | vancouver | ArrayUtil - Global | The ArrayUtil API is a script include with useful functions for working with JavaScript arrays. | [
"ArrayUtil API",
"ArrayUtil",
"concat(Array parent",
"Array child)",
"contains(Array array",
"Object element)",
"convertArray(Object a)",
"diff(Array a",
"Array b)",
"ensureArray(Object object)",
"indexOf(Array array",
"Object element)",
"indexOf(Array array",
"Object element",
"Number s... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ArrayUtil/concept/c_ArrayUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ArrayUtil/concept/c_ArrayUtilAPI.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ArrayUtil - Global
The ArrayUtil API is a script include with useful functions for
working with JavaScript arrays.
These methods are available to ... | ---
title: ArrayUtil - Global
description: The ArrayUtil API is a script include with useful functions for working
with JavaScript arrays.
keywords:
- ArrayUtil API
- ArrayUtil
- concat(Array parent
- Array child)
- contains(Array array
- Object element)
- convertArray(Object a)
- diff(Array a
- Array b)
- ensureArra... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AssessmentCreation/concept/c_AssessmentCreation.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AssessmentCreation/concept/c_AssessmentCreation.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AssessmentCreation/concept/c_AssessmentCreation.html | vancouver | AssessmentCreation - Global | The AssessmentCreation class provides methods that administrators can use to generate assessments and surveys. | [
"AssessmentCreation API",
"AssessmentCreation",
"createAssessments()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AssessmentCreation/concept/c_AssessmentCreation.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AssessmentCreation/concept/c_AssessmentCreation.html"><div class="wm">The Vancou... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AssessmentCreation - Global
The AssessmentCreation class provides methods that administrators
can use to generate assessments and surveys.
There a... | ---
title: AssessmentCreation - Global
description: The AssessmentCreation class provides methods that administrators can
use to generate assessments and surveys.
keywords:
- AssessmentCreation API
- AssessmentCreation
- createAssessments()
breadcrumbs:
- API implementation and reference
- API reference
- Server API ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AuthCredential/concept/AuthCredentialAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AuthCredential/concept/AuthCredentialAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AuthCredential/concept/AuthCredentialAPI.html | vancouver | AuthCredential - Scoped | The AuthCredential() API provides methods that enable you to build credentials for a REST request. | [
"AuthCredential",
"Get authorization credentials",
"Set authorization credentials"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AuthCredential/concept/AuthCredentialAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AuthCredential/concept/AuthCredentialAPI.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AuthCredential - Scoped
The AuthCredential() API provides methods that enable you to build
credentials for a REST request.
Generate outbound signi... | ---
title: AuthCredential - Scoped
description: The AuthCredential() API provides methods that enable you to build credentials
for a REST request.
keywords:
- AuthCredential
- Get authorization credentials
- Set authorization credentials
breadcrumbs:
- API implementation and reference
- API reference
- Server API ref... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AutomationException/concept/c_AutomationException.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/AutomationException/concept/c_AutomationException.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/AutomationException/concept/c_AutomationException.html | vancouver | AutomationException - Global | The AutomationException API provides generic exception wrapping for automation. | [
"AutomationException",
"getMessage()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AutomationException/concept/c_AutomationException.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/AutomationException/concept/c_AutomationException.html"><div class="wm">The Va... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# AutomationException - Global
The AutomationException API provides generic exception wrapping for
automation.
Include this in automation code to im... | ---
title: AutomationException - Global
description: The AutomationException API provides generic exception wrapping for automation.
keywords:
- AutomationException
- getMessage()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/BusinessServiceManager/concept/BusinessServiceManagerAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/BusinessServiceManager/concept/BusinessServiceManagerAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/BusinessServiceManager/concept/BusinessServiceManagerAPI.html | vancouver | BusinessServiceManager - Global | The BusinessServiceManager API unifies service management by converting manually-created services to application services, populating application services, and adding/removing Configuration Items and connections. | [
"BusinessServiceManager",
"BusinessServiceManager",
"BusinessServiceManager()",
"addCI(String service_id",
"String source_ci",
"String target_ci)",
"addManualConnection(String target_id",
"Object manualEndpoint",
"String bs_id)",
"migrateManualToApplicationService(String sys_id)",
"populateAppli... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/BusinessServiceManager/concept/BusinessServiceManagerAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/BusinessServiceManager/concept/BusinessServiceManagerAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# BusinessServiceManager - Global
The BusinessServiceManager API unifies service management by
converting manually-created services to application se... | ---
title: BusinessServiceManager - Global
description: The BusinessServiceManager API unifies service management by converting
manually-created services to application services, populating application services,
and adding/removing Configuration Items and connections.
keywords:
- BusinessServiceManager
- BusinessSe... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIAction/concept/CIActionScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIAction/concept/CIActionScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIAction/concept/CIActionScopedAPI.html | vancouver | CIActionEngine - Scoped | The CIActionEngine API allows you to execute any action on a CI, to check the authorization of a user before executing an action, and to get the status and action outputs of any action execution request. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIAction/concept/CIActionScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIAction/concept/CIActionScopedAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIActionEngine - Scoped
The CIActionEngine API allows you to execute any action on a CI, to check the authorization of a user before executing an a... | ---
title: CIActionEngine - Scoped
description: The CIActionEngine API allows you to execute any action on a CI, to check
the authorization of a user before executing an action, and to get the status and
action outputs of any action execution request.
keywords: []
breadcrumbs:
- API implementation and reference
- A... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIData/concept/c_CIDataAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIData/concept/c_CIDataAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIData/concept/c_CIDataAPI.html | vancouver | CIData - Global | Utility class for working with CI data structures in JavaScript. | [
"CIData API",
"CIData",
"addRelatedList(Array relatedList)",
"CIData(String debugFlag)",
"convertRelatedList(String sensor",
"String tableName",
"String refField",
"String keyName)",
"fromXML(String xml)",
"getData()",
"getM2MTable(String table",
"String refField)",
"getRelatedList(String ta... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIData/concept/c_CIDataAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIData/concept/c_CIDataAPI.html"><div class="wm">The Vancouver release is no longer supported. As suc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIData - Global
Utility class for working with CI data structures in JavaScript.
The CIData API requires the Discovery
(com.snc.discovery.core) pl... | ---
title: CIData - Global
description: Utility class for working with CI data structures in JavaScript.
keywords:
- CIData API
- CIData
- addRelatedList(Array relatedList)
- CIData(String debugFlag)
- convertRelatedList(String sensor
- String tableName
- String refField
- String keyName)
- fromXML(String xml)
- getDat... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIIdentification/concept/c_CIIdentificationAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIIdentification/concept/c_CIIdentificationAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIIdentification/concept/c_CIIdentificationAPI.html | vancouver | CIIdentification - Global | Main class for discovery CI identification. | [
"CIIdentification API",
"CIIdentification",
"CIIdentification(String ciData",
"String logger)",
"debug(String msg)",
"process()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIIdentification/concept/c_CIIdentificationAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIIdentification/concept/c_CIIdentificationAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIIdentification - Global
Main class for discovery CI identification.
Use this with any server-side discovery script for CI identification.
## CI... | ---
title: CIIdentification - Global
description: Main class for discovery CI identification.
keywords:
- CIIdentification API
- CIIdentification
- CIIdentification(String ciData
- String logger)
- debug(String msg)
- process()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIIdentifierResult/concept/c_CIIdentifierResultAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIIdentifierResult/concept/c_CIIdentifierResultAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIIdentifierResult/concept/c_CIIdentifierResultAPI.html | vancouver | CIIdentifierResult - Global | Gets the result returned by an identifier. | [
"CIIdentifierResult API",
"CIIdentifierResult",
"CIIdentifierResult(Array matched",
"Boolean matchable",
"Boolean terminatedChain)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIIdentifierResult/concept/c_CIIdentifierResultAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIIdentifierResult/concept/c_CIIdentifierResultAPI.html"><div class="wm">The ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIIdentifierResult - Global
Gets the result returned by an identifier.
Use with any server-side discovery script.
## CIIdentifierResult - CIIdent... | ---
title: CIIdentifierResult - Global
description: Gets the result returned by an identifier.
keywords:
- CIIdentifierResult API
- CIIdentifierResult
- CIIdentifierResult(Array matched
- Boolean matchable
- Boolean terminatedChain)
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIRelatedList/concept/c_CIRelatedListAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIRelatedList/concept/c_CIRelatedListAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIRelatedList/concept/c_CIRelatedListAPI.html | vancouver | CIRelatedList - Global | The CIRelatedList API is a utility class for working with CI Related lists. | [
"CIRelatedList API",
"CIRelatedList",
"addRec(String record)",
"addRecs(String records)",
"appendXMLChildFld(String parent",
"String name",
"String datum)",
"appendXMLChildRecord(String parent",
"String name",
"String record)",
"checkSysCollection()",
"checkSysM2M()",
"CIRelatedList(String t... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIRelatedList/concept/c_CIRelatedListAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIRelatedList/concept/c_CIRelatedListAPI.html"><div class="wm">The Vancouver release is... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIRelatedList - Global
The CIRelatedList API is a utility class for working with CI Related
lists.
Each instance of this class contains the detail... | ---
title: CIRelatedList - Global
description: The CIRelatedList API is a utility class for working with CI Related
lists.
keywords:
- CIRelatedList API
- CIRelatedList
- addRec(String record)
- addRecs(String records)
- appendXMLChildFld(String parent
- String name
- String datum)
- appendXMLChildRecord(String paren... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIUtils/concept/c_CIUtilsAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CIUtils/concept/c_CIUtilsAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CIUtils/concept/c_CIUtilsAPI.html | vancouver | CIUtils - Global | The CIUtils script include is a utility class for working with configuration items (CI). | [
"CIUtils API",
"CIUtils",
"servicesAffectedByCI(String CI_sys_id)",
"servicesAffectedByTask(GlideRecord task)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIUtils/concept/c_CIUtilsAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CIUtils/concept/c_CIUtilsAPI.html"><div class="wm">The Vancouver release is no longer supported. As... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CIUtils - Global
The CIUtils script include is a utility class for working with
configuration items (CI).
By default, when traversing CI relations... | ---
title: CIUtils - Global
description: The CIUtils script include is a utility class for working with configuration
items (CI).
keywords:
- CIUtils API
- CIUtils
- servicesAffectedByCI(String CI_sys_id)
- servicesAffectedByTask(GlideRecord task)
breadcrumbs:
- API implementation and reference
- API reference
- Serv... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBDuplicateTaskUtilsAPI/concept/CMDBDuplicateTaskUtilsAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBDuplicateTaskUtilsAPI/concept/CMDBDuplicateTaskUtilsAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBDuplicateTaskUtilsAPI/concept/CMDBDuplicateTaskUtilsAPI.html | vancouver | CMDBDuplicateTaskUtils - Global | The CMDBDuplicateTaskUtils API provides methods to create a de-duplication task that contains duplicate configuration items (CIs) that are of independent type. | [
"CMDBDuplicateTaskUtils",
"CMDBDuplicateTaskUtils",
"CMDBDuplicateTaskUtils()",
"createDuplicateTask( String sysIDs)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBDuplicateTaskUtilsAPI/concept/CMDBDuplicateTaskUtilsAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBDuplicateTaskUtilsAPI/concept/CMDBDuplicateTaskUtilsAPI.html"><d... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBDuplicateTaskUtils - Global
The CMDBDuplicateTaskUtils API provides methods to create a
de-duplication task that contains duplicate configurati... | ---
title: CMDBDuplicateTaskUtils - Global
description: The CMDBDuplicateTaskUtils API provides methods to create a de-duplication
task that contains duplicate configuration items (CIs) that are of independent type.
keywords:
- CMDBDuplicateTaskUtils
- CMDBDuplicateTaskUtils
- CMDBDuplicateTaskUtils()
- createDuplica... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBDuplicateTemplateUtils/concept/CMDBDuplicateTemplateUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBDuplicateTemplateUtils/concept/CMDBDuplicateTemplateUtilAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBDuplicateTemplateUtils/concept/CMDBDuplicateTemplateUtilAPI.html | vancouver | CMDBDuplicateTemplateUtil - Global | The CMDBDuplicateTemplateUtil script include provides methods to add and remove de-duplication tasks to/from a de-duplication template. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBDuplicateTemplateUtils/concept/CMDBDuplicateTemplateUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBDuplicateTemplateUtils/concept/CMDBDuplicateTemplateUtilAPI.... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBDuplicateTemplateUtil - Global
The CMDBDuplicateTemplateUtil script include provides methods to add and remove de-duplication tasks to/from a d... | ---
title: CMDBDuplicateTemplateUtil - Global
description: The CMDBDuplicateTemplateUtil script include provides methods to add
and remove de-duplication tasks to/from a de-duplication template.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver rele... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBGroupAPIScoped/concept/c_CMDBGroupAPIScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBGroupAPIScoped/concept/c_CMDBGroupAPIScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBGroupAPIScoped/concept/c_CMDBGroupAPIScoped.html | vancouver | CMDBGroupAPI - Scoped | The CMDBGroupAPI provides methods for performing actions on Configuration Management Database (CMDB) groups. | [
"Scoped CMDBGroupAPI",
"CMDBGroupAPI",
"getAllCI( String groupId",
"Boolean requireCompleteSet)",
"getAllCIFromQueryBuilder(String groupId",
"Boolean requireCompleteSet)",
"getManualCIList(String groupId",
"Boolean requireCompleteSet)",
"getSavedQueryIdList(String groupId",
"Boolean requireComplet... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBGroupAPIScoped/concept/c_CMDBGroupAPIScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBGroupAPIScoped/concept/c_CMDBGroupAPIScoped.html"><div class="wm">The Vancou... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBGroupAPI - Scoped
The CMDBGroupAPI provides methods for performing actions on Configuration Management Database (CMDB) groups.
This API is a s... | ---
title: CMDBGroupAPI - Scoped
description: The CMDBGroupAPI provides methods for performing actions on Configuration
Management Database (CMDB) groups.
keywords:
- Scoped CMDBGroupAPI
- CMDBGroupAPI
- getAllCI( String groupId
- Boolean requireCompleteSet)
- getAllCIFromQueryBuilder(String groupId
- Boolean require... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBQueryBuilderAPI/concept/CMDBQueryBuilderAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBQueryBuilderAPI/concept/CMDBQueryBuilderAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBQueryBuilderAPI/concept/CMDBQueryBuilderAPI.html | vancouver | CMDBQueryBuilderAPI - Global | The CMDBQueryBuilderAPI provides methods to retrieve Query Builder saved query execution details in server-side scripts. | [
"CMDB Query Builder",
"CMDBQueryBuilderAPI",
"Query Builder",
"CMDBQueryBuilderAPI",
"getSavedQueryExecutionDetails(String savedQueryName",
"Boolean executeQuery)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBQueryBuilderAPI/concept/CMDBQueryBuilderAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBQueryBuilderAPI/concept/CMDBQueryBuilderAPI.html"><div class="wm">The Vancou... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBQueryBuilderAPI - Global
The CMDBQueryBuilderAPI provides methods to retrieve Query Builder
saved query execution details in server-side script... | ---
title: CMDBQueryBuilderAPI - Global
description: The CMDBQueryBuilderAPI provides methods to retrieve Query Builder saved
query execution details in server-side scripts.
keywords:
- CMDB Query Builder
- CMDBQueryBuilderAPI
- Query Builder
- CMDBQueryBuilderAPI
- getSavedQueryExecutionDetails(String savedQueryName... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBTransformUtil/concept/c_CMDBTransformUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBTransformUtil/concept/c_CMDBTransformUtilAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBTransformUtil/concept/c_CMDBTransformUtilAPI.html | vancouver | CMDBTransformUtil - Global | The CMDBTransformUtil class uses the Identification and Reconciliation (IRE) framework to minimize the creation of duplicate configuration items (CI). | [
"CMDBTransformUtil",
"CMDBTransformUtil()",
"CMDBTransformUtil",
"getError()",
"getOutputPayload()",
"getOutputRecordSysId()",
"hasError()",
"identifyAndReconcile (Object source",
"Object map",
"Object log)",
"logTransformStats( Object log)",
"CMDBTransformUtil -",
"setDataSource(String sour... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBTransformUtil/concept/c_CMDBTransformUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBTransformUtil/concept/c_CMDBTransformUtilAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBTransformUtil - Global
The CMDBTransformUtil class uses the Identification and
Reconciliation (IRE) framework to minimize the creation of dupli... | ---
title: CMDBTransformUtil - Global
description: The CMDBTransformUtil class uses the Identification and Reconciliation
(IRE) framework to minimize the creation of duplicate configuration items (CI).
keywords:
- CMDBTransformUtil
- CMDBTransformUtil()
- CMDBTransformUtil
- getError()
- getOutputPayload()
- getOutpu... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBUtil/concept/c_CMDBUtilAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CMDBUtil/concept/c_CMDBUtilAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CMDBUtil/concept/c_CMDBUtilAPI.html | vancouver | CMDBUtil - Global | The CMDBUtil API provides utility methods for creating and managing table relationships in the Configuration Management Database (CMDB) and managing CMDB baselines. | [
"CMDBUtil API",
"CMDBUtil",
"baselineProposedChangesApplyChanges(GlideRecord proposedChanges)",
"baselineProposedChangesGenDiff(GlideRecord current",
"String changeSet)",
"bootstrap(String dictFile)",
"createCIRelationship(String tableName",
"String parent",
"String child",
"String parentField",
... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBUtil/concept/c_CMDBUtilAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CMDBUtil/concept/c_CMDBUtilAPI.html"><div class="wm">The Vancouver release is no longer supported... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CMDBUtil - Global
The CMDBUtil API provides utility methods for creating and managing
table relationships in the Configuration Management Database ... | ---
title: CMDBUtil - Global
description: The CMDBUtil API provides utility methods for creating and managing table
relationships in the Configuration Management Database (CMDB) and managing CMDB
baselines.
keywords:
- CMDBUtil API
- CMDBUtil
- baselineProposedChangesApplyChanges(GlideRecord proposedChanges)
- base... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CSBScratchpadUtil/concept/CSBScratchpadUtilScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CSBScratchpadUtil/concept/CSBScratchpadUtilScopedAPI.html | 2025-04-03 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CSBScratchpadUtil/concept/CSBScratchpadUtilScopedAPI.html | vancouver | CSBScratchpadUtil - Scoped | The CSBScratchpadUtil API allows consumers to share "extra" information that is outside of any other Service Bridge service, with their providers. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CSBScratchpadUtil/concept/CSBScratchpadUtilScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CSBScratchpadUtil/concept/CSBScratchpadUtilScopedAPI.html"><div class="wm">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"enus"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implementation-reference.html"
},
{
"title": "API refe... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CSBScratchpadUtil - Scoped
The CSBScratchpadUtil API allows consumers to share "extra" information that is outside of any other Service Bridge serv... | ---
title: CSBScratchpadUtil - Scoped
description: The CSBScratchpadUtil API allows consumers to share "extra" information
that is outside of any other Service Bridge service, with their providers.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CSVParserScoped/concept/CSVParserScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CSVParserScoped/concept/CSVParserScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CSVParserScoped/concept/CSVParserScopedAPI.html | vancouver | CSVParser - Scoped | The CSVParser API provides methods for parsing comma-separated value (CSV) formatted records into an object or an array. | [
"CSVParser",
"parsing CSV records",
"comma separated value parser",
"CSVParser",
"parseLineToArray(String cvsLine",
"String delimiter",
"String quoteCharacter)",
"parseLineToObject(String cvsLine",
"Array headers",
"String delimiter",
"String quoteCharacter)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CSVParserScoped/concept/CSVParserScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CSVParserScoped/concept/CSVParserScopedAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CSVParser - Scoped
The CSVParser API provides methods for parsing comma-separated value (CSV) formatted records into an object or an array.
This A... | ---
title: CSVParser - Scoped
description: The CSVParser API provides methods for parsing comma-separated value
(CSV) formatted records into an object or an array.
keywords:
- CSVParser
- parsing CSV records
- comma separated value parser
- CSVParser
- parseLineToArray(String cvsLine
- String delimiter
- String quote... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CTIOperationRequest/concept/CTIOperationRequestAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CTIOperationRequest/concept/CTIOperationRequestAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CTIOperationRequest/concept/CTIOperationRequestAPI.html | vancouver | CTIOperationRequest - Scoped, Global | The CTIOperationRequest API provides methods to set and get data on the current CTIOperationRequest object. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CTIOperationRequest/concept/CTIOperationRequestAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CTIOperationRequest/concept/CTIOperationRequestAPI.html"><div class="wm">The ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CTIOperationRequest - Scoped, Global
The CTIOperationRequest API provides methods to set and get data on
the current CTIOperationRequest object.
Y... | ---
title: CTIOperationRequest - Scoped, Global
description: The CTIOperationRequest API provides methods to set and get data on the
current CTIOperationRequest object.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CTIOperationResponse/concept/CTIOperationResponseAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CTIOperationResponse/concept/CTIOperationResponseAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CTIOperationResponse/concept/CTIOperationResponseAPI.html | vancouver | CTIOperationResponse - Scoped, Global | The CTIOperationResponse API provides methods to set and get data on the current CTIOperationResponse object. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CTIOperationResponse/concept/CTIOperationResponseAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CTIOperationResponse/concept/CTIOperationResponseAPI.html"><div class="wm">... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CTIOperationResponse - Scoped, Global
The CTIOperationResponse API provides methods to set and get data on
the current CTIOperationResponse object.... | ---
title: CTIOperationResponse - Scoped, Global
description: The CTIOperationResponse API provides methods to set and get data on
the current CTIOperationResponse object.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer suppor... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Cabrillo-client/concept/cabrillo-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Cabrillo-client/concept/cabrillo-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Cabrillo-client/concept/cabrillo-namespace.html | vancouver | cabrillo - Client | Cabrillo JS is a client side JavaScript API for accessing capabilities inside ServiceNow native mobile applications. | [
"Cabrillo",
"Cabrillo",
"isNative()"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Cabrillo-client/concept/cabrillo-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Cabrillo-client/concept/cabrillo-namespace.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo - Client
Cabrillo JS is a client
side JavaScript API for accessing capabilities inside ServiceNow native mobile
applications.
Use Cabrill... | ---
title: cabrillo - Client
description: Cabrillo JS is a client side JavaScript API for accessing capabilities
inside ServiceNow native mobile applications.
keywords:
- Cabrillo
- Cabrillo
- isNative()
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vancouver r... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloAttachments-client/concept/cabrillo-attachments-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloAttachments-client/concept/cabrillo-attachments-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloAttachments-client/concept/cabrillo-attachments-namespace.html | vancouver | cabrillo.attachments - Client | The name space for Cabrillo JS attachment functions. This enables adding and viewing attachments. | [
"cabrillo.attachments",
"cabrillo.attachments",
"addFile(String tableName",
"String sysId",
"Object params",
"String options)",
"viewFile(Cabrillo.Attachment attachment",
"Cabrillo.Rect sourceRect",
"String sourceBase64Image)"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloAttachments-client/concept/cabrillo-attachments-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloAttachments-client/concept/cabrillo-attachments-namesp... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.attachments - Client
The name space for Cabrillo JS attachment
functions. This enables adding and viewing attachments.
## cabrillo.attach... | ---
title: cabrillo.attachments - Client
description: The name space for Cabrillo JS attachment functions. This enables adding
and viewing attachments.
keywords:
- cabrillo.attachments
- cabrillo.attachments
- addFile(String tableName
- String sysId
- Object params
- String options)
- viewFile(Cabrillo.Attachment att... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloCamera-client/concept/cabrillo-camera-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloCamera-client/concept/cabrillo-camera-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloCamera-client/concept/cabrillo-camera-namespace.html | vancouver | cabrillo.camera - Client | Cabrillo JS camera functions to provide camera access for bar code scanning. | [
"cabrillo.camera",
"cabrillo.camera",
"getBarcode()"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloCamera-client/concept/cabrillo-camera-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloCamera-client/concept/cabrillo-camera-namespace.html"><div class... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.camera - Client
Cabrillo JS
camera functions to provide camera access for bar code scanning.
## cabrillo.camera - getBarcode()
Provides ... | ---
title: cabrillo.camera - Client
description: Cabrillo JS camera functions to provide camera access for bar code scanning.
keywords:
- cabrillo.camera
- cabrillo.camera
- getBarcode()
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vancouver release is no longer... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloFlowControl-client/concept/cabrillo-FC-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloFlowControl-client/concept/cabrillo-FC-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloFlowControl-client/concept/cabrillo-FC-namespace.html | vancouver | cabrillo.flowControl - Client | Cabrillo JS functions for managing the flow of a web view. | [] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloFlowControl-client/concept/cabrillo-FC-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloFlowControl-client/concept/cabrillo-FC-namespace.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.flowControl - Client
Cabrillo JS functions for managing the flow of a web view.
## cabrillo.flowControl - flowEnded(String flowName)
Ind... | ---
title: cabrillo.flowControl - Client
description: Cabrillo JS functions for managing the flow of a web view.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release no... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloMessage-client/concept/cabrillo-messgage-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloMessage-client/concept/cabrillo-messgage-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloMessage-client/concept/cabrillo-messgage-namespace.html | vancouver | cabrillo.message - Client | Cabrillo JS functions to display messages in the native UI banner. | [] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloMessage-client/concept/cabrillo-messgage-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloMessage-client/concept/cabrillo-messgage-namespace.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.message - Client
Cabrillo JS functions to display messages in the native UI banner.
## cabrillo.message - showMessage(String style, Strin... | ---
title: cabrillo.message - Client
description: Cabrillo JS functions to display messages in the native UI banner.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vancouver release is no longer supported. As such, the product documentation and releas... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloModal-client/concept/cabrillo-modal-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloModal-client/concept/cabrillo-modal-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloModal-client/concept/cabrillo-modal-namespace.html | vancouver | cabrillo.modal - Client | Cabrillo JS functions for presenting web content inside of native modals. | [
"cabrillo.modal",
"dismissModal( Object results)",
"presentModal( String title",
"String url",
"String closeButtonStyle",
"String modalPresentationStyle)"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloModal-client/concept/cabrillo-modal-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloModal-client/concept/cabrillo-modal-namespace.html"><div class="wm... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.modal - Client
Cabrillo JS
functions for presenting web content inside of native modals.
## cabrillo.modal - dismissModal(Object data)
U... | ---
title: cabrillo.modal - Client
description: Cabrillo JS functions for presenting web content inside of native modals.
keywords:
- cabrillo.modal
- dismissModal( Object results)
- presentModal( String title
- String url
- String closeButtonStyle
- String modalPresentationStyle)
breadcrumbs:
- API implementation and ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloNavigation-client/concept/cabrillo-navigation-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloNavigation-client/concept/cabrillo-navigation-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloNavigation-client/concept/cabrillo-navigation-namespace.html | vancouver | cabrillo.navigation - Client | Cabrillo JS functions for forward and backward navigation. | [
"cabrillo.navigation",
"goBack()",
"goto( String url",
"Cabrillo.NavigationRequest request)"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloNavigation-client/concept/cabrillo-navigation-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloNavigation-client/concept/cabrillo-navigation-namespace.... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.navigation - Client
Cabrillo JS
functions for forward and backward navigation.
## cabrillo.navigation - goBack()
Enables backward naviga... | ---
title: cabrillo.navigation - Client
description: Cabrillo JS functions for forward and backward navigation.
keywords:
- cabrillo.navigation
- goBack()
- goto( String url
- Cabrillo.NavigationRequest request)
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vanco... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloNowApp-client/concept/cabrillo-nowapp-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloNowApp-client/concept/cabrillo-nowapp-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloNowApp-client/concept/cabrillo-nowapp-namespace.html | vancouver | cabrillo.nowapp - Client | The name space for Cabrillo Now App functions. This enables you to interact with screens inside of Now Platform® native mobile apps. | [] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloNowApp-client/concept/cabrillo-nowapp-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloNowApp-client/concept/cabrillo-nowapp-namespace.html"><div class... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.nowapp - Client
The name space for Cabrillo Now App functions. This enables you to interact with screens inside of Now Platform® native mo... | ---
title: cabrillo.nowapp - Client
description: "The name space for Cabrillo Now App functions. This enables you to interact\
\ with screens inside of Now Platform\xAE native mobile apps."
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Client mobile API reference
---
The Vancouver re... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloViewLayout-client/concept/cabrillo-viewLayout-namespace.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CabrilloViewLayout-client/concept/cabrillo-viewLayout-namespace.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CabrilloViewLayout-client/concept/cabrillo-viewLayout-namespace.html | vancouver | cabrillo.viewLayout - Client | Cabrillo JS functions to provide access to native UI elements like buttons and spinners. | [
"cabrillo.viewLayout",
"hideSpinner()",
"setBottomButtons( Array buttons",
"Function handler)",
"setNavigationBarButtons( Array buttons",
"Function handler)",
"setTitle( String title)",
"showSpinner()"
] | [
"API implementation and reference",
"API reference",
"Client mobile API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloViewLayout-client/concept/cabrillo-viewLayout-namespace.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CabrilloViewLayout-client/concept/cabrillo-viewLayout-namespace.... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# cabrillo.viewLayout - Client
Cabrillo JS
functions to provide access to native UI elements like buttons and spinners.
## cabrillo.viewLayout - get... | ---
title: cabrillo.viewLayout - Client
description: Cabrillo JS functions to provide access to native UI elements like buttons
and spinners.
keywords:
- cabrillo.viewLayout
- hideSpinner()
- setBottomButtons( Array buttons
- Function handler)
- setNavigationBarButtons( Array buttons
- Function handler)
- setTitle( S... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CartJSScoped/concept/c_CartJSScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CartJSScoped/concept/c_CartJSScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CartJSScoped/concept/c_CartJSScoped.html | vancouver | CartJS - Scoped | The CartJS API enables you to access the shopping cart for a user. | [
"Scoped CartJS",
"Scoped CartJS",
"addToCart(Map request)",
"CartJS(String cartName)",
"checkoutCart()",
"empty()",
"getCartID()",
"getCartItems()",
"getDeliveryAddress()",
"getRequestedFor()",
"getRequestedForDisplayName()",
"getSpecialInstructions()",
"orderNow(Map request)",
"setDeliver... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CartJSScoped/concept/c_CartJSScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CartJSScoped/concept/c_CartJSScoped.html"><div class="wm">The Vancouver release is no longer... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CartJS - Scoped
The CartJS API enables you to access the shopping cart for a
user.
To use this class in a scoped application, use the `sn_sc` name... | ---
title: CartJS - Scoped
description: The CartJS API enables you to access the shopping cart for a user.
keywords:
- Scoped CartJS
- Scoped CartJS
- addToCart(Map request)
- CartJS(String cartName)
- checkoutCart()
- empty()
- getCartID()
- getCartItems()
- getDeliveryAddress()
- getRequestedFor()
- getRequestedForDi... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatCategory/concept/c_CatCategory.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatCategory/concept/c_CatCategory.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatCategory/concept/c_CatCategory.html | vancouver | CatCategory - Scoped | The CatCategory API enables you to create and modify service catalog categories using scripts. | [
"CatCategory",
"Scoped CatCategory",
"availableForUserCriteria(String action",
"Array[] criteriaIDs)",
"CatCategory",
"canView(Boolean isMobile",
"String userSysId)",
"create(Boolean standardUpdate)",
"deleteRecord(Boolean standardUpdate)",
"notAvailableForUserCriteria(String action",
"Array[] c... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatCategory/concept/c_CatCategory.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatCategory/concept/c_CatCategory.html"><div class="wm">The Vancouver release is no longer sup... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatCategory - Scoped
The CatCategory API enables you to create and modify service catalog categories using scripts.
This API runs in the `sn_sc` n... | ---
title: CatCategory - Scoped
description: The CatCategory API enables you to create and modify service catalog
categories using scripts.
keywords:
- CatCategory
- Scoped CatCategory
- availableForUserCriteria(String action
- Array[] criteriaIDs)
- CatCategory
- canView(Boolean isMobile
- String userSysId)
- create... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatItem/concept/c_CatItem.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatItem/concept/c_CatItem.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatItem/concept/c_CatItem.html | vancouver | CatItem - Scoped | The CatItem API enables you to create and modify service catalog items using scripts. | [
"CatItem",
"API",
"Scoped CatItem",
"availableForUserCriteria(String action",
"Array[] criteriaIDs)",
"CatItem",
"canViewOnSearch(boolean isMobile)",
"canViewInDomain()",
"create(Boolean standardUpdate)",
"deleteRecord(Boolean standardUpdate)",
"getFirstAccessibleCategoryForSearch(String catalog... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatItem/concept/c_CatItem.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatItem/concept/c_CatItem.html"><div class="wm">The Vancouver release is no longer supported. As such,... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatItem - Scoped
The CatItem API enables you to create and modify service catalog items using scripts.
This API runs in the `sn_sc` namespace.
##... | ---
title: CatItem - Scoped
description: The CatItem API enables you to create and modify service catalog items
using scripts.
keywords:
- CatItem
- API
- Scoped CatItem
- availableForUserCriteria(String action
- Array[] criteriaIDs)
- CatItem
- canViewOnSearch(boolean isMobile)
- canViewInDomain()
- create(Boolean s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogClientScriptScoped/concept/c_CatalogClientScriptScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogClientScriptScoped/concept/c_CatalogClientScriptScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogClientScriptScoped/concept/c_CatalogClientScriptScoped.html | vancouver | CatalogClientScript - Scoped | The CatalogClientScript API enables you to create, modify, or delete catalog client script records. | [
"Scoped CatalogClientScript",
"Scoped CatalogClientScript",
"addScript(String script)",
"appliesToCatalogItem(Boolean flag)",
"appliesToCatalogTask(Boolean flag)",
"appliesToRequestedItem(Boolean flag)",
"appliesToTargetRecord(Boolean flag)",
"CatalogClientScript()",
"create(Boolean standardUpdate)"... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogClientScriptScoped/concept/c_CatalogClientScriptScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogClientScriptScoped/concept/c_CatalogClientScriptScoped.html... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogClientScript - Scoped
The CatalogClientScript API enables you to create, modify, or delete
catalog client script records.
To use this class... | ---
title: CatalogClientScript - Scoped
description: The CatalogClientScript API enables you to create, modify, or delete
catalog client script records.
keywords:
- Scoped CatalogClientScript
- Scoped CatalogClientScript
- addScript(String script)
- appliesToCatalogItem(Boolean flag)
- appliesToCatalogTask(Boolean fl... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariable/concept/c_CatalogItemVariable.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariable/concept/c_CatalogItemVariable.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogItemVariable/concept/c_CatalogItemVariable.html | vancouver | CatalogItemVariable - Scoped | The CatalogItemVariable API enables you to create and modify service catalog item variables using scripts. | [
"CatalogItemVariable",
"create(Boolean standardUpdate)",
"deleteRecord(Boolean standardUpdate)",
"read(Object columns",
"Boolean standardUpdate)",
"setAttributes(Object attributes)",
"update(Object columnValues",
"Boolean standardUpdate)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariable/concept/c_CatalogItemVariable.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariable/concept/c_CatalogItemVariable.html"><div class="wm">The Va... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogItemVariable - Scoped
The CatalogItemVariable API enables you to create and modify service catalog item variables using scripts.
This API r... | ---
title: CatalogItemVariable - Scoped
description: The CatalogItemVariable API enables you to create and modify service
catalog item variables using scripts.
keywords:
- CatalogItemVariable
- create(Boolean standardUpdate)
- deleteRecord(Boolean standardUpdate)
- read(Object columns
- Boolean standardUpdate)
- setA... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariableSet/concept/c_CatalogItemVariableSet.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariableSet/concept/c_CatalogItemVariableSet.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogItemVariableSet/concept/c_CatalogItemVariableSet.html | vancouver | CatalogItemVariableSet - Scoped | The CatalogItemVariableSet API enables you to create and modify service catalog item variable sets using scripts. | [
"CatalogItemVariableSet",
"create(Boolean standardUpdate)",
"deleteRecord(Boolean standardUpdate)",
"read(Object columns",
"Boolean standardUpdate)",
"setAttributes(Object attributes)",
"update(Object columnValues",
"Boolean standardUpdate)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariableSet/concept/c_CatalogItemVariableSet.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariableSet/concept/c_CatalogItemVariableSet.html"><div class... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogItemVariableSet - Scoped
The CatalogItemVariableSet API enables you to create and modify service catalog item variable sets using scripts.
... | ---
title: CatalogItemVariableSet - Scoped
description: The CatalogItemVariableSet API enables you to create and modify service
catalog item variable sets using scripts.
keywords:
- CatalogItemVariableSet
- create(Boolean standardUpdate)
- deleteRecord(Boolean standardUpdate)
- read(Object columns
- Boolean standardU... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariableSetM2M/concept/c_CatalogItemVariableSetM2M.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogItemVariableSetM2M/concept/c_CatalogItemVariableSetM2M.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogItemVariableSetM2M/concept/c_CatalogItemVariableSetM2M.html | vancouver | CatalogItemVariableSetM2M - Scoped | The CatalogItemVariableSetM2M API enables you to create and modify service catalog item variable set many-to-many (M2Ms) using scripts. | [
"CatalogItemVariableSetM2M",
"create(Boolean standardUpdate)",
"deleteRecord(Boolean standardUpdate)",
"read(Object columns",
"Boolean standardUpdate)",
"setAttributes(Object attributes)",
"update(Object columnValues",
"Boolean standardUpdate)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariableSetM2M/concept/c_CatalogItemVariableSetM2M.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogItemVariableSetM2M/concept/c_CatalogItemVariableSetM2M.html... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogItemVariableSetM2M - Scoped
The CatalogItemVariableSetM2M API enables you to create and modify service catalog item variable set many-to-man... | ---
title: CatalogItemVariableSetM2M - Scoped
description: The CatalogItemVariableSetM2M API enables you to create and modify service
catalog item variable set many-to-many (M2Ms) using scripts.
keywords:
- CatalogItemVariableSetM2M
- create(Boolean standardUpdate)
- deleteRecord(Boolean standardUpdate)
- read(Object... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogJS/concept/CatalogJSScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogJS/concept/CatalogJSScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogJS/concept/CatalogJSScopedAPI.html | vancouver | CatalogJS - Scoped | The CatalogJS API enables you to use methods to check and retrieve catalog-specific properties. | [
"Scoped CatalogJS",
"CatalogJS",
"Catalog(Glide Record now_GR)",
"Catalog(String sys_id)",
"canView(boolean mobile)",
"getAvailableCatalog()",
"getBackgroundColor()",
"getCatalogCount()",
"getCategories()",
"getCategoryIds()",
"getDescription()",
"getDesktopImageSRC()",
"getGr()",
"getHead... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogJS/concept/CatalogJSScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogJS/concept/CatalogJSScopedAPI.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogJS - Scoped
The CatalogJS API enables you to use methods to check and retrieve
catalog-specific properties.
To use this class in a scoped a... | ---
title: CatalogJS - Scoped
description: The CatalogJS API enables you to use methods to check and retrieve catalog-specific
properties.
keywords:
- Scoped CatalogJS
- CatalogJS
- Catalog(Glide Record now_GR)
- Catalog(String sys_id)
- canView(boolean mobile)
- getAvailableCatalog()
- getBackgroundColor()
- getCata... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogSearchScoped/concept/c_CatalogSearchScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CatalogSearchScoped/concept/c_CatalogSearchScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CatalogSearchScoped/concept/c_CatalogSearchScoped.html | vancouver | CatalogSearch - Scoped | The CatalogSearch API enables you to search catalog item. | [
"Scoped CatalogSearch",
"Scoped CatalogSearch",
"CatalogSearch()",
"search (String catalogID",
"String categoryID",
"String term",
"Boolean mobile",
"Boolean depthSearch)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogSearchScoped/concept/c_CatalogSearchScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CatalogSearchScoped/concept/c_CatalogSearchScoped.html"><div class="wm">The Va... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CatalogSearch - Scoped
The CatalogSearch API enables you to search catalog
item.
To use this class in a scoped application, use the `sn_sc` namesp... | ---
title: CatalogSearch - Scoped
description: The CatalogSearch API enables you to search catalog item.
keywords:
- Scoped CatalogSearch
- Scoped CatalogSearch
- CatalogSearch()
- search (String catalogID
- String categoryID
- String term
- Boolean mobile
- Boolean depthSearch)
breadcrumbs:
- API implementation and re... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CdmQuery/concept/CdmQueryScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CdmQuery/concept/CdmQueryScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CdmQuery/concept/CdmQueryScopedAPI.html | vancouver | CdmQuery - Scoped | The CdmQuery API enables you to query the CDM data model tree. It returns a list of node objects that are specific fields/columns in the CDM Node [sn_cdm_node] table. These values are returned as properties in the object. Every object | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CdmQuery/concept/CdmQueryScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CdmQuery/concept/CdmQueryScopedAPI.html"><div class="wm">The Vancouver release is no longer s... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CdmQuery - Scoped
The CdmQuery API enables you to query the CDM data model tree. It returns a list of node objects that are specific fields/columns... | ---
title: CdmQuery - Scoped
description: The CdmQuery API enables you to query the CDM data model tree. It returns
a list of node objects that are specific fields/columns in the CDM Node [sn_cdm_node]
table. These values are returned as properties in the object. Every object
keywords: []
breadcrumbs:
- API impleme... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CellBoth/concept/CellBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CellBoth/concept/CellBothAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CellBoth/concept/CellBothAPI.html | vancouver | Cell - Scoped, Global | Creates a Cell object as a cell in a table. You can use this API to format the cell and include additional blocks, such as paragraphs and images. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CellBoth/concept/CellBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CellBoth/concept/CellBothAPI.html"><div class="wm">The Vancouver release is no longer supported. As... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Cell - Scoped, Global
Creates a Cell object as a cell in a table.
You can use this API to format the cell and include additional blocks, such as
pa... | ---
title: Cell - Scoped, Global
description: Creates a Cell object as a cell in a table. You can use this API to format
the cell and include additional blocks, such as paragraphs and images.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CertificateEncryptionScoped/concept/c_CertificateEncryptionScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CertificateEncryptionScoped/concept/c_CertificateEncryptionScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CertificateEncryptionScoped/concept/c_CertificateEncryptionScopedAPI.html | vancouver | CertificateEncryption - Scoped | APIs available for encrypting certificates in scoped applications. | [
"GlideCertificateEncryption",
"CertificateEncryption",
"CertificateEncryption()",
"generateMac(key",
"algorithm",
"data)",
"CertificateEncryption",
"getThumbPrint(String certificateID",
"String algorithm)",
"getThumbPrintFromKeystore(String certificateID",
"String alias",
"String algorithm)",
... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CertificateEncryptionScoped/concept/c_CertificateEncryptionScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CertificateEncryptionScoped/concept/c_CertificateEncryption... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CertificateEncryption - Scoped
APIs available for encrypting certificates in scoped applications.
Use these methods to generate a hash for the cer... | ---
title: CertificateEncryption - Scoped
description: APIs available for encrypting certificates in scoped applications.
keywords:
- GlideCertificateEncryption
- CertificateEncryption
- CertificateEncryption()
- generateMac(key
- algorithm
- data)
- CertificateEncryption
- getThumbPrint(String certificateID
- String a... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ChangeCollisionHelper/concept/c_ChangeCollisionHelperAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ChangeCollisionHelper/concept/c_ChangeCollisionHelperAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ChangeCollisionHelper/concept/c_ChangeCollisionHelperAPI.html | vancouver | ChangeCollisionHelper - Global | Helper functions found in the Change Management Collision Detector Plugin. | [
"ChangeCollisionHelper API",
"ChangeCollisionHelper",
"addCiToChgAffectedCis(String ci",
"String changeId)",
"getAffectedCisByChangeId(String changeId)",
"getBlackoutsByDate(GlideDateTime startDate",
"GlideDateTime endDate)",
"getChangesWithAffectedCi(String ci",
"GlideDateTime startDate",
"GlideD... | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ChangeCollisionHelper/concept/c_ChangeCollisionHelperAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ChangeCollisionHelper/concept/c_ChangeCollisionHelperAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ChangeCollisionHelper - Global
Helper functions found in the Change Management Collision Detector Plugin.
Use these methods in server side scripts... | ---
title: ChangeCollisionHelper - Global
description: Helper functions found in the Change Management Collision Detector Plugin.
keywords:
- ChangeCollisionHelper API
- ChangeCollisionHelper
- addCiToChgAffectedCis(String ci
- String changeId)
- getAffectedCisByChangeId(String changeId)
- getBlackoutsByDate(GlideDateT... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ChangeSuccess/concept/ChangeSuccessScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ChangeSuccess/concept/ChangeSuccessScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ChangeSuccess/concept/ChangeSuccessScopedAPI.html | vancouver | ChangeSuccess - Scoped | The ChangeSuccess API provides methods that return the Performance Analytics (PA) success scores for change requests (original change success score based on group), change models, and change types. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ChangeSuccess/concept/ChangeSuccessScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ChangeSuccess/concept/ChangeSuccessScopedAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ChangeSuccess - Scoped
The ChangeSuccess API provides methods that return the Performance Analytics (PA) success scores for change requests (origin... | ---
title: ChangeSuccess - Scoped
description: The ChangeSuccess API provides methods that return the Performance Analytics
(PA) success scores for change requests (original change success score based on
group), change models, and change types.
keywords: []
breadcrumbs:
- API implementation and reference
- API refe... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CheckDefinitionTestBuilder/concept/CheckDefinitionTestBuilderAPIScope.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CheckDefinitionTestBuilder/concept/CheckDefinitionTestBuilderAPIScope.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CheckDefinitionTestBuilder/concept/CheckDefinitionTestBuilderAPIScope.html | vancouver | CheckDefinitionTestBuilder - Scoped | The CheckDefinitionTestBuilder script include enables building test check requests on check definitions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CheckDefinitionTestBuilder/concept/CheckDefinitionTestBuilderAPIScope.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CheckDefinitionTestBuilder/concept/CheckDefinitionTestBuil... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CheckDefinitionTestBuilder - Scoped
The CheckDefinitionTestBuilder script include enables building test
check requests on check definitions.
This ... | ---
title: CheckDefinitionTestBuilder - Scoped
description: The CheckDefinitionTestBuilder script include enables building test check
requests on check definitions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CheckInstanceTestBuilder/concept/CheckInstanceTestBuilderAPIScoped.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CheckInstanceTestBuilder/concept/CheckInstanceTestBuilderAPIScoped.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CheckInstanceTestBuilder/concept/CheckInstanceTestBuilderAPIScoped.html | vancouver | CheckInstanceTestBuilder - Scoped | The CheckInstanceTestBuilder script include enables building test check requests on check instances. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CheckInstanceTestBuilder/concept/CheckInstanceTestBuilderAPIScoped.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CheckInstanceTestBuilder/concept/CheckInstanceTestBuilderAPIS... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CheckInstanceTestBuilder - Scoped
The CheckInstanceTestBuilder script include enables building test
check requests on check instances.
This API re... | ---
title: CheckInstanceTestBuilder - Scoped
description: The CheckInstanceTestBuilder script include enables building test check
requests on check instances.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such,... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimCIData/concept/c_CimCIDataAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimCIData/concept/c_CimCIDataAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CimCIData/concept/c_CimCIDataAPI.html | vancouver | CimCIData - Global | Provides a wrapper for CIM CI data manipulation. | [
"CimCIData API",
"CimCIData",
"addSerial(String type",
"String serial)",
"SerialRecord(String type",
"String serial)",
"setMakeAndModel(String make",
"String model)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimCIData/concept/c_CimCIDataAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimCIData/concept/c_CimCIDataAPI.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CimCIData - Global
Provides a wrapper for CIM CI data manipulation.
Use with any server-side discovery script.
## CimCIData - addSerial(String ty... | ---
title: CimCIData - Global
description: Provides a wrapper for CIM CI data manipulation.
keywords:
- CimCIData API
- CimCIData
- addSerial(String type
- String serial)
- SerialRecord(String type
- String serial)
- setMakeAndModel(String make
- String model)
breadcrumbs:
- API implementation and reference
- API refer... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimIDSensorAPI/concept/c_CimIDSensorAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimIDSensorAPI/concept/c_CimIDSensorAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CimIDSensorAPI/concept/c_CimIDSensorAPI.html | vancouver | CimIDSensor - Global | Performs identification for CIM probe results. | [
"CimIDSensor API",
"CimIDSensor",
"configureTriggeredProbe(String probe)",
"getInstanceHashToken()",
"prepare()",
"process(Object results",
"CimCIData cimData",
"CimIDSensor sensor)",
"runMultiProbeScript(String script",
"Object probeResult",
"String probeRecord)",
"updateDeviceCount()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimIDSensorAPI/concept/c_CimIDSensorAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimIDSensorAPI/concept/c_CimIDSensorAPI.html"><div class="wm">The Vancouver release is n... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CimIDSensor - Global
Performs identification for CIM probe results.
Use in any server-side script to perform identification of CIM probe results.
... | ---
title: CimIDSensor - Global
description: Performs identification for CIM probe results.
keywords:
- CimIDSensor API
- CimIDSensor
- configureTriggeredProbe(String probe)
- getInstanceHashToken()
- prepare()
- process(Object results
- CimCIData cimData
- CimIDSensor sensor)
- runMultiProbeScript(String script
- Obje... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimInstanceToken/concept/c_CimInstanceTokenAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimInstanceToken/concept/c_CimInstanceTokenAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CimInstanceToken/concept/c_CimInstanceTokenAPI.html | vancouver | CimInstanceToken - Global | Represents the unique query identity of a CIM instance. | [
"CimInstanceToken API",
"CimInstanceToken",
"getHashToken(String cimomip)",
"parse(XMLObj instance)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimInstanceToken/concept/c_CimInstanceTokenAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimInstanceToken/concept/c_CimInstanceTokenAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CimInstanceToken - Global
Represents the unique query identity of a CIM instance.
Use with any server-side discovery script.
## CimInstanceToken ... | ---
title: CimInstanceToken - Global
description: Represents the unique query identity of a CIM instance.
keywords:
- CimInstanceToken API
- CimInstanceToken
- getHashToken(String cimomip)
- parse(XMLObj instance)
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimProbe/concept/c_CimProbeAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimProbe/concept/c_CimProbeAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CimProbe/concept/c_CimProbeAPI.html | vancouver | CimProbe - Global | Maintains CIM probe meta data. | [
"CimProbe API",
"CimProbe",
"getNamedQueries()",
"getQueries()",
"getQueryRecords()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimProbe/concept/c_CimProbeAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimProbe/concept/c_CimProbeAPI.html"><div class="wm">The Vancouver release is no longer supported... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CimProbe - Global
Maintains CIM probe meta data.
Use in any server-side script where you need to maintain a CIM probe.
## CimProbe - getNamedQuer... | ---
title: CimProbe - Global
description: Maintains CIM probe meta data.
keywords:
- CimProbe API
- CimProbe
- getNamedQueries()
- getQueries()
- getQueryRecords()
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the produ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimProbeResult/concept/c_CimProbeResultAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CimProbeResult/concept/c_CimProbeResultAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CimProbeResult/concept/c_CimProbeResultAPI.html | vancouver | CimProbeResult - Global | The CimProbeResult API provides methods to process Common Information Model (CIM) probe results. | [
"CimProbeResult API",
"CimProbeResult",
"getNamedInstances(String namedQueries)",
"getQueries()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimProbeResult/concept/c_CimProbeResultAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CimProbeResult/concept/c_CimProbeResultAPI.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CimProbeResult - Global
The CimProbeResult API provides methods to process Common Information
Model (CIM) probe results.
Use to process CIM probe ... | ---
title: CimProbeResult - Global
description: The CimProbeResult API provides methods to process Common Information
Model (CIM) probe results.
keywords:
- CimProbeResult API
- CimProbeResult
- getNamedInstances(String namedQueries)
- getQueries()
breadcrumbs:
- API implementation and reference
- API reference
- Ser... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolution/concept/ClassificationSolutionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolution/concept/ClassificationSolutionAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClassificationSolution/concept/ClassificationSolutionAPI.html | vancouver | ClassificationSolution - Global | The ClassificationSolution API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolution/concept/ClassificationSolutionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolution/concept/ClassificationSolutionAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClassificationSolution - Global
The ClassificationSolution API is a scriptable object used in Predictive Intelligence stores.
This API requires t... | ---
title: ClassificationSolution - Global
description: The ClassificationSolution API is a scriptable object used in Predictive
Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the prod... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolutionStore/concept/ClassificationSolutionStoreAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolutionStore/concept/ClassificationSolutionStoreAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClassificationSolutionStore/concept/ClassificationSolutionStoreAPI.html | vancouver | ClassificationSolutionStore - Global | Enables storing and retrieving solutions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolutionStore/concept/ClassificationSolutionStoreAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolutionStore/concept/ClassificationSolutionSto... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClassificationSolutionStore - Global
Enables storing
and retrieving solutions.
The ClassificationSolutionStore
API requires the Predictive Intell... | ---
title: ClassificationSolutionStore - Global
description: Enables storing and retrieving solutions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolutionVersion/concept/ClassificationSolutionVersionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassificationSolutionVersion/concept/ClassificationSolutionVersionAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClassificationSolutionVersion/concept/ClassificationSolutionVersionAPI.html | vancouver | ClassificationSolutionVersion - Global | The ClassificationSolutionVersion API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolutionVersion/concept/ClassificationSolutionVersionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassificationSolutionVersion/concept/ClassificationSolut... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClassificationSolutionVersion - Global
The ClassificationSolutionVersion API is a scriptable object used in
Predictive Intelligence stores.
This ... | ---
title: ClassificationSolutionVersion - Global
description: The ClassificationSolutionVersion API is a scriptable object used in
Predictive Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html | vancouver | ClassifierProbes - Global | The ClassifierProbes API provides a classifier probe launch facility. Encapsulates an array of probe information records, initialized either from a JavaScript array or the XML serialized version. | [
"ClassifierProbes API",
"ClassifierProbes",
"launch()",
"launchSupplementary()",
"size()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClassifierProbes/concept/c_ClassifierProbesAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClassifierProbes - Global
The ClassifierProbes API provides a classifier probe launch facility.
Encapsulates an array of probe information records,... | ---
title: ClassifierProbes - Global
description: The ClassifierProbes API provides a classifier probe launch facility.
Encapsulates an array of probe information records, initialized either from a JavaScript
array or the XML serialized version.
keywords:
- ClassifierProbes API
- ClassifierProbes
- launch()
- launc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html | vancouver | Client - Scoped, Global | The Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase database, and to receive the results of the transforms. | [
"Client",
"Client",
"Client()",
"deleteSeries(GlideRecord now_GR",
"String metric)",
"getSeries(GlideRecord now_GR",
"String metric)",
"put(DataBuilder metricData)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClientScoped/concept/ClientScopedAPI.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Client - Scoped, Global
The Client API provides methods to add data to the MetricBase database, to execute transforms on the MetricBase
database, a... | ---
title: Client - Scoped, Global
description: The Client API provides methods to add data to the MetricBase database,
to execute transforms on the MetricBase database, and to receive the results of
the transforms.
keywords:
- Client
- Client
- Client()
- deleteSeries(GlideRecord now_GR
- String metric)
- getSerie... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html | vancouver | ClusteringSolution - Global | The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolution/concept/ClusteringSolutionAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClusteringSolution - Global
The ClusteringSolution API is a scriptable object used in Predictive Intelligence stores.
This API requires the Predi... | ---
title: ClusteringSolution - Global
description: The ClusteringSolution API is a scriptable object used in Predictive
Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product docu... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html | vancouver | ClusteringSolutionStore - Global | Enables storing and retrieving solutions. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionStore/concept/ClusteringSolutionStoreAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClusteringSolutionStore - Global
Enables storing
and retrieving solutions.
The ClusteringSolutionStore
API requires the Predictive Intelligence p... | ---
title: ClusteringSolutionStore - Global
description: Enables storing and retrieving solutions.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html | vancouver | ClusteringSolutionVersion - Global | The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ClusteringSolutionVersion/concept/ClusteringSolutionVersionAPI.ht... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ClusteringSolutionVersion - Global
The ClusteringSolutionVersion API is a scriptable object used in Predictive Intelligence stores.
This API requ... | ---
title: ClusteringSolutionVersion - Global
description: The ClusteringSolutionVersion API is a scriptable object used in Predictive
Intelligence stores.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, th... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html | vancouver | Color - Scoped, Global | Creates a Color object used to define color attributes that you can apply to elements in a PDF; such as cells, tables, and lines. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ColorBoth/concept/ColorBothAPI.html"><div class="wm">The Vancouver release is no longer supported... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Color - Scoped, Global
Creates a Color object used to define color
attributes that you can apply to elements in a PDF; such as cells, tables, and
l... | ---
title: Color - Scoped, Global
description: Creates a Color object used to define color attributes that you can apply
to elements in a PDF; such as cells, tables, and lines.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer s... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html | vancouver | ConnectActionResponse - Global | The ConnectActionResponse API provides a method to create a GlideRecord. | [
"ConnectActionResponse API",
"ConnectActionResponse",
"newRecord(String table",
"Object values",
"String view)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectActionResponse/concept/c_ConnectActionResponseAPI.html"><div cla... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ConnectActionResponse - Global
The ConnectActionResponse API provides a method to create a GlideRecord.
ConnectActionResponse methods are accessed... | ---
title: ConnectActionResponse - Global
description: The ConnectActionResponse API provides a method to create a GlideRecord.
keywords:
- ConnectActionResponse API
- ConnectActionResponse
- newRecord(String table
- Object values
- String view)
breadcrumbs:
- API implementation and reference
- API reference
- Server A... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html | vancouver | ConnectionInfo - Scoped, Global | The ConnectionInfo API enables you to get connection attribute information through the connection and credential alias. | [
"ConnectionInfo",
"ConnectionInfo",
"getAttribute(name)",
"getCredentialAttribute()",
"getDataMap()",
"getExtendedAttributes()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfo/Concept/connection-info-api.html"><div class="wm">The Vancouver releas... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ConnectionInfo - Scoped, Global
The ConnectionInfo API enables you to get connection attribute
information through the connection and credential al... | ---
title: ConnectionInfo - Scoped, Global
description: The ConnectionInfo API enables you to get connection attribute information
through the connection and credential alias.
keywords:
- ConnectionInfo
- ConnectionInfo
- getAttribute(name)
- getCredentialAttribute()
- getDataMap()
- getExtendedAttributes()
breadcrum... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html | vancouver | ConnectionInfoProvider - Scoped, Global | The ConnectionInfoProvider API provides methods to select connection information through the connection alias. | [
"ConnectionInfoProvider",
"ConnectionInfoProvider",
"ConnectionInfoProvider()",
"getConnectionInfo()",
"getConnectionInfoByDomain(String aliasID",
"String domainID)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/ConnectionInfoProvider/Concept/connection-info-provider-api.html"><d... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# ConnectionInfoProvider - Scoped, Global
The ConnectionInfoProvider API provides methods to select connection
information through the connection ali... | ---
title: ConnectionInfoProvider - Scoped, Global
description: The ConnectionInfoProvider API provides methods to select connection
information through the connection alias.
keywords:
- ConnectionInfoProvider
- ConnectionInfoProvider
- ConnectionInfoProvider()
- getConnectionInfo()
- getConnectionInfoByDomain(String... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html | vancouver | Conversation - Scoped | The Conversation API enables you to create or modify Connect conversations. | [
"Scoped Conversation",
"Conversation",
"Scoped Conversation",
"get(String sysID)",
"Conversation",
"create(String name)",
"addSubscriber(String sysID)",
"removeSubscriber(String sysID)",
"sendMessage(String body",
"String field)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/Conversation/concept/c_ConversationScopedAPI.html"><div class="wm">The Vancouver re... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Conversation - Scoped
The Conversation API enables you to create or modify Connect
conversations.
To use this class in a scoped application, use t... | ---
title: Conversation - Scoped
description: The Conversation API enables you to create or modify Connect conversations.
keywords:
- Scoped Conversation
- Conversation
- Scoped Conversation
- get(String sysID)
- Conversation
- create(String name)
- addSubscriber(String sysID)
- removeSubscriber(String sysID)
- sendMes... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html | vancouver | CostPlanBatchOperations - Global | Provides methods that enable the creation of a large number of cost plan records for demands and projects using batch processing. Use this API instead of GlideRecord to more efficiently create multiple cost plan records. | [
"Create cost plans",
"batch cost plans",
"CostPlanBatchOperations",
"CostPlanBatchOperations",
"add(Object costPlan)",
"CostPlanBatchOperations",
"clear()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CostPlanBatchOperations/concept/CostPlanBatchOperationsAPI.html"><div... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CostPlanBatchOperations - Global
Provides methods that enable the creation of a large number of cost plan records for
demands and projects using ba... | ---
title: CostPlanBatchOperations - Global
description: Provides methods that enable the creation of a large number of cost plan
records for demands and projects using batch processing. Use this API instead of
GlideRecord to more efficiently create multiple cost plan records.
keywords:
- Create cost plans
- batch ... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html | vancouver | CriteriaEvaluator - Global | Implements a general-purpose criteria evaluator. | [
"CriteriaEvaluator API",
"CriteriaEvaluator",
"addCriterion(String lhComparand",
"String operator",
"String rhComparand)",
"evaluate(Object lhValues",
"String rhValues",
"Boolean any)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/CriteriaEvaluator/concept/c_CriteriaEvaluatorAPI.html"><div class="wm">The Vanc... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# CriteriaEvaluator - Global
Implements a general-purpose criteria evaluator.
The general use pattern is to construct the class, add as many criteri... | ---
title: CriteriaEvaluator - Global
description: Implements a general-purpose criteria evaluator.
keywords:
- CriteriaEvaluator API
- CriteriaEvaluator
- addCriterion(String lhComparand
- String operator
- String rhComparand)
- evaluate(Object lhValues
- String rhValues
- Boolean any)
breadcrumbs:
- API implementatio... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html | vancouver | DCManager - Global | The DCManager API enables you to group data by type. | [] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DCManager/concept/DCManagerAPIGlobal.html"><div class="wm">The Vancouver release is no long... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# DCManager - Global
The DCManager API enables you to group data by type.
With the DCManager API, you can:
* Assign data classifications to existin... | ---
title: DCManager - Global
description: The DCManager API enables you to group data by type.
keywords: []
breadcrumbs:
- API implementation and reference
- API reference
- Server API reference
---
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for inf... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html | vancouver | DSCScriptableAPI - Global | The DSCScriptableAPI provides methods for checking the health of your domain configuration for an instance. | [
"DSCScriptableAPI",
"DSCScriptableAPI",
"chkDataInvalidDomainForTables()",
"chkDataInvalidPathForTables()",
"DSCScriptableAPI",
"DSCScriptableAPI()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DSCScriptableAPI/concept/DSCScriptableAPI.html"><div class="wm">The Vancouver release ... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# DSCScriptableAPI - Global
The DSCScriptableAPI provides methods for checking the health of
your domain configuration for an instance.
The DSCScrip... | ---
title: DSCScriptableAPI - Global
description: The DSCScriptableAPI provides methods for checking the health of your
domain configuration for an instance.
keywords:
- DSCScriptableAPI
- DSCScriptableAPI
- chkDataInvalidDomainForTables()
- chkDataInvalidPathForTables()
- DSCScriptableAPI
- DSCScriptableAPI()
breadc... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html | vancouver | DataBuilder - Scoped, Global | The DataBuilder class creates a series of data points for a metric. Use the sn_clotho.Client.put() method to save the values. | [
"Scoped DataBuilder",
"Scoped DataBuilder",
"add(GlideDateTime start",
"Array value)",
"add(GlideDateTime start Number value)",
"DataBuilder(String table",
"String subject",
"String metric)"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataBuilderScoped/concept/DataBuilderScopedAPI.html"><div class="wm">The Vancouve... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# DataBuilder - Scoped, Global
The DataBuilder class creates a series of data points for a metric. Use the sn\_clotho.Client.put() method to save the... | ---
title: DataBuilder - Scoped, Global
description: The DataBuilder class creates a series of data points for a metric. Use
the sn_clotho.Client.put() method to save the values.
keywords:
- Scoped DataBuilder
- Scoped DataBuilder
- add(GlideDateTime start
- Array value)
- add(GlideDateTime start Number value)
- Data... |
https://www.servicenow.com/docs/en-US/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html | https://servicenow-be-prod.servicenow.com/api/bundle/vancouver-api-reference/page/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html | 2025-05-06 | daily | 0.5 | 3.xml | en-US | vancouver-api-reference | app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html | vancouver | Data - Scoped, Global | A Data object contains the results of transform performed by a sn_clotho.Client.transform() method. | [
"Data",
"Scoped Data",
"getEnd()",
"Scoped DATA",
"getLabel()",
"getMetricName()",
"getPeriod()",
"getStart()",
"getSubject()",
"getTableName()",
"getValues()",
"size()"
] | [
"API implementation and reference",
"API reference",
"Server API reference"
] | <article class="hascomments" data-page="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html" id="bundle:vancouver-api-reference/enus/app-store/dev_portal/API_reference/DataScoped/concept/DataScopedAPI.html"><div class="wm">The Vancouver release is no longer suppo... | {
"attachments": {
"all_attachments": null,
"topic_attachments": []
},
"available_languages": [
"dede",
"enus",
"frfr",
"jajp",
"kokr",
"ptbr"
],
"breadcrumbs": [
{
"title": "API implementation and reference",
"topic_id": "build/applications/concept/api-implemen... | The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
# Data - Scoped, Global
A Data object contains the results of transform performed by a
sn\_clotho.Client.transform() method.
Do not use a constructo... | ---
title: Data - Scoped, Global
description: A Data object contains the results of transform performed by a sn_clotho.Client.transform()
method.
keywords:
- Data
- Scoped Data
- getEnd()
- Scoped DATA
- getLabel()
- getMetricName()
- getPeriod()
- getStart()
- getSubject()
- getTableName()
- getValues()
- size()
bre... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.