SuperPawn:Pawn2ME

From XcelData Wiki
Revision as of 21:30, 24 April 2018 by Charliej (talk | contribs)
Jump to: navigation, search

Electronic Notices via Pawn2ME

Electronic Notices are now available in this version. If you wish to join the beta test for electronic notices please contact us on the support line.

Final notices are generated in SuperPawn and uploaded to Pawn2ME for processing.

  1. Config File Settings

Preview

  • The first thing the customer will see
  • The customer must agree to our terms
  • Standard Notice
  • Standard Notice

Installation Instructions

  1. Install Superpawn update as normal.
  2. For each computer:
    • Download 'VC_redist.x86.exe'

      Note: there should be a copy here 'J:\Pawn2Me\RequiredFiles\VC_redist.x86.exe'

    • Run 'VC_redist.x86.exe'

Required Files

  1. cpprest140_2_9.dll: Included in the Superpawn update zip.
  2. Notices.dll: Included in the Superpawn update zip.

Minimum Computer Requirements

  1. Windows 7 or later

Turn-on Electronic Notices

  1. Open Control File Maintenance.
  2. Go to the Electronic Notices section.
    • Expand Control Maintenance 1
    • Click on 'Electronic Notices'
  3. Check the 'Use Electronic Notices' checkbox.
  4. Enter their store API key into the 'API Key' text box.
    • You can't use ctrl-v but you can right-click and paste
  5. Click the 'Update' button.

If everything goes correctly, once the request is finished, the message "Store key was accepted by the server" should appear on screen and the Status field should be set to 'Enabled.'

If you get any other message and the Status remains set to 'Disabled,' there was a hiccup at some point in the process.

  1. Click the 'Submit' button to save your changes.

Electronic Notice Charge Qualifications

  1. Electronic Notices must be turned on.
  2. Customer has to have been signed-up to receive electronic notices.
  3. Superpawn has to have received the activation update from Pawn2Me.

You can find out the type of notice charge that will be used for a customer by pulling up their profile and clicking the 'Pawn2Me' button. In the window that pops-up,

Signing-up a Customer

  1. Navigate to the Customer Profile.
  2. In the Notices section, enter in their email and/or cell no.
  3. Click the Pawn2Me button. A small window should pop-up.

Note: If the 'Force Send Paper Notice' checkbox is checked, that customer's notices will always be included in the PDF notices section returned by Pawn2Me in addition to any electronic notices they receive.

  1. Click the Send button to send the signup request to Pawn2Me.

If the request goes through successfully, the customer should receive an email/text shortly thereafter.

If any error occurs, the sign-up request will be saved and submitted the next time the Pawn2Me Updates program runs.

Remove Customer From Pawn2Me

  1. Navigate to the Customer Profile.
  2. Click the Pawn2Me button.
  3. Click the 'Deactivate' button.

Send Notices

  1. Open the Notice Wizard.
  2. Select the notices as normal.
  3. Click 'Pawn2Me' on the left-side of the screen.

Note: If you don't see 'Pawn2Me' anywhere, you need to enable electronic notices.

  1. Click the 'Review Notices' button

Note: At this point no electronic notices have or will be sent out by Pawn2Me.

This is when you should double-check to make sure the notices that were selected are correct.

  1. If no errors occur, three buttons should now be enabled:
  • Confirm: Tells Pawn2Me to send out notice texts/emails.
  • Open: Tries to open the PDFs returned by Pawn2Me with the default program associated with PDFs.
  • Save: Saves the zip file containing the PDFs to the filesystem.
  1. After reviewing the PDFs you have two options:
  • Exit and correct any mistakes that were made during the selection process.
  • Click 'Confirm' to tell Pawn2Me to send out the texts/emails.

Note: If the laser notices option is turned off, after the electronic notices have been handled the software will attempt to print the notices using the old notice print program.

Reprint Old Notices

  1. Open the Notice Wizard
  2. Click on 'Pawn2Me'
  3. Click 'Submit'
  4. There should be a list of notice batch numbers in the 'Archived Notices' section
  5. Select any batch no. and press the 'Open' button to access the notice PDFs.

Note: Only notices that have been archived in the electronic notices temp directory that you are using are available from this window.

Notice PDFs

  1. Open button There are three PDFs that it will try to open with the default PDF program.
    • 'notices.pdf': The paper notices that need to be sent through the mail.
    • 'mailer-journal.pdf' OR 'journal.pdf': A one line per notice list of the notices inside 'notices.pdf'
    • 'electronic-journal.pdf'
  2. Save button Opens a window to select the folder where you want to save the zip file containing the PDFs. The default name of the file should be 'notices_DATE_BATCH_NUMBER.zip'.

Digital PDF Printing

When you use electronic notices, you automatically get PDF Printing. This allows you to review the job before committing it to ink. There are three PDF files. One is for reviewing, one is for mailing, and one is a journal for the post office.

  • Mailer PDF
  • Review PDF
  • Journal PDF

Pawn2Me Updates

This program is called once-a-day by the 'New Day' program. It is responsible for retrieving any updated customer information from the website and sending any pending customer sign-up requests. If you need to manually run this program for any reason, go to the Special Program screen and use the name 'PTMUPD'.

Control File Settings

This is a list of all Control File options that affect electronic notices.

Control Maintenance 1 > Electronic Notices

  1. API Key: A string provided by XcelData that provides access to Pawn2Me.
  2. URL: URL where all the Pawn2Me requests will be sent. The default URL is 'https://api.pawn2me.com'. This field should be left alone under normal circumstances.
  3. Batch No: The batch number for the batch of notices sent to Pawn2Me. It is incremented every time notices are selected in the Notice Wizard. This field should be left alone under normal circumstances.
  4. Delay Sending Active Tickets: Doesn't do anything at the moment.

Control Maintenance 1 > General Questions

  1. Notices Mailed at (Permit City)

Control Maintenance 4 > Notices Options

  1. Electronic Notice Charge: The amount that qualifying customers will be charged for an electronic notice.
  2. Last postal bar code placement (Inches from left)
  3. Last postal bar code placement (Inches from top)
  4. Laser custom name/address placement (Inches from left)
  5. Laser custom name/address placement (Inches from top)
  6. Use postal barcodes
  7. Print item on notice
  8. Final Date on Notices
  9. Flip name on notice
  10. Company name on notice
  11. Print interest on notice
  12. Print Test Notice: Downloads a test PDF from Pawn2Me and opens it with the default PDF program. Changing any of the options listed above should affect the test notice without having to save with the 'Apply' and 'Submit' buttons.
  13. Print Notices on Laser: if this option is not checked, after handling the electronic notices, Superpawn will run the normal notice print program.
  14. Apply Notice Charge Per Ticket

Config File Settings

This is a list of all config file electronic notices settings

  1. 'electronic-notices-test-mode': Turned on if set to 1, otherwise turned off.

If this setting is turned on, any notices sent to Pawn2Me won't be sent through email/text.

  1. 'electronic-notices-temp-directory': Path to directory

Tells Superpawn to use this directory to store all electronic notices related files.

If not set, the default directory is CODE-PREFIX\.enotices
(e.g. c:\pawnrun\.enotices)

  1. 'electronic-notices-debug-mode': Turned on if set to 1, otherwise turned off.

Saves all requests and responses related to Pawn2Me into the temp directory.