Skip to main content
Skill parameters allow you to adjust the behavior of a skill without having to change, retrain, and publish it again. This is useful for complex skills that require large numbers of training documents. In the case of a Document skill, skill parameters are used to adjust the skill to various document processing scenarios. In the case of a Process skill, skill parameters are used to reference and adjust the parameters of its Document skill.
Important: Only users with the Tenant Administrator and Skill Designer roles can create and edit skill parameters.

Use Cases

Several common scenarios demonstrate the value of skill parameters:

Processing invoices from different customers using their own data catalogs

You may want to use the same built-in invoice skill to process invoices from different customers. In this case, you can use skill parameters to pass the right data catalog in a particular transaction created with the Vantage API. Some built-in skills, including the Invoice skill, have default parameters that can be used to refer to data catalogs used in a skill. You just need to change their values by passing a new data catalog in the transaction. For information on how to edit skill parameters values via the Vantage API, see Accessing skill parameters via the Vantage API.

Restricting automatic country and expense type detection

You may want to use the Receipt skill to process retail receipts only from one particular country, for example, from Germany. Some built-in skills, including the Receipt skill, have default parameters that can be used to restrict automatic country and expense type detection. To process only German receipts, you will need to specify “DE” and “GeneralRetail” as the values of these parameters. The Country and Expense Type fields will be redefined accordingly, and documents will be processed faster.

Assigning a new value to a certain field

You may want to configure your Document skill to assign a new value to the Date field when processing a specific document set. To do this, you will need to create a new Boolean skill parameter, set its value to No, and add a scripted rule for the Date field. The scripted rule can look like the following:
if (Context.Skill.Parameters["New parameter"].Value == false) {
  Context.GetField("Date field").Value = 'New date'
}
When processing a specific document set, the rule will check whether the value of the Boolean skill parameter is set to No, and if yes, the “New date” value will be assigned to the Date field.

Relations Between Parameters on Different Levels

A Process skill can include an Extract activity that, in turn, uses a Document skill. On each level of this nested structure, you can add and set up the following parameters:
  • Document skill parameters: Used to share extracted data between activities of the Document skill and to specify various document processing settings. You can view and edit these parameters in Vantage, Advanced Designer, and via the Vantage API.
  • Extract activity parameters: Essentially the Document skill parameters that can be accessed from the Extract activity. You can view and edit these parameters in Vantage.
  • Process skill parameters: Used to reference Extract activity parameters and change their values. You can view and edit these parameters in Vantage and via the Vantage API.
Tip: If your Document skill has no parameters, you don’t need to add any parameters to the Process skill.

Types of Skill Parameters

Skill parameters can be of any of the following three types:
TypeDescription
Data CatalogContains a connection string to a data catalog on the server that you are connected to
TextContains a string value
BooleanContains a Boolean value. The possible values are Yes and No

See Also