Quick Start Guide for KatanaPIM Connect

Get your KatanaPIM Connect extension connected and run your first synchronization.

Prerequisites

Before starting, ensure you have:

• Module installed and enabled
• Admin access to Magento
• KatanaPIM account with API credentials (URL and API Key)
• Working Magento cron (for automated sync)

Step 1: Enable the Module

1. Go to Katana PIM → Configuration (or Stores → Configuration → Katana PIM → General)
2. In the General section, set Enabled to Yes
3. Click Save Config

Step 2: Connect to KatanaPIM API

1. Navigate to the API section
2. Enter your URL (your KatanaPIM instance URL)
3. Enter your API Key (from your KatanaPIM account)
4. Click Test Credentials to verify the connection
5. Click Save Config

Step 3: Configure Store Language Mapping

1. Go to Store Languages section
2. Map your KatanaPIM language codes to Magento store views
3. Use default (lowercase) to map KatanaPIM's default language
4. Click Save Config

Example mapping:

Step 4: Import Attributes First

Before importing products, you need to import and map attributes:

1. Go to Katana PIM → Attributes
2. Click Import Attributes button
3. Wait for import to complete
4. For each attribute, use inline edit to:
   • Select the Magento Attribute Code to map to
   • Set Is Configurable to Yes for variant attributes
5. Mark unwanted attributes as Skipped

Step 5: Import Categories (Optional)

If you want to import categories from PIM:

1. Go to Katana PIM → Product Data in configuration
2. Enable Category Import if desired
3. Go to Katana PIM → Categories
4. Click Import Categories button
5. Select categories and use Update/Create Magento Category mass action

Step 6: Run Your First Product Sync

Option A - Via Admin:

1. Go to Katana PIM → Products
2. Click Full Sync button
3. Wait for products to import
4. Select products and use Update/Create Magento Products mass action

Option B - Via CLI:

# Import everything (attributes, categories, products, assets)
bin/magento katana:import:full

# Import only products
bin/magento katana:import:full --products

Step 7: Enable Automation (Optional)

1. Go to Katana PIM → Automation in configuration
2. Set Enable Automation to Yes
3. Configure:
   • Auto create new products - Yes/No
   • Auto create new categories - Yes/No
   • Full Update frequency (e.g., daily)
   • Incremental Update frequency (e.g., every 4 hours)
4. Click Save Config

Verify Your Setup

1. Check Katana PIM → Products grid for imported products
2. Verify products in Catalog → Products with correct data
3. Check Katana PIM → Sync Log for any errors

Next Steps

• Configure Attribute Mapping for all product data fields
• Review the full Configuration Reference
• Understand the Sync Process for Full vs Incremental updates

Need More Help?

Documentation:

• All Help Articles - Complete documentation overview

Support:

• Contact Support - Get help from our team