• TIBCO® Reward User's Guide V3
  • Important Information
  • TIBCO Documentation and Support Services
  • TIBCO Reward CRMS Overview
    • Software as a Service (SaaS)
    • Features and Benefits
  • TIBCO Reward Graphical User Interface and Navigation
    • TIBCO Reward User Interface Elements
    • Accessing the Customer Management or Customer Service Representative (CSR) Tool
    • Accessing the TIBCO Reward Help
  • TIBCO Reward Login and Logout
    • Logging in to TIBCO Reward
    • Logging out of TIBCO Reward
  • Home Section
    • TIBCO Reward Dashboard
  • Target Section
    • Customer Profiles
      • About Customer Profiles
      • Customer Profile: Filters
      • Customer Profiles: Page Features
    • Customer Profile Left Panel
    • Creating Customer Profile
    • Existing Customer Profile
    • Editing Customer Profile
    • Cloning Customer Profile
    • Deleting Customer Profile
    • Profile Filters
      • About Profile Filters
        • The Changing Set of Selected Customers
      • Profile Filters
        • Attributes Filter
          • Adding Custom Attributes
          • Editing Custom Attribute
          • Deleting Custom Attribute
        • Entities Filter
          • Adding Custom Entities
        • Events Filter
          • Creating a New Event Target Profile
        • Location Filters
          • Creating a Location Filter
        • Loyalty Filter
          • Tiers
          • Awards
          • Creating Awards Filter
        • Points Filter
          • Current Point Balance Targeting
        • Purchases & RFM
          • Selecting Customers on Past Purchases
        • Fixed Filter
          • Customer Profile: Adding List
    • Lists
      • About Lists
      • Customer Lists Page
        • Features and Fields
      • About List Imports
      • Creating Target List from File Import
      • Creating Target List from Profile
      • List Details
        • Data Validation and Import Settings
  • Offers Section
    • Offers Overview
      • Creating Offers
        • Setting up the Offer
        • Defining the Criteria
        • Selecting the Target
        • Finalizing the Display
        • Viewing the Summary
        • Changing the View of Offer Records
      • Searching or Locating Offers
      • Filtering Offers
      • Editing Offers
      • Cloning Offers
      • Deleting Offers
    • Communications Overview
      • Creating New Communications
      • Searching or Locating Communications
      • Editing Communications
      • Cloning Communications
      • Deleting Communications
  • Measure Section
    • Reports Page
    • Create Report Views
      • Creating Topic-Based Report Views
      • Creating Domain-Based Report Views
    • Creating a Report
    • Running an Existing Report
    • Creating a Report Dashboard
  • Admin Section
    • Program Data
      • Locations Overview
        • Creating a Geolocation
        • Searching for Geolocations
        • Editing a Geolocation
        • Deleting a Geolocation
      • Post Codes Overview
        • Adding Post Code Sets
        • Deleting Post Code Sets
      • Purchase Rules Overview
        • Searching Purchase Rules
        • Editing Purchase Rules
        • Cloning Purchase Rules
        • Deleting Purchase Rules
    • Rewards
      • Reward Codes Overview
        • Creating Unique Reward Codes
        • Creating Nonunique Reward Codes
        • Searching or Locating Reward Codes
        • Filtering Reward Codes
        • Editing Reward Codes
        • Cloning Reward Codes
        • Deleting Reward Codes
    • Email
      • System Emails Overview
        • Searching or Locating System Emails
        • Enabling or Disabling System Emails
        • Previewing System Emails
        • Creating New Responses for System Emails
        • Assigning Stationery for System Email Response
        • Previewing Responses of System Emails
        • Cloning Responses for System Emails
        • Deleting Responses of System Emails
      • Stationery Overview
        • Creating New Stationery
        • Searching or Locating Stationery
        • Previewing the Stationery
        • Cloning the Stationery
        • Deleting the Stationery
      • Email Settings Overview
        • Customizing Email Settings
    • Refer a Friend
      • Refer a Friend Overview
        • Referring a Friend
    • Main Settings
      • Account Lockout Rules Overview
        • Setting Account Lockout Rules
      • List Import Settings Overview
        • Modifying List Import Settings
      • Points Rules Overview
        • Setting Points Rules
      • Points Management Overview
        • Creating Point Groups
        • Creating Point Types
        • Searching Point Groups
        • Searching Point Types
        • Deleting Point Groups
        • Deleting Point Types
    • Users
      • User Management Overview
        • TIBCO Reward User Roles and Privileges
        • Creating New Users
        • Creating New Users Through File Import
        • Searching or Locating Users
        • Editing User Details
        • Deleting Users
    • System Data
      • Attributes Overview
        • Setting Up an Attribute
        • Searching for Attributes
        • Filtering the List of Attributes
        • Editing an Attribute
        • Cloning an Attribute
      • Entities Overview
        • Creating an Entity
        • Adding Attribute to an Entity
        • Editing an Entity
        • Publishing an Entity
        • Deleting an Entity
        • Searching for Entities
      • Event Overview
        • Cloning an Event
        • Deleting an Event
        • Editing an Event
        • Searching for Events
        • Setting Up an Event
• TIBCO® Reward Integration Guide
  • Important Information
  • TIBCO Documentation and Support Services
  • Data Integration Concepts
    • Software as a Service (SaaS)
      • Implementation and Data Integration
        • TIBCO Reward as an Integration Hub
        • Data Files Sent To and From TIBCO Reward
      • Secure Data Transfer
      • Other Data Security Measures
  • TIBCO Reward CRMS Overview
    • Integration Hub
    • Features and Benefits
    • Multi-Channel Marketing
    • Implementation and Data Integration Summary
      • Integration Hub
      • Data Files Sent To and From TIBCO Reward
    • Secure Data Transfer
    • Other Data Security Measures
  • The Data Integration Process
    • The Data Integration Challenge
    • The TIBCO Reward Technical Integration Process
      • Prerequisites to Data Integration
      • The Data Integration Project Plan and Project Tasks
    • Project Task Descriptions
  • Data Exchange Overview
    • Relationship Between Data Content and Data Exchange Methods
    • Data Content Types
    • Data Exchange Methods
      • Batch-file Exchange
      • Real-Time SOAP-Based APIs
      • On-Demand File Exchange
  • Setting Up Access to Secure File Transfer Directories
    • Overview
  • Batch File Integration
    • About the Batch Files
      • File Processing Constraints
      • Batch File Summary Descriptions
    • Guidelines and Specifications Provided for Each Batch
      • Processing Thresholds for Import Files
        • Batch File Formatting
        • Batch File Naming Convention and Example
    • Transaction and Customer Import File
      • Transaction and Customer Import File Use Cases
      • Standard XML Sample File and XSD Schema
      • Transaction File Data Elements, Formats and Guidelines
        • The Transaction Header and Transaction Data Elements
          • Transaction Data Table
        • Customer Data Purpose and Usage
        • Onboarding Matching Criteria and Matching Hierarchy
          • Customer Data Table
        • Line Item Data Purpose and Usage
          • Line Item Data Table
        • Tender Data Purpose and Usage
          • Tender Data Table
      • Samples and Formats of Transaction Files from Clients
        • XML File Format - Sample
      • Transaction File Failures
        • Transaction File Errors
        • Email Address Validation Criteria
    • Product Catalog Import File
      • General Description
      • Product Catalog File Use Cases
      • Standard XML Sample File and XSD Schema
      • Product Catalog, File Guidelines, Data Elements, and Formats
        • Product Data Format Table
        • Product File Failures
          • Product File Error Table
    • Store Import File
      • General Description
      • Store File Import Use Cases
      • Standard XML Sample File and XSD Schema
      • File Usage Guidelines, Data Elements and Formats
        • Store Data Table
      • Store File Failures
    • Reward Export File
      • General Description
        • Contents of the Reward File
      • Reward Export File Use Cases
      • XML Sample File and XSD Schema
      • Export File Usage Guidelines, Data Elements and Formats
        • Rewards Data Table
        • Award Type Table
      • Standard CSV Sample File
      • Rewards Export File Failures
    • New and Updated Customer Export File
      • General Description
      • Regarding Custom Attributes
      • New and Updated Customer Export File Use Cases
      • Standard XML Sample and XSD Schema
      • File Usage Guidelines, Data Elements and Formats
        • New and Updated Customer Export Data Table
        • Customer Export Data Table
      • Standard CSV Sample Files
      • File Failures
    • Generic Event Import File
      • General Description
        • Reversing Events
      • Generic Event File Import Use Cases
        • Wishlist Use Case
        • Product Reviews Use Case
        • Add a Friend to Your Social Network
        • Web Analytics Data Use Case
      • Standard XML Sample File and XSD Schema
      • File Usage Guidelines, Data Elements and Formats
        • Purpose and Usage
        • Importing Event History
        • Record Validation Based on Event Subject and Object Validation
      • Generic Event File Import Failures
  • On Demand File Exchange
    • Importing List
      • File Format and Sample File
    • Exporting List
      • File Format
    • Creating Profile Export File
    • Creating Email Statistics Export Report
      • File Format
    • Uploading the Reward Catalog File
      • File Format
    • Custom Questions Import
      • Custom Question File Details and Requirements
      • Sample CSV File
        • Preparing a New Custom Question File for Bulk File Upload Process
        • To Make Changes in Existing Custom Questions Using the Bulk File Upload Process
      • File Failures
  • Post-integration Maintenance and Monitoring
    • Client Support Contact
    • System Maintenance and Support Guidelines
    • Availability of TIBCO Reward Staff for Maintenance and Monitoring
  • Appendix A - ARTS/IXRetail
  • Appendix B - FTP File Directories Setup
    • Platform Specific Constraints to Access Secure File Transfer Directories
    • About Webdrive SFTP and FTPS
    • Prerequisites for Secure Client Setup
    • Downloading a Secure Client Application like WebDrive
    • Setting Up an SFTP Client
      • Reconnecting to the SFTP Client
    • Setting Up an FTPS Client
  • Appendix C - Flat File Formats with Examples
    • Import Files
      • Transaction and Customer Sample Files
        • Sample XML File Format
        • Sample Fixed Width File Format
        • Sample Fixed Width File Format Table
        • Sample Comma Separated Value File
        • Sample Comma Separated Value Format Table
      • Sample of Product File from Clients
        • Sample Tab Separated Value Format of Product Catalog File
      • Format and Sample of Store File
  • Appendix D - File Import Reports
    • About the File Import Report
    • Creating a File Report
  • Appendix E - Email Update Import File
    • Email Update Import File Overview
    • Email Update Import File Use Cases
    • Standard XML Sample File and XSD Schema
    • Email Update Import File Usage Guidelines
    • Email Update Import File Data Elements and Formats
    • Email Update Import File Samples and Formats from Clients
    • Email Update Import File Errors and Error Notes
    • Descriptions for Email Update Import File Errors and Error Notes
• TIBCO® Reward API Reference Guide
  • Important Information
  • TIBCO Documentation and Support Services
  • Introduction to TIBCO Reward APIs
    • Integrate TIBCO Reward with Other Applications
      • Supported Operations
      • Objects and the API
      • Standards Compliance
      • Development Platforms
      • API Support Policy
      • Related Resources
  • Loyalty API Batch Processing and Integration
    • Record Level Business Process Application
    • Dates and Times
    • Shopper Matching
    • Bulk Data Processing
    • Null Data Processing
  • TIBCO Reward Entities
    • Entity List
    • Related Actions or Operations
  • API Entity Attribute Description Tables
    • Entity Processing Information and Usage Notes
    • API Entity Attributes and their Properties
      • Shopper Entity Attributes and Properties
      • Offer Status and Offer Attribute Properties
      • Registered Card Attributes Properties
      • Event Instance Properties
      • Reward Product Properties
  • Overview of APIs
    • Understanding API Calls
      • Characteristics of API Calls
      • Typical API Call Sequence
      • Start With Authentication
        • List of APIs
    • Overview of Objects or Entities
    • Security and the API
      • User Authentication
      • Implicit Restrictions for Objects and Fields
    • Error Handling
      • Error Handling for Session Expiry
      • Error handling for Unauthorized Data
      • Error handling for API
      • Generic Error Codes
      • API related Error Codes
      • TravelSuite API Error Codes
      • List of APIs and Related Error Codes
    • Implementation Considerations
  • Preparing to use the API
    • Ensure Your Company is Configured for APIs
    • Obtain a TIBCO Reward API User Account
    • Generate or Obtain the Web Service WSDL File
    • Import the WSDL File Into Your Development Platform
    • Walk Through the Sample Code
  • Sample Code Walkthrough
    • C# Sample Code