A package to build OneStream's snippets
Package is downloadable in different Flavors:
| Flavor | Installer | ChangeLog | |
|---|---|---|---|
| Development | AWSnippets.zip | CHANGELOG.md | |
| Staging | AWSnippets.zip | CHANGELOG.md | |
| Production | AWSnippets.zip | CHANGELOG.md | Last Stable Release |
To install snippets just grab the above mentioned zip file and load it into OneStream through the Application Load/Extract procedure.
The main directories in this project are
- Commons - Here are the common parts of the snippets, attached at the beginning (Pre) and/or End (Post) of each snippet.
- Snippets - The actual snippets, divided into their own Categories.
Each snippet should come in two flavours: C# (extension is .cs) and Visual Basic (extension is .vb).
The directory at first level under Snippets represent the Module Type (they are defined by OneStream):
- General
- Finance
- Stage
- CubeView
- Dashboard
- Extender
- Event Handler
The following grid shows each module’s availability in the Business Rules and other areas of OneStream.
Valid file formats are .cs or .vb
The first three lines are triple slash comments:
- The first line represent the snippet's name
- The second line represent the snippet's description
- The third line contains the comma separated search terms
The fourth line must be left blank (it's ignored when )
The snippet starts at the fifth line
Example:
/// Snippet Name
/// Snippet description
/// Term1, Term2, Term3
string s = ""; // This is the first line of the script
Files starting with "todo_" won't be included in the final Zip file.
Every commit automatically generates an updated release of the Snippets (see the above mentioned links).