Skip to content

fix variable name datasetList #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2025
Merged

fix variable name datasetList #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Development/v4.x/backend/configuration/jobconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ Jobs follow a standard Create-Read-Update-Delete (CRUD) lifecycle:
### Referencing datasets

Many (but not all) jobs relate to datasets. These are specified during job creation in
the `jobParams.datasetsList` array. The array should contain objects with a `pid` string
the `jobParams.datasetList` array. The array should contain objects with a `pid` string
and a `files` array listing individual files that the job should be applied to. An empty
`files` array indicates that the job should apply to all files.

```json
{
"type": ...,
"jobParams": {
"datasetsList": [
"datasetList": [
{
"pid": "12.3456...",
"files": []
Expand Down Expand Up @@ -145,7 +145,7 @@ are given as examples for archive and retrieve jobs:
| finishedUnsuccessful | A system error occurred |

Additional status changes may be associated with datasets referenced in
`jobParams.datasetsList`, for example in the `datasetlifecycle.archiveStatusMessage`
`jobParams.datasetList`, for example in the `datasetlifecycle.archiveStatusMessage`
field.

It is recommended that values of `statusCode` be configured for each job type using a
Expand Down Expand Up @@ -249,7 +249,7 @@ top-level variables are availabe in the handlebars context:
| ------------------ | ------------------------------------ | ---------------------------------------------- | ----------------------------------------------------------------------- |
| `request` | `CreateJobDto` or<br/>`UpdateJobDto` | `{{{request.type}}}`<br/>`{{{request.jobParams}}}` | HTTP Request body |
| `job` | `JobClass` | `{{{job.id}}}` | The job. During the validate phase this is the previous job values (if any); during the perform phase it will be the current database value. |
| `datasets` | `DatasetClass[]` | `{{#each datasets}}{{{pid}}}{{/each}}` | Array of all datasets referenced in `job.jobParams.datasetsList`. |
| `datasets` | `DatasetClass[]` | `{{#each datasets}}{{{pid}}}{{/each}}` | Array of all datasets referenced in `job.jobParams.datasetList`. |
| `env` | `object` | `{{{env.SECRET_TOKEN}}}` | Access environmental variables |
{% endraw %}

Expand Down