org-readiness.json Attributes

Org Readiness Attributes

values Attributes

Each entry must match a variable from the variables.json file, with a defined value to use for the readiness validation. values can contain 0 or more variables.

This example illustrates how to define values for different variable types.

"values": {
  "booleanVar" : true,
  "stringVar" : "My string", 
  "numericVar" : 10, 
  "sobjectFieldVar" : {
    "sobjectName": "Opportunity",
    "fieldName": "StageName"
  }
}

templateRequirements Attributes

An array of requirements to use for validating the template. A requirement uses a definition to evaluate at runtime. The optional type, image, tags, and message attributes define how the requirement results are displayed to end users.

This example illustrates how to define requirements of different complexity.

”templateRequirements” : [
  {
    "expression" : "${Readiness.numberOfAccounts > Variables.numericValue}",
    "type" : "SobjectRowCount",
    "image" : {
      "namespace" : "my_namespace",
      "name" : "accounts_required.jpg"
    }, 
    "successMessage" : "Your org contains enough accounts to proceed.",
    "failMessage" : "You only have ${Readiness.numberOfAccounts} accounts. You must have ${Variables.numericValue} or more accounts to proceed."
    "tags" : ["Accounts", "Cases"]
  },
  {
    "expression" : "${Readiness.numberOfCases > 5}",
    "failMessage" : "You must have 5 or more cases to proceed."
  }
]

definition Attributes

Each entry defines a readiness check. There must be at least 1 definition that is used in the templateRequirements. The evaluated result of each definition is stored in the template context as Readiness['<definition_name>'].

These examples illustrate definitions for different requirement types.

The OrgPreferenceCheck validates one or more org preferences.

"Example Org Readiness Check": {
  "type" : "OrgPreferenceCheck",
  "names" : [ "DashboardSavedViewEnabled" ]
}

EL Expression: ${Readiness['Example Org Readiness Check'].DashboardSavedViewEnabled}

The SobjectRowCount performs a SOQL query to retrieve a row count for the specified sObject and optional filters. Both the sobject and filter attributes can contain EL expressions that are resolved at runtime. This example validates that there are a specific number of accounts with an annual revenue greater than the minimum value specified at runtime. This check is performed before app creation and the results are available for templateReadiness.

"Count of Accounts Revenue" : {
  "type" : "SobjectRowCount",
  "sobject" : "Account", 
  "filters" : [
    {
      "field" : "AnnualRevenue",
      "operator" : "GreaterThan", 
      "value" : "${Variables.MinimumAnnualRevenue}"
    }
  ]
}

EL Expression: ${Readiness['Count of Accounts Revenue'] >= 500}

The OrgDatasetRowCount performs a SQL query on an existing dataset to determine row count based on the dataset id or name and optional filters. This check can query datasets outside of the scope of the current or future app, which is useful for templates that have template dependencies on other apps. This check is performed before app creation and the results are available for templateReadiness.

"Query Parent App Dataset" : {
  "type" : "OrgDatasetRowCount",
  "dataset" : "${Apps.parentTemplateApp.Datasets.quota.Id}",
  "filters" : [
    {
      "field" : "QuotaDollarValue",
      "operator" : "LessThan",
      "value" : "100000"
    }
  ]
}

EL Expression: ${Readiness['Query Parent App Dataset'] >= 500}

The AppDatasetRowCount performs a SQL query on an existing dataset to determine row count based on the dataset id or name and optional filters. This check queries datasets that are created by the template. It validates if a dataset dependent asset, such as a dashboard or Einstein Discovery story can or should be created. This check is performed during app construction, after the datasets are created and recipes are run to populate the datasets. The results of this check can’t be referenced by templateRequirements, but they can be referenced by template asset conditions in template-info.json.

"Query App Dataset" : {
  "type" : "AppDatasetRowCount",
  "dataset" : "${App.Datasets.quota.Id}",
  "filters" : [
    {
      "field" : "QuotaDollarValue",
      "operator" : "LessThan",
      "value" : "100000"
    }
  ]
}

EL Expression: ${Readiness['Query App Dataset'] >= 500}

The ApexCallout performs a check using a custom Apex method in the template’s implementation of WaveTemplateConfigurationModifier. The method must be a non-static, global method with an arbitrary number of arguments. The method return value is also arbitrary or void and is place into the template context for reference in the templateRequirements or in rules processing.

"Global Apex Method Readiness Check" : {
  "type" : "ApexCallout",
  "method" : "checkReadiness",
  "arguments" : {
    "booleanArg" : true
  }
}

EL Expression: ${Readiness['Global Apex Method Readiness Check'] == true}

Example Apex method for the readiness check

global Boolean checkReadiness(Boolean booleanArg) {
  if (booleanArg) {
    return true;
  }
  return false;
}

The DataCloudRowCount performs a SQL query on an existing Data Cloud object, DLO, DMO, or Calculated Insight, to determine row count based on the object name or id and optional filters. This check can query Data Cloud objects outside of the scope of the current or future app. This check is for templates that have dependencies on the existence and status of specific Data Cloud objects. This check is performed before app creation and the results are available for templateReadiness.

"Row Count of DMO" : {
  "type" : "DataCloudRowCount",
  "object" : "ssot__Account__dlm",
  "filters" : [
    {
      "field" : "Id__c",
      "operator" : "In",
      "value" : ["001RO00004KkxxLxxx", "001RO00004KkxxMxxx"]
    }
  ]
}

EL Expression: ${Readiness['Row Count of DMO'] >= 0}