| Contents: | Main | Section | See Also: | User Manual | Advanced User Manual |
The third page of the “Edit Entity” ScreenMan form provides access to the Entity M code fields.
EDIT ENTITY
NAME: ZZPATIENT PAGE 3 OF 3
-------------------------------------------------------------------------------
GET ENTRY ACTION:
GET EXIT ACTION:
GET ID ACTION: I '$$TESTPAT^VADPT(DIEN) S DDEOUT=1
GET POLICY:
PUT ENTRY ACTION:
PUT EXIT ACTION:
PUT ID ACTION:
PUT POLICY:
_______________________________________________________________________________
EXIT SAVE NEXT PAGE PREVIOUS PAGE REFRESH QUIT
ENTER A COMMAND, OR "^" FOLLOWED BY THE CAPTION OF A FIELD TO JUMP TO.
COMMAND:
The GET ENTRY ACTION code does any set up needed to process a GET request using the Entity. It is executed once when the Entity is first invoked, before the query is run and any records are processed. Additional local variables can be set that can be referenced throughout the Entity, but they must be cleaned up in the GET EXIT ACTION.
The GET EXIT ACTION code does any clean up that is needed on a GET; it is executed once at the end, after all records found by the query are processed. Any local variables created in the Entry or ID action fields must be killed here.
The GET ID ACTION code is executed once for every record, before the data elements are retrieved. It can be used for any set up or validation that is needed for each record. For example, an API can be called to retrieve data from the target file and referenced by the Items.
The current record ID is available to reference as read-only in the local DIEN variable.
If a record should not be included in the results, you can S DDEOUT=1 and processing will quit without including the record.
The following variables will be available to reference in any code field throughout the Entity. These values are either passed into the DDE API or set by VA FileMan.
| Variable | Description |
|---|---|
| DFN | PATIENT (#2) file IEN. |
| DFORM | Format of the results:
|
| DMAX | Maximum number (max#) of results to return. |
| DSTRT | Start date.time of search range in VA FileMan format. |
| DSTOP | Stop date.time of search range in VA FileMan format. |
| DTYPE | ENTITY (#1.5) file IEN. |
| FILTER(“name”) | Additional search criteria, passed by reference as the Query array. |
To exit and skip the current record, set the local variable DDEQUIT to 1 in any code field of the Entity.
Similar fields exist in the ENTITY (#1.5) file to support the other REST actions of PUT, POST, and DELETE.
NOTE: The code fields for the PUT actions appear on Page 3 of the form but have not yet been implemented by the Data Mapping Utility yet.
The Data Mapping Utility supports the use of the Data Access Control (DAC) Utility APIs to grant or deny access to data using an Entity. An appropriate APPLICATION ACTION (#1.61) file entry for a policy can be entered in the GET POLICY (#19.1) field to control READ access to the data, if needed.
NOTE: The PUT action has not yet been implemented, so the PUT POLICY (#19.2) field is not currently in use.
Reviewed/Updated: May 2026