Configure the export options settings - Brainware for Transcripts - 24.1 - 24.1 - Ready - Brainware - external - Brainware/Brainware-for-Transcripts/24.1/Brainware-for-Transcripts-User-Guide/Manage-Brainware-for-Transcripts-Settings/Export-Settings/Configure-the-export-options-settings - 2024-10-28

Brainware for Transcripts User Guide
Platform
Brainware
Product
Brainware for Transcripts
Release
24.1
License

You can configure the BFT data export options. It is keyed upon the export profile ID, which can be assigned to individual clients. To configure the export settings, complete the following steps in Solution Configuration Manager.

  1. On the Configure Project page, in the Project list, select the BFT project to be used.
  2. In the Settings list, click Export Settings.
  3. In the Profile list, select the relevant profile.
  4. In the Export Settings list, click Export Options.
    For information on specific fields, refer to the following table.
Parameter Description
Profile Name This is the name of the export profile.
Description This is the description of export profile
Redo All Exports If selected, the system carries out all export options that have been activated even if that export has been carried out before.

For example, if three export options are activated, two are completed and the last one fails, then the document goes to status 750 denoting an export failure. If the flag is not enabled, upon retrying, only the failed export is carried out. If the flag is selected, then all three exports is performed again.
Default Export Path This is the UNC path to the export directory which is used as the default should no export directory be set in RTS.
Output Tiff File If selected, the system outputs a TIFF file of the document image in the export directory.
Output PDF If selected, the system outputs a searchable PDF file for each document.
Custom Export This is a flag to indicate whether a custom export is carried out, as specified in the User Exit Custom Export script user exit.
Output XML File If selected, the system outputs an XML file to the export directory configured on the RTS export instance. If no directory is configured, then the default export path parameter is used. If this is not configured either, then the XML export fails and the batch is sent to status 750.
XML Filename This setting controls the name of the XML output file. This can be set to URN, which names the file according to the component of the image filename mapped in the IMP section. If left blank or set to anything else, the filename is set to same as the document filename.
XML File Type This is the file extension applied to the XML file, for example XML = .XML, TXT = .txt.

If left blank, the file extension defaults to XML.
XML Encoding Header This is the XML file coding header that forms the first line in the XML file.

For example, setting the value as <xml version="1.0" encoding="UTF-16"?> produces an XML file that supports non-Western characters such as letters from the Russian, Greek and Chinese alphabets.
XML File Header This denotes the value of the file header tag in the XML file, for example <MyFileHeader>.

This value defaults to Brainware for Transcripts Document if nothing else is set.
XML File Header Attributes This contains any attributes that need to be assigned to the XML file header tag.
XML Doc Name This denotes the value of the tag marking the document name section in the XML file, for example <FileInfo>.
XML Type This denotes the value of the tag marking the transcript type (College, High School, or Military) item in the XML file, for example <type>.
XML Issue Date This denotes the value of the tag marking the transcript issue date.
XML Student Header This denotes the value of the tag marking the student information section in the XML file, for example <StudentRecord>.

This value defaults to StudentData if nothing else is set.
XML Univ Record Header This denotes the value of the tag marking the university record section in the XML file, for example <universityInstitutionalRecord>.

This value defaults to University Record if nothing else is set.
XML University Header This denotes the value of the tag marking the university degree summary section in the XML file, for example <universitySummary>.

This value defaults to University Summary if nothing else is set.
XML University Degree Header This denotes the value of the tag marking the university degree section in the XML file, for example <universityDegree>.

This value defaults to Degree if nothing else is set.
XML Univ Course Header This denotes the value of the tag marking the university coursework sectione.g.This value will default to "University Courses" if nothing else is set.
XML Univ Course Tag This denotes the value of the tag marking each individual college course.
XML High School Record Header This denotes the value of the tag marking the high school record section in the XML file, for example <highschoolInstitutionalRecord>.

This value defaults to HighSchoolRecord if nothing else is set.
XML High School Header This denotes the value of the tag marking the high school summary in the XML file, for example <HSSummary>.

This value defaults to HighSchoolSummary if nothing else is set.
XML Issue Date This denotes the value of the tag marking the transcript issue date in the XML file, for example <DateIssued>.
XML Univ Course Header This denotes the value of the tag marking the university coursework section in the XML file, for example <universityCourseRecords>.

This value defaults to University Courses if nothing else is set.
XML Univ Course Tag This denotes the value of the tag marking each individual university course in the XML file, for example <Course>.
XML Mil Course Header This denotes the value of the tag marking the military coursework section in the XML file, for example <militaryCourseRecords>.

This value defaults to MilitaryCourses if nothing else is set.
EXP Filtering This is a flag to indicate that whether the exported courses is filtered. If selected, the exported courses is filtered based on the value of EXPExcludedGradeLetters column. Otherwise, the exported courses is not filtered.
EXP Excluded Grade Letters Comma separated list of grade letters that is filtered out from export files. This setting only applies if the EXPFiltering field is selected. If the value of the field is set to empty string, no course is filtered out.
EXP Excluded Terms Comma separated list of terms that are filtered out from export files. This setting only applies if the EXPFiltering field is selected. The courses with blank term are filtered out by default if the EXPFiltering field is selected.
XML HS Course Header This denotes the value of the tag marking the high school coursework section in the XML file, for example <highSchoolCourseRecords>.

This value defaults to HighSchoolCourses if nothing else is set.
XML HS Course Tag This denotes the value of the tag marking each high school coursework record in the XML file, for example <course>.

This value defaults to Course if nothing else is set.
XML HS SAT Scores Header This denotes the value of the tag marking the high school SAT scores section in the XML file, for example <SATScores>.

This value defaults to SATScores if nothing else is set.
XML HS ACT Scores Header This denotes the value of the tag marking the high school ACT scores section in the XML file, for example <ACTScores>.

This value defaults to ACTScores if nothing else is set.
XML HS Other Scores Header This denotes the value of the tag marking the high school other scores section in the XML file, for example <otherScores>.

This value defaults to OtherScores if nothing else is set.
XML HS Grade This denotes the value of the tag marking the high school grade section in the XML file, for example <grade>.

This value defaults to grade if nothing else is set.
XML HS Grade Semester This denotes the value of the tag marking the high school grade semester section in the XML file, for example <semester>.

This value defaults to semester if nothing else is set.
XML Mil Record Header This denotes the value of the tag marking the military record section in the XML file, for example <militaryInstitutionalRecord>.

This value defaults to MilitaryRecord if nothing else is set.
XML Mil Header This denotes the value of the tag marking the military section in the XML file, for example <militarySummary>.

This value defaults to militarySummary if nothing else is set.
XML Mil Credit Details Header This denotes the value of the tag marking the military credit details section in the XML file.

This value defaults to CreditDetails if nothing else is set.
XML HS Header SAT Records This denotes the value of the tag marking the SAT section in the XML file.

This value defaults to "hssatscorerecords" if nothing else is set.
XML HS Header ACT Records This denotes the value of the tag marking the ACT section in the XML file.

This value defaults to "highschoolACTRecords" if nothing else is set.
XML HS Header Other Records This denotes the value of the tag marking the Other section in the XML file.

This value defaults to "hsotherscorerecords" if nothing else is set.
XML Custom Fields Header This denotes the value of the tag marking the Custom 10 fields section in the XML file.

This value defaults to "customfields" if nothing else is set.
Profile Name This is the shortname of the Export Profile.
Enable Course ID Subject Split

If selected, the system splits the Subject and Course ID and exports the separated values based on the following parameters.

  • If the value of the extracted subject and course ID is alphanumeric, the system performs the split from the first numeric value and ignores any special characters or spaces. The alphabetical value is stored in the "Subject" XML key and the numeric value is stored in the "Number" XML key.

  • If the value of the extracted subject and course ID is numeric, the system stores the entire value in the "Subject" XML key and the "Number" XML key remains blank.
Enable Term Year Split

If selected, the system splits the Term and Year and exports the separated values based on the following parameters.

  • The value of the extracted term and year is split and the value of the term is stored in the "Term" XML key and the value of the year is stored in the "Year" XML key.

  • The term year split takes place only when the Activate Term Normalization option in the Term Normalization page is selected.

  • If the term cannot be split, for example when the "Invalid Reason for Term" is selected, the system stores the entire value of the term in the "Term" XML key and the "Year" XML key remains blank.

  • If term normalization is disabled, the system stores the entire value of the term in the "Term" XML key and the "Year" XML key remains blank.