Export and import fine data

While you can manually enter fine information in Circulation, Destiny also accepts fine payment data in an XML (extensible markup language) file format. The import utility does not accept text files with fixed-length, or comma- or tab-delimited fields.

Important: If you can log in as the Destiny Administrator, you can access the files in the \FSC-Destiny\fsc\bin folder, or download them in Destiny from the District Options sub-tab.

Consortium users, whether Follett Destiny Cloud or regional consortium, must download the Command Line tools from within Destiny, and extract them into a folder.

You can:

  • Extract fine information for the entire district, and import it into your cash management system.
  • Import fine payment information from your cash management system into Destiny.
Note: Destiny integrates with several API vendors. This lets you manage fines in addition to patron checkouts, resources, and fees.

Rename the configuration file

The Import and Export fine utilities require a text file that contains the Destiny Administrator login name and password.

  1. From the \FSC-Destiny \fsc\bin folder on your application server, locate exportfines.properties.sample and importfines.properties.sample.
  2. Delete .sample from the file name, or rename the file.
  3. Open each file, and enter your login name and password.
  4. Close and save each file.

Export fine information from Destiny

The command line export utility lets you extract outstanding fine information from the Destiny database. The extraction includes information for the entire district.

  1. Open a command prompt, and change to the \FSC-Destiny\fsc\bin directory.
  2. Enter the command in either of the two forms shown here. For either one, file encoding is optional; the utility assumes UTF-8 unless you define otherwise.
    • This command requires that the information be in the order shown:

      ExportFines configurationFile fineExportFileName contextName fileEncoding

      Example

      ExportFines C:\exportfines.properties C:\FineExport063011.txt

    • This command lets you put the information in any order. File encoding is optional, and is only needed if it is not UTF-8.

      ExportFines -configurationFile=<value> -fineExportFileName=<value> -contextName=<value> -fileEncoding=<value> (all one line)

      Example

      ExportFines -fineExportFileName=C:\FineExp063011 -configurationFile=C:\exportfines.properties (all one line)

      ParamNameRequiredDescription

      configurationFile

      Yes

      Complete path to the file containing configuration information for Export Fines

      fineExportFileName

      Yes

      Complete path and name for the XML output file

      contextName

      Yes - if a member of a consortium

      Database/Context name of the consortium member

      To find the context name, log in as Super Administrator, open Setup and then the Edit <membername> page.

      fileEncoding

      No

      Character encoding for the export file can be one of the following:

      • ISO_8859-1
      • Windows-1252
      • UTF-8 (default)
      • UTF-16BE
      • UTF-16LE
      • UTF-16
      • UTF-32BE
      • UTF-32LE
      • UTF-32

Output file data

The utility writes the following data elements to the output file:

Fine information

  • FineID (Actual primary key of fine)
  • Fine owner site short name (that is, the site where the fine was assessed)
  • Fine description (for example, Overdue, Lost, Damaged)
  • Fine created date
  • Fine note
  • Fine amount (Remaining balance). This could be either positive, indicating a fine, or negative, indicating a refund due.

Patron information

  • Patron's site Short Name (site name of patron)
  • Patron district ID
  • Patron barcode number (Barcode of patron)
  • Patron name (Last, Middle, First)

Item information

  • Item title
  • Item collection type (Resource, Library, Textbook)
  • Item barcode number
  • Budget category
  • Item site short name

Import fine information into Destiny

The import utility lets a third-party utility pass fine payment information to Destiny. The import is available through a command line utility, and submits a job to the Job Manager.

Destiny attempts to apply the fine payment to each fine specified. If an error occurs, such as when the fine is not found or the payment is greater than the outstanding amount, an exception is written to the job summary in Destiny.

  1. Open a command prompt, and change to the \FSC-Destiny\fsc\bin directory.
  2. Do one of the following:
    • Enter the command in the order shown:

      ImportFines configurationFile fineImportFileName contextName

      Example

      ImportFines C:\importfines.properties C:\FineImport102111.txt

    • Enter the command in any order.

      ImportFines -configurationFile=<value> -fineImportFileName=<value> -contextName=<value> (all one line)

      Example

      ImportFines -fineImportFileName=C:\FineExp102111 -configurationFile=C:\importfines.properties (all one line)

      ParamName

      Required

      Description

      configurationFile

      Yes

      File containing configuration information for Import Fines

      fineExportFileName

      Yes

      Fines XML file to be imported

      contextName

      Yes - if a member of a consortium

      Context name of the consortium member

Input file data

These are the input file elements:

Data Required Comment

FineID

Yes

From the export file

AmountPaid

At least 1 of these 2 amounts

Can be positive, indicating a fine payment was received; or negative, indicating a refund was paid out.

AmountWaived

Payments are applied before waivers.

The amount must be a whole number with no decimals, currency units, or separators.

Fine description

No

Any descriptive information you would like to appear in the job summary. It is not, however, written to Destiny.

Process the import file

When processing the input file, Destiny creates a job summary with the following information:

  • Each fine payment, refund, or waiver applied.
  • Error when a fine payment, refund, or waiver cannot be applied.
  • Skipped transaction and the exception if the amount paid exceeds the current outstanding amount of a fine refund.
  • Skipped transaction and the exception if a waiver, or a combination of a payment and waiver, exceeds the fine balance.
  • Balance of a payment or refund if it is a partial payment or refund.

For a printable version, see Export and import fine data.