forked from common-workflow-language/cwltool
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Process.yml
749 lines (665 loc) · 24.8 KB
/
Process.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
$base: "https://w3id.org/cwl/cwl#"
$namespaces:
cwl: "https://w3id.org/cwl/cwl#"
sld: "https://w3id.org/cwl/salad#"
rdfs: "http://www.w3.org/2000/01/rdf-schema#"
$graph:
- name: "Common Workflow Language, v1.1.0-dev1"
type: documentation
doc: {$include: concepts.md}
- $import: "salad/schema_salad/metaschema/metaschema_base.yml"
- name: BaseTypesDoc
type: documentation
doc: |
## Base types
docChild:
- "#CWLType"
- "#Process"
- type: enum
name: CWLVersion
doc: "Version symbols for published CWL document versions."
symbols:
- cwl:draft-2
- cwl:draft-3.dev1
- cwl:draft-3.dev2
- cwl:draft-3.dev3
- cwl:draft-3.dev4
- cwl:draft-3.dev5
- cwl:draft-3
- cwl:draft-4.dev1
- cwl:draft-4.dev2
- cwl:draft-4.dev3
- cwl:v1.0.dev4
- cwl:v1.0
- cwl:v1.1.0-dev1 # a dash is required by the semver 2.0 rules
- name: CWLType
type: enum
extends: "sld:PrimitiveType"
symbols:
- cwl:File
- cwl:Directory
doc:
- "Extends primitive types with the concept of a file and directory as a builtin type."
- "File: A File object"
- "Directory: A Directory object"
- name: File
type: record
docParent: "#CWLType"
doc: |
Represents a file (or group of files if `secondaryFiles` is specified) that
must be accessible by tools using standard POSIX file system call API such as
open(2) and read(2).
fields:
- name: class
type:
type: enum
name: File_class
symbols:
- cwl:File
jsonldPredicate:
_id: "@type"
_type: "@vocab"
doc: Must be `File` to indicate this object describes a file.
- name: location
type: string?
doc: |
An IRI that identifies the file resource. This may be a relative
reference, in which case it must be resolved using the base IRI of the
document. The location may refer to a local or remote resource; the
implementation must use the IRI to retrieve file content. If an
implementation is unable to retrieve the file content stored at a
remote resource (due to unsupported protocol, access denied, or other
issue) it must signal an error.
If the `location` field is not provided, the `contents` field must be
provided. The implementation must assign a unique identifier for
the `location` field.
If the `path` field is provided but the `location` field is not, an
implementation may assign the value of the `path` field to `location`,
then follow the rules above.
jsonldPredicate:
_id: "@id"
_type: "@id"
- name: path
type: string?
doc: |
The local host path where the File is available when a CommandLineTool is
executed. This field must be set by the implementation. The final
path component must match the value of `basename`. This field
must not be used in any other context. The command line tool being
executed must be able to to access the file at `path` using the POSIX
`open(2)` syscall.
As a special case, if the `path` field is provided but the `location`
field is not, an implementation may assign the value of the `path`
field to `location`, and remove the `path` field.
If the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)
(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\`, `"`, `'`,
`<space>`, `<tab>`, and `<newline>`) or characters
[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)
for [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)
then implementations may terminate the process with a
`permanentFailure`.
jsonldPredicate:
"_id": "cwl:path"
"_type": "@id"
- name: basename
type: string?
doc: |
The base name of the file, that is, the name of the file without any
leading directory path. The base name must not contain a slash `/`.
If not provided, the implementation must set this field based on the
`location` field by taking the final path component after parsing
`location` as an IRI. If `basename` is provided, it is not required to
match the value from `location`.
When this file is made available to a CommandLineTool, it must be named
with `basename`, i.e. the final component of the `path` field must match
`basename`.
jsonldPredicate: "cwl:basename"
- name: dirname
type: string?
doc: |
The name of the directory containing file, that is, the path leading up
to the final slash in the path such that `dirname + '/' + basename ==
path`.
The implementation must set this field based on the value of `path`
prior to evaluating parameter references or expressions in a
CommandLineTool document. This field must not be used in any other
context.
- name: nameroot
type: string?
doc: |
The basename root such that `nameroot + nameext == basename`, and
`nameext` is empty or begins with a period and contains at most one
period. For the purposess of path splitting leading periods on the
basename are ignored; a basename of `.cshrc` will have a nameroot of
`.cshrc`.
The implementation must set this field automatically based on the value
of `basename` prior to evaluating parameter references or expressions.
- name: nameext
type: string?
doc: |
The basename extension such that `nameroot + nameext == basename`, and
`nameext` is empty or begins with a period and contains at most one
period. Leading periods on the basename are ignored; a basename of
`.cshrc` will have an empty `nameext`.
The implementation must set this field automatically based on the value
of `basename` prior to evaluating parameter references or expressions.
- name: checksum
type: string?
doc: |
Optional hash code for validating file integrity. Currently must be in the form
"sha1$ + hexadecimal string" using the SHA-1 algorithm.
- name: size
type: long?
doc: Optional file size
- name: "secondaryFiles"
type:
- "null"
- type: array
items: [File, Directory]
jsonldPredicate: "cwl:secondaryFiles"
doc: |
A list of additional files that are associated with the primary file
and must be transferred alongside the primary file. Examples include
indexes of the primary file, or external references which must be
included when loading primary document. A file object listed in
`secondaryFiles` may itself include `secondaryFiles` for which the same
rules apply.
- name: format
type: string?
jsonldPredicate:
_id: cwl:format
_type: "@id"
identity: true
doc: |
The format of the file: this must be an IRI of a concept node that
represents the file format, preferrably defined within an ontology.
If no ontology is available, file formats may be tested by exact match.
Reasoning about format compatability must be done by checking that an
input file format is the same, `owl:equivalentClass` or
`rdfs:subClassOf` the format required by the input parameter.
`owl:equivalentClass` is transitive with `rdfs:subClassOf`, e.g. if
`<B> owl:equivalentClass <C>` and `<B> owl:subclassOf <A>` then infer
`<C> owl:subclassOf <A>`.
File format ontologies may be provided in the "$schema" metadata at the
root of the document. If no ontologies are specified in `$schema`, the
runtime may perform exact file format matches.
- name: contents
type: string?
doc: |
File contents literal. Maximum of 64 KiB.
If neither `location` nor `path` is provided, `contents` must be
non-null. The implementation must assign a unique identifier for the
`location` field. When the file is staged as input to CommandLineTool,
the value of `contents` must be written to a file.
If `loadContents` of `inputBinding` or `outputBinding` is true and
`location` is valid, the implementation must read up to the first 64
KiB of text from the file and place it in the "contents" field.
- name: Directory
type: record
docAfter: "#File"
doc: |
Represents a directory to present to a command line tool.
fields:
- name: class
type:
type: enum
name: Directory_class
symbols:
- cwl:Directory
jsonldPredicate:
_id: "@type"
_type: "@vocab"
doc: Must be `Directory` to indicate this object describes a Directory.
- name: location
type: string?
doc: |
An IRI that identifies the directory resource. This may be a relative
reference, in which case it must be resolved using the base IRI of the
document. The location may refer to a local or remote resource. If
the `listing` field is not set, the implementation must use the
location IRI to retrieve directory listing. If an implementation is
unable to retrieve the directory listing stored at a remote resource (due to
unsupported protocol, access denied, or other issue) it must signal an
error.
If the `location` field is not provided, the `listing` field must be
provided. The implementation must assign a unique identifier for
the `location` field.
If the `path` field is provided but the `location` field is not, an
implementation may assign the value of the `path` field to `location`,
then follow the rules above.
jsonldPredicate:
_id: "@id"
_type: "@id"
- name: path
type: string?
doc: |
The local path where the Directory is made available prior to executing a
CommandLineTool. This must be set by the implementation. This field
must not be used in any other context. The command line tool being
executed must be able to to access the directory at `path` using the POSIX
`opendir(2)` syscall.
If the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)
(`|`,`&`, `;`, `<`, `>`, `(`,`)`, `$`,`` ` ``, `\`, `"`, `'`,
`<space>`, `<tab>`, and `<newline>`) or characters
[not allowed](http://www.iana.org/assignments/idna-tables-6.3.0/idna-tables-6.3.0.xhtml)
for [Internationalized Domain Names for Applications](https://tools.ietf.org/html/rfc6452)
then implementations may terminate the process with a
`permanentFailure`.
jsonldPredicate:
_id: "cwl:path"
_type: "@id"
- name: basename
type: string?
doc: |
The base name of the directory, that is, the name of the file without any
leading directory path. The base name must not contain a slash `/`.
If not provided, the implementation must set this field based on the
`location` field by taking the final path component after parsing
`location` as an IRI. If `basename` is provided, it is not required to
match the value from `location`.
When this file is made available to a CommandLineTool, it must be named
with `basename`, i.e. the final component of the `path` field must match
`basename`.
jsonldPredicate: "cwl:basename"
- name: listing
type:
- "null"
- type: array
items: [File, Directory]
doc: |
List of files or subdirectories contained in this directory. The name
of each file or subdirectory is determined by the `basename` field of
each `File` or `Directory` object. It is an error if a `File` shares a
`basename` with any other entry in `listing`. If two or more
`Directory` object share the same `basename`, this must be treated as
equivalent to a single subdirectory with the listings recursively
merged.
jsonldPredicate:
_id: "cwl:listing"
- name: SchemaBase
type: record
abstract: true
fields:
- name: label
type:
- "null"
- string
jsonldPredicate: "rdfs:label"
doc: "A short, human-readable label of this object."
- name: Parameter
type: record
extends: SchemaBase
abstract: true
doc: |
Define an input or output parameter to a process.
fields:
- name: secondaryFiles
type:
- "null"
- string
- Expression
- type: array
items: [string, Expression]
jsonldPredicate: "cwl:secondaryFiles"
doc: |
Only valid when `type: File` or is an array of `items: File`.
Describes files that must be included alongside the primary file(s).
If the value is an expression, the value of `self` in the expression
must be the primary input or output File to which this binding applies.
If the value is a string, it specifies that the following pattern
should be applied to the primary file:
1. If string begins with one or more caret `^` characters, for each
caret, remove the last file extension from the path (the last
period `.` and all following characters). If there are no file
extensions, the path is unchanged.
2. Append the remainder of the string to the end of the file path.
- name: format
type:
- "null"
- string
- type: array
items: string
- Expression
jsonldPredicate:
_id: cwl:format
_type: "@id"
identity: true
doc: |
Only valid when `type: File` or is an array of `items: File`.
For input parameters, this must be one or more IRIs of concept nodes
that represents file formats which are allowed as input to this
parameter, preferrably defined within an ontology. If no ontology is
available, file formats may be tested by exact match.
For output parameters, this is the file format that will be assigned to
the output parameter.
- name: streamable
type: boolean?
doc: |
Only valid when `type: File` or is an array of `items: File`.
A value of `true` indicates that the file is read or written
sequentially without seeking. An implementation may use this flag to
indicate whether it is valid to stream file contents using a named
pipe. Default: `false`.
- name: doc
type:
- string?
- string[]?
doc: "A documentation string for this type, or an array of strings which should be concatenated."
jsonldPredicate: "rdfs:comment"
- type: enum
name: Expression
doc: |
'Expression' is not a real type. It indicates that a field must allow
runtime parameter references. If [InlineJavascriptRequirement](#InlineJavascriptRequirement)
is declared and supported by the platform, the field must also allow
Javascript expressions.
symbols:
- cwl:ExpressionPlaceholder
- name: InputBinding
type: record
abstract: true
fields:
- name: loadContents
type:
- "null"
- boolean
jsonldPredicate: "cwl:loadContents"
doc: |
Only valid when `type: File` or is an array of `items: File`.
Read up to the first 64 KiB of text from the file and place it in the
"contents" field of the file object for use by expressions.
- name: OutputBinding
type: record
abstract: true
- name: InputSchema
extends: SchemaBase
type: record
abstract: true
- name: OutputSchema
extends: SchemaBase
type: record
abstract: true
- name: InputRecordField
type: record
extends: "sld:RecordField"
specialize:
- specializeFrom: "sld:RecordSchema"
specializeTo: InputRecordSchema
- specializeFrom: "sld:EnumSchema"
specializeTo: InputEnumSchema
- specializeFrom: "sld:ArraySchema"
specializeTo: InputArraySchema
- specializeFrom: "sld:PrimitiveType"
specializeTo: CWLType
fields:
- name: inputBinding
type: InputBinding?
jsonldPredicate: "cwl:inputBinding"
- name: label
type: string?
jsonldPredicate: "rdfs:label"
doc: "A short, human-readable label of this process object."
- name: InputRecordSchema
type: record
extends: ["sld:RecordSchema", InputSchema]
specialize:
- specializeFrom: "sld:RecordField"
specializeTo: InputRecordField
- name: InputEnumSchema
type: record
extends: ["sld:EnumSchema", InputSchema]
fields:
- name: inputBinding
type: InputBinding?
jsonldPredicate: "cwl:inputBinding"
- name: InputArraySchema
type: record
extends: ["sld:ArraySchema", InputSchema]
specialize:
- specializeFrom: "sld:RecordSchema"
specializeTo: InputRecordSchema
- specializeFrom: "sld:EnumSchema"
specializeTo: InputEnumSchema
- specializeFrom: "sld:ArraySchema"
specializeTo: InputArraySchema
- specializeFrom: "sld:PrimitiveType"
specializeTo: CWLType
fields:
- name: inputBinding
type: InputBinding?
jsonldPredicate: "cwl:inputBinding"
- name: OutputRecordField
type: record
extends: "sld:RecordField"
specialize:
- specializeFrom: "sld:RecordSchema"
specializeTo: OutputRecordSchema
- specializeFrom: "sld:EnumSchema"
specializeTo: OutputEnumSchema
- specializeFrom: "sld:ArraySchema"
specializeTo: OutputArraySchema
- specializeFrom: "sld:PrimitiveType"
specializeTo: CWLType
fields:
- name: outputBinding
type: OutputBinding?
jsonldPredicate: "cwl:outputBinding"
- name: OutputRecordSchema
type: record
extends: ["sld:RecordSchema", "#OutputSchema"]
docParent: "#OutputParameter"
specialize:
- specializeFrom: "sld:RecordField"
specializeTo: OutputRecordField
- name: OutputEnumSchema
type: record
extends: ["sld:EnumSchema", OutputSchema]
docParent: "#OutputParameter"
fields:
- name: outputBinding
type: OutputBinding?
jsonldPredicate: "cwl:outputBinding"
- name: OutputArraySchema
type: record
extends: ["sld:ArraySchema", OutputSchema]
docParent: "#OutputParameter"
specialize:
- specializeFrom: "sld:RecordSchema"
specializeTo: OutputRecordSchema
- specializeFrom: "sld:EnumSchema"
specializeTo: OutputEnumSchema
- specializeFrom: "sld:ArraySchema"
specializeTo: OutputArraySchema
- specializeFrom: "sld:PrimitiveType"
specializeTo: CWLType
fields:
- name: outputBinding
type: OutputBinding?
jsonldPredicate: "cwl:outputBinding"
- name: InputParameter
type: record
extends: Parameter
fields:
- name: id
type: string
jsonldPredicate: "@id"
doc: "The unique identifier for this parameter object."
- name: inputBinding
type: InputBinding?
jsonldPredicate: "cwl:inputBinding"
doc: |
Describes how to handle the inputs of a process and convert them
into a concrete form for execution, such as command line parameters.
- name: default
type: Any?
jsonldPredicate: "cwl:default"
doc: |
The default value for this parameter if not provided in the input
object.
- name: RegularInputParameter
type: record
extends: InputParameter
fields:
- name: type
type:
- "null"
- CWLType
- InputRecordSchema
- InputEnumSchema
- InputArraySchema
- string
- type: array
items:
- CWLType
- InputRecordSchema
- InputEnumSchema
- InputArraySchema
- string
jsonldPredicate:
"_id": "sld:type"
"_type": "@vocab"
refScope: 2
typeDSL: True
doc: |
Specify valid types of data that may be assigned to this parameter.
- name: OutputParameter
type: record
extends: Parameter
fields:
- name: id
type: string
jsonldPredicate: "@id"
doc: "The unique identifier for this parameter object."
- name: outputBinding
type: OutputBinding?
jsonldPredicate: "cwl:outputBinding"
doc: |
Describes how to handle the outputs of a process.
- type: record
name: ProcessRequirement
abstract: true
doc: |
A process requirement declares a prerequisite that may or must be fulfilled
before executing a process. See [`Process.hints`](#process) and
[`Process.requirements`](#process).
Process requirements are the primary mechanism for specifying extensions to
the CWL core specification.
- type: record
name: Process
abstract: true
doc: |
The base executable type in CWL is the `Process` object defined by the
document. Note that the `Process` object is abstract and cannot be
directly executed.
fields:
- name: id
type: string?
jsonldPredicate: "@id"
doc: "The unique identifier for this process object."
- name: inputs
type:
type: array
items: InputParameter
jsonldPredicate:
_id: "cwl:inputs"
mapSubject: id
mapPredicate: type
doc: |
Defines the input parameters of the process. The process is ready to
run when all required input parameters are associated with concrete
values. Input parameters include a schema for each parameter which is
used to validate the input object. It may also be used to build a user
interface for constructing the input object.
- name: outputs
type:
type: array
items: OutputParameter
jsonldPredicate:
_id: "cwl:outputs"
mapSubject: id
mapPredicate: type
doc: |
Defines the parameters representing the output of the process. May be
used to generate and/or validate the output object.
- name: requirements
type: ProcessRequirement[]?
jsonldPredicate:
_id: "cwl:requirements"
mapSubject: class
doc: |
Declares requirements that apply to either the runtime environment or the
workflow engine that must be met in order to execute this process. If
an implementation cannot satisfy all requirements, or a requirement is
listed which is not recognized by the implementation, it is a fatal
error and the implementation must not attempt to run the process,
unless overridden at user option.
- name: hints
type: Any[]?
doc: |
Declares hints applying to either the runtime environment or the
workflow engine that may be helpful in executing this process. It is
not an error if an implementation cannot satisfy all hints, however
the implementation may report a warning.
jsonldPredicate:
_id: cwl:hints
noLinkCheck: true
mapSubject: class
- name: label
type: string?
jsonldPredicate: "rdfs:label"
doc: "A short, human-readable label of this process object."
- name: doc
type: string?
jsonldPredicate: "rdfs:comment"
doc: "A long, human-readable description of this process object."
- name: cwlVersion
type: CWLVersion?
doc: |
CWL document version. Always required at the document root. Not
required for a Process embedded inside another Process.
jsonldPredicate:
"_id": "cwl:cwlVersion"
"_type": "@vocab"
- name: InlineJavascriptRequirement
type: record
extends: ProcessRequirement
doc: |
Indicates that the workflow platform must support inline Javascript expressions.
If this requirement is not present, the workflow platform must not perform expression
interpolatation.
fields:
- name: class
type: string
doc: "Always 'InlineJavascriptRequirement'"
jsonldPredicate:
"_id": "@type"
"_type": "@vocab"
- name: expressionLib
type: string[]?
doc: |
Additional code fragments that will also be inserted
before executing the expression code. Allows for function definitions that may
be called from CWL expressions.
- name: SchemaDefRequirement
type: record
extends: ProcessRequirement
doc: |
This field consists of an array of type definitions which must be used when
interpreting the `inputs` and `outputs` fields. When a `type` field
contain a IRI, the implementation must check if the type is defined in
`schemaDefs` and use that definition. If the type is not found in
`schemaDefs`, it is an error. The entries in `schemaDefs` must be
processed in the order listed such that later schema definitions may refer
to earlier schema definitions.
fields:
- name: class
type: string
doc: "Always 'SchemaDefRequirement'"
jsonldPredicate:
"_id": "@type"
"_type": "@vocab"
- name: types
type:
type: array
items: InputSchema
doc: The list of type definitions.