Skip to main content

Submission Requirements

Listed below are the artifacts and requirements needed to launch a solution on OneStream’s Solution Exchange.

Community Solution documentation templates are located here.

ArtifactArtifact

type

DescriptionRequirementsNotes / Examples
Solution Code PackageCodeThe code package that a customer downloads and installs from the Solution Exchange
  • Must be saved as a .zip file
  • Naming convention must be: XXX_PVX.X.X_SVXXX_PackageContents (ex: OSP_PV7.4.0_SV100_PackageContents)
Release NotesDocumentationRelease Notes inform the customer of the features and bugs for a given release
  • Must follow the OneStream documentation standards
  • Naming convention must be: XXX_PVX.X.X_SVXXX_ReleaseNotes (ex: OSP_PV7.4.0_SV100_ReleaseNotes)
  • Two file formats: .docx and pdf
Optional for Private Preview
User Guide / InstructionsDocumentationA solution manual
  • Must follow the OneStream documentation standards
  • Naming convention must be: XXX_PVX.X.X_SVXXX_Instructions (ex: OSP_PV7.4.0_SV100_Instructions)
  • Two file formats: .docx and pdf
Optional for Private Preview
OverviewDocumentationA detailed summary describing the solution
  • Must follow the specific template to be sized correctly on the Solution page
  • Naming convention must be: XXX_Overview (ex: OSP_Overview)
  • Two file formats: .docx and pdf
DescriptionTextA high-level summary describing the solution presented in the cards displayed on the Solution Exchange pages.
  • Must be less than 200 characters
Example: alt text
KeywordsTextUp to ten keywords can be added to expand search capabilities for solutions
  • Maximum ten keywords.
  • The match logic is exact. You can use two words, but those two words would need to both be entered to return a result. For example, adding Journal Entry will return results only when the two words are entered in the search exactly as “Journal Entry”. In this example, it is recommended that Journal Entry, Journal and Entry are entered as three separate keywords. Words can be separated by a hyphen.
Solution ScreenshotsImagesSolution screenshots are the four thumbnails that show the solution UI.
  • Up to four screenshots can be presented. Three if a video file is also available.
  • Must be sized at 1900x900
  • Must be in PNG file format
  • Naming convention must be: XXX_Screenshot1 thru 4 (ex: ADM_Screenshot1)
Solution VideosVideoOverview video describing or marketing the solution.
  • Only 1 video file will be supported per solution
  • The maximum video file size is 7 MB
  • The minimum video resolution is 1080p (1920x1080)
  • The video format is mp4
  • The file name must be XXX_Video, ex: ADM_Video
  • For a solution to be published a minimum of one solution screenshot must be included regardless of the video file present
  • If there are four screenshots available in the solution folder then the video replaces Screenshot4
  • If the video file exists Application Database solution folder then it is presented in the UI as long as it meets the file requirements
Solution iconIconsSolution icons represent the solution and are displayed in the solution tiles and on the solution details page.
  • 32-bit PNG
  • Naming convention must be: Image_XXX (ex: Image_ADM)
Example: alt text
See Solution Icon Design Guidelines for more details.
Security Group membersName and EmailIf solution release is part of a Early Access programs then members need to be added to the security group.
  • Full name and email
  • Must have Solution Exchange access

Was this page helpful?