Name

sn_rf.RFConstants

Description

Contains constants used in Recommendation Framework

Script

var RFConstants = Class.create();

RFConstants.tables = {
  ML_CAPABILITY_DEFINITION_BASE: 'ml_capability_definition_base',
  ML_CAPABILITY_DEFINITION_SIMILARITY: 'ml_capability_definition_similarity',
  SYS_SCRIPT_INCLUDE: 'sys_script_include',
  SYS_EXTENSION_INSTANCE: 'sys_extension_instance',
  ML_CAPABILITY_DEFINITION_CLASSIFICATION: 'ml_capability_definition_classification',
  PIWB_MODEL: 'piwb_model',
  SYS_JOURNAL_FIELD: 'sys_journal_field',

  SN_RF_EVALUATION_TYPE_INPUT: 'sn_rf_evaluation_type_input',
  SN_RF_EVALUATION_TYPE: 'sn_rf_evaluation_type',
  SN_RF_RECOMMENDATION_RULE: 'sn_rf_recommendation_rule',
  SN_RF_CONDITIONAL_DEFINITION: 'sn_rf_conditional_definition',
  SN_RF_RECOMMENDATION_EXPERIENCE: 'sn_rf_recommendation_experience',
  SN_RF_RECOMMENDATION_ACTION: 'sn_rf_recommendation_action',
  SN_RF_TREND_DEFINITION: 'sn_rf_trend_definition',
  SN_RF_RECORD_DISPLAY_CONFIGURATION: 'sn_rf_record_display_configuration',
  SN_RF_RECOMENDATION_HISTORY: 'sn_rf_recommendation_history'
};

RFConstants.feedbackTracking = {
  SOLUTION: 'solution',
  POSITION: 'position',
  QUERY: 'query',
  PREDICTIONS: 'predictions',
  TABLE: 'table',
  SYS_IDS: 'sysIds'
};


RFConstants.fields = {
  ACTIVE: 'active',
  SYS_ID: 'sys_id',
  SYS_CREATED_ON: 'sys_created_on',
  SYS_UPDATED_ON: 'sys_updated_on',
  SYS_MOD_COUNT: 'sys_mod_count',

  SYS_SCRIPT_INCLUDE_API_NAME: 'api_name',

  SYS_JOURNAL_FIELD_ELEMENT_ID: 'element_id',
  SYS_JOURNAL_FIELD_ELEMENT: 'element',
  SYS_JOURNAL_FIELD_VALUE: 'value',

  SYS_EXTENSION_INSTANCE_POINT: 'point',
  SYS_EXTENSION_INSTANCE_SCRIPT_INCLUDE: 'script_include',

  ML_CAPABILITY_DEFINITION_BASE_SOLUTION_NAME: 'solution_name',
  ML_CAPABILITY_DEFINITION_BASE_TABLE: 'table',
  ML_CAPABILITY_DEFINITION_SIMILARITY_TEST_TABLE: 'test_table',
  ML_CAPABILITY_DEFINITION_CLASSIFICATION_OUTPUT_FIELD: 'output_field',
  ML_CAPABILITY_DEFINITION_SIMILARITY_TEST_FIELDS: 'test_fields',

  PIWB_MODEL_USECASE: 'usecase',
  PIWB_MODEL_STATUS: 'status',
  PIWB_MODEL_ML_MODEL_CONFIG: 'ml_model_config',
  PIWB_MODEL_ML_MODEL_SOLUTION_NAME: 'ml_model_solution_name',
  PIWB_MODEL_CAPABILITY_VALUE: 'usecase.template.ml_solution_definition.capability.value',

  SN_RF_TREND_DEFINITION_TABLE: 'table',
  SN_RF_TREND_DEFINITION_THRESHOLD: 'threshold',
  SN_RF_TREND_DEFINITION_TREND_TYPE: 'trend_type',
  SN_RF_TREND_DEFINITION_COMMON_FIELD: 'common_field',
  SN_RF_TREND_DEFINITION_REFERENCE_TYPE: 'reference_type',
  SN_RF_TREND_DEFINITION_TREND_FIELD: 'trend_field',
  SN_RF_TREND_DEFINITION_M2M_TABLE: 'm2m_table',
  SN_RF_TREND_DEFINITION_M2M_FROM_FIELD: 'm2m_from_field',
  SN_RF_TREND_DEFINITION_M2M_TO_FIELD: 'm2m_to_field',
  SN_RF_TREND_DEFINITION_CONDITION: 'condition',

  SN_RF_CONDITIONAL_DEFINITION_TABLE: 'table',
  SN_RF_CONDITIONAL_DEFINITION_INPUT_CONDITION: 'input_condition',
  SN_RF_CONDITIONAL_DEFINITION_RECOMMENDATION: 'recommendation',

  SN_RF_RECOMMENDATION_RULE_TABLE: 'table',
  SN_RF_RECOMMENDATION_RULE_EVALUATION_TYPE: 'evaluation_type',
  SN_RF_RECOMMENDATION_RULE_EVALUATION_TYPE_INPUT: 'evaluation_type_input',
  SN_RF_RECOMMENDATION_RULE_RE_EVALUATION_FIELDS: 're_evaluation_fields',
  SN_RF_RECOMMENDATION_RULE_ACTIVE: 'active',
  SN_RF_RECOMMENDATION_RULE_DOES_NOT_APPLIES_TO: 'does_not_applies_to',
  SN_RF_RECOMMENDATION_RULE_APPLIES_TO: 'applies_to',
  SN_RF_RECOMMENDATION_RULE_CONDITION_BUILDER: 'condition_builder',
  SN_RF_RECOMMENDATION_RULE_TITLE: 'title',
  SN_RF_RECOMMENDATION_RULE_DESCRIPTION: 'description',
  SN_RF_RECOMMENDATION_RULE_ORDER: 'order',
  SN_RF_RECOMMENDATION_RULE_PRIORITIZE: 'prioritize',
  SN_RF_RECOMMENDATION_RULE_SYS_ID: 'sys_id',

  SN_RF_RECOMMENDATION_EXPERIENCE_ACTIVE: 'active',
  SN_RF_RECOMMENDATION_EXPERIENCE_SHOW_AS: 'show_as',
  SN_RF_RECOMMENDATION_EXPERIENCE_RULE: 'recommendation_rule',
  SN_RF_RECOMMENDATION_EXPERIENCE_RULE_ACTIVE: 'recommendation_rule.active',
  SN_RF_RECOMMENDATION_EXPERIENCE_LABEL: 'label',
  SN_RF_RECOMMENDATION_EXPERIENCE_TITLE: 'title',
  SN_RF_RECOMMENDATION_EXPERIENCE_MESSAGE: 'message',
  SN_RF_RECOMMENDATION_EXPERIENCE_SHOW_RECORD: 'show_record',
  SN_RF_RECOMMENDATION_EXPERIENCE_RECORD_DISPLAY_CONFIGURATION: 'record_display_configuration',
  SN_RF_RECOMMENDATION_EXPERIENCE_TABLE: 'table',
  SN_RF_RECOMMENDATION_EXPERIENCE_ON_FIELD: 'on_field',
  SN_RF_RECOMMENDATION_EXPERIENCE_FIELD_MESSAGE: 'field_message',
  SN_RF_RECOMMENDATION_EXPERIENCE_THRESHOLD: 'threshold_for_stamping',
  SN_RF_RECOMMENDATION_EXPERIENCE_STAMP_VALUE: 'stamp_value',
  SN_RF_RECOMMENDATION_EXPERIENCE_PRIMARY_ACTION: 'primary_action',
  SN_RF_RECOMMENDATION_EXPERIENCE_OTHER_ACTIONS: 'other_actions',
  SN_RF_RECOMMENDATION_EXPERIENCE_ORDER: 'order',

  SN_RF_RECOMMENDATION_ACTION_LABEL: 'label',
  SN_RF_RECOMMENDATION_ACTION_ACTIVE: 'active',
  SN_RF_RECOMMENDATION_ACTION_TYPE: 'type',
  SN_RF_RECOMMENDATION_ACTION_UNDO_ACTION: 'undo_action',
  SN_RF_RECOMMENDATION_ACTION_SERVER_SCRIPT: 'server_script',
  SN_RF_RECOMMENDATION_ACTION_SUBFLOW: 'sub_flow',
  SN_RF_RECOMMENDATION_ACTION_ACTION_KEY: 'action_key',
  SN_RF_RECOMMENDATION_ACTION_CLIENT_PAYLOAD: 'uxf_client_payload',

  SN_RF_EVALUATION_TYPE_EVALUATION_SCRIPT: 'evaluation_script',
  SN_RF_EVALUATION_TYPE_NAME: 'name',

  SN_RF_EVALUATION_TYPE_INPUT_ELEMENT: 'element',
  SN_RF_EVALUATION_TYPE_INPUT_MODEL: 'model',

  SN_RF_RECORD_DISPLAY_CONFIGURATION_TABLE: 'table',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_CARD_LABEL: 'card_label',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_CARD_TITLE: 'card_title',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_CARD_DESCRIPTION_FIELD: 'card_description_field',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_CARD_ADDITIONAL_FIELDS: 'card_additional_fields',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_CARD_DISPLAY_FOOTER: 'card_display_footer',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_DETAIL_ADDITIONAL_FIELDS: 'detail_additional_fields',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_DETAIL_DISPLAY_WORK_NOTE: 'detail_display_work_note',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_DETAIL_TITLE_FIELD: 'detail_title_field',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_DETAIL_LINK_FIELD: 'detail_link_field',
  SN_RF_RECORD_DISPLAY_CONFIGURATION_DEFAULT_DETAIL_VIEW: 'default_detail_view',

  SN_RF_RECOMMENDATION_HISTORY_UNIQUE_VALUE: 'unique_value',
  SN_RF_RECOMMENDATION_HISTORY_RULE_OUTPUT: 'rule_output',
  SN_RF_RECOMMENDATION_HISTORY_TARGET_TABLE: 'target_table',
  SN_RF_RECOMMENDATION_HISTORY_TARGET_RECORD: 'target_record',
  SN_RF_RECOMMENDATION_HISTORY_RECOMMENDATION_EXPERIENCE: 'recommendation_experience',
  SN_RF_RECOMMENDATION_HISTORY_IS_PRIMARY_ACTION: 'is_primary_action',
  SN_RF_RECOMMENDATION_HISTORY_STATUS: 'status',
  SN_RF_RECOMMENDATION_HISTORY_RECOMMENDATION_ACTION: 'recommendation_action',
  SN_RF_RECOMMENDATION_HISTORY_RECOMMENDATION_RULE: 'recommendation_experience.recommendation_rule',
  SN_RF_RECOMMENDATION_HISTORY_SNAPSHOT_MOD_COUNT: 'snapshot_mod_count'
};

RFConstants.historyStatus = {
  COMPLETED: 'completed',
  REVERTED: 'reverted',
  DISCARDED: 'discarded'
};

RFConstants.evaluationOutputNames = {
  PREDICTED_RECORD: 'predictedRecord',
  OLDEST_CREATED_AT: 'oldestCreatedAt',
  COUNT: 'count',
  HIGHEST_CONFIDENCE_RECORD: 'highestConfidenceRecord',
  DISPLAY_VALUE: 'displayValue',
  VALUE: 'value',
  TREND_RECORD: 'trendRecord',
  PREDICTED_VALUE: 'predictedValue',
  CONFIDENCE_SCORE: 'confidenceScore',
  SIMILARITY_DEFINITION_ID: 'similarityDefinitionId',
  TREND_DEFINITION_ID: 'trendDefinitionId',
  QUALIFIED_RECORD_IDS: 'qualifiedRecordIds'
};
RFConstants.evaluationOutputLabels = {
  PREDICTED_RECORD: 'Prediction',
  OLDEST_CREATED_AT: 'Oldest created at',
  COUNT: 'Count',
  HIGHEST_CONFIDENCE_RECORD: 'Highest confidence',
  DISPLAY_VALUE: 'Display value',
  VALUE: 'Value',
  TREND_RECORD: 'Trend record',
  PREDICTED_VALUE: 'Predicted value',
  CONFIDENCE_SCORE: 'Confidence score',
  SIMILARITY_DEFINITION_ID: 'Similarity definition id',
  TREND_DEFINITION_ID: 'Trend definition id',
  QUALIFIED_RECORD_IDS: 'Qualified record ids'
};
RFConstants.evaluationOutputTypes = {
  STRING: 'string',
  REFERENCE: 'reference'
};

RFConstants.trendTypes = {
  COMMON_VALUE: 'common_value',
  COMMON_REFERENCE: 'common_reference',
  COMMON_CONDITION: 'common_condition'
};
RFConstants.trendReferenceTypes = {
  SIMPLE: 'simple',
  M2M: 'm2m'
};

RFConstants.mlPredictorOptions = {
  TOP_N: 'top_n'
};

RFConstants.piwbModelStatus = {
  NEW: 'new',
  IN_PROGRESS: 'in_progress',
  TRAINING_COMPLETE: 'training_complete',
  INTEGRATED: 'integrated',
  ERROR: 'error'
};

RFConstants.mlCapability = {
  CLASSIFICATION: 'classification_trainer'
};

RFConstants.evaluationTypeSysIds = {
  CONDITIONAL_RULES: '43121fa453433010e530ddeeff7b1293',
  SIMILARITY: 'd8128f64538330103953ddeeff7b1226',
  CLASSIFICATION: 'd303c535530330107234ddeeff7b1263',
  CLASSIFICATION_PIWB: '4893799553d330107234ddeeff7b12f8',
  SIMILARITY_WITH_TREND: '0f63ed41530330107234ddeeff7b1237'
};

RFConstants.experienceType = {
  MESSAGE_CARD: 'message_card',
  RECORD_CARD: 'record_card',
  FIELD_LEVEL: 'field_level'
};
RFConstants.actionType = {
  SERVER_SCRIPT: 'server_script',
  SUBFLOW: 'subflow',
  UXF_CLIENT_ACTION: 'uxf_client_action',
  DISCARD: 'discard',
  DISABLED: 'disabled'
};

RFConstants.actionVars = {
  CURRENT: 'current',
  RULE_OUTPUTS: 'ruleOutputs',
  RULE_OUTPUTS_SUBFLOW: 'rule_outputs',
  INTERNAL_NAME: 'internal_name',
  SCOPE: 'sys_scope',
  GLOBAL: 'global',
  DOT: '.'
};

RFConstants.pillPickerVars = {
  NAME: 'name',
  LABEL: 'label',
  TYPE: 'type',
  FILTERABLE: 'filterable',
  DISABLED: 'disabled',
  REFERENCE: 'reference',
  REFERENCE_TABLE: 'referenceTable',
  REFERENCE_DISPLAY_FIELD: 'reference_display_field',
  LINK: 'link',
  DOT: 'dot',
  TABLE: 'table',
  TABLE_LABEL: 'table_label',
  SYS_ID: 'sys_id',
  COLUMNS: 'columns',
  CONTEXT_RECORD_KEY: 'current',
  CONTEXT_RECORD_LABEL: 'Context',
  RULE_OUTPUT_KEY: 'ruleOutputs',
  RULE_OUTPUT_LABEL: 'Rule output',
  BASE_REFERENCE_LINK: '/api/now/em/meta/',
  RULE_OUTPUT_IDENTIFIER_TABLE: 'sn_rf_rule_output',
  BASE_ELEMENTS: 'base_elements',
  RULE_OUTPUT_ELEMENTS: 'rule_output_elements'
};

RFConstants.STATUS = 'status';
RFConstants.SUCCESS = 'success';
RFConstants.ERROR = 'error';
RFConstants.INITIALIZED = 'init';
RFConstants.EXCEPTION = 'exception';
RFConstants.ERROR_CODE = 'errorCode';
RFConstants.ERROR_MESSAGE = 'errorMessage';
RFConstants.DEFAULT_ACTION_SUCCESS_MESSAGE = gs.getMessage('Action was executed successfully.');
RFConstants.DEFAULT_ACTION_ERROR_MESSAGE = gs.getMessage('There was an error while executing action.');
RFConstants.DISCARD_SUCCESS_MESSAGE = gs.getMessage('This recommendation was discarded successfully.');
RFConstants.DISCARD_ERROR_MESSAGE = gs.getMessage('There was an error while discarding recommendation.');

RFConstants.TRUE = true;
RFConstants.FALSE = false;

RFConstants.DOT = '.';

RFConstants.operator = {
  IN: 'IN'
};

RFConstants.EVALUATOR_RECORD_SYS_ID = 'da2aa78753073010e530ddeeff7b12c6';
RFConstants.evaluatorVariable = {
  PARAM: 'param',
  RESULT: 'result',
  INPUTS: 'inputs',
  CONTEXT_RECORD: 'contextRecord',
  SCHEMA: 'schema',
  METADATA: 'metaData',
  CONFIDENCE: 'confidence',
  CONFIDENCE_INTERNAL: '__confidence',
  HIDDEN: 'hidden',
  HIDDEN_INTERNAL: '__hidden',
  UNIQUE_KEY: 'uniqueKey',
  UNIQUE_KEYS_INTERNAL: '__uniqueKey'
};
RFConstants.evaluatorFunction = {
  GET_EVALUATION_OUTPUT_SCHEMA: 'getEvaluationOutputSchema',
  GET_EVALUATION_OUTPUTS: 'getEvaluationOutputs'
};
RFConstants.graphQLExperienceTypes = {
  FORM: 'form',
  SIDE_COMPONENT: 'side_component',
  ALL: 'all'
};
RFConstants.experienceToTypes = {
  'form': [RFConstants.experienceType.FIELD_LEVEL],
  'side_component': [RFConstants.experienceType.MESSAGE_CARD, RFConstants.experienceType.RECORD_CARD],
  'all': [RFConstants.experienceType.FIELD_LEVEL, RFConstants.experienceType.MESSAGE_CARD, RFConstants.experienceType.RECORD_CARD]
};
RFConstants.queryConstants = {
  IN: 'IN',
  COUNT: 'count',
  TRUE: 'true'
};
RFConstants.extensionPoint = {
  SCRIPTING_RULE_INTERFACE: 'sn_rf.ScriptingRuleInterface'
};

RFConstants.experienceDetails = {
  SHOW_AS: 'showAs',
  ON_FIELD: 'onField',
  MESSAGE: 'message',
  STAMP_DETAILS: 'stampDetails',
  IS_CONFIDENT: 'isConfident',
  VALUE: 'value',
  DISPLAY_VALUE: 'displayValue',
  TAG: 'tag'
};

RFConstants.actionDetails = {
  TYPE: 'type',
  ACTION_SYS_ID: 'actionSysId',
  LABEL: 'label',
  IS_UNDO: 'isUndo',
  ADDITIONALPARAMETERS: 'additionalParameters',
  UNDO_OF: 'undoOf',
  ACTION_KEY: 'actionKey',
  CLIENT_PAYLOAD: 'clientPayload',
  RULE_OUTPUTS: 'ruleOutputs',
  EXPERIENCE_ID: 'experienceId'
};

RFConstants.stampResponse = {
  RECOMMENDATIONS: 'recommendations',
  FIELD_NAME: 'fieldName',
  FIELD_VALUE: 'fieldValue',
  IS_CONFIDENT: 'isConfident'
};

RFConstants.configurationPropertyVars = {
  PREFIX: 'com.sn_rf',
  sn_rf_recommendation_rule: 'rule',
  sn_rf_recommendation_experience: 'experience',
  active: 'active',
  threshold_for_stamping: 'threshold',
  FOOTER_VISIBLE: 'footer_visible',
  RECOMMENDATION: 'recommendation',
  ROLES_OVERRIDE: 'roles_override',
  PROPERTY_NOT_EXISTS: 'propertyNotExists'
};

RFConstants.DEFAULT_ORDER = 100;
RFConstants.VALUE = 'value';
RFConstants.LABEL = 'label';
RFConstants.TYPE = 'type';
RFConstants.REFERENCE_TYPE = 'referenceType';
RFConstants.USAGE = 'usage';
RFConstants.DISCARD_LABEL = gs.getMessage('Discard');
RFConstants.EMPTY_STRING = '';

Sys ID

d594c10b537230103953ddeeff7b124f

Offical Documentation

Official Docs: