Data Structure of HelioDisk Job Details
This data describes all the information that can be specified in the CLOUDFLOW HelioDisk Job Details to generate a HelioDisk .pro file.
HelioDisk Job Details
The following fields are defined in the CLOUDFLOW HelioDisk Job Details:
- jobname (optional, string): a name to assign to a job.
- printmaterial (optional, string): defines the material the job will be printed on.
- comment (optional, string): a comment to associate with the job.
- cylinders (optional, array): defines the parameters that are specific
per cylinder that is part of the generated HelioDisk .pro file. See HelioDisk Cylinder
below for a description of all possible fields.Note: Each entry in this array must be linked to the correct plate (tiff file), and this can be either be done by index, or it can be done based on colorant names, and in that case the colorant_name key is required and controls the linking.
- test_cut (optional, object): defines test cut parameters. The following sub
fields are defined:
- layout (required, object): defines the test_cut layout parameters.
The following sub fields are defined:
- origin (required, object): defines the origin of the test cut layout. The
following sub fields are defined:
- x (required, number): origin in x direction (in mm).
- y (required, number): origin in y direction (in mm).
- x_base (optional, string, enumeration): specifies the
reference for the x coordinate. Possible values:
- engraving: (default)
- cylinder:
- y_base (optional, string, enumeration): specifies the reference for the
y coordinate. Possible values:
- gbs: (default)
- picture:
- size (required, object): defines the size of the test cut layout. The
following sub fields are defined:
- width (required, number): width (in mm).
- height (required, number): height (in mm).
- tile (required, object): defines the size of a single tile in the test
cut layout. The following sub fields are defined:
- width (required, number): width (in mm).
- height (required, number): height (in mm).
- line_order (optional, string, enumeration): the line order to use.
Possible values:
- axis: (default)
- circumference:
- line_length (required, number): line length (in mm).
- origin (required, object): defines the origin of the test cut layout. The
following sub fields are defined:
- layout (required, object): defines the test_cut layout parameters.
The following sub fields are defined:
HelioDisk Cylinder
This data describes the information that can be set per cylinder when generating a HelioDisk .pro file.
The following fields are defined in the CLOUDFLOW HelioDisk Cylinder data:
- gradation (optional, string): a URL to a gradation file. This can be an absolute URL to an actual gradation file, or it can be a relative URL (which means that a base URL for gradation files must be specified at the time of conversion to a .pro file), or just a file name (but still URL encoded).
- quality (optional, object): defines quality parameters. The following
sub fields are defined:
- font_width (optional, string): a URL to a font-width (anti-aliasing) file. This can be an absolute URL to an actual gradation file, or it can be a relative URL (which means that a base URL for font_width files must be specified at the time of conversion to a .pro file), or just a file name (but still URL encoded).
- engraving_amplification (optional, string): the name of a engraving-amplification file, URL encoded. You don't need to specify the extension since it will be appended by default when needed.
- sharpen (optional, object): defines sharpen parameters. The
following sub fields are defined:
- axial (optional, number): defines axial sharpening. 1 based value. 1 is no sharpening.
- circumference (optional, number): defines circumference sharpening. 1 based value. 1 is no sharpening.
- engraving (optional, object): defines engraving parameters. The
following sub fields are defined:
- method (optional, string, enumeration): the engraving method
to use. Possible values:
- normal:
- laser:
- extreme:
- formation (optional, string, enumeration): the engraving
formation to use. Possible values:
- circular:
- helix:
- enable (optional, boolean): enables/disables engraving. Engraving will be enabled if this parameter is not specified.
- method (optional, string, enumeration): the engraving method
to use. Possible values:
- mirror (optional, object): defines mirror parameters. The following
sub fields are defined:
- circumference (optional, boolean): enables/disables mirroring in circumferential direction.
- screen (optional, object): defines screening parameters. The following
sub fields are defined:
- value (optional, string): the screening value.
- angle (optional, integer): the screening angle.
- test_cut (optional, object): defines test cut parameters. The
following sub fields are defined:
- data (optional, object): defines the test cut data. The following
sub fields are defined:
- preset (optional, object): a reference to a (CLOUDFLOW) CLOUDFLOW
HelioDisk Job Details preset file. From this file, only the relevant test_cut data
section is extracted. All other parameters in this data section are ignored if a preset is
defined. The following sub fields are defined:
- url (required, string): a URL to the preset file.
- values (required, array of objects): the values. Currently this array
must always contain three entries. Each entries can contain the following sub fields:
- input (required, integer): defines the digital input data. Value between (and including) 1 and 254.
- transverse_diagonal (required, integer): defines the transverse diagonal in micrometer.
- longitudinal_diagonal (optional, integer): defines the longitudinal diagonal in micrometer. Must be specified in the first entry, and optional for other entries (unless true_volume is enabled).
- canal (required, integer): defines the canal in micrometer.
- angle (required, integer): the screening angle.
- true_volume (optional, boolean): enables/disables True Volume mode.
- wall_width_correction (optional, object): specifies wall width
correction parameters. By default wall width correction is disabled if this parameter is
not specified.
- enable (optional, boolean): enables/disables wall width correction. By default wall width correction is enabled if this key is not specified in the enclosing wall_width_correction parameter.
- minimum (required, integer): defines the minimum wall width correction in micrometer.
- maximum (required, integer): defines the maximum wall width correction in micrometer.
- preset (optional, object): a reference to a (CLOUDFLOW) CLOUDFLOW
HelioDisk Job Details preset file. From this file, only the relevant test_cut data
section is extracted. All other parameters in this data section are ignored if a preset is
defined. The following sub fields are defined:
- data (optional, object): defines the test cut data. The following
sub fields are defined:
- name (optional, string): the name of the cylinder.
- length (optional, number): the length of the cylinder (in mm).
- id (optional, string): the ID to assign to the engraved cylinder.
- web_shrink_compensation (optional, number): a compensation factor for paper shrink while printing (in mm).
- gbs_offset (optional, number): specifies the GBS offset (in mm).
- comment (optional, string): a comment to associate with this cylinder.
- colorant_name (optional, string): the colorant name of this cylinder. This information is not really needed for the HelioDisk .pro file, but can be used to match cylinder info coming from two sources. For example, if have a set of files representing the plates and you also have some XML/JSON data coming from an MIS, you might need to match the plate names with the cylinder array. You can do this with the colorant_name entry.