You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

The Tabular Files Extractor component can be configured using the Aspire REST API. It requires the following entities to be created:

Below are the examples of how to configure the component. 



API Fields

  • "type" must always be specified as "application".
  • "_type" must always be specified as "application".
  • "description" must be a descriptive string without spaces.
  • "config" must always be specified as "com.accenture.aspire:app-tabular-files-extractor".
  • "appType" must always be specified as "tabular-files-extractor".
  • "appName" must always be specified as "Tabular Files Extractor".


Create Workflow


NOTE: Some options in the following table collapse or are displayed only when selecting other options, such as a checkbox or selects.


Field


Required


Default


Multiple

NotesExample
descriptionYes-NoName of the component application.

"tabular-files-extractor"

propertiesYes-NoConfiguration object
separatorAltYescomma (,)NoThe character that is used to separate each column on the tabular file. It can be: comma, semicolon, tab, pipe, SOH start of header (x001), dotaccent (·) (x307), c-cedilla (Ç), medium shade (▒), tilde (~) or a custom string separator (not longer than 5 characters)comma (,)
separatorYes""NoCustom separator string, cannot be longer than 5 characters"^|"
headersOnFirstRowYestrueNoWhether to use the first row data as column names or not. If false, columns will be named column1, column2, ...,true
ignoreQuotesYestrueNoDetermine if the quotes are going to be used as literal text or nottrue
maxSubJobsYes0NoMax number of sub-jobs, 0 means process all sub-jobs0
maxLinesToReadYes0NoMax number of lines to read, 0 means process all lines0
genericColumnNameYescolumnNoIf column names are not specified in the first row, this prefix will be used for column names followed by a sequential number"column"
includeEmptyColumnsYesfalseNoWhether or not to include empty columns in sub-jobsfalse
metadataMapYes-NoConfiguration object for your mapping configuration
debugNofalseNoOption if you want to debug messages enabled.false

Example 

NOTE: The following structure is not ordered by the sections of the component configuration.

PUT aspire/_api/workflows/9bdf3efb-c266-46ac-ab59-eb8eda87d9e9/rules
{     
	"type": "application",
	"appName": "Tabular Files Extractor",
	"appType": "tabular-files-extractor",
	"config": "com.accenture.aspire:app-tabular-files-extractor",
	"description": "tabular-files-extractor",
	"properties": {
		"debug": true
	} 
}  
  • No labels