TIBCO Scribe® Online Connector For Magento 1
Use the Connector for Magento 1 to quickly and seamlessly integrate your Magento E-Commerce site to your back-office systems. For the latest release notes, see Magento 1 Release Notes.
Use Cases
- Sync Magento orders to your back-office systems in real time.
- Automate your order fulfillment process by eliminating administrative overhead of manual order taking and payment processing.
- Easily maintain a single customer database as well as a single inventory database by syncing your Magento customer and inventory information with your back-office system.
- Sync customer information between Magento and your CRM system.
Connector Specifications
This Connector supports version 1.9 of the Magento 1.9 REST API.
| Supported | |
|---|---|
|
Agent Types |
|
| On Premise | X |
| Cloud | X |
|
Replication Services |
|
| Source | |
| Target | |
|
Integration Services |
|
| Source | X |
| Target | X |
|
Migration Services |
|
| Source | |
| Target | |
|
Maps |
|
| Integration | X |
| Request-Reply | X |
| Message | |
Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.
Supported Entities
The Magento 1 Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online.
Standard Operations
| Entity | Query | Create | Update | Delete | Upsert |
|---|---|---|---|---|---|
|
Customer |
X |
|
X |
X |
|
|
X |
X |
X |
X |
|
|
|
Order |
X |
|
|
|
|
|
Order_Item |
X |
|
|
|
|
|
Order_Address |
X |
|
|
|
|
|
Product |
X |
X |
X |
X |
|
|
X |
X |
|
X |
|
|
|
X |
X |
X |
X |
|
|
|
Stock_Item |
X |
|
X |
|
|
Setup Considerations
- A Subscription Key is required to complete Connection setup.
- Magento REST consumer must be set up to complete the Connection setup process.
- If additional entities and/or custom fields are required, then a companion extension for Magento must be installed, and custom metadata must be enabled in the TIBCO Scribe® Online Connection configuration. This is available upon request.
API Usage Limits
Typically, Magento does not impose any REST API call limitations, however, some Magento hosting companies do impose API limits.
Selecting An Agent For Magento
Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.
Connecting To Magento 1
Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.
- Select More > Connections from the menu.
- From the Connections page select Add
to open the Add a New Connection dialog. - Select the Connector from
the drop-down list in the Connection Type field, and then enter the following information for this Connection:
- Name — This can be any meaningful name, up to 25 characters.
- Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
- Service URL — The URL for your Magento service instance in the format: http://<server name>.
- OAuth Key — REST OAuth consumer key
- OAuth Secret — REST OAuth consumer secret
- OAuth Username — Magento System username
- OAuth Password — Magento System user password
- Admin Folder — Name of the Magento admin folder
- Subscription Key — Subscription key provided by Datix
- Custom Metadata — Enables discovering of custom metadata. Select Yes to enable or No to disable. If enabled, requires that the companion extension for Magento be installed. If the extension is not installed, and Custom Metadata is enabled, an exception is generated.
- Select Test to ensure that the Agent can connect to Magento. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
- Select OK/Save to save the Connection.
Metadata Notes
- Null field values are not considered when present in lookup conditions.
- All metadata fields are nullable however, inputting null field values may result in unexpected behavior within the target Magento environment and is not recommended.
Relationships
- Hierarchical relationships, such as grandparent, parent, grandchild relationships are not supported. See Hierarchical Data for examples.
- Both Parent and Child relationships are supported for some entities. Review the TIBCO Scribe® Online Connector For Magento 1 section for details on specific entities.
- The parent_id field in child level tables corresponds to entity_id in the parent table.
Note: For this Connector, only one level of relationship, Parent/Child, is supported for the entity selected in the Query or Fetch Block. For records with multiple levels of relationships, such as Parent, Child, Grandchild, only the selected Parent entity and related Child entities can be retrieved. Additional levels beneath Child entities, such as Grandchildren, cannot be accessed for this Connector using the Include tab. See Block Properties Include Tab — Relational Data.
Retry Logic
- Automated retries after timeouts are not currently supported.
Errors
Errors containing HTML response codes, such as a 500 error indicating that there is server problem, are generated within Magento.
Magento 1 Connector As IS Source
Consider the following when using the Connector as an Integration Services source.
Query Or Lookup
- Query and Lookup operations on child entities require the parent_id field as a filter on the Block Properties Filter tab.
- The parent_id fields for child entities are not included in Query or Lookup results.
Filtering
- For best performance, it is recommended that the record id field entity_id be used as a filter in Queries or Lookups wherever possible.
- Both logical ANDs and ORs are supported. However, when ORs are used, filters are not applied until all records have been returned, which can have an impact on performance.
- Supported operators include:
- Equals =
- Does not equal <>
- Greater than >
- Less than <
Net Change
- Using Net Change to retrieve only new and updated records is supported for all entities, including custom entities, with a date field that is updated when a record is added or changed, such as created_on or modified_on.
Magento Connector As IS Target
Consider the following when using the Magento Connector as an Integration Services target.
- Batch processing is not supported.
- Create and Delete operations for the product_category entity behave as assignment operations rather than Create and Delete operations. To assign a category to a product use the product_category Create operation and to unassign a category use the Delete operation. These operations do not Create or Delete product categories in Magento.
Notes On Standard Entities
Custom fields are supported for standard entities provided that custom metadata is enabled for the connection and the companion extension for Magento is installed on the target Magento environment.
Customer_Address
- Query or Lookup — Requires the parent_id field as a filter or no records are returned.
- When a new Customer_Address record is created, the is_default_billing and is_default_shipping fields are treated as if they were set to 0 or disabled by default. Once a Customer_Address record has either field set to 1, which is enabled, that record cannot be deleted nor can the flag be disabled. You can change the default shipping or billing address to another Customer Address for that customer.
Product_Category
- Query or Lookup —
- Only the category_id field is returned. You can add custom fields to a Product_Category to provide additional information and those fields are also returned.
- Requires the parent_id field as a filter or no records are returned.
Product_Image
- Query or Lookup —
- The file_content, file_mime_type, and file_name fields are returned as null values.
- Requires the parent_id field as a filter or no records are returned.
Notes On Custom Entities
Custom entities and REST API endpoints are supported for standard entities provided that custom metadata is enabled for the Connection and the companion extension for Magento is installed on the target Magento environment.
TIBCO Scribe® Online API Considerations
To create Connections with the TIBCO Scribe® Online API, the Magento 1 Connector requires the following information:
|
Connector Name |
Magento 1 |
|
Connector ID |
C3C9EE7C-78DD-42B5-9D26-F0CEE7E39A12 |
TIBCO Scribe® Online Connection Properties
In addition, this Connector uses the Connection properties shown in the following table.
Note: Connection property names are case-sensitive.
| Name | Data Type | Required | Secured | Usage |
|---|---|---|---|---|
|
ServiceUrl |
String |
Yes |
No |
Server address |
|
key |
String |
Yes |
No |
REST user key |
|
secret |
String |
Yes |
No |
REST secret |
|
Username |
String |
Yes |
No |
REST user username |
|
Password |
String |
Yes |
Yes |
REST user password |
|
AdminFolder |
String |
No |
No |
Name of the Magento admin folder |
|
SubscriptionKey |
String |
Yes |
No |
Provided by Datix |
|
CustomMetadata |
String |
Yes |
No |
Set to Yes to enable support for custom metadata. |
More Information
For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.
