1 $group
2 $
3 var sect = {
4 title: 'The "wzjob" schema'
5 };
6 section( §)
7 p The `wzjob` Wizzi schema, implemented by the `wizzi-core` plugin,
8 \b is the configuration schema of a Wizzi job.
9 ittf-panel
10 title Sample `wzjob` ITTF document.
11 ittf
12 wzjob wizzi-docs-concepts
13 $
14 var models_folder = path.join(__dirname, 'models');
15 var html_folder = path.join(__dirname, 'html');
16 var dest_folder = "c:/my/wizzi/v5/github/wizzifactory.github.io";
17 models-base-folder ${'$'}{models_folder}
18 model concepts
19 src wizzi-jobs.docs.ittf
20 schema docs
21 line html
22 cwd-folder ${'$'}{html_folder}
23 $raw wzjob/art-wo-html( docs.html.ittf )
24 model-ref concepts
25 transformer docs/preprint
26 production
27 dest-folder ${'$'}{dest_folder}
28 line-ref html
29 ul The `wzjob` Wizzi Schema elements are
30 li Wfjob
31 li Model
32 li ModelRef
33 li Line
34 li LineRef
35 li Artifact
36 li Production
37 h3 The WfJob element
38 ittf-panel
39 ittf
40 wzjob {wzName}
41 string title `short-description`
42 # For info and error messages
43 string models-base-folder `path`
44 # The base path to use when the 'src' attribute of models is a relative path
45 string dest-base-folder `path`
46 # The base path of the destination folder of artifacts generated by this job
47 # Can be overridden by the 'dest-folder' attribute of Line elements
48 [ models
49 [ lines
50 [ productions
51 h3 Model element
52 p A model can be:
53 ul
54 li An ITTF document of a Wizzi Schema exposed by a plugin
55 \b loaded in the wizzi.WizziFactory instance that is executing the job.
56 li A POJO module coded in one of these known formats: 'json', 'nodejs'
57 \b module exporting the function 'toModel'.
58 ittf-panel
59 ittf
60 ...
61 model `model-name`
62 string src `path`
63 # The source path of the ITTF Document or POJO module.
64 # When relative the base path is the 'models-base-folder' attribute of the
65 # WfJob element.
66 string schema {schema-name}
67 # The name of the Wizzi Model type (wfschema) that will load the
68 # mTree defined in the source ITTF Document.
69 # Is alternative to the 'format' attribute.
70 string format `format-name`
71 One-of 'json', 'nodejs'
72 # Is alternative to 'schema' attribute.
73 string dump-file `path`
74 [ modelRefs
75 # References to the models to be used, as properties of the mTreeBuildUpContext
76 # parameter, passed to the wizzi-mtree.loader.loadMTree function,
77 # for loading the model mTree.
78 h3 ModelRef element
79 ittf-panel
80 ittf
81 ...
82 model-ref `model-name`
83 string export-name `name`
84 [ transformers
85 h3 Line element
86 p Production lines declare artifacts that are processed asynchronously and
87 \b concurrently.
88 ittf-panel
89 ittf
90 ...
91 line `line-name`
92 string cwd-folder `path`
93 string dest-folder `path`
94 [ artifacts
95 h3 Artifact element
96 p An Artifact element declares one artifact production that is driven by a
97 \b source model. Each production has one driver model, but an Artifact element
98 \b can result in many production because the 'src' attribute of this element
99 \b may refer to:
100 ul
101 li one single source model
102 li a group of source models described by a glob pattern
103 li one single source model which Model element declares a model collection
104 \b property, meaning that each item of the collection is a source model
105 \b of the production and produces one artifact.
106 ittf-panel
107 ittf
108 ...
109 artifact `artifact-name`
110 # For info and errors messages.
111 string src `path` | `glob-pattern`
112 # Can be:
113 # . the path of a final artifact that must be simply copied in the destination path.
114 # . the glob-pattern of final artifacts that must be simply copied in the destination path.
115 # . the path of a source ITTF Document
116 # . the glob-pattern of sources ITTF Documents
117 schema {schema-name}
118 # When the 'src' attribute is the path of an ITTF Document, is the wizzi
119 # model type (wfschema) that will load and validate the document.
120 # Is alternative to the 'format' attribute.
121 # Can be null if the artifact is a final artifact.
122 ignore `path` | `glob-pattern`
123 # Files returned by the 'src' attribute glob-pattern that are to be ignored.
124 # Can be a glob pattern.
125 generation `artifact-generator-name`
126 # The name of the artifact generator that will produce the artifact.
127 # When the artifact is a final artifact must be omitted.
128 dest-path `artifact-file-path`
129 # The 'src' attribute is the default
130 # relative destination path of the generated artifact,
131 # but, when set, this attribute overrides the default.
132 # It may be an absolute path.
133 extension `artifact-file-extension`
134 # The path extension of the generated artifact.
135 # Optional. The default is the 'src' atribute path extension without
136 # the ending '.ittf' string.
137 # Child elements
138 [ modelRefs
139 h3 Production element
140 p Production elements contain a list of references to previously declared
141 \b production lines that must be sequentially executed.
142 ittf-panel
143 ittf
144 ...
145 production 'production-name'
146 string dest-folder `path`
147 [ lineRefs
148 h3 LineRef element
149 ittf-panel
150 ittf
151 ...
152 line-ref `line-name`