User Exit - Edit Document Exit

EditAtDocumentExit

BOOL EditAtDocumentExit( char *psRecord, int *iEntryMethod )

{

BOOL fDONOTReEditDocument = TRUE;

}

where:

psRecord is the full data record for the document just edited including any changes made to the record during editing.

iEntryMethod is a value indicating how the document was exited defined as follows:

1 = Key Pressed on the last character of the last field to be edited or Enter

hit on the last failing field which is not the last field in the edit list (this

uses the same code as the key pressed code)

2 = "Accept As Good" button was hit by the operator

3 = "Suspend" button was hit by the operator

4 = "Delete" button was hit by the operator

5 = "Next Field" button was hit by the operator while on the last field to be

edited or last field was skipped (the difference can be told by keeping track

of whether the user exit skipped the last field in the field entrance user

exit point)

This iEntryMethod value can be used to do special processing based on the how the record was exited (for example Are You Sure? prompting on the Delete button)

The document exit user exit should return the following (by setting the fDONOTReEditDocument variable to the desired value) depending on whether the document exit user exit has determined the document’s data record needs to be re-edited due to failing a post edit record level verification:

TRUE if the document’s data record DOES NOT need to be re-edited

FALSE if the document’s data record DOES need to be re-edited

Editexits.cpp

Called one time per edit failing document after the user has seen all the edit failing fields on the document which were not skipped by the field entry user exit but before the document’s edited data has been saved to the data file on disk.

Used to carry out special post-edit verification of the document’s entire edited data record (psRecord) and force the document’s data record to be re-edited, if it fails this verification. If the document’s data record is to be re-edited, the document exit user exit can select the field to be the active field (highlighted in the edit list, data shown with the cursor on the first edit error failing character or the first character if no edit error failing characters are present in the field, edit error prompt shown, and the clip highlighted for the first failure in this field) when re-editing starts. The field selected to be active does not have to be a field which was edited previously but can be a field which has not be edited before (gets an "Added" label in the edit listbox if this is the case).

To aid in this verification process, the full record data in the psRecord variable is available. It is also possible to get data from any specific field including previously edited data, using the GetOutputRecordDataByField helper function to get a field’s data by field name or field number. During Double Key Verify special edit mode Pass 2 and Pass 3, the data from previous passes is also available, in the psPass1 and psPass2 global variables, to aid in making any verification decisions.

This document exit point can also be used to allow the user exit to modify any or all of the document’s data after the editing process has completed as outlined below in the Changing Information In The Full Data Record discussion below. This modified data will go directly into the document’s data record on disk, if the document is not re-edited, or will be presented to User, if document is to be re-edited.

It is possible to get information about the state of the Edit by accessing the information stored in the Uerec structure and the various global variables. The following is an example of getting this information:

//*******************************************************************************//// example of the use of the information available during edit at document exit// format a string to indicate the state of the user exit

cstStatus.Format("Pass = %d\nDocument Number = %d\nSerial Number = %d\n"

,iEditPass, GetUerec()->docnum, GetUerec()->seqnum);

// set up a string containing the edited data and any extra pass data

CString cstTemp;

switch (iEditPass)

{

case 2:

cstTemp.Format("Edit Rec = %s!!!\nPass 1 = %s!!!\n",

GetUerec()->outrec,psPass1);

break;

case 3:

cstTemp.Format("Edit Rec = %s!!!\nPass 1 = %s!!!\nPass 2 = %s!!!\n",

GetUerec()->outrec,psPass1,psPass2);

break;

default:

cstTemp.Format("Edit Rec = %s!!!\n",GetUerec()->outrec);

break;

}

cstTemp = cstStatus + cstTemp;

AfxMessageBox (cstTemp);

//*******************************************************************************//

The full data record for the document that has just been edited can be accessed directly through the psRecord parameter. It can also be accessed via the GetOutputRecordDataByField application helper function. Information about a specific field to help in the post-edit verification process can be obtained using the GetFieldInfoByName, and GetFieldInfoByNumber application helpers. All of these helpers are covered in greater detail in the User Exit Helper Functions topic. The following is an example of how these functions can be used to get information:

Getting Data From The Full Data Record and Field Information example

//*******************************************************************************////

example of how to use the application helper functions to get data from

// the full data record for the document which just been edited

// example of getting field information by name

char psFieldData[100];

char psFieldName[] = "doc1a";

FLDINFO MyFiByName;

GetFieldInfoByName( psFieldName , &MyFiByName );

// example of getting the field data by the field name (field name = doc1a)

GetOutputRecordDataByField( psFieldName, (char *) &psFieldData, 100 );

cstTemp.Format("Data By Name = %s\nField Start Position By Name = %d\nField Length By Name = %d",

psFieldData, MyFiByName.iStartPos, MyFiByName.iLength);

AfxMessageBox(cstTemp);

// example of getting field information by number

FLDINFO MyFiByNumber;

GetFieldInfoByNumber( 2, &MyFiByNumber );

// example of getting the field data by the field number (field number = 2)

GetOutputRecordDataByField( MyFiByNumber.achFieldName, (char *) &psFieldData, 100 );

cstTemp.Format("Field Data By Number = %s\nField Start Position By Number = %d\nField Length By Number = %d",

psFieldData, MyFiByNumber.iStartPos, MyFiByNumber.iLength);

AfxMessageBox(cstTemp);

//*******************************************************************************//

It is possible at the Document Exit Edit User Exit point to modify the data in the full edit data record which will be then written to the disk or presented to the User, if the document is to be re-edited. This can be done by directly accessing the psRecord parameter using one of the GetFieldInfoByName, and GetFieldInfoByNumber application helpers as described above or by using the SetOutputRecordData or SetOutputRecordDataByField application helpers to make this task easier. The following example shows how to uses these two helper functions to change the information in the full data record:

SetOutputRecordDataByField Example

//*******************************************************************************//

// example of how set data in the full output record by field name or by

// field number

// setup the data to storechar psDataToStore[] = "My";

// setting the full output record data by field name

// space pad the data to the length for the field

// if the field is data is too long the SetOutputRecordDataByField

// command will automatically truncate it

GetFieldInfoByName( psFieldName , &MyFiByName );

for (int i=strlen(psDataToStore);i<=MyFiByName.iLength;i++)

strcat(psDataToStore," ");

// set the actual data in the field

SetOutputRecordDataByField( psFieldName, psDataToStore );

// setting the full output record data by field number (for field number 3)

// space pad the data to the length for the field

// if the field is data is too long the SetOutputRecordDataByField

// command will automatically truncate it

GetFieldInfoByNumber( 3 , &MyFiByNumber );

for ( i=strlen(psDataToStore);i<=MyFiByNumber.iLength;i++)

strcat(psDataToStore," ");

// set the actual data in the field

SetOutputRecordDataByField( MyFiByNumber.achFieldName, psDataToStore );

//*******************************************************************************//

SetOutputRecordData Example

//*******************************************************************************//

// example of setting data directly in the output record without using field

// information.In our example, we are setting the entire field, minus the NCS

// header at the beginning and the trailing CR/LF to spaces.

//*******************************************************************************//

char *psNewDataToStore;psNewDataToStore = (char *)malloc ( GetUerec()->reclen + 10);strcpy(psNewDataToStore,"");

for (int i=1;i<=CurrentRecordLength() - 42;i++)

strcat(psNewDataToStore," ");

// put the data in the document’s data record staring at by 40 (just passed the NCS header)

SetOutputRecordData(40,psNewDataToStore);

free (psNewDataToStore);

//*******************************************************************************//

After a decision about whether a document’s data record needs to be re-edited has been made, the document exit user exit can indicate to ScanTools that a document should be re-edited, if this is desired. If re-editing of the document is required, the document exit user exit can also select the field to be active when the re-editing starts. These tasks can be accomplished as in the following examples.

p style="Indent">//*******************************************************************************//p style="Indent">// example of signaling ScanTools that document’s data record needs re-editingp style="Indent">if (MessageBox(GetUerec()->hwndScan,"Do You Wish To Re-Edit This Document","",MB_YESNO) == IDYES)

// yes, signal ScanTools that the document should be re-edited

fDONOTReEditDocument = FALSE;

//*******************************************************************************//

//*******************************************************************************//

// example of the various methods of selecting the field to be active if a document

// needs to be re-edited by setting the value of the iEntryMethod variableif (MessageBox(GetUerec()->hwndScan,"Do Leave The Last Field Edited As the Active Field?","",MB_YESNO) == IDYES)

// set to -1 to leave the last edited field active

*iEntryMethod = -1;

else if (MessageBox(GetUerec()->hwndScan,"Do Wish To Make Field 3 the Active Field?","",MB_YESNO) == IDYES)

// note the 3 in the line below can be changed to any desired field

// set to the field number for the desired field from the record descriptor

*iEntryMethod = 3;

else if (MessageBox(GetUerec()->hwndScan,"Do Wish To Make the First Field in The Edit Box the Active Field?","",MB_YESNO) == IDYES)

// set to 100000 to make the first field in the edit listbox the active field

*iEntryMethod = 100000;

//*******************************************************************************//