Skip to main content

ExtractorFieldCapability Class

ExtractorFieldCapability is a class signifying the field information that an extractor can process, used in declaring capabilities when the GetCapabilities() method of the IExtractorActivity interface is initiated.

Definition​

  • Namespace: UiPath.DocumentProcessing.Contracts.DataExtraction
  • Assembly: UiPath.DocumentProcessing.Contracts

Description​

A public class that represents field level information that the extractor is capable of processing. Used by the extractor in order to declare its capabilities, when the GetCapabilities() method of the IExtractorActivity interface is called.

note

The ExtractorFieldCapability instances in the Components list should contain sub-field information that the extractor is capable of interpreting, if it receives them as input to an execution. An example of such sub-fields would be the columns of a table.

Members​

Constructors​

ExtractorFieldCapability() - The default constructor.

Properties​

  • FieldId string - an identifier for a field that the extractor can target for data extraction.
  • Components ExtractorFieldCapability[] - A list of sub-fields that the extractor can target for data extraction, for the given field.
  • SetValues string[] - If a field is of type Set (can have values from a limited number of allowed possibilities), this property will contain the possible values that are allowed for the given field.