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-slide-extractor".
- "appType" must always be specified as "slide-extractor".
- "appName" must always be specified as "Slide Extractor".
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| properties | Yes | - | No | Configuration object | |
| setTempFile | Yes | true | No | The path to the folder where the temporal files were processed. Furthermore, you can set a System Variable "user.dir" with the path | true/false |
| tempFilesPath | No | "${aspire.home}/temp" | No | The path to the folder where the temporal files were being processed | "${aspire.home}/temp" |
| maxFileSize | Yes | false | No | Maximum characters for the file loaded into memory to be parsed. (False will be set to unlimited) | true/false |
| characters | No | 1000000 | No | The max number of characters as a limit for the number of characters to be processed, to prevent memory consumption | 1000000 |
| addParentInfo | Yes | false | No | Check if you want to add extra info from the parent to every slide of the file | true/false |
| parentField | No | "datamodel" | No | Specify the name of the field from the parent job to add as extra info to every slide | "datamodel" |
| threadTimeout | Yes | 15 | No | Maximum time (in minutes) for the processing thread to wait for the parsing result | 15 |
| subJobSleep | Yes | 60000 | No | Time to wait (in milliseconds) until all sub jobs are done | 60000 |
| debug | No | false | No | Set to true to enable debug messages. | true/false |
Create example
POST /aspire/_api/workflows/:id/rules
# All languages
{
"type": "application",
"_type": "application",
"description": "sample-slide-extractor",
"config": "com.accenture.aspire:com.accenture.aspire:app-slide-extractor",
"appType": "slide-extractor",
"appName": "Slide Extractor",
"properties": {
"setTempFile": true,
"tempFilesPath": "${aspire.home}/temp",
"maxFileSize": true,
"characters": "1000000",
"addParentInfo": true,
"parentField": "datamodel",
"threadTimeout": 15,
"subJobSleep": 60000,
"debug": false
}
}
Overview
Content Tools
Copyright © 2024 Accenture
