Dashboard parameters

For the SLA JSON string field, you enter parameter values that affect the behavior of the dashboard.

For information about these parameters and the specific parameter names to use, see the Service-level-agreement parameters section in this topic. Use the following format for the field value (but without any carriage returns):


{"SLA": {
    "parameter1-name": parameter1-value,
    "parameter2-name": parameter2-value,
    "parameterN-name": parameterN-value
    }
}

Here is an example:


{"SLA": {
    "businessName": "IBM Corporation",
    "appName": "TravelDocs",
    "batchesAbortedInPresetTime": 20,
    "batchesPendingInPresetTime": 100,
    "pageAccuracy": 97.9,
    "fieldAccuracy": 96.5
    }
}

Service-level-agreement parameters

Parameter subject matter	Parameter name	Statistics type	Comments
Accuracy rate - field - minimum	fieldAccuracy	OCR accuracy	A percentage such as 96.5 that specifies the minimum OCR accuracy rate for fields. A warning is shown if the recent OCR accuracy rate is below the specified minimum but not more than 10% below the minimum. An alert is shown if the recent OCR accuracy rate is more than 10% below the minimum.
Accuracy rate - page - minimum	pageAccuracy	OCR accuracy	A percentage such as 97.9 that specifies the minimum accuracy rate for page type identification. A warning is shown if the recent page identification accuracy rate is below the specified minimum but not more than 10% below the minimum. An alert is shown if the recent page identification accuracy rate is more than 10% below the minimum.
Batches - aborted	batchesAbortedInPresetTime	In-progress tasks	The number of minutes that a batch must have an aborted status to be reported by the dashboard as aborted. For example, a parameter value of 60 means that the dashboard shows all aborted batches that were aborted 60 minutes ago or longer. If you configure email notification, an email is sent for a batch in the following circumstances: the batch has an aborted status beyond the specified period, and the batch is one of the top 10 longest aborted batches. For details about the emails that are sent, see Enabling email notification.
Batches - pending	batchesPendingInPresetTime	In-progress tasks	The number of minutes that a batch must have a pending status to be reported by the dashboard as pending. For example, a parameter value of 120 means that the dashboard shows all pending batches that were made pending 120 minutes ago or longer. If you configure email notification, an email is sent for a batch in the following circumstances: the batch has a pending status beyond the specified period, and the batch is one of the top 10 longest pending batches. For details about the emails that are sent, see Enabling email notification.
Name - application	appName	N/A	The names of the applications for which you enabled statistics collection. For information about enabling statistics collection, see Enabling application statistics collection.
Name - business	businessName	N/A	The name of your business