Smart Print Controller v4.0.2311.0. Copyright (c) 2022 Global Graphics Software. All rights reserved.

Overview

Smart Print Controller provides a user with two conceptual methods of operations:

  1. Engineer - Installation and setup.
  2. Operator - Manage job submission and review progress.

This 'operator' level of operation can be driven from external clients using an industry-standard interface.

When the Open Platform Communications (OPC) server in Smart Print Controller is enabled an OPC node tree is published. The top-level nodes in this tree represent grouped areas of state and functionality. For example, the Servers section allows:

  • the Harlequin Direct server list to be enumerated.
  • the server connection status to be examined.
  • all servers to be restarted.
  • ...and more.

NOTE If Smart Print Controller is launched with a /ServerMode command-line argument the application will be launched minimized, with OPC automatically enabled and External Control granted.

Certificates

Communication between OPC UA clients and servers require both parties to possess their own application certificate. To enable further communication each party must trust the opposing certificate. This trust can be established automatically, programmatically or manually depending on the application's configuration or implementation. The certificate for SPC can be found in %programdata%\Global Graphics Software Ltd\Smart Print Controller\App Certificates\certs should you need to copy it to the Trusted Peer Certificate folder. In this release it will be a Self Signed Certificate issued by and for Smart Print Controller.

OPC Nodes

The OPC node mechanism will report when any state changes, allowing clients to react accordingly.

While most exposed values can be read by a client, write-access (or calling a method to request a state change in Smart Print Controller) will require External Control to be granted (See App.IsExternalControlActive). This is an action explicitly performed by the Smart Print Controller operator, resulting in control of the application to be given to the OPC client.

OPC Methods

Many published OPC method nodes will return a String value indicating their success or error state:

Return ValueDescription
CommandCannotExecuteA command could not run because its execution criteria was not met.
FailedToLoadAppConfigFailed to load an application PCC configuration.
FailedToPreprocessThe PDF could not be preprocessed.
FailedToPrintThe job was submitted, but failed to print.
FailedToRestoreConfigsFailed to restore the HD configs to the original values.
FailedToSetConfigsFailed to update the HD configs to the values required for printing.
FailedToStartPrintRunThe print run failed to start.
FailedToSubmitFailed to submit the job to the server(s).
FeatureIsDisabledDirect printing is currently disabled.
IncompatibleSmdThe media's printer profile differs from the 'active' profile.
ItemNotFoundThe specified item was not found.
NoServersAt least one server is required for printing.
PendingConnectionThe HD connection(s) must be connected or disconnected - Not pending.
PreprocessingFailedThe PDF was preprocessed, but was invalid (E.g. It contains non-embedded fonts).
PrintBarNotFoundThe print bar does not appear in the printer profile.
PrintRunIsActiveDirect printing cannot interrupt an active print run.
RequestDeniedThe conditions needed to perform the action were not satisfied.
SuccessThe request completed successfully.

Any methods listed in this documentation will include details about their required parameters (if any), and return value.

In the event of an error please see the Smart Print Controller log file for more information.

OPC Client Library

There are several OPC libraries available, but the one used internally by Smart Print Controller is from Traeger Industry Components GmbH.

NOTE The default maximum message sizes used by OPC clients to communicate to the server are sufficient for most use cases. However, to ensure transfer of larger data packets (such as retrieving some job thumbnail images) it may be necessary to configure the OPC client with custom values. For example:

	Client = new OpcClient();
	Client.Transport.MaxArrayLength = 1024 * 1024 * 50;
	Client.Transport.MaxBufferSize = 1024 * 1024 * 50;
	Client.Transport.MaxMessageSize = 1024 * 1024 * 50;
	Client.Transport.MaxStringLength = 1024 * 1024 * 50;

See here for more information.

SPCSet

SPCSet is the top-level set containing all available OPC nodes. Immediately underneath this root-level node are a categorized collection of sub-nodes, each encapsulating a different area of behavior.

Section NameDescription
ActiveJobState relating to the currently active job.
ActiveMediaState relating to the currently active media.
AllJobsState relating to all jobs in the Waiting/Print/Completed queues. Note that this tree will dynamically include children named from the GUID of each known job.
AllMediaState relating to all available media.
AllMedia.SelectedMediaState relating to the selected media (See AllMedia.SelectedName).
AppState relating to the entire application.
PrintBarGroupsState relating to the active print bars.
PrinterProfileState relating to the active printer profile.
PrintRunState relating to the print run.
PrintRunConfigState relating to the print configuration (Applies to both media sides).
PrintRunConfig.ConfigSideAThe print configuration specific to media side 'A'.
PrintRunConfig.ConfigSideBThe print configuration specific to media side 'B'.
ServersState relating to the collection of Harlequin Direct servers.
SingleJobDescribes the collection of nodes representing a single job, positioned as a child of the WaitingQueue, PrintQueue, or CompletedQueue nodes.
StreamlineDirectState relating to Streamline Direct technology.

ActiveJob

State relating to the currently active job.

Properties

NameTypeWritableDescription
CopyCountInt32NoNumber of copies to print.
CurrentPageUInt32NoPage number of the current processed page.
GuidStringNoUnique job descriptor.
HasNonEmbeddedFontsBooleanNoThe result after running job font analysis.
IsStreamlineOptimizedBooleanNoWhether Streamline Optimize has processed the job.
JobTagStringNoProperty which can be used to attach arbitrary state to a job.

The source of the state comes from an optional JobTag string field in the .complete JSON file written into the Waiting queue hot folder.
The state lasts for the lifetime of the job, and will persist if a job is copied from the Completed queue to the Waiting queue.
NameStringNoThe job name (from the original job file name).
PageCountInt64NoPage count of the document.
PageHeightMmDoubleNoPage height (mm).
PageWidthMmDoubleNoPage width (mm).
PredictedLineSpeedDoubleNoThe Streamline Direct predicted line speed (m/min).
PredictedLineSpeedIndicatorStringNoThe Streamline Direct predicted line speed (Status indicator).

Values:
Unavailable - Analysis unavailable.
Red - Unable to achieve target speed.
Amber - Should achieve target speed.
Green - Will achieve target speed.
StartTimeStringNoWhen the job started printing (ISO 8601).
ThumbnailStringNoBASE64-encoded representation of the job thumbnail PNG data.
TotalPageCountInt64NoPage count of the printed document (PageCount * CopyCount).

ActiveMedia

State relating to the currently active media.

Details

The active media is the one actually being used to print.
The selected media (See AllMedia.SelectedName) is the one highlighted in the application UI.

Properties

NameTypeWritableDescription
CmykImagesIntentOverrideStringNoThis intent overrides all CMYK images. This setting will also apply to gray images when 'ColorManageGrayAsCmyk' is true.
ColorantsString[]NoCollection of supported colorant names.
ColorManageGrayAsCmykBooleanNoWhether to process gray with CMYK color management.
DeviceEmulationIccProfileStringNoName of the media's device emulation ICC profile.
EmulateAnotherPrinterBooleanNoWhether the device emulation ICC profile will be used.
InputCmykIccProfileStringNoName of the media's input CMYK ICC profile.
InputGrayIccProfileStringNoName of the media's input Gray ICC profile.
InputRgbIccProfileStringNoName of the media's input RGB ICC profile.
KeepTextBlackBooleanNoWhether to keep text black.
MainRenderingIntentStringNoThis is the default rendering intent. The rendering intents in the document will override it.
NameStringNoThe active media name.
OutputIccProfileStringNoName of the media's output ICC profile.
OverrideColorManagementInPdfBooleanNoWhether to override the color management specified in the PDF.
Preserve100BlackBooleanNoWhether to preserve 100% black.
RgbImagesIntentOverrideStringNoThis intent overrides all RGB images.
WidthMmDoubleNoThe media width in mm.

AllJobs

State relating to all jobs in the Waiting/Print/Completed queues. Note that this tree will dynamically include children named from the GUID of each known job.

Details

These OPC nodes are fully populated to a consistent state when the OPC server starts, apart from job GUIDs - These nodes are dynamically added and removed as jobs are added and removed to/from the workflow.
(If there are already jobs in the workflow, these GUIDs will exist when the OPC server starts.)

When a job is added to the Waiting queue a GUID node is created containing the job information (containing the same tag names as the ActiveJob node) and that GUID is added to the WaitingQueue array.
The job keeps the same GUID as is travels through the system, moving between the WaitingQueue, PrintingQueue, and CompletedQueue arrays.

The GUID node is removed when the job is removed from the workflow.

See the SingleJob section for a description of all available job-level nodes.

Properties

NameTypeWritableDescription
AutoPrintWaitingQueueJobsBooleanYesWhen enabled, jobs in the Waiting queue will automatically move to the Print queue.

NOTE Modification requires external control.
AutoStopPrintRunBooleanYesWhen enabled, the print run is automatically stopped when all jobs have been printed.

NOTE Modification requires external control.
CompletedQueueString[]NoCollection of ordered GUIDs representing the jobs in the Completed queue.
CompletedQueueEventsInt32NoCount of node changes made to jobs within the Completed queue.
PrintQueueString[]NoCollection of ordered GUIDs representing the jobs in the Print queue.
PrintQueueEventsInt32NoCount of node changes made to jobs within the Print queue.
TransferAllJobsBooleanYesWhen enabled, the print run will copy all jobs over before we start printing.

NOTE Modification requires external control.
WaitingQueueString[]NoCollection of ordered GUIDs representing the jobs in the Waiting queue.
WaitingQueueEventsInt32NoCount of node changes made to jobs within the Waiting queue.

Methods

NameReturnsDescription
CancelJob(String jobGuid)StringCancel a job in the Print queue. (Requires external control)
ClearCompletedQueue()StringRemove all jobs from the Completed queue. (Requires external control)
DuplicateJob(String jobGuid)StringDuplicate a job in the Waiting queue. (Requires external control)
RemoveJob(String jobGuid)StringRemove a job from any queue. (Requires external control)
ResubmitJob(String jobGuid)StringResubmit a job from the Completed queue to the Waiting queue. (Requires external control)
SendToPrintQueue(String jobGuid)StringMove a job from the Waiting queue to the Print queue. (Requires external control)

AllMedia

State relating to all available media.

Properties

NameTypeWritableDescription
MediaNamesString[]NoCollection of all available media names.

NOTE Media which is incompatible with the current setup will be excluded.
SelectedMediaForIOStringYesCall prior to using the MediaDataIO node. (See InstallMedia()).
SelectedNameStringYesThe selected media name (which may differ from the applied media name).

Valid values can be obtained from MediaNames.
Examine the AllMedia.SelectedMedia node tree to see properties of the selected media.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.

Methods

NameReturnsDescription
DeleteMedia(String mediaName)StringPermanently delete the named media (Use with caution). (Requires external control)

NOTE At least one media entry must always exist.
NOTE The active media should not be deleted.
InstallMedia()StringInstall a new .smd media file. (Requires external control)

Prior to calling InstallMedia() clients should:
- Set SelectedMediaForIO to a unique GUID (which is internally used to reference the media).
- Use the MediaDataIO OPC file object to write the .smd file data. (Closing after use.)

NOTE Any existing media with the same name will be overwritten.

Files

NameDescription
MediaDataIOAllows read/write access to an SMD file. (See SelectedMediaForIO)

NOTE OPC File nodes contain functions which allow access to file content:

  • Open(int fileAccess) - Open the file with the specified fileAccess (1:read, 2:write), returning an integer file handle.
  • Read(int fileHandle, int length) - Read data from an open file handle, returning an array of bytes.
  • Write(int fileHandle, byte[] buffer) - Write/append data to an open file handle.
  • Close(int fileHandle) - Close the file handle after use.

For more information see the OPC documentation.

AllMedia.SelectedMedia

State relating to the selected media (See AllMedia.SelectedName).

Properties

NameTypeWritableDescription
CmykImagesIntentOverrideStringNoThis intent overrides all CMYK images. This setting will also apply to gray images when 'ColorManageGrayAsCmyk' is true.
ColorantsString[]NoCollection of supported colorant names.
ColorManageGrayAsCmykBooleanNoWhether to process gray with CMYK color management.
DeviceEmulationIccProfileStringNoName of the media's device emulation ICC profile.
EmulateAnotherPrinterBooleanNoWhether the device emulation ICC profile will be used.
InputCmykIccProfileStringNoName of the media's input CMYK ICC profile.
InputGrayIccProfileStringNoName of the media's input Gray ICC profile.
InputRgbIccProfileStringNoName of the media's input RGB ICC profile.
KeepTextBlackBooleanNoWhether to keep text black.
MainRenderingIntentStringNoThis is the default rendering intent. The rendering intents in the document will override it.
NameStringNoThe selected media name.
OutputIccProfileStringNoName of the media's output ICC profile.
OverrideColorManagementInPdfBooleanNoWhether to override the color management specified in the PDF.
Preserve100BlackBooleanNoWhether to preserve 100% black.
RgbImagesIntentOverrideStringNoThis intent overrides all RGB images.
WidthMmDoubleNoThe media width in mm.

App

State relating to the entire application.

Properties

NameTypeWritableDescription
IsExternalControlActiveBooleanNoWhether the application is allowing clients external control.
TotalSheetCountUInt64NoTally of the total printed sheet count.
VersionNumberStringNoDescribes the application version number.

Methods

NameReturnsDescription
ApplySettings()StringApply the current application settings and update all Harlequin Direct server config files. (Requires external control)
LoadAppConfig(Byte[] pccFileData)StringFor internal use only. (Requires external control)
PrintWithSmd(Byte[] pdfFileData, Byte[] smdFileData)StringFor internal use only. (Requires external control)
RevertSettings()StringRevert any pending application settings. (Requires external control)

Files

NameDescription
LogFileAllows read-only access to the application log file.

NOTE OPC File nodes contain functions which allow access to file content:

  • Open(int fileAccess) - Open the file with the specified fileAccess (1:read, 2:write), returning an integer file handle.
  • Read(int fileHandle, int length) - Read data from an open file handle, returning an array of bytes.
  • Write(int fileHandle, byte[] buffer) - Write/append data to an open file handle.
  • Close(int fileHandle) - Close the file handle after use.

For more information see the OPC documentation.

PrintBarGroups

State relating to the active print bars.

Details

Note that each print bar 'group' corresponds to a collection of print bars which use the same settings (BPP, resolution, etc).

Properties

NameTypeWritableDescription
BitsPerPixelInt32[]NoThe bits per pixel (BPP) of each print bar group.
ColorantsString[]NoThe colorant list for each print bar group.
CountInt32NoThe number of print bar groups.
GroupNamesString[]NoThe names of each print bar group.
HorizontalResolutionInt32[]NoThe horizontal resolution (DPI) of each print bar group.
HorizontalScalingDouble[]YesThe horizontal page scale (%) of each print bar group.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
MediaSidesString[]NoWhich media side each print bar group relates to (A/B).
PlaneNumbersString[]NoThe plane numbers for each colorant in each print bar group.
VerticalResolutionInt32[]NoThe vertical resolution (DPI) of each print bar group.
VerticalScalingDouble[]YesThe vertical page scale (%) of each print bar group.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.

Methods

NameReturnsDescription
SetFailedNozzles(String inkName, Boolean isSideA, UInt64[] failedNozzles)StringSet the failed nozzles for a given print bar.

PrinterProfile

State relating to the active printer profile.

Properties

NameTypeWritableDescription
LineSpeedMetersPerMinuteInt32NoThe printer line speed (m/min).
ManufacturerStringNoThe printer manufacturer.
MediaTypeStringNoThe type of media.

Values: Web, Sheet
ModelStringNoThe printer model.
NameStringNoThe name of the active printer profile.
PrintBarHorizontalToImageBooleanNoWhether the print bars are horizontal to the printed page image.
PrinterTypeStringNoThe type of printer.

Values: Inkjet, Toner
SupportColorBooleanNoWhether the printer supports color.
SupportDirectQiBooleanNoWhether the printer supports a QI vision system.
SupportDuplexBooleanNoWhether the printer supports duplex.
SupportedMediaWidthsMmStringNoA list of supported media widths (mm).
SupportOfflineModeBooleanNoWhether the printer supports offline printing mode (RIP Ahead).

Methods

NameReturnsDescription
GetPrinterProfileAsJson()StringFor internal use only.

PrintRun

State relating to the print run.

Properties

NameTypeWritableDescription
AbortButtonStateStringNoThe state of the print run Abort button.

Values: Disabled, Enabled, Active
IsActiveBooleanNoWhether the print run is currently active.
StartButtonStateStringNoThe state of the print run Start button.

Values: Disabled, Enabled, Active
StatusStringNoThe status of the print run.

Values: Stopped, Starting, Started, Stopping, Aborting
StopButtonStateStringNoThe state of the print run Stop button.

Values: Disabled, Enabled, Active

Methods

NameReturnsDescription
AbortPrintRun()StringAbort an active print run (Immediate). (Requires external control)
StartPrintRun()StringStart an active print run. (Requires external control)
StopPrintRun()StringStop an active print run (As soon as possible). (Requires external control)

PrintRunConfig

State relating to the print configuration (Applies to both media sides).

Properties

NameTypeWritableDescription
AddJobInformationPagesBooleanYesWhether to automatically append an information page to each printed job.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
CueMarkIntervalMmDoubleNoThe cue mark interval in mm.
DuplexModeStringNoThe duplex mode.

Values: Undefined, SimplexSideA, SimplexSideB, DuplexSideAFirst, DuplexSideBFirst
NozzleRefreshBarsEnabledBooleanYesWhether to add nozzle refresh bars onto the printed output.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
NozzleRefreshPageEndCountUInt64YesHow many nozzle refresh pages to append to the job. (0+)

NOTE Requires nozzle refresh pages to be enabled.
NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
NozzleRefreshPageIntervalUInt64YesHow many pages to process before inserting mid-document nozzle refresh pages. (1+)

NOTE Requires nozzle refresh pages to be enabled.
NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
NozzleRefreshPageIntervalCountUInt64YesHow many nozzle refresh pages to add each time NozzleRefreshPageInterval pages have been processed. (0+)

NOTE Requires nozzle refresh pages to be enabled.
NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
NozzleRefreshPagesEnabledBooleanYesWhether to add nozzle refresh pages into the printed output.

NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.
NozzleRefreshPageStartCountUInt64YesHow many nozzle refresh pages to prepend to the job. (0+)

NOTE Requires nozzle refresh pages to be enabled.
NOTE Changes must be 'applied' before they take effect.
NOTE Modification requires external control.

PrintRunConfig.ConfigSideA

The print configuration specific to media side 'A'.

Properties

NameTypeWritableDescription
PrintPositionStringNoThe print position (GearLeft, Center, OperatorRight).

PrintRunConfig.ConfigSideB

The print configuration specific to media side 'B'.

Properties

NameTypeWritableDescription
PrintPositionStringNoThe print position (GearLeft, Center, OperatorRight).

Servers

State relating to the collection of Harlequin Direct servers.

Properties

NameTypeWritableDescription
ColorantsString[]NoWhich colorants each server will process.
ConnectionStatusesString[]NoPer-server connection statuses.

Values: Disconnected, Connecting, Connected
CountInt32NoThe number of Harlequin Direct servers.
MediaSideString[]NoWhich media side each server relates to (A/B).
OverallConnectionStatusStringNoOverall connection status.

Values: Disconnected, Connecting, Connected
PrintRunStatusesString[]NoPer-server print run statuses.

Values:
Idle - No jobs are printing.
Preparing - Print run is active and one or more jobs are preparing to print.
Processing - Print run is active and one or more jobs are printing.
Error - A job has failed to print.
ServerConfigsString[]NoPer-server Harlequin Direct configurations.
ServerPathsString[]NoPer-server Harlequin Direct paths.

Methods

NameReturnsDescription
RestartAll()StringRestart all Harlequin Direct servers. (Requires external control)
SelectLogFile(Int32 serverIndex)StringAllows a Harlequin Direct log file to be selected for reading.

NOTE Must be called before any attempt to read data via ServerLogFile.

Files

NameDescription
ServerLogFileAllows read-only access to the selected Harlequin Direct log file. (See SelectLogFile)

NOTE OPC File nodes contain functions which allow access to file content:

  • Open(int fileAccess) - Open the file with the specified fileAccess (1:read, 2:write), returning an integer file handle.
  • Read(int fileHandle, int length) - Read data from an open file handle, returning an array of bytes.
  • Write(int fileHandle, byte[] buffer) - Write/append data to an open file handle.
  • Close(int fileHandle) - Close the file handle after use.

For more information see the OPC documentation.

SingleJob

Describes the collection of nodes representing a single job, positioned as a child of the WaitingQueue, PrintQueue, or CompletedQueue nodes.

Properties

NameTypeWritableDescription
QueuePositionInt32NoThe job position within the current queue (1+).
StatusStringNoUp-to-date print status of the job.

None - Inactive
Transferring - Copying to server(s).
TransferFailed - Copy failed.
ReadyToPrint - File copied and ready to print.
Printing - Currently printing.
Succeeded - Job printed completed successfully.
Failed - Job failed to print.
Cancelled - User cancelled printing.
PreRipped - Job pre-Ripped successfully.
EndTimeStringNoWhen the job finished printing. (ISO 8601)
PreprocessorStatusStringNoPreprocessor status.

Values: Pending, Active, Complete, Failed
CopyCountInt32YesNumber of copies to print.

Writable only for jobs in the Waiting queue.
NOTE Modification requires external control.
GuidStringNoUnique job descriptor.
NameStringNoThe job name (from the original job file name).
TotalPageCountInt64NoPage count of the printed document (PageCount * CopyCount).
ThumbnailStringNoBASE64-encoded representation of the job thumbnail PNG data.
StartTimeStringNoWhen the job started printing (ISO 8601).
PageCountInt64NoPage count of the document.
PageWidthMmDoubleNoPage width (mm).
PageHeightMmDoubleNoPage height (mm).
HasNonEmbeddedFontsBooleanNoThe result after running job font analysis.
IsStreamlineOptimizedBooleanNoWhether Streamline Optimize has processed the job.
PredictedLineSpeedDoubleNoThe Streamline Direct predicted line speed (m/min).
PredictedLineSpeedIndicatorStringNoThe Streamline Direct predicted line speed (Status indicator).

Values:
Unavailable - Analysis unavailable.
Red - Unable to achieve target speed.
Amber - Should achieve target speed.
Green - Will achieve target speed.
JobTagStringNoProperty which can be used to attach arbitrary state to a job.

The source of the state comes from an optional JobTag string field in the .complete JSON file written into the Waiting queue hot folder.
The state lasts for the lifetime of the job, and will persist if a job is copied from the Completed queue to the Waiting queue.

StreamlineDirect

State relating to Streamline Direct technology.

Properties

NameTypeWritableDescription
AnalysisMaxPagesInt32YesThe number of pages to sample when estimating print time.

NOTE Takes effect when new jobs are added.
NOTE Modification requires external control.
AnalysisStartPageInt32YesPage number of the first page to process when estimating print time.

NOTE Takes effect when new jobs are added.
NOTE Modification requires external control.
EnableEstimationBooleanYesWhether to estimate print time for jobs added to the Waiting Queue.

NOTE Takes effect when new jobs are added.
NOTE Modification requires external control.
LineSpeedInt32YesThe press's target line speed (m/min).

NOTE Modification requires external control.
OptimizeAllJobsBooleanYesWhether to optimize all jobs added to the Waiting Queue.

NOTE Takes effect when new jobs are added.
NOTE Modification requires external control.

Methods

NameReturnsDescription
OptimizeJob(String jobGuid)StringOptimize a job using Streamline Direct. (Requires external control)

NOTE This action is asynchronous. Use the job's IsStreamlineOptimized node to track completion.