OLX Campaign Setup Import Spec

OLX Campaign Setup Import Spec

Info
Module: Import
Path: Processing > Import/Export > Import
Topic: OLX Campaign Setup Import
Version(s):  5.1 & up
Editions: All

What Is OLX Campaign Setup Import

The OLX Campaign Setup Import is a powerful and robust import that can create and update client, campaign, source, toll free number and script information within the OrderLogix application. This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with all required information in a specific sequence. This document will cover in detail, the specifications needed to create a valid file that OrderLogix can successfully import.
It is important to note the complexity of the OLX Campaign Setup Import, as it is capable of simply adding a new client or campaign to the system or creating a multitude of new sources while changing TFNs and scripts, all at the same time.

Making The Connection

Where Will I See This Within OLX?

The settings and connections made with this import will be used as guides for order entry by agents and vendors

What Reports Can Be Pulled?

  1. Client List Report Definitions
  2. Calls By DNIS Report Definitions
  3. PBX Daily Calls Report Definitions
  4. Customer Service Activity Report Definitions
  5. Item Status Report Definitions
  6. Performance Report Definitions
  7. CS Performance Report Definitions
  8. Client Performance Report Definitions
  9. Campaign Statistics By Hour Report Definitions
  10. Agent Revenue Report Definitions
  11. Agent Ratio Report Definitions
  12. Agent Ratio Details Report Definitions
  13. Agent Performance Visualizer Definitions
  14. Adjusted Performance Report Definitions
  15. Adjusted Client Performance Report Definitions

What Imports/Exports Relate to xxxx

  1. at this time there are not other imports/exports related to Campaign setup

Troubleshooting

  1. UPDATE existing DNIS

    1. Make sure you have the setting for Overwrite Sources (and File includes header, if needed) checked on the configurator when you import
    2. NEW SOURCE? = 1

Setup


Import Configuration

Navigate to Processing > Import/Export > Imports

  1. Category = Other
  2. Import Type = OLX Campaign Setup Import
  3. Data Source
    1. Upload - This will allow you to upload a file directly from the device you are working from

      2. Select Choose File to initiate a file window popup that will allow you to navigate to the specific file you are trying to upload
    2. FTP

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
        1.  allows you to test connection from the system to the Server address provided
      3. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      4. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      5. Username - This is the username for the remote server.
      6. Password - This is the password for the remote server.
      7. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    3. SFTP (SSH)

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
        1.  allows you to test connection from the system to the Server address provided
      3. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      4. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      5. Username - This is the username for the remote server.
      6. Password - This is the password for the remote server.
      7. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    4. FTPS (SSL)

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
        1.   allows you to test connection from the system to the Server address provided
      3. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      4. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      5. Username - This is the username for the remote server.
      6. Password - This is the password for the remote server.
      7. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    5. Email

      3. Mail Server - The name of the email server you are using.
      4. Login - This is the username for the mail server.
      5. Password - This is the password for the mail server.
      6. Server Port - Unless instructed otherwise this should be set to 110
      7. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)

Configuration Tab



  1. File Includes Header Row
    1. checked - the first row will be ignored for data
    2. unchecked - first row will be reviewed for data
  2. Overwrite Sources
    1. checked - sources will not be added as new records but will update records already created in system
    2. unchecked - sources will be added as new records
  3. Overwrite TFNs
    1. checked - TFNs will not be added as new records but will update records already created in system
    2. unchecked - TFNs will be added as new records

Decryption Tab

  1. None
    1. no decryption method will be used

  2. Zip
    1. the password entered here is the password needed to unzip the file and pull the information into the system

  3. PGP
    1. PGP Key Option - select the PGP from the drop down
    2. Verify passphrase - this must match the passphrase associated to the selected PGP above

Results Tab



The Results tab will display something similar to what you displayed above or if there are errors it will display information about the error to help you resolve and try again.

Spec

Alert
IMPORTANT:
For newer users, it is advised to try and accomplish only one task per line in the CSV file and always preview your work before importing. For example, it may be easier to create a new client on the first line, then add a campaign on the next, and multiple sources on the following lines.

File Format:

ASCII text (standard US-English letters, numbers and keyboard characters). The file must contain one line per addition, with each field enclosed in double quotes and comma separated, ending with a Carriage Return (↵) <CR>. All unused fields will be left blank and remain separated by a single comma.

File Naming:

<Organization Identifier><YYYYMMDD>.csv

Import Definitions:


 #Field NameReq.TypeMaxField Description
01CLIENT NAMEY
Parent of # 14		Alpha50
Required for all additions and updates.
NOTE: Existing client name must match client name in OLX.
02CLIENT CODE
Alpha50Client reference code.
03CONTACT
Alpha50Client contact name.
04CLIENT ADDRESS 1
Alpha255Client street address.
05CLIENT ADDRESS 2
Alpha255Client street address continued.
06CLIENT CITY
Alpha50Client city.
07CLIENT STATE
Alpha50Client state.
08CLIENT ZIP
Alpha20Client zip code.
09CLIENT COUNTRY
Alpha50Client country.
10CLIENT PHONE
Alpha30Client phone number.
11CLIENT FAX
Alpha30Client fax number.
12CLIENT WEBSITE
Alpha50Client website url.
13CLIENT EMAIL
Alpha255Client email address.
14NEW CLIENT?Y
Required by # 1		Numeric1
  1. Existing client = 0
  2. New client = 1
15CAMPAIGN NAMEY
Parent of # 30		Alpha255
Required for Campaign, Source and TFN additions and updates.
NOTE: Existing campaign name must match campaign name in OLX.
16CAMPAIGN CODE
Alpha50Campaign reference code.
17DEFAULT CC ACCOUNT
Alpha50Must be valid and active credit card account in OLX.  Not Required.
18DEFAULT EC ACCOUNT
Alpha50Must be valid and active electronic check or telecheck account in OLX.  Not Required.
19CAMPAIGN START DATE
Date10Format: MM/DD/YYYY
20CAMPAIGN END DATE
Date10Format: MM/DD/YYYY
21CAMPAIGN NOTES
Alpha255Campaign notes.
22CAMPAIGN COMPANY NAME
Alpha255Campaign company name.
23CAMPAIGN ADDRESS
Alpha50Campaign street address.
24CAMPAIGN CITY
Alpha50Campaign city.
25CAMPAIGN STATE
Alpha20Campaign state.
26CAMPAIGN ZIP
Alpha20Campaign zip code.
27CAMPAIGN COUNTRY
Alpha50Campaign country.
28CAMPAIGN PHONE
Alpha20Campaign phone number.
29CAMPAIGN FAX
Alpha20Campaign fax number.
30NEW CAMPAIGN?Y
Required by # 15		Numeric1
  1. Existing Campaign = 0
  2. New Campaign = 1
31SOURCE NAMEY
Parent Of # 37		Alpha50
Required for Source and TFN additions and updates.
NOTE: Existing source name must match source name in OLX.
32DNISRequired by # 31Alpha50Required for Source and TFN additions and updates.
33CALL TYPESee notesAlpha50Required for Source additions only.  Must be a valid call type or call type code defined in OLX.
34MEDIA BUYER
Alpha50Media buyer name,
35MEDIA TYPE
Alpha50Must be valid media type defined in OLX.
36BUYER SOURCE CODE
Alpha50Media buyer source code.
37NEW SOURCE?Required by # 31Numeric1
  1. Existing Source = 0
  2. New Source = 1
38TOLL FREE NUMBERParent of # 41Alpha75Required for TFN additions and updates.
39MEDIA NUMBER
Alpha50Media number.
40RRN
Alpha15Register Receiver Number
41NEW TOLL FREE NUMBER?Required by # 38Numeric1
  1. Existing Toll Free Number = 0
  2. New Toll Free Number  = 1
42SCRIPT NAMEY
Parent of # 46		Alpha255
Required for Script additions and updates.
NOTE: Existing script name must match script name in OLX.
43SCRIPT START DATE
Date10Format: MM/DD/YYYY
44SCRIPT END DATE
Date10Format: MM/DD/YYYY
45SCRIPT DESCRIPTION
Alpha500Script description.
46NEW SCRIPT?Y
Required by # 42		Numeric1
  1. Existing Script = 0
  2. New Script = 1
47SPLIT SCRIPT B NAMEParent of # 51Alpha255
Required for Script B additions and updates.
NOTE: Existing script name must match script name in OLX.
48SPLIT SCRIPT B START DATE
Date10Format: MM/DD/YYYY
49SPLIT SCRIPT B END DATE
Date10Format: MM/DD/YYYY
50SPLIT SCRIPT B DESCRIPTION
Alpha500Script description.
51NEW SPLIT SCRIPT B?Required by # 47Numeric1
  1. Existing Script = 0
  2. New Script = 1
52SPLIT SCRIPT C NAMEParent of # 56Alpha255
Required for Split Script C additions and updates.
NOTE: Existing script name must match script name in OLX.
53

Date10Format: MM/DD/YYYY
54SPLIT SCRIPT C END DATE
Date10Format: MM/DD/YYYY
55SPLIT SCRIPT C DESCRIPTION
Alpha500Script description.
56NEW SPLIT SCRIPT C?Required by # 52Numeric1
  1. Existing Script = 0
  2. New Script = 1




Attachments

The attached documentation includes the OLX Campaign Setup Import Spec, Template, and Example.




    • Related Articles

    • OLX Telemarketing Import Spec

      The OLX Telemarketing Import Spec is a 121 column order import used to bring outside calls and orders into the OrderLogix application. This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with all ...

    • OLX Telemarketing Import Spec

      Module: Order Import Path: Processing > Import/Export > Import Topic: OLX Telemarketing Import Version(s): 3.5 & up Editions: All What Is OLX Telemarketing Import The OLX Telemarketing Import Spec is a 121-column order import used to bring outside ...

    • OLX BIN List Import Spec

      Module: Campaign Topic: BIN List Version(s): 5.1 & up Editions: All What Is The OLX BIN List Import This import allows you to import lists of BIN lists that can allowed or disallowed during payment processing of a new order in your OrderLogix ...

    • OLX Order Import/Export Spec

      Module: Order Import Path: Processing > Import/Export > Import Topic: OLX Order Import/Export Version(s): 3.5 & up Editions: All What Is OLX Order Import/Export The OLX Order Import/Export is compatible with OrderLogix versions 3.5 & up. It is the ...

    • OLX Toll Free Number Import Spec

      The OrderLogix TFN Add and Update functionality is found within the OLX Campaign Setup Import, which allows for the utilization of a specific subset of fields to only target TFNs. This is accomplished by creating a CSV (a file with information ...