Commit f55db85c authored by Matija Obreza's avatar Matija Obreza
Browse files

Docs: Accession options

parent bd19380e
...@@ -32,6 +32,11 @@ Add a container `<div>` to your HTML page and initialize the Genesys UI with the ...@@ -32,6 +32,11 @@ Add a container `<div>` to your HTML page and initialize the Genesys UI with the
filter: { filter: {
institute: { code: [ 'ETH013' ] }, // Genesys data filter institute: { code: [ 'ETH013' ] }, // Genesys data filter
}, },
accession: {
pdci: true, // Show PDCI
subsets: true, // Show list of subsets
datasets: true, // Show list of datasets
},
shoppingCart: { shoppingCart: {
enabled: true, // Enable shopping cart enabled: true, // Enable shopping cart
} }
...@@ -60,10 +65,22 @@ to *@geneesys-pgr/ui-embedded*: ...@@ -60,10 +65,22 @@ to *@geneesys-pgr/ui-embedded*:
|`clientSecret` | **Required** | Ditto. | |`clientSecret` | **Required** | Ditto. |
|`filter` |`undefined` | Allows for narrowing the scope of requested accession data from Genesys API. <br />To filter for accessions from your genebank, use: `{ institute: { code: ['XXX000'] } }` with the FAO WIEWS Code of your genebank. Default `undefined` value will return all accessions. | |`filter` |`undefined` | Allows for narrowing the scope of requested accession data from Genesys API. <br />To filter for accessions from your genebank, use: `{ institute: { code: ['XXX000'] } }` with the FAO WIEWS Code of your genebank. Default `undefined` value will return all accessions. |
|`language`|`'en'`| Specify the language of the user interface.<br />Fully supported: `en`<br />Partially supported: `es` | |`language`|`'en'`| Specify the language of the user interface.<br />Fully supported: `en`<br />Partially supported: `es` |
| `shoppingCart` | `{ ... }` | See *Shopping cart* configuration | | `accession` | `{ ... }` | See *Accession* configuration options |
| `shoppingCart` | `{ ... }` | See *Shopping cart* configuration options |
Additional configuration options are described below. Additional configuration options are described below.
## Accession options
Features can be toggled by setting corresponding property **on** (set to `true`) or **off** (`false`):
|Property|Default|Description|
|---|---|---|
|`subsets`|`true`| Display the list of **subsets** on accession details page |
|`datasets`|`true`| Display the list of C&E **datasets** on accession details page |
|`pdci`|`true`| Display passport data completeness index (PDCI) information on accession details page |
### Shopping cart options ### Shopping cart options
The shopping cart is **disabled by default**. To allow users to add accessions to the cart, access the cart and submit requests for material you must explicity enable it in your configuration: The shopping cart is **disabled by default**. To allow users to add accessions to the cart, access the cart and submit requests for material you must explicity enable it in your configuration:
...@@ -77,6 +94,8 @@ const genesysConfig = { ...@@ -77,6 +94,8 @@ const genesysConfig = {
}; };
``` ```
**Note:** The form to request for material includes a **reCaptcha** check. Valid public and private reCaptcha keys must be registered with Genesys.
|Property|Default|Description| |Property|Default|Description|
|---|---|---| |---|---|---|
|`enabled`|`false`| Toggle Shopping cart functionality | |`enabled`|`false`| Toggle Shopping cart functionality |
......
...@@ -70,8 +70,13 @@ ...@@ -70,8 +70,13 @@
institute: { code: ['COL003', 'BEL084'] }, // Genesys data filter institute: { code: ['COL003', 'BEL084'] }, // Genesys data filter
}, },
language: queryLang, language: queryLang,
accession: {
pdci: true, // Show PDCI
subsets: true, // Show list of subsets
datasets: true, // Show list of datasets
},
shoppingCart: { shoppingCart: {
enabled: true, enabled: true, // Enable shopping cart
} }
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment