diff --git a/docs/software-developer-documentation/client-side-extensions/openbis-webapps.md b/docs/software-developer-documentation/client-side-extensions/openbis-webapps.md index 2e7efc0fb4789ecc79d9632c7990a7f745999448..75ff3bf5cfbd4f8403d870c093aeceba03933dee 100644 --- a/docs/software-developer-documentation/client-side-extensions/openbis-webapps.md +++ b/docs/software-developer-documentation/client-side-extensions/openbis-webapps.md @@ -144,51 +144,16 @@ experiment details view that will be displayed for experiments with type A full list of supported properties is presented below. -|Property Key|Description|Allowed values| -|--- |--- |--- | -|openbisui-contexts|Place where the webapp is shown in the OpenBIS UI.|modules-menu - - -webapp is an item in the modules top menu - - - -experiment-details-view - - -webapp is a tab in the experiment details view -requires experiment-entity-types to be defined - - -sample-details-view - - -webapp is a tab in the sample details view -requires sample-entity-types to be defined - - -data-set-details-view - - -webapp is a tab in the data set details view -requires data-set-entity-types to be defined - - -material-details-view - - -webapp is a tab in the material details view -requires material-entity-types to be defined - - +|Property Key |Description |Allowed values | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|openbisui-contexts |Place where the webapp is shown in the OpenBIS UI. |modules-menu webapp is an item in the modules top menu experiment-details-view webapp is a tab in the experiment details view requires experiment-entity-types to be defined sample-details-view webapp is a tab in the sample details view requires sample-entity-types to be defined data-set-details-view webapp is a tab in the data set details view requires data-set-entity-types to be defined material-details-view webapp is a tab in the material details view requires material-entity-types to be defined Accepts a comma separated list of values with regular expressions, e.g. "modules-menu, .*-details-view"| +|label |The label. It will be shown in the GUI. |String | +|sorting |Sorting of the webapp. Webapps are sorted by "sorting" and "folder name" ascending with nulls last (webapps without sorting are presented last).|Integer | +|experiment-entity-types|Types of experiments the webapp should be displayed for. |Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*" | +|sample-entity-types |Types of samples the webapp should be displayed for. |Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*" | +|data-set-entity-types |Types of data sets the webapp should be displayed for. |Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*" | +|material-entity-types |Types of materials the webapp should be displayed for. |Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*" | -Accepts a comma separated list of values with regular expressions, e.g. "modules-menu, .*-details-view"| -|label|The label. It will be shown in the GUI.|String| -|sorting|Sorting of the webapp. Webapps are sorted by "sorting" and "folder name" ascending with nulls last (webapps without sorting are presented last).|Integer| -|experiment-entity-types|Types of experiments the webapp should be displayed for.|Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*"| -|sample-entity-types|Types of samples the webapp should be displayed for.|Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*"| -|data-set-entity-types|Types of data sets the webapp should be displayed for.|Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*"| -|material-entity-types|Types of materials the webapp should be displayed for.|Accepts a comma separated list of values with regular expressions, e.g. "TYPE_A_1, TYPE_A_2, TYPE_B_.*"| #### Creating embedded webapps