Skip to content

Commit

Permalink
Update Configuration Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arendd committed Feb 22, 2024
1 parent aff2113 commit c135918
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ There are three config files:

### Prefilling of ISA entities during wizard initialization

`config.prefill` is an array of objects. Each object consists of the keys `isasMapping` and `values`
`config.prefill` is an array of objects. Each object consists of the keys `isaMapping` and `values`

Example to prefill the initially empty ISA object with a person under investigation level:

Expand All @@ -37,9 +37,47 @@ window.config = {
affiliation : 'IPK Gatersleben'
}
}
],
]
}
```

Example to prefill a comment in the ISA object under investigation (alternatively study/assay) level:

```javascript
window.config = {
prefill: [
{
type: 'comment',
isaMapping: {
entity: 'investigation',
attribute: 'comments'
},
values: {
name: 'Study Country',
value: 'Germany'
}
}
]
}
```

Example to prefill any ISA attribute, here the 'Study Description' in the ISA object under study (alternatively investigation/assay) level:

```javascript
window.config = {
prefill: [
{
type: 'value',
isaMapping: {
entity: 'study',
attribute: 'description',
studyIndex: 0
},
value: 'Prefilled study description ...'
}
]
}
```

## wizard.steps.config.js

Expand Down

0 comments on commit c135918

Please sign in to comment.