Card Import Service


Table of Contents

 Click here to expand...

Overview


Introduction

The Pro+ Card Import Service is a user-configurable access credential import utility used to perform one-time or re-occurring cardholder data imports. The Card Import Service runs in the background of the Pro+ PARCS System Server to continuously monitor for the presence of CSV card data import files to update access cardholder data in the Parker Database. The location, expected order, data types, and data values of the CSV card data import file are configured using the OPUSClient UI via the Setup > Card Access > Card Import page.

The Card Import Service is enabled from the McGann32.dll file. To order this service, use part number APS4401.

Click on the links below for detailed information about preparing a CSV card data import file based on areas of interest. Each section describes how to apply data types and values into each field of the data import file, depending on the column type:

Refer to the sections below to install and setup the Pro+ Card Import Service.

System Requirements

  • iParc Pro+ PARCS System Software version 6.0 or later installed
  • The AMI.CardImportService.Setup.msi must be installed on the Pro+ PARCS System Server
  • .NET Framework 4.5 installed

OPUSClient UI – Card Import Home Screen.

Before You Begin


Current Implementation

  • As of Pro+ software version Greece 3.0, the Transfer sub-folder resides in the Program Files (x86)/AMI folder by default.
  • The Pro+ Card Import Service also installs to the Program Files (x86)/AMI folder by default.

  • Unique ID

♦ The Card Import Service uses the Unique ID field to identify the Access Holder record. If you perform a delete using the Card Import Service, it will delete that Access Holder record and all credentials tied to it.

AMI Tip!

If you want to delete a specific credential, contact AMI Customer Support. They will guide you in making the change to the AMI.CardImportService.exe config file’s <Configuration> block.

♦ If the Unique ID in the card data import file does not exist in the Parker Database, the Card Import Service will search for a matching record based on the combination of Credential Number, Credential Type ID, and System Code from the CSV card import data file. If it finds this combination of identifiers, it assigns the Unique ID to the Access Holder record that matches those credentials.

♦ If cannot find the Unique ID and cannot locate an Access Holder record based on matching credentials, it will create a new Access Holder record and link it to the Unique ID provided. 

♦ If the Unique ID in the card data import file does exist in the Parker Database, it will update the associated Access Holder record.

  • Credential Numbers

♦ If the Credential Number in the card data import file does not exist in the Parker Database, the Card Import Service will try to create a new credential based on the Credential Number in the the card data import file. 

♦ If a Unique ID exists in the Parker Database, but a Credential Number does not, the Card Import Service will apply the Credential Number from the the card data import file as a new credential in the existing Access Holder record.

♦ If the Unique ID exists in the Parker Database and the Credential Number in the associated Access Holder record also exists, the Card Import Service will update the existing record rather than create a new one.

The following table illustrates the combination of data types present and expected results:

Unique IDCredential NumberResults
Doesn't ExistDoesn't ExistAdds a new Access Holder record and creates a link between the provided Unique ID and the new Access Holder record.
Does ExistDoesn't ExistUpdates the existing associated Access Holder record and adds a new Credential Number.
Does ExistDoes ExistUpdates both the existing associated Access Holder record and the existing Credential Number.
Doesn't ExistDoes Exist

Verifies that the combination of Credential Number, Credential Type ID, and System Code already exists. If it does, it will link the Unique ID to the Access Holder record that this credential belongs to.

Important Prerequisites

There are several important prior requirements to address before the OPUSClient UI Card Import sub-menu option can be accessed and used:

  • The Card Import Service must be ordered separately (p/n APS4401) for use with the iParc Pro+ PARCS system software.
  •  For iParc Pro+ PARCS systems, an installer resides in the > Premium Features folder. Install the Card Import Service software using the install file AMI.CardImportService.Setup.msi.
  • The Card Import Service software must be installed and enabled through the McGann32.dll parameter CAWebImport. Verify that the System Code exists. If it is not enabled in the McGann32 files, please contact AMI Channel Support to have those files modified. 
  • The Windows user must have full access rights to the Program Files (x86)/AMI > Transfer sub-folder. During installation and setup, choose a Windows user account that already has access (or adjust access rights) to the folder after installing the Card Import Service.
  • The setup process uses the CSV card import data file as a sample for configuring the import data format. The initial CSV card import data file must reside at the root of the Program Files (x86)/AMI > Transfer sub-folder. If the CSV card import data file is not present at the root of the > Transfer sub-folder, it will not load. Prior to initial use of the Card Import Service, copy the CSV card import data file into the Pro+ PARCS System Server's > Transfer sub-folder.
  • Ensure that the Access Group(s) present in the CSV card import data file actually exist in the OPUSClient UI. If not, you must create them.

Good to Know!

The Access Group names in the CSV card import data file must exactly match the Access Group names in the OPUSClient UI Parker Database or the data upload will fail. The fields that are mapped in the following steps apply to all other rows in the CSV card import data file. If subsequent rows don't match the first (or header) row, the CSV card import data file upload may fail, or the software may load account records in error.

  • The card data import file must be a CSV-formatted file.

Important!

If any required field (*) is not included in the card data import file, none of the records will be imported. The import data file will be moved to the > NotProcessed folder and the Error Log will show: [Missing Field Name] is required.

OPUSClient UI – Card Import Setup Screen.

Install the Card Import Service and CSV Card Import Data File

1. Install the AMI.CardImportService.Setup.msi received with your OPUSite install package.

2. Copy the CSV card import data file into the Pro+ Server default > Transfer sub-folder prior to setting up and running the Card Import Service. The setup process uses this file as a sample for configuring the import format.

Import the CSV Card Import Data File

1. Open an up-to-date web browser and launch OPUSClient UI.

2. Click the Setup tab on the main menu bar. Select Professional and select the Card Access option on the side navigation panel.

3. Click the Card Import sub-menu option to open the Card Import Setup screen.

4. If the CSV card import data file contains a header row, check the CSV contains a header row checkbox.

5. The Recurring Import checkbox must always be checked.

6. Click on the Load CSV File button. If the requirements listed above have been met, the |Import Config| table expands and populates with rows of cardholder account data, as shown in the figure right.

7. In the Map to Field column of the Import Config table, map the fields in the import data file header row to their corresponding OPUSClient UI descriptors (e.g., account holder id  Access Holder ID *). Do not use any field more than once.

8. Set the time interval in the range of 2-1440 minutes (24 hours max) for the Card Import Service to check for an updated import data file.

9. Click Save to save the changes or Cancel to exit without saving. The imported data will populate the Parker Database in a few minutes. The contents of the imported data file are displayed as shown in the figure right.

If the Card Import Service Stops Working

1. Click the Windows®  icon and search for Services.

2. In the Services window, locate Amano McGann Standard Card Import. Click on the filename to select it.

3. Click on Restart or Stop/Restart to reinitialize the Card Import Service.

4, Test the application again.

Recurring Data File Imports

Subsequent (recurring) CSV card import data files that are copied into the > Transfer sub-folder are automatically imported by the Card Import Service every N minutes based on the value set in the Check for every ___ minutes (2 - 1440 minutes) field. The location of the > Transfer sub-folder is configurable using the Enter the location of your Transfer folder: text box as shown in the figure right. Make sure that the pathname used is correct or the Card Import Service may not find the CSV card import data file.

Logs are available for review in C:\ProgramData\AMI\CardImportService.

OPUSClient UI – Card Import Setup Example.

Card Import Data Fields


The table shown right provides a list of all available fields that can be included in the CSV card import data file.

  • All fields shown with an asterisk (*) are required and must be in the CSV card import data file
  • Other fields listed are optional
  • Fields can be configured and placed in the import data file in any order

Detailed information about specific field values and how they apply is provided in the related documents listed above.

An example of a CSV card import data file with all the possible fields populated, including the header and sample values provided, follows:

Example:

NotUse,Add/Remove,UniqueID,AccessCredentialTypeID,CredentialNo,FacilityID,SystemCode,Mode,
Access_Group_1,Access_Group_2,Access_Group_3,Access_Group_4,Access_Group_5,Access_Group_6,
Account_Name,Account_Number,Paid_Thru,Renewal,First_Name,MI,Last_Name,Address_Type_ID,
Address1,Address2,City,State,Zip,Email,Phone1,Phone2,Make,Model,year,Color,license,PlateState,
Spare1,days/uses

"","1","p0talbott9","1","1009976","1","10","0","Park'N'Ride",
"","","","","","","","","","Tommy","","Talbott","1","123 Elm Street",
"","St Paul","MN","55422","Tommy.Talbott@pnr.com","(123) 456-7890","123-456-7891",
"TOYOTA","Camry","2018","MAROON","","MN","","","7"

Minimum Required Data Fields

There are minimal requirements for which data fields must be included in a functional CSV card import data file. There are no restrictions on the file name.

  • Add/Remove
  • Unique ID
  • Access Credential Type ID
  • Access Credential No.
  • System Code
  • Access Group 1

A functional CSV card import data file having the minimal set of required fields for a single row without a header would be: 1,Unique1,1,41853,0,"Corporate HQ"

Where:

  • Add/Remove – 0 = add, 1 = update, or 2 = delete
  • Unique ID – used to map to the same Access Holder ID in all future CSV card import data files that share the same Unique ID,
  • AccessCredentialTypeID – 1 =- Proximity Card, 2 = Magstripe Card, 3 = Barcode, 4 = License Plate
  • Credential No. – Magstripe card number, Barcode card number, Proximity contract card number, License Plate number, etc.
  • System Code – 0 by default
  • Access Group 1 – matches an Access Group name configured in OPUSClient UI (e.g., "Corporate HQ")

A more typical CSV card import data file would look like this: 1,Unique1,1,141853,0,"Mohamed","Hassam",09/01/2021,08/01/2021,"Corporate HQ","","","","",""

Where:

  • Add/Remove – 0 = add, 1 = update, or 2 = delete
  • Unique ID – used to map to the same Access Holder ID in all future CSV card import data files that share the same Unique ID
  • AccessCredentialTypeID – 1 =- Proximity Card, 2 = Magstripe Card, 3 = Barcode, 4 = License Plate
  • Credential No. – Magstripe card number, Barcode card number, Proximity contract card number, License Plate number, etc.
  • System Code – 0 by default
  • "First Name" – Access Holder's first name
  • "Last Name" – Access Holder's last name
  • Expiration Date: – MMDDYYYY
  • Renewal Date: – MMDDYYYY
  • "Access Group 1" – matches an Access Group name configured in OPUSClient UI (e.g., "Corporate HQ")
  • "Access Group 2" – matches an Access Group name configured in OPUSClient UI (e.g., "East Side Ramp")
  • "Access Group 3" – same
  • "Access Group 4" – same
  • "Access Group 5" – same
  • "Access Group 6" – same


Field Name

Required

Note

NotUse


Fields mapped to this will be skipped by the import.

Add/Remove


System will default to Add/Update if this field is not included

  • 1 = Add/Update Card
  • 2 = Delete Card

Unique ID*

Required

Unique ID is a field used to identify Access Holders. This ID is made up by the user and tied to access holders through Card Import. It has a character limit of 20.

AccessCredentialTypeID*

Required

  • 1 = Prox
  • 2 = Mag Stripe
  • 3 = Barcode
  • 4 = License Plate

CredentialNo*

Required

Card number, License Plate, Barcode, etc.

Facility ID*Required

SystemCode*

Required

Field is required when used with prox or mag credentials, but can be empty for Barcode and License Plate credential types

Mode


System will default to Normal mode if this field is not included.

  • 0 = Normal
  • 1 = Locked Out
  • 2 = Override
  • 3 = Nested
  • 4 = Override AP

Access_Group_1*

Required

Must match an access group name configured in OPUSClient UI

Access_Group_2


Must match an access group name configured in OPUSClient UI

Access_Group_3


Must match an access group name configured in OPUSClient UI

Access_Group_4


Must match an access group name configured in OPUSClient UI

Access_Group_5


Must match an access group name configured in OPUSClient UI

Access_Group_6


Must match an access group name configured in OPUSClient UI

Account_Name



Account_Number



Paid_Thru



Renewal



First_Name



MI



Last_Name



Address_Type_ID


  • 1 = Home
  • 2 = Work

Address1



Address2



City



State



Zip



Email



Phone1



Phone2



Make



Model



year



Color



License



PlateState



Spare1



Custom Fields
Custom fields will show up with the field name as it was set in the SQL database
Days/Uses

This field is used to specify the number of days or uses for the auto activate and limited use feature. If Days/Uses are defined in the CSV file, and the mode is not set to 5 for auto activate or 6 for limited use, the days will import as 0. If the mode is set to 5 for auto activate or to 6 for limited use, then it will import the number of days entered in the CSV.

Example: