documentSettings
Print
Modified on: Fri, 22 Apr, 2016 at 9:49 AM
documentSettings is only required if using an event notification of handleMethod DocumentRetrieval. It contains all of the configurations for how to handle the documents being retrieved.

- documentStorageFilePath
- Only required if indexFileEnabled
- The file path where the indexed filed will be stored
-
Ensure the file path is given the correct permissions
- Example format: documentStorageFilePath="C:\FileStore\"
- indexFileEnabled
-
This indicates whether or not to index the files received
- Default value is false
- includeHeaderRecord
- Includes document header record for indexing
- Only required if indexFileEnabled="true"
- Default value is false
- indexFileExtension
- The newly indexed files extension
- Only required if indexFileEnabled="true"
- Default value is txt
- indexFileFormat
- The newly indexed file format
- Options are: csv, csvnoquotes, tabdelimited, fixedwidth
- Default value is csv
- fileNameFormat
- fieldMappingCollection: a collection of fields to create in the indexed file. Only required if indexFileEnabled="true".
-
fieldPosition: the order in which to put the column values
- fileFieldName: the name of the header for this field
-
propertyFieldValue: the value of the field, should also be one of the Event Property Values. For example: propertyFieldValue="EventStudentId"
- dynamicFieldValue: a string that represetns a javascript expression that can be used to alter any of the Existing Event Property Values. For example: dynamicFieldValue="'EventAwardYearFormat1'.substring(5,9)"
-
constantFieldValue: if propertyFieldValue is missing place hard coded value here to be default. For example: propertyFieldValue"EventStudentId" constantFieldValue="0"
-
dbCommandFieldValue: see dbCommandFieldValue in eventNotificationSettings.
- NOTE: if both dbCommandFieldValue and dynamicFieldValue exist dyanmicFieldValue will be ignored and the dbCommandFieldValue will be used.
Did you find it helpful?
Yes
No
Send feedback Sorry we couldn't be helpful. Help us improve this article with your feedback.