Installation specific methods for documents are also included.

This module contains rules for creation of letters and electronic messages.

As electronic messages have SWIFT character set definitions on tag/field base the standard for all electronic message rules is as follows:
The rule is always defined with format TEXT (SetContext (“DOCFORMAT” “TEXT”)). For every print command the document format is changed to the necessary version and after the print had been completed it is reset to TEXT. To enable this, all print rules for electronic messages get the character set as explicit argument. In case there are print rules without SWTPRT rule in the message body this change of DOCFORMAT has to be done also in the main rule.

/

This text block contains the complete content for tag 78 in the messages and is filled via default rules

This text block contains the complete content for tag 79 in the messages and is filled via default rules

For messages that will be split automatically when content of tag 79 is too long (e.g. MT707)

This text block contains the complete content for tag 45 in the messages and is filled via default rules.

This text block contains the complete content for tag 47 in the messages and is filled via default rules.

This text block contains the complete content for tag 48 in the messages and is filled via default rules.

This text block contains the complete content for tag 74 in the messages and is filled via default rules

This text block contains the complete content for tag 77A in the messages and is filled via default rules

This text block contains the complete content for tag 77B in the messages and is filled via default rules

This text block contains the complete content for tag 77C in the messages and is filled via default rules

For messages that will be split automatically when content of tag 77C is too long (e.g. MT767)

Original size is 150×65

This text block contains the complete content for tag 77J in the messages and is filled via default rules

Tree representation of list of documents for 'Attachment'-panel. DOCTRESTM is calculated from DOCTRIDSTM For every role an additional line is inserted as group header Tree has the follwoing three levels: - Role - documents (that might carry attachments) - attachments

List of documents used to calculate DOCTRESTM for 'Attachment'-panel.

DOCTRESTM conains one line for every document from DOCEOT. Everey line contains the following fields (separated by tabs): - 'ZZZDOC'+Receiver PTYINR (or 'ZZZINT' for internal documents) - id of leading document (i.e. the id of this document for top level documents and the parent id for attachments) - ' 'for top level documents and the id for attachments - index in DOCEOT - document description - receiver name

In the rare case, that during creation of an electronic message is found, that this message can not carry the needed information, this flag should be set.

For tagged messages like SWIFT or TCO the content of the message is converted into a free format message.

For Bolero messages, an error is set and the user has either to choose another CORTYP or to change the message content.

If the invalid information is needed in MakeAndConvertRuleDoc MSGINVFLG may be copied to this field be for beeing cleared

Error text corresponding to MSGINVFLG.

Content of TAG 39C for electronic messages. Filled from default in AAMMOD.

Original output chanel (CORTYP) of message for DOCCUR (DOCCUR\CORTYP contains result of GetUseCORTYP of current document as result of PrepareDocument)

Dummy field to enforce redefaulting of text fields during document generation. For fields, which should be recalculated during document exection a dummy reference to this field in a default is needed. Example: default TAG79TXT order 1 $dummy = TXTDEFFLG

The content of this variable may be set in a level 6 init rule and contain the name of a rule to be executed as part of the DefDocEotBOP Processing (e.g. if additional initialization for fields in DOCEOT is required for each run through RegisterDocument-rules)

This text block contains the complete content for tag 47 in the messages and is filled via default rules.

This text block contains the complete content for tag 45 in the messages and is filled via default rules.

This text block contains the complete content for tag 77U in the messages and is filled via default rules

For messages that will be split automatically when content of tag 77U is too long (e.g. MT767, section B)

Original size is 150x65z

This text block contains the complete content for tag 77L in the messages and is filled via default rules

For messages that will be split automatically when content of tag 77L is too long (e.g. MT767, section C)

Original size is 150x65z

roles in setpay used for Compliance

Create a new attachment under document `argID`
function returns new ID

send copy / original to separate address

Get content of field for DOCEOT with specified Id

Checks if there are existing messages for a party which are not suppressed
argRol: Party role. Mutually exclusive with argPtaInr
argPtaInr: Party PTAINR. Mutually exclusive with argRol
argCorTypLst: Optional list of CORTYPs. If empty, then all messages are searched. If not empty, then only messages using these CORTYPs are searched
argInvCorTypLst: Optional list of CORTYPs. If empty, then all messages are searched. If not empty, then only messages not using these CORTYPs are searched
Returns TRUE if at least one message is found for the party

Format date into DTA standard (most used for :Mxx:-Tags).

Returns a file attribute for Tag :A5: at DTA _and_ DTE messages.
(ddd:hhmm) - ddd = day of actual year/ hh = hours/ mm = minutes

Returns a file attribute for Tag :A5: at DTA Guarantee messages.
(JJJJMMTTHHMM) - JJJJMMTT = actual date / hh = hours/ mm = minutes

Returns the own address for DTA/ DTE messages.
Get them as continuous text and convert to 4*35.

DTA Guarantees A2 - bank code or BIC

grppath should be path from top, e.g. \\xxDGRP

get contract amount of current contract

returns the maximum linelength for the medium for which the current document/message is created
-1 is returned for Letter
-2 is returned for `ASCII only` messages without limitation or line length

returns the content of a field within the DOCEOT for current document

returns the medium by which the current document/message will be sent
the value returned by this function has to be respected if
e.g. a letter will generate different parts (e.g. header or settlement)
if the real destination is e.g. telex or fax
DOCCUR\CORTYP contains the result of GetUseCortyp e.g. if the LET template is used for an email

Evaluate the document sending format an returns the numeric expression for TCO and DTx

returns the MessageType of an electronic message for the CORTYP
if MessageType could not be detemined “NONE” is returned

Returns a creationdate in Format.
(JJJJMMTTHHMM) - JJJJMMTT = actual date / hh = hours/ mm = minutes

Returns a RowID determined from MsgID. Used in document rules to get a row number (e.g. of liaall) out of the msgid.
The Rowno. is encoded into the message ID in the relevant registerdocument method
ArgMsgID = ID of the relevant message
ArgPos = the starting position of the rowID
ArgMsgRule = the name of the calling document rule

return content for tag 23X for score if attachment is present

DTA/ DTE Tag A3 - customer/ account no.

check, if for address in argument DOCx messages should be created

Get Rembour cancelation status needed for MT747 in LITAME and LTTAME

Check, if the Party in ArgPtsPtaPth is allowed to send messages with Cortyp in ArgCorTyp

check, if TCO message to be created should be sent in TCO or in DTA/DTG format

Get raw character data from ArgStm
Set errorcode -1 if 1st digit in lines are - or :

get reference of role, in long or short version, depending on cortyp and tag
If role has no reference return “NONREF”

get reference of role, in long or short version, depending on cortyp and tag

get amount at current language of document

Formats the content of any passed field.

connect currency and amount at current language of document
with a non-breaking (protected) space

get date at current language of document
possible values of argDatTyp are:
“L” = long
“S” = short
“N” = normal

get date for documents
take document date if filled else today

Get complete name of party.

Get complete name of party.

get text of “Form of L/C”

Get complete name of party.

get text of “Partial Shipment”

get text of “Transhipment”

Get text of table at current language of document.

Bind two arguments with a passed seperator.
Insert seperator between argTxt1 and argTxt2.
argSep = seperator, e.g. (“ ”), (“, ”), (“\b”), (CR), (CR + CR)

Print Received Documents in Bolero XML Format
If no tag is omitted, the tag will not printed

if while execution of textfunction the flag for free message is set, change the remaining plan

checks, if content of ArgWrkBlk fits into size of ArgField. Used for format checking of SWIFT fields

Dummy rule, please use the new!
connects two textblocks to one without an empty line between
checks, if is empty

sub to register attachment
`trigger`+`argID` internal ID of parent document
`argSubID` subId under parent
`argATTTYP` record type of attachment (`SMH`, `FIL`, `INT`
`argIDREF` id of attachend internal document if argATTTYP is `INT`
function returns new ID

sub to register document for list of documents

arguments:

trigger
which part of the software triggered this document, e.g. “TRN” or “SET”
(to avoid naming conflicts)
subid
id of the registration

trigger+subid identify a line in the list of documents

argdocpannam
rule / panelname to generate document
APFCOD (optional)
application from set
3 digits (to select group) or 6 digits can be specified
mandatoryFlag
= 0 not mandatory
= 1 mandatory
= 2 not mandatory, initially suppressed
ptainr (optional)
PTA of addressee (if role is a valid PTSPTA in objmod, this item is derived from PTSPTA and this parameter is ignored)
objmod
object for which this document is generated (Path)
(e.g. to determine proper OWNREF field)
pandsc
description of line
role
role of addressee (mandatory)
adrblk (optional)
address of addressee (do not pass if it should be derived from PTSPTA in objmod, if set it is used as address of the message to be able to pass a letter to a different address (e.g. attatchment to beneficiary sent to advising bank)

Allows overwritting of mandatory flag for all documents within transaction,
i.e. if all documents should be able to be suppressed, set the value to 0

Display document/attachemnt

Copy # of copies from original to `Send To` entry

collect all ids belonging to argId

restore old value for DOCEOT as stored in DOCEOTPopup

show document under DOCEOT(id)

sets the default Dispatch Type (DOCSNF) for the specified document
ArgTrigger first part of the document identification (as defined with defdoceot)
ArgSubId second part of the document identification (as defined with defdoceot)
ArgDOCSNF the DOCSNF value to be used
Is usually called immediately following “defdoceot” in a registerdocument rule

CONDOCSTM with connected documents

Routine to handle records received via DDE (for RCVATT instance)

called after a SMH has been selected
Routine to handle selection for RCVATT instance

If while creation of an electronic message is found, that no further processing possible because
SWIFT or other standards do not allow the content of the message please use this function to
create a free message for the same channel with the actual content
is used i.e. for settlement messages with more than one currency for one receiver
the call of this rule must follow MessageIsInvalidPre.
the call of this rule must be followed by MessageIsInvalidPost.

If while creation of an electronic message is found, that no further processing possible because
SWIFT or other standards do not allow the content of the message please use this function to
create a free message for the same channel with an autoconverted letter as if the electronic message definition is not there
is supported for SWIFT (Score) Message e.g. for the MT 776 in LETAMC not allowed before SR2018 ( DNGDEV.001241)
the call of this rule must follow MessageIsInvalidPre.
the call of this rule must be followed by MessageIsInvalidPost.

Register an additional message for allNETT, if the relevant customer is connected to allNETT.
In case no business message should be send then check in a second step, if an additional MSC should be created as header message for allNETT attachments

Register an additional message for RIVO, if the relevant customer is connected to RIVO.
In case no business message should be send then check in a second step, if an additional MSC should be created as header message for RIVO attachments

Removes the CORTYP from the list of possible CORTYP values for the specified document
must be called after DEFDOCEOT call for that document
if this list contains just one entry, field CORTYP is automatically disabled

add text to field additional text in DOCEOT
should be used from RegisterAddTxt rules in transactions

set allowed CORTYP values for the specified document
if this function has been called onyl CORTYP matching with this list (one CORTYP per line) are allowed
if this list contains just one entry, field CORTYP is automatically disabled

set letter date for the specified document
if this function has been called only DOCUIL matching with one entry are allowed

set letter date for 2nd mail letter
set DOCDAT on panel ADDINF disable. DocSemDat (= BOTP\SEMDAT) is taken for 2nd mail date

set allowed DOCUIL values for the specified document
if this function has been called only DOCUIL matching with one entry are allowed

set EtaSndEty values for the specified document
Call only necessary if default (take Etasndety) shall not be used

set forbidden CORTYP values for the specified document
if this function has been called onyl CORTYP matching with this list (one CORTYP per line) are allowed
if this list contains just one entry, field CORTYP is automatically disabled

Set Key Amount for Telex/Swift Authentication for document
use at any time after call to defdoceot for document

Manages how a document is shown on message panel.
It is used in RegisterDocument (for defdoceot) only.
Has to be called after the connected but before the controlled document.

documets may not be changed by recalculation
set PTAINR, CORTYP and name of documents in MTABUT\PDXFIXSTM that may not be changed

Check if this is a Standby L/C and if related messages shall be created as converted free message. This option can be
configured in DBISYS. If all theses options take place a autogenerated free-format Message will be created.

ArgLCRTYP: Form of L/C (most likely xxDGRP\REC\LCRTYP)
ArgAPPRUL: Applicable Rules (most likely xxDGRP\REC\APPRUL
ArgDocNam: Name of the document most recently “\TRNMOD\TRNDOC\DOCCUR\DOCNAM”
RETURN: function returns TRUE if a auto-converted message will be created. Otherwise false.

set list of cortypes that use tag :79Z:
in trigger and SubId:ID and sub id of message as used in defdoceot
ArgCortypLst : CR seperated list of Cortypes supporting Tag 79Z

supresses automatic creation of attachment for this message

Fill treeview for documents

Select specific document-id in treeview

Updates INR (i.e. File) of an attachment created with CreateAttachment
ArgAttId : Id retured from CreateAttachment-Call
ArgNewAttInr : New ATTINR (i.e. file identification)

is used at ordinary letters over all transactions

is used at ordinary letters over all transactions

Get a list of all full fieldreferences of fields with changed contents into a stream.
All modified fields of ArgNewGrp are compared with there corresponding fields of ArgOldGrp.
If there are changes in content, the fieldreferences are stored in ArgStream with old and new separated by a TAB.
To print the stream use XMLPrtFldDifFromStream after.
Intended to be used by xxTAME + xxTRAM to get the list of changed fields.

Get a list of all fieldreferences of fields marked as modified into a stream.
All modified fields of the passed module (without its sub modules) are returned.
To print the stream use XMLPrtFldFromStream after.
Intended to be used by xxTAME + xxTRAM to get the list of amended fields.

Get Tag 39A or 39B for letters with description.

prints a text within quote and unquote behind an introduction (intro)
If txt is empty, this rule will not be executed.

prints a bold text with an empty line
most used as title of letters

prints an underline text with an empty line
most used as title of letters

Receiver address is printed with four empty lines.

output of fields

Print header for differences (XMLPrtFldDifFromStream).

Print sentence of introduction for changed conditions.
Most used by xxTAME + xxTRAM.

prints a number of empty lines
with following properties for Page-Break:
- widows = 3 (Always one line more than defaulted by A4.XSI)
- keep with previous

Print all fields from stream with their description before as table.
In 1 streamline have to be 2 fields separated by an TAB.
Use XMLGetAllFldAme to get the stream before.
A following empty line will be printed after output of all fields.
Most used by xxTAME + xxTRAM.

Print all fields from stream with their description before.
Use XMLGetAllFldMod to get the stream before.
A following empty line will be printed after output of all fields.
Most used by xxTAME and xxTRAM.

Print sentence of introduction for amended conditions.
Most used by xxTAME + xxTRAM.

prints a common reference block with four empty lines
is used at ordinary letters over all transactions

Get standard line of reference.
If no argValue is passed, no line of reference will be returned.

Print field description in one line and content in the next line
If no argValue is passed, no line of reference will be returned.

prints a referenceline using the parent reference if available
is used at ordinary letters over all transactions

prints a common reference block with four empty lines
is used at ordinary letters over all transactions

Get complete name of party with his description of role
for standard line of reference block.

prints a common reference block with four empty lines
is used at ordinary letters over all transactions

print end of reply message

print end of reply message

is used at ordinary letters over all transactions

Print any Swift message (without header tags) as pretty print within a letter.

Print any (calling) text (=argText) at 1st line.
Print connected block (=argValue) to next line.
If no argValue is passed, nothing will be returned.

Print any (calling) text (=argText) at left side.
Print connected block (=argValue) to right side.
If no argValue is passed, nothing will be returned.

prints a textblock with an empty line

Telex Cover Letter
“Free Message” (=CoverA) is created via button [Add New] (=TRNDOC\BUTNEW) on Panel “Attachments”
(see TRNDOC.CreateDocument)

prints a complete Tag together with its date content in DTA format
If Tag or date are empty this rule will not create output.
Is called within textfunctions with the “print” statement.

function to print a block within size limitations, adding a comment if cut off at end
blank lines are removed
tag may be blank if not needed, : will be inserted to tag if missing

Prints the M2 tag for TCO messages, including CR
Issuing Medium (of the LC of course, not of this message)

print addressblock and optional account

format address ArgPtsPta with tag with appropriate option (A or D) and account acc
DOKA knows 4 line address block, thus option B is not needed
suppresses empty addresslines
no output of option A for TCO messages

format addressblock of ArgPtsPta with tag

format address ArgPtsPta with tag with appropriate option (A or D)
DOKA knows 4 line address block, thus option B is not needed
suppresses empty addresslines
no output of option A for TCO messages

format address ArgPtsPta with tag with appropriate option (A or D)
DOKA knows 4 line address block, thus option B is not needed
suppresses empty addresslines
no output of option A for TCO messages

format address ArgPtsPta with tag with appropriate option (F or G)
suppresses empty addresslines

prints a complete Tag together with its contents
If Tag or Content are empty this rule will not create output.
Is called within textfunctions with the “print” statement.

Print Tag with converted Block using charset and tag depending on availability of char set Z .
argTagOld = TAG to be used if option Z is not yet active
argTagZ = TAG to be used if option Z is active
argField = field, which controls size of ConvertBlock

Used to print Tag 71B/71D and 77/77A 000352)

print date and place of expiry. Usually used to print tag 31D

format address ArgPtsPta with tag with appropriate option (A or without letter option) and account acc
if ArgOptF not empty, use letter Option F if possible
DOKA knows 4 line address block, thus option B is not needed
suppresses empty addresslines
no output of option A for TCO messages

Print Tag with converted Block.
argTag = TAG to print
argField = field, which controls size of ConvertBlock
ArgCharSet is set to “Z” if field to be printed allows SWIFT extended character set. Otherwise empty.

MT 410 - acknowledgment

Print Tag 39A or 39B.
prints always :39A: or :39B:, Argtag only for documentation porposes

Print Tag 39A or 39B.
Output for Amendment and Request an Amendment only, if exists differences.

print reference of role, in long or short version, depending on cortyp

prints information about delivery (4!C[/6x35x])
ArgCortype: Coretype of message to be printed (i.e. SWT, DTG)
ArgTag: Tag to be printed (i.e. 24G). Nothing will be printed if ArgTag is empty!
ArgCode: Code to be pritned (i.e. BENE, APPL, OTHR)
ArgTxt: Additional text. Mandatory if ArgCode = “OTHR”

add missing zeros to 26E if the content is less as 3 numbers
argTag can contain “:26E:” or “:D6E:” (SCO739)

Customer specific function to print Tag :49G:, :49H: or :49Z:
49G is used in Score-Messages
49H is used in the DTA-Messages of all business sectors
49Z is used in Score-Messages of guaranties from SWIFT 2020 on
ArgTag: Tag incl. number and option. The colon is optional but recommended (:49G:, :49H: or :49Z:)
ArgField: Field to be printed in the message
ArgCharSet: Characterset. Possible Values: tdChrSetSWT, tdChrSetSWT_Z

print tag 72 72C 72Z with correct third character and in correct character set depending on SWIFT2018 activation
argSign = postfix for :72 (i.e. C or Z)
argField = field with content to be printed
ArgCharSet = character set to be used if SWIFT 2018 is activ

Customer specific function to print Tag :78:
ArgField: Field to be printed in the message
ArgCharSet: Characterset. Possible Values: tdChrSetSWT, tdChrSetSWT_Z

prints a complete Tag together with its Account content
If Tag or date are empty this rule will not create output.
Is called within textfunctions with the “print” statement.

print the amount fields `as is`.
Corresponding functions: SWTPrtTagAmountAB, SWTPrtTagAmountABK, SWTPrtTagAmountNul
If Tag, curr or amount are empty this rule will not be executed.

print the amount fields with or without value date,
3rd char of Tag (4th if incl:) is set to A or B accordingly
If Tag, curr or amount are empty this rule will not be executed.
Corresponding functions: SWTPrtTagAmount, SWTPrtTagAmountABK, SWTPrtTagAmountNul

Corresponding functions: SWTPrtTagAmount, SWTPrtTagAmountAB, SWTPrtTagAmountNul

print the amount fields `as is`, even if amount is empty
Corresponding functions: SWTPrtTagAmount, SWTPrtTagAmountAB, SWTPrtTagAmountABK
If Tag, curr or amount are empty this rule will not be executed.

prints Applicable Rule and (optional) App.rule text

DTAEA contact person and phone of advising bank (1×35 or 2×35, depending on message type)
DTALCD contact person and phone of issuing bank (2×35)
Get name and phone of responsible user if available.
Otherwise look for login user.

prints a complete Tag together with its date content
If Tag or date are empty this rule will not create output.
Is called within textfunctions with the “print” statement.

prints a complete Tag together with its contents
If Tag or Content are empty this rule will not create output.
Is called within textfunctions with the “print” statement.

Should be used for single fields only, which need just one line, because
empty lines will not be deleted, otherwise use “XMLGetTxtSepTxt( <text1>, CR, <text2>)”.
To insert a textblock as Content, use ConvertBlock before.

DTAEA M4 - contact person and phone of advising bank (1×35 or 2×35, depending on message type)
Get name and phone of responsible user if available.
Otherwise look for login user.

DTAEA M4 - contact person and phone of advising bank (1×35 or 2×35, depending on message type)
Get name and phone of responsible user if available.
Otherwise look for login user.

Added text to tag :79Z: if Tag79Z is not modified and text is´t already in `TAG79Z
in trigger and SubId:ID and sub id of message as used in defdoceot
ArgTxt text to be added to Tag 79Z