File Header – VIPBM16 |
DEVELOPER |
 |
The File Definition: Header file, VIPBM16 defines the physical type and properties of files. In Native PROIV the equivalent file was FILEHDR.
VIPBM16 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@FLN |
32 |
|
File Name |
|
002 |
A |
@FLCOF |
1 |
|
Co/Div? flag. (Key is prefixed with a 3 character Co/Div code) |
|
003 |
A |
@FLPGF |
1 |
|
Auto Sequenced? flag. (Last key element is maintained as a sequence) |
|
004 |
A |
@RESERVED_VIPBM16_004 |
1 |
|
Reserved Attribute |
|
005 |
A |
@EXTF |
1 |
|
External File? flag. (File data is stored in an external format) |
|
006 |
N |
@FLKL |
4 |
|
Key length |
|
007 |
A |
@ALFNAME |
40 |
|
Alternate file name |
|
008 |
A |
@FILECAT |
8 |
|
Security category of file |
|
009 |
N |
@RESERVED_VIPBM16_009 |
5 |
|
Reserved Attribute |
|
010 |
A |
@FDTYPE |
8 |
|
External file type |
|
011 |
A |
@FILDESC |
70 |
|
File description
|
|
012 |
N |
@FILESECA |
2 |
|
Minimum security level (1-9) to allow access to this file in Add mode |
|
013 |
N |
@FILESECC |
2 |
|
Minimum security level (1-9) to allow access to this file in Change mode |
|
014 |
N |
@FILESECD |
2 |
|
Minimum security level (1-9) to allow access to this file in Delete mode |
|
015 |
N |
@FILESECL |
2 |
|
Minimum security level (1-9) to allow access to this file in Look-Up mode |
|
016 |
A |
@ENCRYPTKEY |
8 |
|
Encryption Key used to protect data on this file |
|
017 |
A |
@PRIMFILE |
32 |
|
Primary File Definition this index belongs to (Alternate Index Headers only) |
|
018 |
N |
@RESERVED_VIPBM16_018 |
3 |
|
Reserved Attribute |
|
019 |
N |
@RESERVED_VIPBM16_019 |
3 |
|
Reserved Attribute |
|
020 |
N |
@RECLEN |
5 |
|
Record length |
|
021 |
A |
@ENFPAGING |
1 |
|
Lock Sequence? flag (Locks all records within sequence during edit) |
|
022 |
A |
@RESERVED_VIPBM16_022 |
10 |
|
Reserved Attribute |
|
023 |
A |
@RESERVED_VIPBM16_023 |
34 |
|
Reserved Attribute |
|
024 |
N |
@FILECDATE |
8 |
|
File creation date |
|
025 |
A |
@FILECTIME |
6 |
|
File creation time
|
|
026 |
A |
@MAP_PRIMARY |
8 |
|
Primary file name (Associate/Pseudo File Definitions only) |
|
027 |
A |
@DEFAULT_RECORD_NOT_ON_FILE |
74 |
|
Default message to display when record is not on file |
|
028 |
A |
@DEFAULT_RECORD_ALREADY_ON_FILE |
74 |
|
Default message to display when record is already on file |
|
029 |
A |
@DEFAULT_RECORD_LOCKED_RETRYING |
74 |
|
Default message to display when record is locked and trying to access |
|
030 |
A |
@DEFAULT_RECORD_LOCKED_ABORT |
74 |
|
Default message to display when record is locked and asking Abort/Retry? |
|
031 |
A |
@MASTER_FILE_NAME |
32 |
|
Master file name (Child File Definitions only) |
|
032 |
A |
@ML_TM_DEF_REC_NOT_ON_FILE |
1 |
|
Multilingual translation mode for "Record Not on File" message |
|
033 |
A |
@ML_MN_DEF_REC_NOT_ON_FILE |
5 |
|
Multilingual meaning code for "Record Not on File" message |
|
034 |
N |
@ML_MX_DEF_REC_NOT_ON_FILE |
4 |
|
Multilingual maximum length for "Record Not on File" message |
|
035 |
A |
@ML_TM_DEF_REC_ALREADY_ON_FL |
1 |
|
Multilingual translation mode for "Record Already on File" message |
|
036 |
A |
@ML_MN_DEF_REC_ALREADY_ON_FL |
5 |
|
Multilingual meaning code for "Record Already on File" message |
|
037 |
N |
@ML_MX_DEF_REC_ALREADY_ON_FL |
4 |
|
Multilingual maximum length for "Record Already on File" message |
|
038 |
A |
@ML_TM_DEF_REC_LOCKED_RETRY |
1 |
|
Multilingual translation mode for "Record Locked: Retrying" message |
|
039 |
A |
@ML_MN_DEF_REC_LOCKED_RETRY |
5 |
|
Multilingual meaning code for "Record Locked: Retrying" message |
|
040 |
N |
@ML_MX_DEF_REC_LOCKED_RETRY |
4 |
|
Multilingual maximum length for "Record Locked: Retrying" message |
|
041 |
A |
@ML_TM_DEF_REC_LOCKED_ABORT |
1 |
|
Multilingual translation mode for "Record Locked: Retry/Abort?" message |
|
042 |
A |
@ML_MN_DEF_REC_LOCKED_ABORT |
5 |
|
Multilingual meaning code for "Record Locked: Retry/Abort?" message |
|
043 |
N |
@ML_MX_DEF_REC_LOCKED_ABORT |
4 |
|
Multilingual maximum length for "Record Locked: Retry/Abort?" message |
|
044 |
N |
@RESERVED_VIPBM16_044 |
5 |
|
Reserved Attribute |
When changing the File Type attribute @FDTYPE, the file layout records held on VIPBM25 must also have their external storage types specified or removed accordingly.
If the Alternate File Name attribute is changed, the cross-reference table VIPBM30 must be updated accordingly.
|
|
Caution: File Definitions must be built to Native after they have been updated. This process can be performed by the VIPFLBLD Helper Function. Please refer to PROIV Developer Helper Functions for more information. |
Record Layouts – VIPBM25
The File Definition: Record Layouts file, VIPBM25 defines the attributes and how they are stored on a file’s records. In Native PROIV the equivalent file was FILEDEF.
VIPBM25 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
K |
@FLN |
32 |
|
File Name |
|
002 |
K |
@FLSQ |
3 |
|
File Variable Sequence Number |
|
003 |
A |
@FLDT |
4 |
|
Data Type of File Variable |
|
004 |
A |
@FVNM |
32 |
|
Variable Name |
|
005 |
N |
@VMX |
4 |
|
Maximum Length of File Variable |
|
006 |
N |
@DIM |
4 |
|
Dimension of File Variable |
|
007 |
A |
@EXTYPE |
6 |
|
External Type of this File Variable |
|
008 |
A |
@EXFMT |
6 |
|
External Storage Format for this File Variable |
|
009 |
A |
@FDLISEG |
8 |
|
DLI Segment ID |
|
010 |
A |
@FDLIKEY |
8 |
|
DLI Key |
|
011 |
A |
@ENCRYP |
1 |
|
"Encrypted?" flag |
|
012 |
A |
@ALTVNM |
32 |
|
Alternate Field Name for external database |
|
013 |
A |
@READ_ONLY_UNUSED |
1 |
|
File Variable is Read-only |
|
014 |
A |
@NULL_PERMIT |
1 |
|
"Permit Null Data?" flag |
|
015 |
A |
@VAR_DESC |
74 |
|
Help Message to use as default for this File Variable |
When the File Variable name, @FVNM is altered, the developer should also ensure that the variable exists in the data dictionary. There are a set of Helper Functions to facilitate Data Dictionary maintenance, please refer to PROIV Developer Helper Functions for more information. The Variable-to-File cross reference table, VIPBM30 also requires updating to reflect changes to the File Variables.
Alternate Index Definitions – VIPBM26
The File Definition: Alternate Index Definitions file, VIPBM26 defines the alternate key indexes for files which support them. In Native PROIV this information was stored on FILEDEF.
VIPBM26 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@FLN |
32 |
|
File Name |
|
002 |
AK |
@MAP_ID |
32 |
|
File Index Map ID |
|
003 |
AK |
@MAP_SEQ |
2 |
|
File Index sequence number |
|
004 |
A |
@MAP_VARIABLE |
32 |
|
Name of File Index Variable |
|
005 |
N |
@MAP_VARIABLE_LEN |
4 |
|
Length of File Index Variable |
SQL Table Creation Script – VIPBM27
The File Definition: SQL Table Creation Script file, VIPBM27 defines the creation script which is used to create this file’s table in the SQL database.
VIPBM27 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@FLN |
32 |
|
File Name |
|
002 |
AK |
@LINE_NO |
3 |
|
Line Number |
|
003 |
A |
@RESERVED_VIPBM27_003 |
8 |
|
|
|
004 |
A |
@SQL_TX |
100 |
|
Script Text |
Child Files – VIPBM46
The File Definition: Child Files file, VIPBM46 defines the Child Files which are automatically generated when the Master File Definition is edited.
VIPBM46 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@FLN_MASTER |
32 |
|
Master File Definition |
|
002 |
AK |
@FLN_CHILD |
32 |
|
Child File Definition |
|
003 |
A |
@CHILD_SUFFIX_CHARS |
2 |
|
Characters to be appended to each Master Variable Name in the Child Definition. |
|
004 |
A |
@CHILD_DESCRIPTION |
70 |
|
Description of Child File Definition |
File Cross-References – VIPBM29, VIPBM30
These tables should be updated accordingly when a file’s physical name or its record variables are changed.
Physical Name to File Definition Cross Reference Table – VIPBM29
VIPBM29 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@PHYSICAL_FILE |
40 |
|
Physical file name |
|
002 |
AK |
@FLN |
32 |
|
File name |
The physical file name attribute should either contain the file’s Alternate File Name, or if that is undefined, its filename.
Variable to File Definition Cross Reference Table – VIPBM30
VIPBM30 is defined as follows:
|
Seq |
Type |
Variable |
Len |
Dim |
Description |
|
001 |
AK |
@FVNM |
32 |
|
Variable name |
|
002 |
AK |
@FLN |
32 |
|
File name |
|
003 |
AK |
@FLSQ |
3 |
|
File Variable Sequence Number |
Topic ID: 500674