• TIBCO® Reward User's Guide
  • Important Information
  • TIBCO Documentation and Support Services
  • TIBCO Reward CRMS Overview
    • Software as a Service (SaaS)
    • Features and Benefits
  • CRMS User Interface Elements
    • User Interface
    • CRMS: Navigation
      • Saving Your Work
  • CSR
    • CSR: Overview
    • CSR: Roles & Privileges
    • About Customers
    • Creating Active Customer Account
    • Creating a New Enrolled Customer Account
    • Customer: View Details
      • Customer: Status
      • Customer: Change History
        • Transactions
        • Email
        • Rewards
    • Customer: Edit
  • Promote
    • Offers
    • Offer Lifecycle
      • Anatomy of an Offer
    • Prerequisites for Creating an Offer
      • Notes on Data Integration requirements
    • Offers Page Overview
    • Creating an Offer
      • Offer Description Page Overview
      • Defining the Description of an Offer
      • Offer Qualification and Award
        • Award
        • Action Types
        • Actions
        • Uploading Offer Qualifying Product Stock Keeping Unit (SKU) as a File
        • Attaching Product SKU File to an Offer
        • Qualification Evaluation Level
        • Additional Conditions
      • Basket Targeting
        • Define Basket Target
          • Defining the target of an offer by adding basket profiles
        • Including and Excluding Basket Profile
      • Customer Targeting
        • Customer Target Definition
          • Defining the target of an offer by adding customer profile
          • Defining the target of an offer by excluding customer profile
        • Including and Excluding Customer Profile
      • Presentation
        • Selecting Image from Product Database
        • Selecting a Local Image
        • Selecting Existing Offer Image
      • Schedules and Rules
        • Defining Schedules and Rules
      • Summary & Preview
        • Summary & Preview Page Details
        • Using Summary & Preview Page
      • What's Next
    • Change Status
      • Saved to Pending Offer Status
      • Offer Status Options
      • Changing Offer Status
      • Offer Status Details
    • Cloning an Offer
      • Clone Offer Record
    • Deleting Offer
    • Award Options
      • Award Types
      • Criteria for Offering Awards
    • Returns
  • Loyalty
    • Refer a Friend
      • About Refer a Friend
      • Configuring Refer a Friend
      • Award & Limits Options
  • Target
    • Customer Profiles
      • About Customer Profiles
      • Customer Profile: Dimensions
      • Customer Profile: List Page
        • Profiles Page Features
    • Customer Profile Editor
    • Creating Customer Profile
    • Existing Customer Profile
    • Editing Customer Profile
    • Cloning Customer Profile
    • Exporting List
      • Export Email File Format
      • List Export Headers
      • Profile Export Fields with Custom Attributes
    • Deleting Customer Profile
    • Profile Dimensions
      • About Profile Dimensions
        • The Changing Set of Selected Customers
      • Profile Dimension: Conditions
        • Default Dimension: Customer Type = Registered Customers Only
      • Profile Dimension: How to Use
      • Profile Dimension: MUST Match
      • Profile Dimension: Definitions
        • Dimension: Activities
          • Defining Activity Based Conditions
        • Dimension: Category Interests
          • Targeting Customers in Categories
        • Dimension: Custom Attributes
          • Defining Dimension Conditions Based on Custom Attributes
        • Dimension: Custom Entities
        • Dimension: Custom Questions
          • Setting up Customer Response at Level I
          • Setting up Customer Response at Level II
        • Dimension: Customer Types
        • Dimension: Gender
          • Targeting Customers by Gender
        • Dimension: Generic Events
          • Creating a New Generic Event Target Profile
        • Dimension: Geographic
          • Geographic Targeting Using Postal Code Sets
          • Geographic Targeting Using U.S. States
          • Geographic Targeting Using Stores
          • Geographic Targeting Using Metro Area
          • Geographic Targeting Using Mobile Geolocation
        • Dimension: Lists
          • Customer Profile: Adding Target List
          • Customer Profile: Removing Target List
        • Dimension: Offer Redemptions
        • Dimension: Past Purchases
          • Selecting Customers on Past Purchases
        • Dimension: Point Activity
        • Dimension: Point Balance
          • Targeting Customers According to Their Current Point Balance
        • Dimension: Communications
        • Dimension: RFM (Recency, Frequency, Monetary Value)
          • Setting Parameters for the Conditions
          • Disabling a Parameter Setting for a Condition
          • Modifying Frequency or Monetary
        • Dimension: Tender Types
        • Dimension: Tiers
    • Basket Profiles
      • About Basket Profiles
      • Basket Profile List Page
        • Profile Page Features
      • Creating Basket Profile
      • Basket Profile Conditions
        • Creating Products Condition
        • Creating Categories Condition
        • Creating Brands Condition
        • Creating Tenders Condition
        • Creating Quantity/Spend Condition
        • Creating Product Custom Attributes Condition
      • Editing Basket Profile
      • Cloning Basket Profile
      • Deleting Basket Profile
    • Lists
      • About Target Lists
      • Target List Page
        • Features and Fields
      • Create Target List
      • About Target List Imports
        • Features and Fields
      • Creating Target List from File
      • Profile Target List
      • Creating Target List from Profile
      • Target List Details
        • Data Validation and Import Settings
    • Postal Codes
      • Defining Profile Using Postal Code
        • Fields and Features
      • CSV File Example
    • Custom Questions
      • Creating Custom Question
      • Setting up a New Questionnaire
      • Creating Custom Question
      • Custom Question Details
        • Editing Custom Question
      • Import Custom Questions
        • Custom Question File Details and Requirements
        • Sample CSV File (displayed as text)
        • Creating a new Custom Question using Bulk File Upload Process
        • Changing Existing Custom Questions using Bulk File Upload Process
      • Questionnaire Setup
        • Questionnaire Setup Page
        • Creating Questionnaire
    • Mobile Geolocations
      • About Mobile Geolocations
      • Creating Mobile Geolocation
      • Editing Mobile Geolocation
      • Deleting Mobile Geolocation
  • Email
    • Communications
      • Lifecycle
      • Email Communication: List Page
        • Features and Fields
      • Creating Email Communication
      • Choose Template
      • Properties
        • Schedule
        • Geolocation Trigger Events
        • Tracking
        • Communication Properties
      • Target
        • Fields and Features
      • Rich Content
        • Fields and Features
      • Reference Tags
      • Text-only
        • Fields and Features
      • Summary
        • Fields and Features
      • Cloning an Email Communication
      • Change Status
        • Status Details
      • Address Rules
      • ISP Profiles
    • Campaigns
      • About Campaigns
        • Fields and Features of Campaigns
      • Creating Campaigns
      • Campaign Properties
        • Fields and Features of Campaign Properties
      • Campaign Details
        • Fields and Features of Campaign Details
    • Trigger Events
      • About Trigger Event Response Emails
      • Trigger Event Descriptions
      • Trigger Event List Page
        • Features and Fields of Trigger Events
      • Manage Trigger Event
        • Features and Fields of Manage a Trigger Event Page
      • Response Email
        • About Response Emails
        • Creating Response Email
          • Properties
          • Rich Content
          • Text-Only Content
          • Summary
        • Change Response Email
          • Changing the Response Email Assigned to the Trigger Event
          • Cloning the Response Email, Modifying the Clone, and then Choosing that Response Email
          • Creating a New Response Email and Then Assigning It to the Trigger Event
    • Stationery
      • About Stationery
      • About Stationery Creation
      • Creating Stationery
      • About Editing Stationery
      • Stationery Properties
      • Stationery Rich Content
      • Stationery Text-Only Content
      • Stationery Summary
    • Test and Seed Lists
      • Test & Seed List Requirements
    • Email Communication: Guidelines
  • Signage
    • About Signage
      • Signage Widgets
    • Features and Fields
    • About Creating Signage
      • Signage: Developer's Guide
      • Signage: Example
    • Embed Tag: Use
      • Notes on Widget Embed Tags
      • How the Embed Tag is Processed
      • Server-Side Tags
  • Content
    • Content Items and Rule Sets
      • Dynamic Content
    • Content Items
      • Content Item: Content
      • Content Item: Properties
      • Creating a New Content Item
      • Editing Content Item
      • Content Item: Rich Content
      • Content Item: Text-Only
      • Deleting Content Item
    • Content Rule Sets
      • Content Rule Set: Match Conditions
      • Match Condition: Define
        • Defining Match Condition
      • Content Rule Set: Properties
      • About Creating Content Rule Set
      • Editing Content Rule Set
      • Deleting Content Rule Set
  • Program Microsites
    • About Offer Showcases
    • About Mobile Microsites
  • Clienteling
    • Clienteling: Access
    • Clienteling: Creating Users
  • Rewards
    • Reward Codes
      • Reward Code: Requirements
      • Uploading Unique Reward Codes
      • Defining a Non-Unique Reward Code
      • Setting Up a Reward Code Inventory Alert
    • Reward Items
      • Creating Reward Item
      • Reward Item: File Requirements
      • Uploading a Reward File
    • Reward Catalogs
      • Reward Catalog: Settings
      • Creating a Reward Catalog
  • Reports
    • About Reports
      • Reports: Parameter Settings
      • Reports: Graphic Data Display
      • Reports: Data Table
        • Specifying the Time Period
        • Terminology Used in Reports
    • Reports: Customer
      • Sales Performance by Customer States (Time Series Analysis)
      • Customer Purchase Activity Report
      • Customer Activity by Channel Report
        • Channel Data Listed In Rows
      • Sales Performance Comparison (Time Series Analysis)
      • Sales Performance by Customer States
      • Gender Breakdown Report
      • Sales Performance by Customer Stated Category Preference
    • Reports: Offer
      • All Offer Performance Report
    • Reports: Email
      • Campaign Summary Report
      • Campaign Detail Executive Report
      • Campaign Detail Extended Report
      • Email Performance Executive Report
      • Email Performance Extended Report
      • Clickthrough Analysis by Email
      • Email Performance over Time
      • Email Report: Email Bounce Analysis
      • List Performance Summary Report
      • List Performance Time Series Report
    • Reports: Specialized
      • Signup and Membership Report
      • Custom Question Detail Report
        • File Import Summary Report
      • Report: Signage
        • Web Signage Summary Report
        • Web Signage Detailed Report
      • Report: Activity
        • Activity Analysis Report
        • Activity Time Series Report
      • Report: CSR Activity
        • CSR Activity Breakdown Report
    • Point Expiration
      • Point Expiration Forecast Report
    • Reports: Ad-hoc Reporting
      • Configuring Ad-hoc Reporting
        • Creating Users for Ad-hoc Reporting
        • Editing Users for Ad-hoc Reporting
        • Accessing Ad-hoc Reporting
  • Admin
    • Main Settings
      • Configuration: List Import
        • List Import: Email Opt-In
      • Configuration: Points
        • Configuration: Member Point Limit
        • Points: Expiration Options
      • Configuration: Account Lockout
        • Setting Up Account Lockout Rules
          • Lockout Threshold
          • Lockout Observation Window
          • Lockout Duration
          • Lockout Messages
        • Account Lockout Rules: Unlocking Accounts
          • Unlocking Accounts: Business Users
          • Unlocking Accounts: Customer Accounts
    • CRMS Users
      • User: Roles
      • User: Permissions
      • Creating User
        • Creating Users Through File Import
        • Creating Users Through File Import: Associate Stores
        • Creating Users Through File Import: Associate Categories
      • Resetting Password
    • Partners
      • Partner Offers: Create
        • Partner Offers: Step 1 - Creating Point Type
        • Partner Offers: Step 2 - Creating Partner
        • Partner Offers: Step 3 - Creating Offer
        • Partner Offers: Step 4 - Targeting Offer
        • Partner Offers: Step 5 - Launching Offer
    • Announcement
      • Creating Announcement
      • Editing Announcement
    • Custom Attributes
      • Custom Attribute: Constraints
      • Using Custom Attribute
      • Custom Attribute: Reference Tag Use
      • Custom Attribute: List Page
      • Custom Attribute: Prerequisites
      • Custom Attribute: Create
        • Creating Custom Attribute
      • Custom Attribute: Creating Number
      • Custom Attribute: Creating Month/Day
      • Custom Attribute: Creating Date/Time
      • Custom Attribute: Creating Lookup
      • Custom Attribute: Create Text
        • Using a Text Custom Attribute
        • Text Custom Attribute Constraints
      • Custom Attribute: Add Customer Data
      • Custom Attribute: Add Product Data
    • Custom Entities
      • Creating Custom Entity
      • Custom Entity: Adding Attributes
      • Custom Entity: Lookup Codes
      • Custom Entity: Adding Attribute Lookup Codes
      • Custom Entity: Delete Attribute Lookup Codes
      • Custom Entity: Importing Keys
      • Editing Custom Entity
      • Publishing Custom Entity
      • Deleting Custom Entity
      • Custom Entity: Targeting
      • Custom Entity: Creating a Targeting Dimension
    • Customers
      • Customer: Manage
      • Customer: Details Page
      • Customer: Merge
        • Merging Customer Accounts
    • Generic Events
      • Generic Event: List Page
        • Fields and Features
      • Creating Generic Event
      • Targeting Generic Event
      • Generic Events: Reversing Events
    • Product Taxonomy
    • Tiers
      • System Based Tiers
      • Editing Tier
      • Targeting Tier
• 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