Skip to content

Commit d571299

Browse files
authored
Update migration-islandora-workbench.md (Islandora#2167)
1 parent 18c024f commit d571299

File tree

1 file changed

+37
-34
lines changed

1 file changed

+37
-34
lines changed

docs/technical-documentation/migration-islandora-workbench.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,67 @@
11
## Islandora Workbench
22

3+
Islandora Workbench provides a command-line solution to create, update, and delete Islandora content from CSV data. The Islandora Workbench repository can be found on [Github](https://github.com/mjordan/islandora_workbench). Full details and documentation for Islandora Workbench are available [here](https://mjordan.github.io/islandora_workbench_docs/).
34

4-
### Repository
5-
6-
<https://github.com/mjordan/islandora_workbench>
75

86
### Overview
97

10-
More tailored for end users with less technical knowledge or limited server access.
8+
Islandora Workbench is tailored towards end users with less technical knowledge or limited server access.
119

12-
- Uses Islandora’s REST API
13-
- Runs on your computer
14-
- “CSVs and a pile of scans”
15-
- Cross Platform - Python
10+
Workbench provides an alternative to Drupal's Migrate framework, as it does not need to be run on the Drupal server. Islandora Workbench uses Islandora's REST API and offers cross-platform support (Windows, Mac, Linux) to run on your computer, using your provided CSVs and files.
1611

1712
### Islandora Workbench highlights
1813

19-
- Opinionated
20-
- MUCH less configuration. Decisions made for you.
21-
- No Processing
22-
- CSV has to be in the right format
23-
- Write Operations
24-
- Create, Update, and Delete content
25-
- Bumpers On
26-
- Configuration and CSV are validated
14+
Islandora Workbench:
15+
16+
- **Enables you to perform write operations:** Create, update, and delete content.
17+
- **Is opinionated:** Workbench provides MUCH less configuration than Drupal's Migrate framework. Decisions are made for you.
18+
- **Does not provide pre-processing:** Your CSVs have to be in the right format. More information on preparing your data can be found in [the Islandora Workbench documentation](https://mjordan.github.io/islandora_workbench_docs/preparing_data/).
19+
- **Provides data validation:**: The YAML configuration file and CSVs you provide are validated with the [--check option](https://mjordan.github.io/islandora_workbench_docs/check/).
2720

28-
### Islandora Workbench basics
21+
### Islandora Workbench Basics
2922

30-
- Column names are field names
31-
- If your value contains a comma, wrap it in double quotes
32-
- Multiple values are pipe delimited
33-
- Entity references are done via numeric id (nid, mid, tid)
23+
- Column names are field names.
24+
- If a cell value contains a comma, make sure the value is wrapped in double quotes. Spreadsheet applications will do this for you
25+
- Multiple values are pipe delimited.
26+
- Entity references are done via numeric id (nid, mid, tid).
3427

35-
Islandora Workbench - Taxonomy Terms:
28+
#### [Taxonomy Terms](https://mjordan.github.io/islandora_workbench_docs/fields/#taxonomy-reference-fields)
3629

37-
- Can use term id, term name, or both
30+
Using Islandora Workbench, **you can assign both existing and new taxonomy terms to nodes.** Within the CSVs you provide, the values of the taxonomy field/columns can:
31+
32+
- Use term IDs (integers), term names, or both. For example:
3833
- 26
3934
- Cats
4035
- 26|Cats
41-
- If using multiple vocabularies, prefix with vocabulary id:
36+
- Use multiple vocabularies, by prefixing the value with the vocabulary id:
4237
- cats:Calico|dogs:Dachshund
43-
- Terms that dont exist can be created
38+
- Create new terms that don't exist yet in your taxonomy.
4439

45-
Islandora Workbench - More Field Types:
40+
#### Other Field Types
4641

47-
- Typed Relations - Prefix term ids with namespace:rel:
42+
- Typed Relations - Prefix term ids with namespace:rel:. More available on typed relation fields [here](https://mjordan.github.io/islandora_workbench_docs/fields/#typed-relation-fields). For example:
4843
- relators:pht:30
4944
- Relators:pht:30|relators:pub:45
50-
- Geolocation fields - “Lat,Long”
45+
- Geolocation fields - Workbench allows geocoordinates to be provides in “Lat,Long” format. For example:
5146
- "49.16667,-123.93333"
5247

53-
Paged Content - Two Ways:
48+
#### [Paged Content](https://mjordan.github.io/islandora_workbench_docs/paged_and_compound/)
49+
50+
There are multiple ways to create paged content with Islandora Workbench. More information on each option is available [here](https://mjordan.github.io/islandora_workbench_docs/paged_and_compound/). You may:
51+
52+
- Use [a specific subdirectory structure](https://mjordan.github.io/islandora_workbench_docs/paged_and_compound/#using-subdirectories) to define the relationship between the parent item and its children.
53+
- Use [page-level metadata in the CSV](https://mjordan.github.io/islandora_workbench_docs/paged_and_compound/#with-pagechild-level-metadata) to create the relationship.
54+
- Create [a secondary task](https://mjordan.github.io/islandora_workbench_docs/paged_and_compound/#using-a-secondary-task) in Workbench.
55+
56+
### Workbench Instructional Videos
57+
58+
Click the video previews shown below to open the corresponding video in Youtube.
5459

55-
- Metadata on Parent
56-
- Simple directory structure and filename convention
57-
- Page Level Metadata
58-
- Parent and page metadata in same CSV
60+
### IslandoraCon 2022: Migration Strategies
5961

62+
This [video](https://www.youtube.com/watch?v=FzISzvc9xbE) (August 2022) is an overview of how to harvest data from an existing Islandora 7 site using Workbench, how to sanitize and prep that data with custom Python tools, and how to pull that data into a new Islandora 2 site.
6063

61-
### Videos
64+
[![IslandoraCon 2022: Migration Strategies](https://img.youtube.com/vi/FzISzvc9xbE/0.jpg)](https://www.youtube.com/watch?v=FzISzvc9xbE)
6265

6366

6467
#### Summer of Islandora Workbench: Introduction to Islandora Workbench

0 commit comments

Comments
 (0)