The following article contains instructions for installing AI-powered solutions into your environment. Each Generally Available solution also has its own individual install guide with additional instructions should they be needed.
Install Order
Due to dependencies across solutions, the recommended install order for solutions is:
- AIS Dependency Bundle - This solution facilitates interaction with the Xperiflow Engine.
- Xperiflow Administration Tools - This solution controls user and group access to your solutions and projects.
- Xperiflow Cloud Tools - (Circumstantial) This solution may be required to upgrade the Xperiflow Engine version of your environment (ex. Upgrading from 4.0.4 to 4.1.0).
- AI-Powered Solutions - At this point all supporting solutions have been installed.
Platform Version
Your OneStream install is on a specific Platform Version, for example v9.0.0. The Platform Version for any Solution you wish to install must align with the Platform Version you have installed to ensure compatibility. A Solution built for v9.1.0 is not guaranteed to function on a v9.0.0 OneStream install.
Minor version discrepancies such as v9.0.0 vs v9.0.1 are likely to be compliant. Check with a OneStream consultant if you are unsure about version compatibility.
All solution uploads must be performed by a user with visibility of the Application tab within OneStream. To verify visibility, log in to your supplied OneStream client and check the left navigation window. The Application tab mustbe visible to load solutions into your environment.
Xperiflow Version
Along with the Platform version, Solutions are released alongside a specific Xperiflow Engine version as well. A misalignment between a Solution’s target Xperiflow version and your environment’s Xperiflow version may create compile and/or runtime issues.
Download
To begin, navigate to Solution Exchange from your browser and log in with your provided OneStream credentials. Once at the Solution Exchange Home Page, navigate to and select the Solutions tab.
The solution you will be installing will fall within the AI Category. Search for the solution directly or use the filters to narrow down search results until your solution is visible. Select the solution to open its download page.
Ensure that the selected Platform Version matches the Platform Version you will be working with. Select the latest Solution Version, then click Download.
In some cases, you may be advised to download a specific, non-latest Solution Version for a given solution. The best version for you will be dependent on your Xperiflow Engine Version.
Install
With your solution downloaded, open your OneStream Client, connect to your Server, log in, and select the desired Application for installing the new solution.
Make sure that your Platform Version matches your new solution’s Platform Version. Solutions may not launch or function properly on incorrect Platform Versions.
To upload your Solution, select the Application tab, then under Tools select Load/Extract.
Select the ellipsis … to open your local File Explorer. Select your downloaded Solution, then Open, and finally the Load button to upload the Solution to the environment.
If a copy of the solution is already present in the environment, you will likely receive an error during upload. If that is the case, delete or uninstall the prior solution to upload the new one.
To verify the install completed successfully, open the Workspaces window under Presentation.
Every solution with an interactable dashboard will direct you to go through a Setup page when first installed. These setup steps are similar across solutions; however, some may have extra considerations. Please consult your specific solutions Install or User Guide for more information.