The XML file defines many important properties that control how the application process the file. Properties differ based on whether the file is inbound or outbound.
Inbound properties include:
- File Name: Programmatic name for the file. It is prefixed with fle.
- File ID: Numeric reference for the file record. This is the ID it has in the application.
- Description: Short phrase associated with the file record in the application. Users can search for file records by description.
- File Type: Inbound for an inbound file.
- Path: Folder where the file object is stored. This is the XML folder that contains the entity that corresponds to the business object the file is bound to.
- File Object: C# file object that has the logic to process the file.
- Progress Counter: Determines how many records in the file are processed between each status update. The default is 10. If your file will have thousands of records, you should increase this.
- Record Type: Either fixed length or delimited. If delimited, you have to enter a delimiter.
- Transaction Code Position: The transaction code determines which object to bind the associated data to. This property tells the application where in the file the transaction code is.
- Transaction Code Length: Tells the application how many characters are in a transaction code (fixed length files only).
- Header Group Position: If the file updates both a parent object and child objects, it will have a header group. The header group identifies the record header to either create or edit. This property tells the application where in the file the header value is.
- Header Group Length: Tells the application how many characters are in the header value (fixed length files only).
- Inbound Mask: Tells the application which file extensions to upload from the inbox. If you enter ., the application will accept any file extension.
- Base Path: Location of the relative paths that follow. This is the same as the application's base directory.
- Mail Box Path: Relative path of the Inbox folder.
- Staging Path: Relative path of the Staging folder.
- Error Path: Relative path of the Error folder.
- Process Path: Relative path of the Processed folder.
- Record Layout: Defines the content of the file.
- Process Details: If selected, the application validates each individual record in the file, rather than a header and details together. You should not select this if the inbound file updates both a parent and a child (that is, it has a header and one or more details).
- Process In Group: If selected, the application uses default functions to receive, process, and upload the file. You should not select this if you have written specific methods for these functions.
Outbound properties include:
- File Name: Programmatic name for the file. It is prefixed with fle.
- File ID: Numeric reference for the file record. This is the ID it has in the application.
- Description: Short phrase associated with the file record in the application. Users can search for file records by description.
- File Type: Outbound for an outbound file.
- Path: Folder where the file object is stored. This is the XML folder that contains the entity that corresponds to the business object the file is bound to.
- File Object: C# file object that has the logic to process the file.
- Record Type: Either fixed length or delimited. If delimited, you have to enter a delimiter.
- Query ID: This is the query the application executes to pull the data it uses to populate the outbound file.
- Object Method: This is the method the application uses to load the data after it executes the query. The method comes from the C# file object.
- File Collection: This is the object collection the application pulls data from to populate the outbound file.
- File Name: This is what the outbound file will be called. You can append the current datetime to the file name by adding a $ at the end. For example: MailingLabel$.txt.
- File Name Mapper: Allows you to set the file name using a static method from the business object.
This post is part of the Files topic. Click here to open the Files Overview.