Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Macros

General Properties

Language element

Deviations

Data types

New array data type for handling multiple values (instead of separator-separated strings)

Variables

Internal system variables are often renamed. Examples would be

DOCID DocName DOCDBID DocId STACKID BatchName STACKDBID BatchId

Constants

  • No support for constants in macro expressions in the syntax "@{constant name}"

  • Syntax yyyy-MM-ddTHH:mm:ss for constant date values no longer supported, but only yyyy-MM-dd HH:mm:ss

Operators

Operator ? (short form for If(), IfThen() and IfThenElse()) no longer supported)

Macro parameters

Escape sequences in text parameters no longer supported, some of which might be proprietary (except \n)

Field macros

Elimination of unnecessary auxiliary functions that replaced operators not yet available in the old macro syntax (e.g., And() and Add()) and were used to define elementary values (e.g., ConstStr())

File conversion macros

  • Elimination of the standard function parameters 3 (use original files) and 4 (discard source file)

  • Removal of the obsolete "ImageMan" graphics library (the relevant functions are now only implemented via the "GdPicture" library)

Batch macros

Not implemented

Field Macros

Macro function

Equivalent

CheckMandatory

Field macro CheckMandatory()

Default

Field property . Field[].InitValue

ExecBlock

Formulation as a block in curly brackets: {expression1; ...; expressionN}

IfEmptyThen

---

(Alternative: Check and, if necessary, execution using field macros If() and IsEmpty())

IfThen, If, ?

Field macro If()

(Parameter lists of variable length are not supported. Alternatively, these can be formulated as a block.)

IfThenElse, If, ?

Field macro IfElse()

Pause

Field macro Pause()

SelectCase

Field macro Switch() (working method differs in detail)

Macro function

Equivalent

And

Operator &, && or and

Or

Operator |, || or or

Contains

Field macro Contains()

IsEmpty

Field macro IsEmpty()

IsEqual

Operator = or ==

IsGreater

Operator >

IsNotEqual

Operator ! = or <>

IsLess

Operator <

IsLike

Operator ~

IsNumber

Field macro CanParseAsNumber()

Not

Operator !

RegExIsMatch

Field macro RegExIsMatch()

Macro function

Equivalent

Between

---

ConstStr

Formulation as a constant text value

ExtractCOLD

---

FileNamePart

GetFilePart() field macro

FilterValidChars

Field macro KeepChars()

Join

Operator +

LCut

RCut

Field macros CutLeft() and CutRight()

Left

Right

Left() and Right() field macros

IndexOf

Field macro Pos()

Length

Field macro Length()

LFill

RFill

Field macros FillLeft() and FillRight()

Mid

Field macro Mid()

RegExMatch

Field macros RegExMatch() and RegExMatches()

RegExReplace

Field macro RegExReplace()

RemoveInvalidChars

Field macro RemoveChars()

Replace

Field macro Replace()

ToANSI

---

ToLower

ToUpper

Field macros ToLower() and ToUpper()

Trim

LTrim

RTrim

Field macros Trim(), TrimLeft() and TrimRight()

Macro function

Equivalent

AddListValue

---

(possible alternative: field macro AppendItem() for arrays)

ContainsListValue

---

(possible alternative: field macro Contains() for arrays)

FilterListValues

---

(possible alternative: field macro RemoveItemsWhere() for arrays)

FirstNonEmptyListValue

---

(possible alternative: GetItemWhere() field macro for arrays with ! IsEmpty() as a condition)

ForEachListValue

---

(possible alternative: field macro ForEachItem() for arrays)

ListLength

---

(possible alternative: ItemCount() field macro for arrays)

ListValue

---

(possible alternative: GetItem() field macro for arrays)

IndexOfListValue

---

(possible alternative: field macros ItemNo() or ItemNoWhere() for arrays)

PosValuesToList

---

RemoveEmptyListValues

---

(possible alternative: field macro RemoveItemsWhere() for arrays with IsEmpty() as a condition)

RemoveListDuplicates

---

(possible alternative: field macro Distinct() for arrays)

RemoveListValue

---

(possible alternative: field macros RemoveItem() or RemoveItemAt() for arrays)

ReplaceListValue

---

(possible alternative: ReplaceItemAt() field macro for arrays)

SortList

---

(possible alternative: field macro Sort() for arrays)

Macro function

Equivalent

ConstDat

Formulation as a constant date value

CalendarWeek

---

CurrentDate

Field macro GetDate()

DateAdd

Field macro DateAdd()

Day Month Year

Field macro GetDatePart()

DayOfWeek

---

FirstDateOfWeek

---

IsLeapYear

---

LastDateOfMonth LastDateOfPrevMonth FirstDateOfNextMonth

---

Timestamp

Combination of GetDate() and ToText() field macros

ToDate

Field macro ParseAsDate()

Macro function

Equivalent

Add

Operator +

Divide

Operator / or \

CalcGrossAmount

---

CalcVatRate

---

ConstNum

Formulation as a constant numerical value

HexToNumber

---

Mod

Operator % or mod

Multiply

Operator *

Round

Field macro Round()

Subtract

Operator -

ToNegative

---

(Alternative: check whether greater than zero and multiply by -1 if necessary)

ToNumber

Field macro ParseAsNumber()

ToPositive

Field macro Abs()

Macro function

Equivalent

FindFirstMatch

---

(Alternative: Field macro RegExMatch())

FindLastMatch

---

FindFirstMatchStartIndex FindFirstMatchStartIndex

---

(Alternative: field macros RegExMatchPos and RegExLastMatchPos)

FirstNonEmptyParam

---

LookupDB

Field macro QueryDbField()

LookupINI

LookupINILike

Field macros Lookup() and LookupLike() (reading from different configuration file not supported)

LookupXInvoiceCode

---

Macro function

Equivalent

ExtractBarcode

Field macro ReadBarcode()

ExtractFulltextOCR

Field macro ExtractFullTextOcr()

ExtractFulltextPDF

Field macro ExtractFullTextPdf()

ExtractIndex

---

(possible alternative: use index data reader)

ExtractProperty

Index data reader "Mail" as well as field macros GetImageProperty() and GetPdfProperty() (deviating, no support for XML files)

Macro function

Equivalent

BLOBContains

---

(Alternative for PDF files: GetPdfProperty() field macro with EmbeddedCount property)

BLOBCount

BLOBCountExclude

Field macro FileCount()

BLOBName

GetFileProperty() or GetFilesProperty() field macros with Name property (no selection possible via index number of the file attachment)

BLOBProperty

Field macros GetFileProperty() or GetFilesProperty(), GetFileExtKey() or GetFilesExtKey() and GetFileMetaData() or GetFilesMetaData() (external file properties are not supported, e.g. the creation date)

CurrentPos

---

DocProperty

Field macro GetDocProperty()

IsFirstDoc

IsLastDoc

---

IsFirstPos

IsLastPos

---

PosCount

Field macro LineItemCount()

StackID

Field macro GetDocProperty() with property BatchName or document variable BatchName

DocID

Field macro GetDocProperty() with property Name or document variable DocName

StackProperty

---

(Subset of batch properties can be read via GetDocProperty() field macro or document variables)

Macro function

Equivalent

Break

---

Debug

---

Defer

Document macro SetDeferred()

Error

Suspend

Cancel

Document macros SetError(), SetSuspended() and SetCanceled()

Log

---

Macro function

Equivalent

AddXMLNode

Field macro AddXmlNode()

AggregatesPosFields

---

ClassifyImage

---

Custom

Custom field macro function (in external DLL file) or custom JavaScript macro function of type "Field"

Encrypt Decrypt

---

FindZUGFeRDFileAttach

Field macros FindEInvoiceFileByFormat() or FindEInvoiceFilesByFormat with format "ZUGFeRD" and field macros IsZugferdXml() or IsZugferdPdf()

FindXInvoiceFileAttach

Field macros FindEInvoiceFileByFormat() or FindEInvoiceFilesByFormat with format "XRechnung" and field macro IsXRechnungXml()

FindPEPPOLInvoiceFileAttach

Field macros FindEInvoiceFileByFormat() or FindEInvoiceFilesByFormat with format "Peppol" and field macro IsPeppolXml()

EvalKoSITValidatorReport

Field macro EvalKositValidatorReport()

ExecDBCommand

Field macros ExecDbCommand() and QueryDbField()

ExecVB

ExecCS

---

Custom field macro function (in external DLL file) or custom JavaScript macro function of type "Field"

Format

Field macro ToText()

GetFromRestService

Field macro CallWebService()

GetStackAttribute

SetStackAttribute

---

GlobalCount

---

(Alternative: field macro GetDbCounter())

GlobalCountDB

Field macro GetDbCounter()

HTML2Text

---

MD5Hash

Field macro GetMd5Hash()

Random

Field macros GetRandomText(), GetRandomNumber(), GetRandomDate() and GetRandomBool()

ShellExecute

---

TypeCast

Field macros ParseAsNumber() and ParseAsDate()

ReadFromCustomStore WriteToCustomStore DeleteFromCustomStore

ReadFromCustomStore() field macro and WriteToCustomStore() and DeleteFromCustomStore document macros

(The document macro DeleteFromCustomStore does not support the deletion of multiple entries)

UploadFileXFlowStorage UploadFileXFlowStorageEx

---

UUID

Field macro GetUuid()

WriteToINI

---

Document macros

Macro function

Equivalent

IfThen, If, ?

Field macro If() (not supported for variable-length parameter lists)

ExecFieldMacro

Formulation as field assignment

ForEachIndex

Document macro ForEachIndex()

Macro function

Equivalent

ExtractIndex

---

(possible alternative: use index data reader)

LookupDB

Document macros QueryDbRecord() (execution per item data line is not supported)

Macro function

Equivalent

ForEachPos

Document macro ForEachLineItem() (as an exception, no support for reverse loop pass, variably long parameter list and a change to the line structure)

AggregatePos

Document macro AggregateLineItems()

CreateDummyPos

Document macro AddLineItem()

CreateEmptyPos

---

(Possible alternative for only one line to be created: Document macro AddLineItem() with empty parameter list)

CreatePosByLookupDB

Document macro QueryDbRecords()

DropAllPos

Document macro ClearLineItems()

DropPosOnCondition

Document macro RemoveLineItems()

ListValuesToPos

---

Macro function

Equivalent

CheckBLOBExists

---

(Alternative: Check and, if necessary, trigger an error via the field macros If(), FileCount() and document macro SetError())

SetFileAttributes

Document macro SetFileMetaData() (as an exception, no selection via index number of the file attachment possible)

SetFileExternalKey

---

Macro function

Equivalent

ReadFromCustomStore WriteToCustomStore DeleteFromCustomStore

ReadFromCustomStore() field macro and WriteToCustomStore() and DeleteFromCustomStore document macros

(The document macro DeleteFromCustomStore does not support the deletion of multiple entries)

PersistFieldContents RestoreFieldContents

---

(currently only possible to persist individual fields via the above macro functions)

Macro function

Equivalent

FTPPutFiles

---

SendMail SendMailExt SendMailExt2

---

(possible alternative: "Mail" output system)

TriggerXFlowClassify

---

Macro function

Equivalent

CopyFile MoveFile

---

CreateTextFile

Document macro WriteExternalFileFromField()

DeleteFile

Document macro DeleteExternalFile()

Macro function

Equivalent

Break

---

Debug

---

Defer

Document macro SetDeferred()

Error

Suspend

Cancel

Document macros SetError(), SetSuspended() and SetCanceled()

Log

---

Rest

Field macro Pause()

Macro function

Equivalent

DuplicateFieldContent

---

SetStackAttributes

---

Custom

Custom document macro function (in external DLL file) or custom JavaScript macro function of type "Document"

File conversion macros

Macro function

Equivalent

IfThen, If, ?

Field macro If()

Macro function

Equivalent

ConvAny

File macro ConvertToPdf() (only supports the target format PDF)

ConvAnyGdPic

File macro ConvertAny()

ConvByEXE

---

ConvByPrinter

---

ConvImgFormat

File macro ConvertImage()

ConvMSExcel ConvMSOutlook ConvMSPowerPoint ConvMSWord

File macros ConvertMsExcel(), ConvertMsOutlook(), ConvertMsPowerPoint() and ConvertMsWord()

ConvPdf

File macro ConvertPdf()

HTML2PDF

---

(possible alternative: file macro ConvertMsWord())

Img2PDF

File macro ConvertImageToPdf()

PDF2TIF

File macro ConvertPdfToTiff()

TIF2PDF

File macro ConvertTiffToPdf()

TIF2PDFOCR

File macro ConvertTiffToPdfOcr()

TransformXML

File macro TransformXml()

TransformXInvoiceXML

File macro CreateKositVisualization()

XInvoice2PdfByXRaaS

---

Macro function

Equivalent

AddBarcode AddBarcodePDF

---

AddOverlay

---

AddWatermark

File macro DrawTextPdf()

AdjustOrientation

File macro RotatePagesAuto()

ChangePDFVersion

File macro ChangePdfVersion()

DecryptPDF EncryptPDF

File macros DecryptPdf() and EncryptPdf()

OptimizeImage

---

PDF2PDFA

File macro ConvertPdfToPdfA()

PDF2PDFOCR

File macro ConvertPdfToPdfOcr()

ReducePDF

---

ResizeImage

File macro ConvertImage()

ResizePDF

---

Macro function

Equivalent

DeletePDFPages

File macro DeletePages()

MultiPDF MultiTIF

MergePdf() and MergeTiff() file macros

RemoveBlankPages

File macro DeleteBlankPages()

SinglePDFs SingleTIFs

File macros SplitPdf() and SplitTiff()

(no support for the boundary of the area on the side)

SplitByBarcode

File macro SplitByBarcode()

(no transfer of information to target fields supported)

Macro function

Equivalent

EmbedPDF

---

EmbedZUGFeRD

---

ExtractMail

Input Format "Mail"

(no support for multiple nested embedded mails)

ExtractP7M

---

ExtractPEPPOLInvoice ExtractXInvoice ExtractZUGFeRD

Input formats "PeppolInvoice", "XRechnung" and "Zugferd"

ExtractPDF

File macro ExtractFilesPdf()

ExtractPDFImages

---

ExtractPDFPages ExtractTIFPages

File macro ExtractPages()

UnZip

File macro ExtractFilesZip()

(no support for encrypted ZIP files)

ZipFile

File macros CreateZip() and AddToZip()

Macro function

Equivalent

AddFile

File macro AddExternalFile()

AddFileFromField

File macro AddFileFromField()

AddFileFromURL

File macro AddFileFromWebService()

CreateDOC

Output format "MsWord"

CreateFulltextFile

---

CreateKoSITValidatorReport CreateKositValidatorReportByWebService

File macro CreateKositValidatorReport()

CreatePeppolDoc CreateXRechnungDoc

File macros CreatePeppolInvoiceVisualization() and CreateXRechnungVisualization()

DownloadFileXFlowStorage

---

TXT2PDF

---

Macro function

Equivalent

Custom

---

Dummy

---

Rename

File macro Rename()

Sort

---

StoreFile

Document macro WriteExternalFile()

Global macros

Macro function

Equivalent

CleanupFileStorage

---

DeleteFileAfterDays DeleteFolderAfterDays

global macros DeleteFiles() and DeleteFolders()

DeleteFolderIfEmpty

global macro DeleteEmptyFolders()

MoveFileAfterDays MoveFolderAfterDays

---

RenameFileAfterDays

---

Macro function

Equivalent

BackupDatabase

---

CompactMongoDB

---

DeleteLogRecordAfterDays

global macro DeleteDbLogEntries()

DeleteStackRecordAfterDays

global macro DeleteBatches()

Macro function

Equivalent

FTPGetFiles FTPPutFiles

---

Macro function

Equivalent

LogResourceUsage

---

LogThreadStates

---

StartWatcher

---

ThreadMonitor

---

Macro function

Equivalent

ShellExecute

---

UnZipFile ZipFile

---