Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 6.89 KB

add_service.md

File metadata and controls

48 lines (27 loc) · 6.89 KB

Creating, Deleting and Updating Services

Add a Service

Studies are composed of one or more Services. To create another Service inside of an existing Study, you can double-click in the empty space of the Pipeline Workspace which will bring up the Service Catalog. Here you can filter, search and select a Service to add to your Study. You can also sort the Services by name or by number of hits (in ascending or descending order) by clicking on the sorting buttons (e.g. )

image

You can also access the Service Catalog by clicking on the input or output port of an existing Service, and dragging and dropping the connection arrow to an empty location in the Study Workbench.

add_service_dragging_arrow

Delete a Service

You can delete a Service in multiple ways:

  1. In the workspace, click on the three dots button of the Service you want to delete, then select Delete and confirm.
  2. In the workspace, click on the Service and press the Delete key on your keyboard (or Fn + Backspace if you are using a Mac).
  3. In the primary column of your Study, click on the nodes list button , select the Service from the list, click on the three dots button of the Service you want to delete, then select Delete and confirm.

Update a Service

It is recommended to update a Service when a new version is available. If your Study contains outdated Services and you click on the Open button, a new window will appear. If you click on Yes, the Service Updates tab will open and will show which Services can be updated. You can also choose not to update (by clicking on No), in this case the Study will just open. The next time you access the same Study, you'll be faced with the same selection.

From your dashboard, an update icon will appear on the Study card (lower right corner).

Update a Service from the Dashboard

When you click on the update icon on the Study card (lower right corner) a new window will open. The Services that can be updated are highlighted and you can choose to update them one-by-one or update all at the same time.

You can also open the same window by clicking on the Study card and then selecting Service Updates from the left bar.

updateservice

Update a Service from inside the Study

It is also possible to update a Service from inside the Study Workbench (Secondary Column). When you click on a node (Service) that can be updated, you will find the Update Service function under the "Options" section in the Secondary Column. To update the Service, just follow the instructions (Stop the Service, this will also trigger the saving of the data inside the service, update it, and restart it).

image Items of note:

  • It is only possible to update to the latest version
  • All settings and data will be preserved when updating
  • By following the steps above, you can only update the patch version and not to minor/major versions (e.g. from version 1.0.1 to 1.0.4 and not from 1.0.1 to 1.1.1 or 2.0.1)
  • To update to minor/major versions you have to open the Study, delete the outdated node and then create a new node with the latest Service version. Make sure to download the node data (if there is any) locally before deleting the original node. In some cases, a minor/major update can break the pipeline and you will need to adapt your Study to work with the updated Service.