Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Scenario Configuration

General Properties

Configuration element

Equivalent

[General].IncludeConfig

General.IncludeConfig[]

[General].InputSystem

InputSystem

InputFormat[]

ProcessReadIndex[]

[General].OutputSystem

OutputFormat[]

OutputSystem[]

[General].CheckDuplicateInputMode

Input.CheckDuplicateMode

Input.CheckDuplicateMacro

[General].Priority

General.Priority

[General].WriteStackLogFile

General.BatchLogFile

[General].MaxErrorDocsInStack

---

(An attempt is always made to process all documents in a batch)

[General].ErrorReset***

General.Retry***

[General].DummyStackOnInputError

---

(If a read-in error occurs, an empty batch data record is always generated)

[General].DisableOutputOnErrorText

---

[General].KeepWorkFiles

Backup.DeleteFromStorage (no named marking as deleted)

[General].TransactionMode

---

(mode always active)

[General].StackMacro***

---

(Batch-related actions are no longer supported, as processing only takes place at document level)

[General].SwitchScenario

Process.ScenarioSwitchMacro

[General].SwitchScenarioReadOriginalFields

---

[General].CustomKey

Input.CustomKeyMacro

[General].GlobalKey

---

[General].StatService***

---

[General].MacroLegacyMode

---

(The macro parser generally no longer supports old syntax)

[Constants]

Constant[]

[Process.Macros]

ProcessMacro[].Macro[]

Field Catalog

Configuration element

Equivalent

[Fields].ControlFields

FieldCatalog[].ConditionMacro

Differentiation between standard catalog [Fields] and alternative catalog [Fields.{control field content}]

FieldCatalog[].IsDefault

[Fields].GlobalFields

FieldCatalog[].IsGlobal

[Fields].Field

FieldCatalog[].Field[]

[Fields].Field.Type

---

(Type determination implicitly via field name syntax, i.e. whether table name is prefixed)

[Fields].Field.InternalName

FieldCatalog[].Field[].Name

[Fields].Field.InputName

ProcessReadIndex[].Field[].InputName

[Fields].Field.OutputName

OutputFormat[].Field[].OutputName OutputSystem[].Field[].OutputName

[Fields].Field.OutputFlag

---

(Definition implicitly through the existence of a mapping in OutputFormat[].Field[] or OutputSystem[].Field[])

[Fields].Field.InputFormat

ProcessReadIndex[].Field[].InputFormat

[Fields].Field.OutputFormat

OutputFormat[].Field[].OutputFormat OutputSystem[].Field[].OutputFormat

[Fields].Field.Check

FieldCatalog[].Field[].InitType

(Mandatory field check to be carried out explicitly via macro printout if necessary)

[Fields].Field.Macro

FieldCatalog[].Field[].InitValue FieldCatalog[].Field[].InitMacro

Input Interfaces – General Properties

Configuration element

Equivalent

[Input].BackupFolder

Backup.DestFolder

[Input].BackupDuplicatesMode

Backup.OnDestFileExists

[Input].DocFilePrepareMacro

Input.PreProcessMacro[]

(Execution only takes place after a possible document separation)

[Input].DocSplit***

Input.DocSplit.***

[Input].DocDuplicate***

---

[Input].DocMerge***

---

[Input].DeleteSignalFiles

---

[Input].MultiFieldSep

ProcessReadIndex[].ReadMultiValues

(Read in as an array instead of a string separated by separators)

[Input].StackLogFile

General.BatchLogFile

[Input].WriteWebServiceRequestFile

---

(Can only be activated as normal trace log entries for xSuite Archive output systems)

[Input].IgnoreInitError

---

[Input].ForceGcCollect

---

[Input].ProcessDelay***

---

[Input].MacroPre

Input.DocSplit.PreProcessMacro[] Input.PreProcessMacro[]

[Input].MacroPost

Input.PostProcessMacro[]

Input Interfaces

Configuration element

Equivalent

AscentXtrata

---

COLD

Input system "File"

Input system "Pdf"

Index data reader "Pdf"

(Only PDF files are supported, but no more textual COLD files)

EASYDocuments

---

EASYDocumentsSOAP

---

EASYSID

Input system "File"

Input format "EasySid"

Index data reader "EasySid"

EDI

---

ExchangeGraph

Input system "ExchangeGraph"

Index data reader "Json"

ExchangeWS

Input system "ExchangeWs"

Index data reader "Json"

ImageFile

Input system "File" or "Folder"

Index data reader "FileName"

IRISXScan

---

IRISXtractConnector

---

IRISXtractExport

Input system "Xtract"

Index data reader "Csv", "Xml" and/or "XtractDat"

ITZBundZRE

---

JSONFile

Input system "File"

Input format "Json"

Index data reader "Json"

Mail

Input system "ImapMail" or "Pop3Mail"

Index data reader "Json"

MSOffice

Input system "File"

Index data reader "MsExcel" or "MsWord"

PEPPOLInvoice

Input system "File"

Input format "PeppolInvoice"

Index data reader "PeppolInvoice"

SAPxFlowInterfaceNetRFC

---

SQLDB

---

Storecove

---

Possible alternative: "XSuiteEDna" input system, "XSuiteEDnaInvoice" input format and "XSuiteEDnaInvoice" index data reader

TextRecords

Input system "File"

Input format "Csv"

Index data reader "Csv"

(Only the CSV format is supported.)

xFlowBus2

Input system "XSuiteBus2"

Index data reader "XSuiteBus2"

xFlowIInternal

Input system "File"

Input format "InternalJson"

Index data reader "InternalJson"

xFlowIndexClient (Office+)

---

(Possible alternative: "WebServiceIndexClient" input system and "WebService" index data reader)

xFlowIndexWebClient xFlowIndexWebClient2 (Office+ as web application)

Input system "WebServiceIndexClient"

Index data reader "WebService"

xFlowIRestService

Input system "WebServiceInput"

Index data reader "WebService"

xFlowIRestServiceNotify

---

xFlowIRestServiceQuery

Input system "WebServiceOutputClient"

Index data reader "WebService"

xFlowIWebService (SOAP)

---

(Alternative: "WebServiceInput" input system and "WebService" index data reader)

xFlowIWebServiceQuery (SOAP)

---

(Alternative: "WebServiceOutputClient" input system and "WebService" index data reader)

XRechnung

Input system "File "

Input format "XRechnung"

Index data reader "XRechnung"

XRechPortalNRW

---

xSuiteHelixWFL

Input system "XSuiteWorkflow"

Index data reader "Json"

(Only the WFL API v2 is supported instead of v1)

ZUGFeRD (Version 1.0)

---

ZUGFeRD2 (Version 1.0 and 2.x)

Input system "File"

Input format "Zugferd"

Index data reader "Zugferd"

(Only ZUGFeRD version 2.x is supported)

Output interfaces – General properties

Configuration element

Equivalent

[Output].Condition

OutputFormat[].ConditionMacro

OutputSystem[].ConditionMacro

[Output].BreakAfterOutput

---

[Output].MacroPre

[Output].MacroPost

OutputSystem[].PreProcessMacro[]

OutputSystem[].PostProcessMacro[]

[Output].FileFilter

[Output].FileFilterExclude

OutputFormat[].AttachFileFilter

OutputSystem[].FileFilter

[Output].PosColSep

[Output].PosLineSep

[Output].PosMaxLen

[Output].PosOutputEmptyFields

---

[Output].MultiFieldSep

---

(This element is not relevant because multiple values within a field are stored as an array and not as a delimited string. The new property Output***[].MultiValueSep is the counterpart for converting such an array into a delimited string on output.)

Output Interfaces

Configuration element

Equivalent

Custom

---

EASYDocumentsSOAP

Output System "OtrisDocumentsSoap"

EASYSID

---

EASYXMLServer

---

ImageFile

Output system "File"

IRISXtract

---

JSONFile

Output format "Json"

Output system "File" or "MongoDB"

Mail

Output System "Mail"

SAPxFlowInterfaceNetRFC

Output system "SapXSuiteInterfaceNwRfc" (requires other SAP interface files)

SAPxSuiteInterfaceSOAP

Output System "SapXSuiteInterfaceSoap"

SQLDB

---

StoreCove

StoreCoveResult

---

Test

---

TextFile

Output format "Text"

Output system "File"

xFlowArchiveClient

---

(Alternative: "XSuiteArchivePrism" output system)

xFlowArchiveRestService

XSuiteArchivePrism" or "XSuiteArchiveHelixLegacy" output system

xFlowBus2

Output system "XSuiteBus2"

xFlowIndexWebClient2StackOrg***

Process.StackOrg.***

Output system "StackOrg"

xFlowIInternal

Output format "InternalJson"

Output system "File"

xFlowIRestService

Output system "WebServiceInputClient"

xFlowIRestServiceListen

Output system "WebServiceOutput"

xFlowIWebService (SOAP)

---

(Alternative: output system "WebServiceInputClient")

xFlowIWebServiceListen (SOAP)

---

(Alternative: output system "WebServiceOutput")

XMLFile

Output format "Xml"

Output system "File"

xSuiteHelixArchive

Output System "XSuiteArchiveHelix"

xSuiteHelixConveyorResult

Output System "XSuiteConveyorResult"

xSuiteHelixWFL

Output System "XSuiteWorkflow"

(Only the WFL API v2 is supported instead of v1)

xSuiteSphere

---

ZUGFeRD

---