The following article contains instructions for installing the AI Data Tools (previously AI Data Manipulator) solution. Prior to installing AI Data Tools, ensure that both the AIS Dependency Bundle and the Xperiflow Administration Tools Solution are 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 is AI Data Tools. 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.
AI Data Tools contains the AIS AI Data Tools (DTL) Solution.
Versions prior to SV110/Xperiflow Version v4.1.0 will contain the AIS AI Data Manipulator (DMA) Solution.
Solution Setup
The AI Data Tools solution setup consists of three steps.
Create Tables
Click on the Create Tables button to generate Solution Tables. These are required for the solution to function. If any of these tables already exist, they will be preserved as needed.
Set Default Settings
AI Data Tools has an additional layer of security settings to further segment access across security groups. More information on these settings can be found in the solution user guide. To complete setup, Modify the roles such that at least one of the Security Groups has the Security Modify Access setting set to True. This ensures that at least one group will be able to access these settings again during normal app usage.
Validate Endpoint
In the Endpoint Parameter field, enter the engine endpoint supplied to you by your OneStream consultant. If this is not the first solution set up in the environment, a value may be pre-filled in this textbox. Click Save to submit your endpoint and verify its validity.
At this point the AI Data Tools solution is ready to launch. Click the Launch Solution button to navigate to the Home Page. Final solution checks will be performed and setup will complete.
