Import / Export of Custom Block R and Python Scripts

Modified on Tue, 09 Nov 2021 at 11:52 AM

It is possible to import, export, bookmark, and add custom scripts to the community section within Omniscope EVO. This allows users to store, reuse, and share their scripts, as well as re-utilise and build on the scripts of others.

Export

At any point during the development of a custom block, the script including options, meta data and output configuration can be exported using the "Export Custom Block" button in the three-dots menu to the upper right of the block configuration dialog.

When clicked, the block will be downloaded as a zip file containing two files: The actual code as a python or R script, and a manifest.json file containing configuration information.

Import

Previously exported custom blocks, or stand-alone scripts can be imported into Omniscope EVO using the import button located in the upper right of the blocks-picker.

The button will open an import dialog. Here, you can add multiple R and Python script files, script files accompanied by manifest.json files, zip files, or even whole directories. The files can either be added by drag and drop, or selected via the "Browse" button

Clicking "Apply" will add them to the workspace.

Design Lock

It is possible to hide the Custom Block Design tab using a button from within the Custom Block dialog by using the button "Lock Custom Block design".

Hiding the tab can be useful if you want to share the block, but make it clear that it is better not to modify it, thus locking the design. Doing so and then exporting the block will automatically hide the design tab when the block is imported into another workflow.

Bookmarks

Adding a Custom Block Bookmark

Custom Blocks can also be bookmarked which allows for easy sharing with everyone that is connected to the same Omniscope EVO instance. The bookmark dialog button is located just next to the three dots menu in the Custom Block configuration dialog.

Bookmarked blocks appear in the "Bookmarks" section of the block picker. More information can be found here: https://help.visokio.com/support/solutions/articles/42000077609-bookmarks

Bookmark customisation

The appearance of the bookmark and the information that is shown when hovering over a bookmark can be customised for Custom Blocks. In the very bottom of the Custom Block configuration dialog, directly underneath the script editor is a section called "Advanced":

Block icon URL

Block icon URL can contain either a URL to a picture, such as http://some.website.com/picture.png, or a data url which contains a complete png or jpeg picture encoded in base64. In order to convert any picture into the base64 format, tools such as https://www.base64-image.de/ can be used. Alternatively, a google search for "convert png to base64" results in many usable tools to accomplish the same. The tools convert the whole picture into some text which can then copy and pasted into the "Block icon URL" field.

Short description

Insert here a short description of the functionality of the script. It will be part of the tooltip for bookmarks, as well as community blocks, if uploaded to github. For more information check the next section.

Category and Sub-Category

Enter any category under which you would like to file the bookmark. This is currently used only for organisational purposes. However, if in Category you put one of the main categories, such as Input, Connectors, Preparation, Analytics, Text Analysis, Outputs, Custom Scripts, or Reports, the bookmark colour will change to the appropriate section colour.

Github community blocks

If you would like to share a Custom Block with the whole Omniscope EVO community, it is possible to upload the block to github where it then becomes part of the community section.

Currently there are two ways to do so. For both ways, simply export the custom block as a zip file. Then, either clone the Omniscope Custom Block github repository https://github.com/visokio/omniscope-custom-blocks, add your block, and create a pull request. Or, simply contact us and send us the block directly. In both cases we will review the submission and integrate it if it is safe to do so.

As for bookmarks, the same customisations apply. It is possible to change the block icon, as well add useful descriptions and tags that will be shown and used in the block picker.