KatanaPIM Configuration
Complete settings reference for the KatanaPIM Connect extension. This guide explains each setting and when to use it.
General Configuration
Navigate to Stores → Configuration → Katana PIM → General or via the admin menu Katana PIM → Configuration.
General
| Setting | Description |
|---|---|
| Enabled | Master switch for the KatanaPIM integration |
When to disable: Only disable if you need to temporarily stop all PIM synchronization without uninstalling the module. Useful during major catalog restructuring or PIM migrations.
API
Connect your Magento store to your KatanaPIM instance.
| Setting | Description |
|---|---|
| URL | Your KatanaPIM instance URL (e.g., https://yourcompany.katanapim.com) |
| Key | API key from your KatanaPIM account (stored encrypted) |
| Test Credentials | Validates your API connection |
Where to find your API key: In KatanaPIM, navigate to your account settings or contact your KatanaPIM administrator.
Tip: Always test credentials after entering them. A failed connection will prevent all synchronization.
Import Settings
Fine-tune how the extension processes data during synchronization.
Batch Size Settings
Control how many entities are processed per batch. Smaller batches use less memory but take longer; larger batches are faster but may hit memory limits.
| Setting | Default | Description |
|---|---|---|
| Import PIM products page size | 100 | Products fetched from KatanaPIM per API call |
| Create Magento products page size | 50 | Products created/updated in Magento per batch |
| Import attributes page size | 100 | Attributes imported per batch |
| Import categories page size | 100 | Categories imported per batch |
| Import Katana assets page size | 100 | Assets (images/files) fetched from PIM per batch |
| Import Magento assets page size | 50 | Assets processed into Magento per batch |
When to adjust:
- Lower values if you experience memory errors or timeouts during sync
- Higher values if you have a powerful server and want faster imports
- Asset page sizes are typically the most memory-intensive - start conservative
Async Update Settings
| Setting | Description |
|---|---|
| Concurrency Limit | Maximum simultaneous async requests |
When to adjust: Lower this if you see Redis connection errors or "too many connections" errors. The default is usually safe, but high-traffic stores may need to reduce it.
Reindex Data
| Setting | Description |
|---|---|
| Init Reindex after full sync | Automatically trigger Magento reindex after completing a full sync |
Warning: Not recommended for production stores with large catalogs. Reindexing can cause performance issues during business hours. Instead, schedule reindex via cron during off-peak times.
When to enable: Only on development/staging environments, or small catalogs where reindex completes quickly.
Store Filter
If your KatanaPIM account has multiple stores, you can filter which store's data to import.
| Setting | Description |
|---|---|
| Import Stores | Fetches available stores from KatanaPIM |
| Store Filter | Select which KatanaPIM store to sync from |
When to use: Multi-brand setups where different Magento instances connect to different KatanaPIM stores. Leave empty to import from all stores.
Import New Products in Websites
| Setting | Description |
|---|---|
| Websites | Magento websites where new products will be assigned |
Important: This only affects NEW products. Existing products keep their current website assignments. Select all websites where PIM products should be visible.
Store Languages
Map KatanaPIM languages to your Magento store views for multi-language product data synchronization.
| Setting | Description |
|---|---|
| Store Language Mapping | Map KatanaPIM language codes to Magento store views |
Finding Your KatanaPIM Language Codes
In your KatanaPIM backend, navigate to Configuration > Languages to see all available languages and their codes.
Common language code formats:
nl-NL- Dutch (Netherlands)en-US- English (United States)fr-FR- French (France)de-DE- German (Germany)it-IT- Italian (Italy)es-ES- Spanish (Spain)
Mapping the Default Language
To map KatanaPIM's default language (marked with checkmark in "Is default" column), use the string default (lowercase) as the Katana Language Code.
Example mapping:
| Katana Language Code | Magento Store View |
|---|---|
default |
English (Default Store View) |
nl-NL |
Dutch |
de-DE |
German |
How It Works
- When products sync, the extension checks which languages are mapped
- For each mapped language, it pulls the translated product data from KatanaPIM
- The data is saved to the corresponding Magento store view
- Unmapped languages are ignored during sync
Tip: Only map languages you actually use in Magento. Mapping unused languages increases sync time without benefit.
Debug & Logging
| Setting | Description |
|---|---|
| Debug Mode | Enable detailed logging for troubleshooting |
| View Logs | Download debug and error logs directly from admin |
Log locations:
- Debug log:
var/log/katanapim/debug.log - Error log:
var/log/katanapim/error.log
When to enable: Only when troubleshooting issues. Debug mode logs extensive information and can grow large quickly. Disable after resolving issues.
Product Data Configuration
Navigate to Stores → Configuration → Katana PIM → Product Data.
These settings control how product data flows from KatanaPIM to Magento.
General
| Setting | Description |
|---|---|
| Enable Product Import | Master switch for product synchronization |
| If SKU exists update product | Link existing Magento products to KatanaPIM by matching SKU |
SKU matching explained: When enabled, if a product in KatanaPIM has the same SKU as an existing Magento product, they'll be linked. Future syncs will update that Magento product instead of creating a duplicate.
When to enable SKU matching:
- Migrating from another PIM system
- Connecting KatanaPIM to an existing catalog
- Merging product data sources
When to disable: Fresh installations where all products come from KatanaPIM.
Attributes
Map KatanaPIM attributes to core Magento product fields. Select which KatanaPIM attribute should populate each Magento field.
| Setting | Maps to Magento field |
|---|---|
| Name | name |
| Short Description | short_description |
| Description | description |
| GTIN | Custom attribute for EAN/UPC codes |
| Manufacturer Part Number | Custom attribute for MPN |
| Attachments | Product attachments/downloads |
| Meta Keywords | meta_keyword |
| Meta Description | meta_description |
| Meta Title | meta_title |
Tip: These dropdowns show all available KatanaPIM attributes. If you don't see the attribute you need, run an attribute import first from Katana PIM → Attributes.
Asset Data
Control how images and videos from KatanaPIM are handled.
| Setting | Description |
|---|---|
| Import Video to Gallery | Include videos in the product media gallery |
| Title Attribute | KatanaPIM attribute to use as video title |
| Gallery Position | Where videos appear in the gallery (lower = first) |
| Compare Image Hash | Only re-import images if content changed |
Image hash comparison: When enabled, the extension compares file hashes before importing. This prevents re-downloading identical images and speeds up incremental syncs significantly.
When to disable hash comparison: If images in PIM are being updated but hashes aren't changing (rare), or during initial import for speed.
Product Import Defaults
Set default values for newly created products. These apply only when creating products - existing products are not affected.
| Setting | Options | Recommendation |
|---|---|---|
| Status | Enabled / Disabled | Disabled - Review products before making them live |
| Visibility | Not Visible / Catalog / Search / Both | Not Visible - Enable after QA |
| Use config manage stock | Yes / No | Yes - Use global inventory settings |
| Is in stock | Yes / No | Yes - Unless you manage stock separately |
Recommended workflow: Import products as Disabled/Not Visible, review them in Magento, then enable in bulk after QA.
Price Updates
| Setting | Description |
|---|---|
| Update product price changes | Sync price, special_price, and cost from PIM |
When to disable: If prices are managed in Magento (promotions, customer-specific pricing) rather than PIM. Enabling this will overwrite any Magento-side price changes.
Category Data Configuration
Navigate to Stores → Configuration → Katana PIM → Category Data.
General
| Setting | Description |
|---|---|
| Enable Category Import | Master switch for category synchronization |
| If name exists link category | Match existing Magento categories by name and depth |
Category matching explained: When enabled, if a KatanaPIM category has the same name as a Magento category at the same tree depth, they're linked. This preserves your existing category URLs and SEO.
Example: KatanaPIM category "Clothing > Shirts" will match Magento category "Clothing > Shirts" if both are at depth 2.
When to enable: Connecting KatanaPIM to an existing catalog with established categories.
When to disable: Fresh installations, or if you want completely separate category structures.
Automation Configuration
Navigate to Stores → Configuration → Katana PIM → Automation.
Automate synchronization via Magento cron jobs.
Settings
| Setting | Description |
|---|---|
| Enable Automation | Master switch for cron-based sync |
| Auto create new products | Allow cron to create new Magento products |
| Auto create new categories | Allow cron to create new Magento categories |
Auto-create settings: Control whether the automated sync can create new entities or only update existing ones.
Conservative approach: Disable auto-create initially. New products appear in the Katana PIM grid but aren't created in Magento until you manually approve them.
Hands-off approach: Enable both for fully automated catalog management. New products in PIM automatically appear in Magento.
Cron Settings
| Setting | Description |
|---|---|
| Full Update | Complete resync of all data |
| Incremental Update | Sync only changes since last update |
Recommended schedule:
- Full Update: Weekly or daily (off-peak hours)
- Incremental Update: Every 1-4 hours
Full vs Incremental:
- Full sync fetches everything from PIM, ensuring Magento matches PIM exactly. Slower but catches any missed changes.
- Incremental sync only fetches items modified since the last sync. Much faster for day-to-day updates.
Tip: If products seem out of sync, run a manual full sync from the admin grid or CLI.
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team