Skip to main content

Implementing the Orion Library

This guide provides concise steps for implementing the Orion.js library for on-page analytics. Orion.js collects client-side information that is reported in the Spiny app.

Prerequisites​

Requirements Gathering​

The below are optional however they do make breaking out your content easier in the Spiny application.

Page Types​

Our page types designation is intended to account for various details around the user experience you have or would like to have on your site. Generally these can be referred to as designations for a specific user experience/layout on your site. Examples include article, slideshows, home, category, database, database-item and so forth. We will need a sample URL for both staging and production for each of these page types such that we can properly organize our processes and for staging environments verify changes. This value for articles, recipes, courses, and podcast pages is automatically determined if implementing via the Tag Implementation. Additionally the standard WordPress page types(if being leveraged) are automatically handled as well for our WordPress implementation.

Channels​

Spiny offers the ability to break out your data with four tiered and custom channel designations. Channels generally are categorical(but don't have to be) in nature and have no special logic around them outside of breaking out data and content. The usage of this capability is optional. We encourage you to read more about channels here as it can greatly benefit how your team can break out data within the Spiny application.

Networks​

Similar to channels the Network schema is a more rigid implementation with special logic associated to the data access permissions. If you would like to leverage the Network please let the Spiny team know so we can make the appropriate configurations to the generated bundle. We encourage you to read more about Network designations and it's implications here as it can greatly benefit your experience within our application.

Implementation Options​

There are 3 ways to implement the Orion library explained below. We recommend the tag implementation at this time. Please choose the implementation option that best fits your needs.

Tag Implementation​

This is the most simple approach for implementing Orion. Simply include your bundle script on the page and Orion will automatically pick up/infer all of the needed metadata with the exception of third party integrations. While the most simple this implementation type does include additional requirements compared to the other options as well as some caveats.

Please find our guide at the following link: Orion - Getting Started ( Tag ).

WordPress Implementation​

If you're leveraging WordPress as your CMS we have built an integration for your CMS.

Please find our guide at the following link: Orion - Getting Started ( WordPress )

Manual Implementation​

If you want the most fine-grained integration capabilities with Orion or if any of the other implementations do not fit your needs please leverage this implementation.

Please find our guide at the following link: Orion - Getting Started ( Manual )