Standard parameter structure for 2E calls

From Plex-XML

In order to enhance and standardize the communication between external functions build with 2E and calling Plex functions and also between external and some internal 2E functions we are using a data structure within the 2E function parameters that looks like this:

File name. . . . : ##StructPLXParChkUpd
## USER                   TXT REF       A      WCTZ          10  
## Language               STS REF       A      BOSW           1  
*Programm-Modus           STS           A      *PGMMODE       3  
## CommitControl          STS REF       A      IESW           1  
## SessionID              NBR REF       A      P4NB           9.0
## CreateLogRecord        STS REF       A      IGSW           1  
## TransactionSucceeded   STS REF       A      V5TZ           1  
## TransactionReturncode  TXT REF       A      V6TZ           7  
## TransactionMessage     TXT REF       A      V8TZ        1024  
## TransactionFieldname   TXT REF       A      WBTZ          25  
## TransactionFunction    TXT REF       A      DYTW          25  
## Future1                TXT REF       A      F1TW          15  
## Future2                TXT REF       A      F2TW          15  
## OldDate                DTE REF       A      OLDA           7.0
## OldTime                TME REF       A      OLTM           6.0
## OldUser                TXT REF       A      OLTW          10  
## NewDate                DTE REF       A      NWDA           7.0
## NewTime                TME REF       A      NWTM           6.0
## NewUser                TXT REF       A      NWTW          10  

The meaning of those parameters in detail

## USER

If you need the user id for security reasons or to write a log file this should be the user for this. If an external function is call from our web apps the current user in the *Job context might be a general user that initiates the job and the connection. To get the real user it might be necessary to pass this session user to the function using a parameter.

## Language

If your application is designed for the parallel use in different languages you will need to know the language the actual user wants to use.

*Programm-Modus

Sometimes we are using some functions for different modes like create, update, delete, copy or validate. In this case we need to tell the function about the requested mode using this parameter.

## CommitControl

To enable an external control of the commit-control-behavior of a call function this parameter has to set to

M = Master

S = Slave

## SessionID

Here you can give back and forth your SessionID

## CreateLogRecord

If you are maintaining your own LogFiles this paramter can be used

1 = yes

0 = no

## TransactionSucceeded

This parameter tell the calling function about an successful result of your transaction

1 = yes

0 = no

## TransactionReturncode

Using this parameter you can be more specific about the result of your transaction

QUIT

ERROR

NORMAL

## TransactionMessage

If your call results with an error your will get the error message here

## TransactionFieldname

If your call results with an error your will get the related field name here

## TransactionFunction

If your call results with an error your will get the function name here

## OldDate / ## OldTime / ## OldUser

In order to control checked updates this is the place for the historic record values after reading the record for the first time

## NewDate / ## NewTime / ## NewUser

In order to control checked updates this is the place to pass the new settings

These settings should be delivered from the server function at the beginning of the transaction

In case of multiple updates within one transaction you will need to check against the old and the new settings