Skip to content

Commit b3c9474

Browse files
Address comments in PR #206
1 parent acbe1f4 commit b3c9474

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/how_to_run.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
# Understanding and Running the DSC Workflow
1+
# Understanding and Running DSC
22

3-
This documentation describes the DSC workflow and how to run the application.
3+
This documentation describes the DSC application and how to run it.
44

55
**DISCLAIMER**: While the CLI application is runnable on its own, the DSO Step Function offers a simplified user interface for running the full ETL pipeline. For more details on the DSO Step Function and how to use it, see https://mitlibraries.atlassian.net/wiki/spaces/IN/pages/4690542593/DSpace+Submission+Orchestrator+DSO.
66

7-
## The DSC Workflow
8-
9-
The DSC workflow consists of the following key steps:
7+
Running DSC consists of the following key steps:
108

119
1. Create a batch
1210
2. Queue a batch for ingest
13-
3. Items are ingested into DSpace by DSS*
11+
3. _Items are ingested into DSpace by DSS*_
1412
4. Analyze ingest results
1513

1614
***Important:** DSC is not responsible for ingesting items into DSpace nor does it execute this process. This task is handled by [DSS](https://github.com/MITLibraries/dspace-submission-service), which is invoked via the [DSO Step Function](https://github.com/MITLibraries/dspace-submission-service).
1715

18-
The DSC CLI provides commands for all other steps in the DSC workflow.
19-
2016
### Create a batch
21-
DSC processes deposits in "batches", a collection of item submissions grouped by a unique identifier. DSC requires that the item submission assets (metadata and bitstream files) are uploaded to a "folder" in S3, named after the batch ID. While some requestors may upload the submission assets to S3 themselves, in other cases, these files need to be retrieved (via API requests) and uploaded during the batch creation step.
17+
DSC processes deposits in "batches", a collection of item submissions grouped by a unique identifier. Generally, assets for batches are provided in one of two ways:
18+
19+
1. Requestors upload raw metadata and bitstreams (see [How To: Batch deposits with DSO for Content Owners](https://mitlibraries.atlassian.net/wiki/spaces/INF/pages/4411326470/How-To+Batch+deposits+with+DSpace+Submission+Orchestrator+DSO+for+Content+Owners))
20+
2. DSC workflows retrieve raw metadata and/or bitstreams programmatically (via API requests)
21+
22+
Once all assets are stored in a "folder" in S3, DSC verifies that metadata and bitstreams have been provided for each item submission. It is only after _all_ item submissions have been verified that DSC will establish the batch by recording each item in DynamoDB.
2223

2324
At the end of this step:
2425
* If all item submission assets are complete:

0 commit comments

Comments
 (0)