External Data Property Type

An external data property is used to reference a file stored on the client device’s file system. This file is external to the application’s production data. The file data itself is not stored with the production data. This property type is normally used in conjunction with the file transfer functionality. The default display value of an external data property is the full path and file name of the referenced file.

For object properties the attributes of this property type related to the location for the file specify where the file will be stored on the client device when retrieved from the back end system. For transaction properties these same attributes specify the default location from which the user should make a selection. The file dialog opened in this case does allow the user to navigate the file system to select the desired file. Two separate paths can be defined for the external data property, one for client devices running the Windows PC group of operating systems, and a second for client devices running supported versions of the Mobile Windows OS’s.

The attributes of this data type also allow for designating whether the file should be read-only on the client device, the file extension for the file, and whether or not to delete the file when the parent object to the property is deleted.

The recommended use for this property type is define an object that represents the document and includes this property, as well as other information about the file. The external data property itself will reference the location of the file and can return the file’s full path and name, just the file name, just the file path, just the file extension, as well as metadata about the file such as its last modified date and time and whether or not it has been modified since it was downloaded to the client device. Many of these values are exposed via rules and/or format strings. A separate property of a data type other than external data must exist and be referenced by the external data property that contains the name the file will be given when saved on the client device. This value must be set during synchronization prior to transferring the file itself.

External Data Property Attributes

Note: This property type does not have Special Value attributes.

General Attributes

Name: This is the unique identifier for the property definition. This value must be unique among all properties within the same parent definition.
Display Name: This attribute sets the default display name to label or otherwise identify the property value on the Agentry Client. This will also be the default label for any screen control that displays this property.

Client File Attributes

File Name: This attribute references a property within the same parent definition as the external data property. The referenced property’s value will be used as the file name for the file referenced by the external data property when it is downloaded from the back end during object synchronization. In a transaction, the File Name property will store the name of the file as saved on the client device.
File Extension: This attribute is optional and can contain the file extension for the file referenced by the external data property. For objects this extension will be appended to the file when it is downloaded from the back end and saved on the client device. For transactions this extension will be used to filter the options displayed to the user in the file dialog when selecting the file. Only files with the same extension will be displayed. If this attribute is not set, files saved to the Agentry Client during object synchronization will keep the same file extension as provided by the back end. For transactions, all files will be listed in the File Dialog to the user, regardless of file extension.
When Object is Deleted: This attribute specifies what to do with the file referenced by the external data property when the parent object of the property is deleted from the Agentry Client. The options are to always delete the file, never delete the file, or only delete the file when retrieved from the back end by the mobile client application. This last option will exclude files attached locally on the Agentry Client via a transaction. This option is unaffected by the Read Only attribute, meaning if this setting results in the file being deleted, it will be removed regardless of whether or not it is read-only.
Read Only: This attribute specifies whether or not the file’s read-only switch will be true. When set, this will prevent the user from modifying the file but will not prevent the Agentry Client from deleting or otherwise accessing the file.
Use Most Recent Location: This attribute specifies whether, when selecting a file on the Agentry Client to be referenced bu the external data property, the file dialog displayed should be opened to the most recently selected folder, or to the default folder regardless of the previous selection made.

Filter

File Filter: This attribute specifies the file type that may be selected or referenced by the external data property.
File Filter Description: This attribute allows for the specification of a file description to be associated with the file extension listed in the File Filter attribute.
Restricted Files: This attribute allows for the specification of file names or file extensions that may not be selected. Multiple files or file types can be listed here separated by semi-colons.

Windows 9.x/NT/2000/XP

Base Path: This attribute specifies the base path to which the file will be saved (objects) or the default location the user will be displayed in the file dialog to select a file (transactions). This attribute is for Windows PC operating system builds for PC’s, laptops, and tablets. This may or may not be the entire path for the application, dependent on the Relative Path attribute. Options for this attribute include:
- Absolute Path: This selection will result in the value of the Relative Path attribute being used and is assumed to contain the full path, including drive letter, for the files location.
- Application Data: This selection will set the file’s location to be the path configured in Windows to be the location for application data.
- My Documents: This selection will set the file’s location to be the path configured in Windows to be the user’s My Documents folder.
- My Pictures: This selection will set the file’s location to be the path configured in Windows to be the user’s My Pictures folder.
- Program Files: This selection will set the file’s location to be the path configured in Windows to be the Program Files folder.
- Windows Temporary Directory: This selection will set the file’s location to be the path configured in Windows to be the Windows TEMP folder.
Relative Path: The value of this attribute will be appended to the path resulting from the Base Path attribute setting. If Base Path is set to Absolute Path, the value of Relative Path will be used as the full path for the file’s location.

Windows CE (Mobile Windows versions)

Use Path: This attribute, when checked, will use the same path as defined in the Windows 9.x/NT/2000/XP set of attributes. This will disable the Base Path and Relative Path attributes for mobile devices.
Base Path: This attribute specifies the base path to which the file will be saved (objects) or the default location the user will be displayed in the file dialog to select a file (transactions). This attribute is for Mobile Windows operating system builds. This may or may not be the entire path for the application, dependent on the Relative Path attribute. Options for this attribute include:
- Absolute Path: This selection will result in the value of the Relative Path attribute being used and is assumed to contain the full path, including drive letter, for the files location.
- My Documents: This selection will set the file’s location to be the path configured in Windows to be the user’s My Documents folder.
- Program Files: This selection will set the file’s location to be the path configured in Windows to be the Program Files folder.
- Windows Temporary Directory: This selection will set the file’s location to be the path configured in Windows to be the Windows TEMP folder.
Relative Path: The value of this attribute will be appended to the path resulting from the Base Path attribute setting. If Base Path is set to Absolute Path, the value of Relative Path will be used as the full path for the file’s location.