adding old doc to be merged

_search-plugins/ubi/client_datastructures.md

@@ -0,0 +1,85 @@
+The datastructures that we use for indexing events adhere to the following nested structure that aligns with the Ubi schemas.  See the [schemas](.././schemas.md) for descriptions and examples of the following fields.
+
+`struct UbiEvent {`
+- application
+- action_name
+- user_id
+- query_id
+- session_id
+- page_id
+- message_type
+- timestamp
+- <details>
+	<summary>event_attributes {</summary>
+	<p>
+
+  - <details>
+  	<summary>position {</summary>
+
+  		- ordinal
+  		- x
+  		- y
+  		- trail
+  	}
+  	</details>
+  - <details>
+  	<summary>object {</summary>
+
+  		- internal_id
+  		- object_id
+  		- object_type
+  		- description
+  		- object_details /
+        - object_details.json
+  		}
+  	</details>
+	}
+  </details>}
+`}`
+
+Typescript versions of these classes can be found in [ts/UbiEvent.ts](./ts/UbiEvent.ts).
+
+Example javascript code:
+```js
+    // basic message format
+    let e = new UbiEvent('chorus', 'add_to_cart', user_id, query_id);
+    e.message_type = 'PURCHASE';
+    e.message = item.title + ' (' + item.primary_ean + ')';
+    e.session_id = session_id;
+    e.page_id = window.location.pathname;
+
+    // adding custom data fields
+    e.event_attributes['user_info'] = {user_name:'TheJackal', phone:'555-555-1234'}
+
+    // associate the object added to the cart
+    e.event_attributes.object = new UbiObject('product', item.primary_ean, item.title, item);
+
+    // save any click info
+    e.event_attributes.position = new UbiPosition({x:event.clientX, y:event.clientY});
+
+    // index here
+    console.log(e.toJson());
+```
+
+With very similar [python data structures](./py/ubi.py):
+```python
+if __name__ == '__main__':
+	e = UbiEvent(application='chorus', action_name='add_to_cart', 
+              user_id='USER-' + guuid(), query_id='QUERY-ID-'+ guuid(), session_id='SESSION-' + guuid(),
+              # object added to the cart
+              object= UbiObject(
+                  		object_type='product', 
+                    	object_id='ISBN-' + guuid(), 
+                      description='a very nice book', details={'product_data':'random product data'}              
+            )
+	)
+	e.message_type = 'PURCHASE'
+
+	# adding custom attribute fields
+	e.event_attributes['user_info'] = {'user_name':'TheJackal', 'phone':'555-555-1234'}
+
+ 	# product position information
+	e.event_attributes.position = UbiPosition(ordinal=3, x=250, y=400)
+
+	print(e.to_json())
+```