Documentation

Create Model Advisor Checks

Pass/fail checks, check registration and definition, callback functions, action definition, formatted results

You can use the Model Advisor API to create Model Advisor checks. Custom checks provide you with the ability to specify which conditions and configuration settings the Model Advisor reviews. For the workflow, see Create Model Advisor Checks Workflow. For simple examples, see Create and Add Custom Checks - Basic Examples.

Classes

Advisor.authoring.CustomCheckDefine custom check
Advisor.authoring.DataFileInteract with data file for model configuration checks
ModelAdvisor.ActionAdd actions to custom checks
ModelAdvisor.CheckCreate custom checks
ModelAdvisor.PreferencesSet Model Advisor window preferences by specifying which folders and tabs to display
ModelAdvisor.GroupDefine custom folder
ModelAdvisor.InputParameterAdd input parameters to custom checks
ModelAdvisor.ListViewParameterAdd list view parameters to custom checks
ModelAdvisor.ProcedureDefine custom procedures
ModelAdvisor.RootIdentify root node
ModelAdvisor.FormatTemplateTemplate for formatting Model Advisor analysis results
ModelAdvisor.ImageInclude image in Model Advisor output
ModelAdvisor.LineBreakInsert line break
ModelAdvisor.ListCreate list class
ModelAdvisor.ParagraphCreate and format paragraph
ModelAdvisor.TableCreate table
ModelAdvisor.TextCreate Model Advisor text output

Functions

Advisor.authoring.generateConfigurationParameterDataFileGenerate XML data file for custom configuration parameter check

Topics

Create Model Advisor Checks Workflow

When you create checks, follow this workflow.

Create and Add Custom Checks - Basic Examples

These examples show how to add a custom check to the By Product folder, create a pass/fail check, and create a pass/fail check with a fix action.

Create Check for Model Configuration Parameters

To verify the configuration parameters for your model, create a configuration parameter check.

Register Checks

To add checks to the Model Advisor, register the checks.

Define Custom Checks

Define custom checks in functions that specify the properties of the ModelAdvisor.Check class.

Create Callback Functions and Results

To execute the Model Advisor custom check, create a callback function for each check and action.

Exclude Blocks From Custom Checks

This example shows how to exclude blocks from custom checks.

Format Check Results

Use the ModelAdvisor.FormatTemplate class to format the custom check results.

Was this topic helpful?