Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Job Summarizer Executor can be configured using the Rest API. 

Easy Heading Free
navigationTitleOn this Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default

Create Job Summarizer Executor


addSchematrue

Field

Required

Default

Multiple

NotesExample
typeYes-No

The value must be "application".

"application"

_typeYes-No

The value must be "application".

"application"

appNameYes-NoThe name of the application"Job-Executor"
appTypeYes-NoThe value must be "job-summarize-executor"."job-summarize-executor"
configYes-NoThe value must be "com.accenture.aspire:app-jobsummarize-executor"."com.accenture.aspire:app-jobsummarize-executor"
descriptionYes-NoThe description

"Job-Executor"

propertiesYes-NoConfiguration object
dataPathYes-NoThe path of the job that contains the tables data"/doc"
containerPathYes-NoThe sub path of the data that contains each table"container"
tableIdPathYes-NoThe sub path of table data that contains the table id"container/url"
seedIdPathYes-NoIf enabled the table schema will be added to the processed columns.trueThe sub path of table data that contains the seed id"container/seed/id"
columnsPathYes-NoThe sub path of table objects that contains the columns information"dataProfile/columns"
columnNamePathYes-NoThe sub path of column objects that contains the column name"columnName"
columnTypePathYes-NoThe sub path of column objects that contains the column type"column_type"
columnsPatternsYes[]YesThe columns patterns to detect each column type[{"type":"TEXT","pattern":"STRING"},{"type":"INT","pattern":"INT32"}]
typeYes"TEXT"NoThe data type to use for the specified pattern. Accepted values: "TEXT", "LONG", "INT", "FLOAT", "DOUBLE", "BOOLEAN""TEXT"
patternYes-NoThe pattern to match"STRING"threadPoolYes5NoThe number of threads to use for parallel processing.5






logFrequencyYes1000NoThe frequency for reporting the processed rows.1000
filterRowsYesfalseNoEnable to filter the rows to process.true
useFilterFileYestrueNoEnable to use a groovy file to filter the rowstrue
groovyPathNo-NoThe path of the groovy script that contains the filter logic.  It must return a boolean value, if true the row will be filtered"C:\\Aspire\\config\\rowsGroovyFilter.txt"
groovyScriptNo-NoScript used to filter the rows. It must return a boolean value, if true the row will be filtered"row.getBoolean(\"sensitive\") == true"
urlYes-NoServer URL"http://localhost:9200/"
authTypeYes"none"NoThe authentication type. Accepted values: "none", "basic", "aws""none"
usernameYes-NoUser with the permissions to read from the Elastic index specified. Used only if the authType is "basic""admin"
passwordYes-NoThe password for the specified user. Used only if the authType is "basic""password"
regionYes-NoAWS region. Used only if the authType is "aws""us-east-2"
useCredentialsProviderChainYesfalseNoUse AWS Credentials Provider Chain. Used only if the authType is "aws""true"
accessKeyYes-NoKey utilized to access Amazon Web Services (AWS). Used only if the authType is "aws" and if useCredentialsProviderChain is false"AKIAIOSFODNN7EXAMPLE"
secretKeyYes-NoSecret key for the access key. Used only if the authType is "aws" and if useCredentialsProviderChain is false"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
assumeRoleNofalseNoEnable to assume the specified role to get the credentials. Used only if the authType is "aws"true
roleArnNo-NoThe Role ARN to assume. Used only if the authType is "aws" and if assumeRole is true"arn:aws:iam::123456789012:user/group/role"

Example

Code Block
themeRDark
titlePOST /aspire/_api/workflows/{workflow}/rules
{
  "type": "application",
  "_type": "application",
  "description": "Job-Executor",
  "config": "com.accenture.aspire:app-Jobsummarize-executor",
  "appType": "Job-summarize-executor",
  "appName": "Job Summarize Executor",
  "properties": {
    "addSchema": true,
    "useTempFile": true,
    "debug": false,
    "threadPool": 5,
    "logFrequency": 1000,
    "filterRows": true,
    "useFilterFile": false,
    "groovyScript": "// This script must return a boolean.\n// The references of the job, doc, component, row and table objects are available.\n// Javadoc references \n// Row (row) - http://{manager}/javadocs/com/accenture/aspire/services/summarization/Row.html\n// Table (table) - http://{manager}/javadocs/com/accenture/aspire/services/summarization/Table.html\nrow.getBoolean(\"sensitive\") == true"
  }
}

Update Job Summarizer Executor


Field

Required

Default

Multiple

NotesExample
idYes-NoId of the application to update"61014782-442a-4587-ab85-ba1439a7f7b5"
typeYes-No

The value must be "application".

"application"

_typeYes-No

The value must be "application".

"application"

appNameYes-NoThe name of the application"Job-Executor"
appTypeYes-NoThe value must be "job-summarize-executor"."job-summarize-executor"
configYes-NoThe value must be "com.accenture.aspire:app-jobsummarize-executor"."com.accenture.aspire:app-jobsummarize-executor"
descriptionYes-NoThe description

"Job-Executor"

propertiesYes-NoConfiguration object
addSchemaYestrueNoIf enabled the table schema will be added to the processed columns.true
threadPoolYes5NoThe number of threads to use for parallel processing.5
logFrequencyYes1000NoThe frequency for reporting the processed rows.1000
filterRowsYesfalseNoEnable to filter the rows to process.true
useFilterFileYestrueNoEnable to use a groovy file to filter the rowstrue
groovyPathNo-NoThe path of the groovy script that contains the filter logic.  It must return a boolean value, if true the row will be filtered"C:\\Aspire\\config\\rowsGroovyFilter.txt"
groovyScriptNo-NoScript used to filter the rows. It must return a boolean value, if true the row will be filtered"row.getBoolean(\"sensitive\") == true"

Example

Code Block
themeRDark
titlePUT /aspire/_api/workflows/{workflow}/rules/{id}
{
  "id": "61014782-442a-4587-ab85-ba1439a7f7b5", 
   "type": "application",
  "_type": "application",
  "description": "Job-Executor",
  "config": "com.accenture.aspire:app-Jobsummarize-executor",
  "appType": "Job-summarize-executor",
  "appName": "Job Summarize Executor",
  "properties": {
    "addSchema": true,
    "useTempFile": true,
    "debug": false,
    "threadPool": 5,
    "logFrequency": 1000,
    "filterRows": true,
    "useFilterFile": false,
    "groovyScript": "// This script must return a boolean.\n// The references of the job, doc, component, row and table objects are available.\n// Javadoc references \n// Row (row) - http://{manager}/javadocs/com/accenture/aspire/services/summarization/Row.html\n// Table (table) - http://{manager}/javadocs/com/accenture/aspire/services/summarization/Table.html\nrow.getBoolean(\"sensitive\") == true"
  }
}