Create and host your own Omniscope project templates

Modified on Mon, 20 Nov 2023 at 05:18 PM


Omniscope templates are comprehensive projects that pack together data transformation process and interactive reporting capabilities. This feature significantly streamlines the process for users by eliminating the need to start building the model from scratch. Instead, users can simply select from a range of pre-existing projects and focus solely on customisation.


While generic templates are readily available on the project page, Enterprise users now have the option, from Omniscope Evo version 2023.2, to create and manage their own templates within the platform.


There are two primary use cases that demonstrate the practicality of this feature:


- Productivity booster use case: Collaboration amongst team members becomes more efficient as they can collectively build a repository of useful templates, eliminating redundant work.


- Self-service data exploration use case: templates can be designed in such a way that end users (internal or external) can upload data and view the transformed results in a convenient report format without accessing the intricate workflow details. This capability is particularly valuable for creating a seamless experience for those users who should not have access to the workflow area.


Commencing with Omniscope Evo 2023.2, you can now host customised project templates, prominently displayed on the Project List page. 




How to create your own project template


Step 1: Define the location of the templates storing folder


You can define the local templates folder from the Admin web app > Web server > Settings section.




In the same place you can choose to hide the Visokio project templates if you wish. 

The Local project templates folder must be a sub-folder of the main Omniscope Folder.


Once you have defined your local project template settings, simply save your changes. 


If you then go to the Project list page, you should see your new folder in the specified location. We recommend that this be a top-level folder, just like Macros, for ease of administering permissions, etc.



Step 2: Create template projects


Creating project templates can be done in two ways:


Automated Template Creation:


  1. Move your project into the specified folder from step 1.
  2. Your project will become available as a template in the project templates dialog, accessible by clicking "Templates" on the sidebar



Manual Template Creation:


  1. Move the project into the Templates folder from step 1.
  2. Open the project.
  3. Navigate to the Workflow and click on the three dots menu.
  4. Select "Template settings" to configure the template manually.









In the Project Template Settings dialog, you can configure information that influences how the template appears in the Project list page.


This includes defining options that trigger specific UI widgets for user configuration before project creation. To make these widgets functional, link the option to the parameter.  Omniscope will automatically connect user input values to the corresponding parameter. 


For example, selecting "File upload" as the type for a text parameter prompts users to upload a data file when they click on the template name on the Project list page.



NOTE: If you choose "Auto" type for defining parameter type then Omniscope will automatically choose the appropriate UI for a given parameter. For example, if you have a boolean parameter user will see a checkbox.




In the dialog, you can additionally define blocks to execute and a shared report to open automatically. 



Step 3: Save your settings - your own project template should now appear in the project templates section.





Permissions


Grant permissions for the Templates folder as you would for any other folder in Omniscope, limiting the access to those users who should be able to create and edit templates - you can restrict certain users from creating 'Project templates' accessible to end-users. 

Additionally, you can hide the Templates folder from all users by selecting 'Hide in parent' in the folder permissions dialog.


Permissions required to create "Project templates" for end-users


Any potential template creator must have access to the Templates folder and be able to create projects inside this folder. 

Relevant permissions that should be enabled:

  • File management
  • Project editor


Permissions required to create new project from existing template


End-users seeking to utilise the existing project templates only require permission to create a project within the designated folder. They do not need access or editing permissions for the templates folder defined in Step 1.


The permissions the user normally required are:

  • File management
  • Project editor


Step 3: Create a project based on an existing template


In the scenario where templates are used by the internal team to collaborate and share models, every user can create a new folder to create a new project inside, based on one of the templates:

Open the destination folder, then pick a template, either on the sidebar or on the plus button, to create a new project.


In the scenario where the external users or clients are enabled to create self-service projects without getting access to the workflow, it is necessary for the Omniscope administrator to create the destination folder and manage the user access and permissions (e.g. only one user from a company is allowed to access the folder/ manage/edit files OR a group of users from that company is granted access and given the editing rights).

Once the user has opened the project destination folder, they can click on the template to create a new project inside this location.


This is what a template new project prompt might look like in case
a) the only param is the fils location or,
b) there is another param referenced in the workflow and in the template settings, as seen on the right.




See this article for an example of a template implementation project.



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article