1. Configuration Guide
  2. XProcessor Gift Cards and Plug-ins
  3. Stored Value Solutions (SVS) Processor
  4. Configuring the SVS Processor and Content Files

Configuring the SVS Processor and Content Files

The SVS processor is an extension to the XProcessor Extension Application. It provides access to the Stored Value Solutions (SVS) gift card solution.

Before configuring the SVS Processor, you must ensure that the XProcessor Extension Application Framework is installed and configured.

Follow the steps outlined in Setting Up the XProcessor Framework before continuing with the SVS processor configuration. After performing an upgrade, existing SVS Processor users can continue using their current SVS processor configuration as long as the latest SVS release package is being utilized. The latest SVS version is 1.2.2.22.

The instructions in this topic explain how to add the following SVS Processor files to the Content module in the EMC.

Table 49-3 SVS Processor Content Filename and Description

Filename Description

SVSProcessor.svs

SVS Processor configuration.

SVSHostSettings.svs

Sets various connection settings to the SVS host vendor and enables or disables the optional bonus card feature.

SVSBonusCard.svs

Enables the issuance of a bonus gift card with a pre-configured limited amount value.

Ensure that you enter the filename exactly as shown; otherwise problems may occur in the system. Do not include the file extension, for example *.xml or *.dll, in the records Name field.

  1. Select the Enterprise level, click Setup, and then click Content.
  2. Double-click the XProcessorConfiguration row in the Name column.
  3. Locate the processor id=”svs” entry. This file includes an entry for the SVS Processor as shown in the following figure:

    Figure 49-9 XProcessor Configuration Entry for SVS


    This figure shows the XProcessor Configuration processor id entry for the SVS Processor, indicated with a red rectangle surrounding the code.

    If you are using only the SVS Processor for the gift card service, un-comment the SVS Processor and delete or keep the existing comment marks around the other processors.

  4. Click the insert icon This image shows the Insert icon, which is a green circle with a white plus sign symbol. on the toolbar.
  5. In the record’s Name field, enter SVSProcessor.svs, and then click OK.
  6. Double-click the SVSProcessor.svs row and set the Content Type to 1 - Loose Xaml, so you can see the tags in various colors, making it easier to read.
  7. Click the Import from a file link.
  8. Browse to [Drive Letter]:\MICROS\Simphony2\EMCClient, select SVSProcessor.svs.xml, and then click Open.
  9. You must modify the imported SVSProcessor.svs file so each applicable <macro> entry in the SVSProcessor.svs file has the actual EMC record number for the respective Tender/Media or Service Charges. Another option is to remove individual macros you do not intend to use. Edit the file as needed to use the correct:

    • Currency Code: For the currencycode setting near the beginning of the imported SVSProcessor.svs file. This setting defaults to USD (which stands for US Dollars).

    • Reload Service Charge: For the macro id-”post_reload” operation, enter the [service-charge-number] record number (as shown in the EMC) between the braces.

    • Redeem Tender Media: For the macro id=”post_redeem” operation, enter the [payment-tender-number] Tender/Media record number (twice as shown in the EMC) between the braces.

    • Cash Out Tender Media: For the macro id=”post_cashout” operation, enter the [payment-tender-number] record number (as shown in the EMC) between the braces.

      Note:

      When entering EMC record numbers for macros, such as a [payment-tender-number] or a [service-charge-number], remove the placeholder braces, leaving only the record number between the Number tags. Brace removal applies when editing all of the imported *.xml files.

      Figure 49-10 EMC Content Module - SVSProcessor.svs Configuration


      This figure shows the EMC Content module and the SVS processor configuration.
    1. Repeat step 9 for each remaining macro operation you want to enable for the this processor.
    2. Click Save.
  10. Add the SVSHostSettings.svs configuration file to the Content module.

    This file needs to be modified to set various connection settings to the SVS host and to enable the optional Bonus Gift Card feature. Entries here also set the bonus gift card’s amount values.

    1. Import the SVSHostSettings.svs.xml file available in the [Drive Letter]:\MICROS\Simphony2\EMCClient folder.
    2. Modify this configuration file for rows 3 through 11 to match the information provided by your SVS service provider.

      Figure 49-11 EMC Content Module - Imported SVSHostSettings.svs File


      This figure shows the EMC Content module and the SVSHostSettings.svs configuration settings.
    3. To enable the Bonus Gift Card feature, configure rows 12 through 17:

      Note:

      Bonus Card configuration is required even if users have no intention of using the Bonus Card feature. As described in step 11 (below), the SVSBonusCard.svs XML file must be added to the Content module and the file needs to have its placeholder values replaced with valid record numbers (even if they are not referring to actual service charge or discount entries). Add valid service charge and discount record numbers to the placeholder fields as shown in this figure: EMC Content Module - Imported SVSBonusCard.svs File.

      • ElligibleParentBonusGC: This field is user defined, but must match the name field of the parent processor as configured in the SVSProcessor.svs file (shown below).

        Figure 49-12 EMC Content Module - Imported SVSProcessor.svs File


        This figure shows the EMC Content module and the SVSProcessor.svs configuration settings.

      • ElligibleBonusGC: This field is user defined, but must match the name field located in the SVSBonusCard.svs (shown below).

        Figure 49-13 EMC Content Module - Imported SVSProcessor.svs File


        This figure shows the EMC Content module and the SVSProcessor.svs configuration settings.

      • BonusGCFeature: This field enables the Bonus Gift Card feature by setting it to true. The default setting for this field is false (disabled).

      • ElligibleBonusAmount: This field is for used to establish the amount that customers are eligible for an additional bonus gift card after the ElligibleBonusAmount field’s threshold is reached. In the Figure EMC Content Module - Imported SVSHostSettings.svs File (above), because the eligible bonus amount is set to 50.00, when a customer purchases a 50.00 gift card, they are eligible to receive an additional bonus gift card amount as configured in the subsequent IssueBonusAmount field (this amount is 10.00 as shown in the same figure).

      • IssueBonusAmount: This field establishes the amount of the bonus gift card that is issued when customers meet the configured bonus gift card threshold amount. This amount must match what SVS has configured.

      • MaxLimitToIssueBonusGC: This field establishes the maximum amount customers are eligible for earning additional bonus gift cards. In other words, if this value is set to 200.00, customers are limited to earning four 50.00 gift cards (for a total of 200.00), thus earning four bonus gift cards (worth 10.00 each for a total value of 40.00).

  11. Add the SVSBonusCard.svs configuration file.
    1. Import the SVSBonusCard.svs.xml file available in the [Drive Letter]:\MICROS\Simphony2\EMCClient folder.
    2. To assist the system with identifying gift cards (for both magnetically swiped and manually entered cards), enter your issued gift cards preamble numbers in the value field. Scroll down to the preamble section (near row 190) and edit the rows beginning with preamble. You must determine how many preamble digits you want to enter. Oracle Food and Beverage recommends entering a range from 10 to 17 digits.
    3. Enter the number of digits you entered in the value field in the count field. The number of digits entered in the value field must match the number entered in the count field.

      Figure 49-14 EMC Content Module - Imported SVSBonusCard.svs File Preamble Settings


      This figure shows the EMC Content module and the required SVSBonusCard.svs gift card preamble number configuration fields.
    4. Bonus card transactions are primarily handled based on the assigned discount. Modify the configuration file with the appropriate service charge and discount record numbers between the braces, leaving only the record number between the Number tags.

      Figure 49-15 EMC Content Module - Imported SVSBonusCard.svs File


      This figure shows the EMC Content module and the required SVSBonusCard.svs service charge and discount configuration fields.
  12. Click Save.
  13. Update or reload the database on the workstation to ensure that the changes apply to the workstation.

    Updating Workstations After Configuration Changes in the Oracle MICROS Simphony POS User Guide contains information about this process.

Parent topic: Stored Value Solutions (SVS) Processor