Opentaps Analytics Data Loader - Revision history

Oandreyev: /* Magento */

2011-06-30T20:19:08Z

‎Magento

Oandreyev: /* Magento */

2011-06-30T20:15:52Z

‎Magento

Sichen: /* Magento */

2011-05-27T22:42:00Z

‎Magento

Sichen: /* Examples */

2011-05-27T22:40:58Z

‎Examples

Sichen: /* opentaps and OFBiz */

2011-05-27T22:39:04Z

‎opentaps and OFBiz

Sichen: /* RETURN_ITEM_FACT */

2011-05-27T22:38:31Z

‎RETURN_ITEM_FACT

Sichen: /* ORDER_ITEM_FACT */

2011-05-27T22:37:42Z

‎ORDER_ITEM_FACT

Sichen: /* CUSTOMER_DIMENSION */

2011-04-22T18:24:16Z

‎CUSTOMER_DIMENSION

Jwickers: /* ORDER_ITEM_FACT */

2011-04-22T11:10:28Z

‎ORDER_ITEM_FACT

Sichen: /* API */

2011-04-14T18:51:44Z

‎API

@@ Line 22: / Line 22: @@
 * (RETURNED || REFUNDED) -> one record on return_item_fact with status as COMPLETED
-In order to install opentaps Analytics Loader for Magento copy the module files into Magento directory in accordance with their place in source tree. Sources can be found at svn://svn.opentaps.org/opentaps/modules/magento-analytics-upload/versions/1.0/trunk. "Opentaps Analytics Loader" top level menu item should appear in Magento Admin Panel.
+In order to install opentaps Analytics Loader for Magento copy the module files into Magento directory in accordance with their place in source tree. Sources can be found at svn://svn.opentaps.org/opentaps/modules/magento-analytics-upload/versions/1.0/trunk. "Opentaps Analytics Loader" top level menu item should appear in Magento Admin Panel. If no, try to click "Save Config" button on System->Configuration page.
 == API ==

@@ Line 21: / Line 21: @@
 * (PARTIAL || MIXED) -> one record for the shipped/invoiced as COMPLETED and another one for the missing qty as PENDING
 * (RETURNED || REFUNDED) -> one record on return_item_fact with status as COMPLETED
 == API ==

← Older revision		Revision as of 22:42, 27 May 2011
Line 14:		Line 14:

	=== Magento ===		=== Magento ===
		+
		+	Status from Magento order items are mapped into opentaps Analytics:
		+	* (PENDING \|\| BACKORDERED) -> PENDING
		+	* (SHIPPED \|\| INVOICED) -> COMPLETED
		+	* (CANCELED) -> CANCELLED
		+	* (PARTIAL \|\| MIXED) -> one record for the shipped/invoiced as COMPLETED and another one for the missing qty as PENDING
		+	* (RETURNED \|\| REFUNDED) -> one record on return_item_fact with status as COMPLETED

	== API ==		== API ==

@@ Line 48: / Line 48: @@
 Posting data in the ''CHANNEL_DIMENSION'':
-   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234 -d "0.channel_dimension.channel_id=MY_CHANNEL" -d "0.channel_dimension.channel_name=My Channel" <nowiki>https://analytics.opentaps.com/analytics/control/loaddata</nowiki>
+   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234
 Returned Success message would be like:
@@ Line 66: / Line 69: @@
    curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234 \
-    -d "0.sales_team_dimension.sales_team_id=MY_TEAM" -d "0.sales_team_dimension.sales_team_name=My Sales Team" \
+    -d "0.sales_team_dimension.sales_team_id=MY_TEAM"
     -d "1.sales_rep_dimension.sales_rep_id=MY_SALESREP" -d "1.sales_rep_dimension.sales_team_id=MY_TEAM" \
     <nowiki>http://analytics.opentaps.com/analytics/control/loaddata</nowiki>
@@ Line 72: / Line 76: @@
 Example with bad authentication:
-   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234 -d "0.channel_dimension.channel_id=MY_CHANNEL" -d "0.channel_dimension.channel_name=My Channel" <nowiki>http://analytics.opentaps.com/analytics/control/loaddata</nowiki>
+   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234
    HTTP/1.1 401 Unauthorized
@@ Line 87: / Line 94: @@
 Example of Error when trying to add data in an in-existing field:
-   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234 -d "0.channel_dimension.channel_id=MY_CHANNEL" -d "0.channel_dimension.channel_description=My Channel" <nowiki>http://analytics.opentaps.com/analytics/control/loaddata</nowiki>
+   curl -i -d userlogin=myuser -d password=mypass -d webkey=thisisatest1234
    HTTP/1.1 500 Internal Server Error

@@ Line 4: / Line 4: @@
 === opentaps and OFBiz ===
-analytics-upload component help to gather and upload analytical data to server. A few steps should be done to install it with opentaps or OfBiz instance.
 # Checkout component into hot-deploy. Use <code>svn co svn://svn.opentaps.org/opentaps/modules/analytics-upload/versions/1.5/trunk analytics-upload</code>
@@ Line 11: / Line 12: @@
 # Note there are two ''scripts'' value in configuration file, default one to use with opentaps instance and another for OfBiz.
 # Start instance and run '''analytics.uploadAnalyticalData''' service.
 == API ==

@@ Line 325: / Line 325: @@
 | DISCOUNT_AMOUNT_BASE_CURRENCY || Numeric (18,2) || Discount for the amount being returned
 |-
-| RESOLUTION_STATUS || String (25) || Status of the return: processed, rejected, canceled, etc.
+| RESOLUTION_STATUS || String (25) || Status of the return.  Acceptable values are: PENDING, COMPLETED, CANCELLED, REJECTED. Please map your return status to one of these.
 |}

@@ Line 283: / Line 283: @@
 | DISCOUNT_AMOUNT_BASE_CURRENCY || Numeric (18,2)|| Amount of discount on order item
 |-
-| RESOLUTION_STATUS || String (25) || Status of the order item: completed, canceled, etc.
+| RESOLUTION_STATUS || String (25) || Status of the order item.  Acceptable values are: PENDING, COMPLETED, CANCELLED, REJECTED.  Please map your order status to one of these.
 |-
 | RETURNED_QUANTITY || Numeric (18,6) || The quantity of the item that was returned

@@ Line 182: / Line 182: @@
 |-
 | COUNTRY || String (100) || Country of the customer's address
 |-
 | POSTAL_CODE || String (60) || Full postal code for the customer's address

@@ Line 271: / Line 271: @@
 | SALES_REP_ID || String (60)|| The sales representative identifier, references the SALES_REP_DIMENSION
 |-
-| SALES_REP_TEAM_ID || String (60) || The sales team identifier, references the SALES_TEAM_DIMENSION
+| SALES_TEAM_ID || String (60) || The sales team identifier, references the SALES_TEAM_DIMENSION
 |-
 | ORDER_DATE || String (Date) || The date the order was placed, format is ''YYYY-MM-DD''

@@ Line 14: / Line 14: @@
 == API ==
-Data Loading is done via an HTTP POST to <tt>http://analytics.opentaps.com/analytics/control/loaddata</tt>
+Data Loading is done via an HTTP POST to <nowiki>http://analytics.opentaps.com/analytics/control/loaddata</nowiki>
 The following parameter are required:
@@ Line 33: / Line 33: @@
 * 500 Internal error : other exception during import
-To clear your data, you can send an HTTP POST to <tt>http://analytics.opentaps.com/analytics/control/cleardata</tt> with your userlogin, password, and webkey.
+To clear your data, you can send an HTTP POST to <nowiki>http://analytics.opentaps.com/analytics/control/cleardata</nowiki> with your userlogin, password, and webkey.
-Your userlogin must have the ANALYTICS_DATA_CLEAR permission to load data.
+'''WARNING''': This REALLY will get rid of all your data.
 === Examples ===