CIM Setup / JDF Setup - Technical Communication Setup

Summary

In this article you can find all information how to setup a JDF communication with any known workflow partner (vendor for JDF-certified software). It is a general description and the setup may vary because of special requirements of one of the workflow partners. 

Unfortunately, a JDF integration is not "Plug and Play" - which means it needs skills and experience with these kinds of integrations. This need to be kept in mind as well if an existing setup needs to be changed. Please contact PrintVis support for help.

Please be aware that you might also need to request some additional information from the involved vendors to set up the communication and the controllers/devices correctly!

Additionally calculation data must be linked to specific values from the JDF CIP4 definition. Please find further information in the PrintVis JDF Setup for Data Integration article.

JDF Vendor Experience Overview

The official CIP4 integration matrix is the best way to get an easy overview about the integration/workflow partners with for PrintVis. 

Please see:

JDF Integration Matrix: NovaVision / PrintVis - Filter by = PrintVis

JDF Integration Levels

To classify the needed effort for JDF integration projects, it makes sense to classify levels of integration. The more levels that need to be implemented, the more effort for testing and training is required for the customer. This needs to be calculated in the integration project cost.

Level 1: "Basic JDF-Integration" (without Automation)

• Automatic creation of jobs from MIS in workflow partner system

• Detailed Product Description

• Human-readable electronic Job Ticket

• Repeat Jobs

Level 2: "Advanced JDF Integration" (with Automation)

• (partial) automatic Layout preparation (Stripping Parameter)

• Processing / Process net out of the MIS

• Presetting data

• Change Order

• Scheduling Data

Level 3: "JDF/JMF Feedback from Production"

• Job Status / Job Tracking

• Job Costing

PrintVis System Requirements for JDF/JMF integration

PrintVis requires the following apps and tools for full JDF/JMF support:

• PrintVis app/extension must be installed

• PrintVis CIM extension must be installed

• All full users must have the advanced full user license

• PrintVis Link installer must be installed  (Windows Installer to be installed in the local network)

JDF Interface Configuration

Required Setup for Level 1 integration and for a basic setup (level 1 is always needed!)

Service Tier setup

On the service tier make sure the following settings are made:

• Services Default Company need to be set to the company name that is running the JDF/JMF integration

• Use NTLM Authentication must be enabled

• SOAP Services need to be enabled

Web Service Setup

The PrintVis JMF Controller Service/WCF Communication Component uses a NAV/BC365 Web Service to forward requests to and from JDF/JMF Workflow Partners.

This Web Service needs to be setup in NAV/BC365 with the following Entry in the Web Services table:

Required web service field values:

Object Type	Object ID	Service Name	Published
Codeunit	6010920	PrintVisJMF	Yes

Please note: The service name must be PrintVisJMF!

Result:

Now the Web Service should be available at (SOAP URL):

http(s)://<server>:<port_SOAP_Services>/<Instance>/WS/<CompanyName>/Codeunit/<ServiceName>

Example URL for the JMF Web Service: http://pvbc14-abced.local:9905/PV14-NUP/WS/PRINTVIS/Codeunit/PrintVisJMF

CIM/JDF Setup

The JDF/JMF communication works through http and therefore some basic information is needed which the PrintVis Link sowtware requires to communicate with it.

PrintVis supports several features and versions related to JDF/JMF standard.

These cannot be influenced directly by setup, but sometimes it is useful to know what the current system supports., because they are determined by the codebase and the system version.

General TAB required settings

JMF Channel Port	Default port is 4060 (change if not available and make sure that ports are open if communication need to be passing the firewall) The JMF Channel Port is the Port which will be used to send and receive JMF messages from PrintVis. It should be a port which is not used by the operating system and/or third party products.
HTTP Listener Port	Default port is 4061 (change if not available and make sure that ports are open if communication need to be passing the firewall )
HTTP Status Port	Default port is 4062 (change if not available and make sure that ports are open if communication need to be passing the firewall )
Regular TCP Binding Port	Default port is 9998 (change if not available and make sure that ports are open if communication need to be passing the firewall )
WCF Network MAC Address	Enter the MAC address of the server running the WCF service This field is being deprecated and not be used anymore from PV Version 17 and onward.
WCF Service Serial Number	Enter the Serial No. that you have received for this MAC address. A new serial no. is required if the server MAC address or the NAV/BC license is changed. This field is being deprecated and not be used anymore from PV Version 17 and onward.
JMF Channel IP	Will be filled automatically if the the Service created by PrintVis Link is running.
Host URL	Will be filled automatically if the the Service created by PrintVis Link is running.
HTTP Listener URL	Will be filled automatically if the the Service created by PrintVis Link is running.
HTTP Status Page	Will be filled automatically if the the Service created by PrintVis Link is running. If you click on the link or paste it into an internet browser address field after the service (please see below) has been installed and is running, you'll get the status information: 

The ports are default ports and need to be setup on the firewall. If those ports are not available other ports number can be chosen. It should be a port which is not used by the operating system and/or third party products.

It is mandatory to check if the system runs an active firewall which may be setup as well!

The Host URL shows the current complete JMF setup of PrintVis for incoming JMF's.

Some vendors need this information to setup their systems properly. So if they require the PrintVis JMF IP, it can easily be found there.

HTTP Status Page

If you click on the link or paste it into an internet browser address field after the PrintVis Service (please see below) has been installed and is running, you'll get the status information: If you get this information the connection to the PrintVis server should be working fine. Problem to reach this page from other servers can be caused by some blocked ports. Make sure all ports that are setup on the PrintVis CIM setup are open in the firewall to connect to other JDF servers.

JDF Details TAB settings

JDF Descriptive Naming (Job Name)	In this field you can select where to read the PrintVis Job Name from: From Case From Job
JDF Version	Please select the latest/highest version that can be handled by all workflow partners.
Job Ticket	Select the object ID from the Job Ticket report to use on the request from the HTTP Listener URL If nothing is setup here standard Job Ticket 6010313 is chosen

Test Communication TAB settings

It is possible to enable some additional features during setup and test phases. These settings are typically used if a PrintVis technician is troubleshooting the integration. If you use it make sure you know what you are doing. You can create additional traffic, file creation and options that might not be useful for a standard user.

Test Mode	If the Test Mode is switched on, it will also influence some actions on pages. The Case Card will show a new button to manually send JMF/JDF messages to a specific device, which enables the operator to send a quick message while testing. In a "Live Environment" this will be done automatically by the status code setup.  On page Workflow Partner Commands a new action "Test" is displayed to manually process and send messages. This enables the operator to reset any previously sent test jobs after some case data has be changed - and to resend the job manually (e.g. color renamed, imposition information changed). Partner Responses are not processed automatically if "Test Mode" is enabled!
Test JDF File	Enter the path and file name of a JDF file that should be send to a workflow partner. With this option it is not necessary to have a test case ready.
Test Controller Code	Select the controller where to send the "JDF Test File" to. This can be used if more than one Workflow Partner is integrated, to be able to send test data to only one specific Workflow Partner.
Test Save JMF files	If enabled outgoing and incoming JMF files will be stored in the folder that is setup in the field below.
Save JMF Messages folder	Path/Folder where to save outgoing and incoming JMF files Make sure this path can be accessed from the service tier! Please not: This will have impact on the system performance and creates several files on the given path. Make sure to disable this setting if not required anymore and clean-up the folder from files that are no longer needed!
Test Disable Auto Processing	If enabled JDFs/JMFs will not be processed automatically, even if all services and job queues are running. The JDFs/JMFs can be processed manually from the Workfkow Partner Commands/Responses
Delete Response History	If the Workflow Partner Response table need to be maintained this field can be enabled and a date formula (Retain History Date Formula field) must be entered. All entries before the calculated date will be removed. The response history will be deleted when running the job queue report "PVS CIM Job Queue".

The Case Card will show a new action to manually send JMF/JDF messages to a specific device.

This enables the operator to send a quick message while testing.

In a "Live" system this will be done automatically by the status code setup and the JDF/JMF client.

The Workflow Partner Commands Page will show a new button "Test" to manually process and send messages.

This enables the operator to reset any previously sent test jobs after some case data has be changed - and to resend the job manually (e.g. color renamed, imposition information changed).

Azure Service Bus Setup

Please note: The Azure Service Bus Setup is optional and only needed for WCF Service Mode = Service Bus

If the WCF Service mode is set to "Service Bus" the following settings are required:

PrintVis Link (OnPrem Installation)

The PrintVis Link Software is being used to created a service that is handling the communication between PrintVis and external software components. It need to be installed in the local network and is required for Cloud and On Premise installations.

Please ind the setup instructions in this article: PrintVis Link

Job Queue Setup

A job queue if the JDF/DCM should be processed automatically:

A typical setup with that runs 1x per minute is shown in the screenshot.

The job queue can be setup automatically by clicking the actions:

• Create/Check Job Queue Entry CIM

  • Will open the job queue for the JDF/CIM communication

  • If not existing it will create it

• Create/Check Job Queue Entry DCM

  • Will open the job queue for the DCM communication

  • If not existing it will create it

PrintVis CIM Controller Setup

A controller is required for each workflow partner and manages the jobs for the devices connected to it.

If you are looking for a specific workflow partner setup take a look into the article: "Default/Special Controller Settings for JDF Workflow Partners"

Fields on TAB General

Code	Enter a code
Description	Enter a description
Workflow Partner Name	Enter the descriptive name for this controller which is used in the JDF/JMF file. If due to setup requirements more than 1 cost center is setup in PrintVis, it is possible to setup also different devices but use the same Workflow Partner Name on each device.
System	Just use "JDF" here; All other option are for special use
Submission Method	To send jobs via JMF the setting must be set to JMF. Hotfolder is only used in some rare cases.
Target URL	The Target URL is the full address of the controller. Typically you get this information from the vendor you want to connect to, or from a key user who is operation the Workflow Partner system. The URL must typed in according this schema: http://<IP>:<port>/<target> Example: http://123.1.1.123:8520/jmfdings Additionally you can add a %1 at the end, then the DeviceID will added while sending.
Subscription Method	Just use "None" here; All other options are for special use
Receiving Method	To receive signals and audit information via JMF the Receiving method must be set to JMF. Hotfolder is only used in some rare cases.
Receive Detail Level	Options are: None SubmitQueueEntry Device Globally Query Device (Globally) Job Level JDF Node Query Job Level JDF Node Job Level JDF Node (Device)
Hotfolder Incoming	If Receiving Method is Hotfolder enter the path here.
Workflow Submission	Options are: The option will be triggered by the sorting order in the calculation by the cost centers and their assigned devices in a PrintVis. First only No matter how many Controllers are available and mapped to a calculation, only for the first a JDF/JMF will be sent. Always JDFs/JMFs will be sent for every device One per Controller JDFs/JMFs will be sent for every controller mapped to the calculation.
MIME Packaging	MIME Packaging defines if the JMF contains the JDF according the MIME standard. This might be filled (if supported from Workflow Partner) from the Query Known Submission method, which can be called via the according action on the controller setup card. If it is disabled, the JMF will contain only a link to the JDF and the controller has to download the JDF himself from the virtual PrintVis http server.
Closed	If enabled this Controller is disabled
Resubmission Allowed	Enable this field if the Workflow Partner allows the resubmission of a JDF.
No. of Submission Retries	No. of submission retries defines the number of attempts from PrintVis to send the JMF if the previous attempt was not successful.

Fields on TAB Integration

Job Ticket ID	Select the desired Job Ticket report
Filetype	Select the filetype that should be provided
Special Target URL	This is used for Kodak RBA (Rule based Automation). There is special Report 6011021 which is being used to trigger certain events in Kodak which is using the “Special Target URL” on Controller. The report needs development based on what automation is available in the Kodak Prinergy System.
Use HTTP Server for Resources and Runlists	If this field is checked the runlist file links are encoded as http links. This means the Workflow Partner is able to steam the Production-PDF (Runlist file) from the PrintVis "folder". This is the only option if PrintVis and the Workflow partner are not part of the ame network (e.g. Cloud installations) If the field is unchecked, the runlist files are encoded as file links. The Workflow Partner must have access to the foiled system!

Fields on TAB JDF Details

Private Namespace	If the controller supports a private namespace it may be selected via the Private Namespace setup. If a private namespace is selected, additional will be added to the JDF file.
JDF Structure	The JDF Structure setup supports three different setup options. If Standard is selected, the system creates a standard PrintVis JDF with all data included. If Process Level is selected, the system creates an optimized JDF for digital printing. If Single Process is selected, the system creates a JDF which only includes the information for the print process.
Sender ID	This field is used for the JDF/JMF mapping and is flled from the Workflow Partner when running the Action "Query Known Devices".
Position Type	AbsoluteBox: RelativeBox:
JDF ProductTypeDetails Value	Options to trigger a workflow in the Workflow Partner system (e.g. AGFA) Product Group JDFProductTypeDetails  Is tranverffing the value from the seletced product group Custom Custom build from the settings in the field below
JDF ProductTypeDetails BuildUp	For the above option "Custom" in field "JDF ProductTypeDetails value" to build the tranferred JDF ProductTypeDetails Value : Syntax:  %1=ProductGroup Code %2=ProductGroup Comment %3=ProductGroup "JDF ProductTypeDetails" %4=ProductGroup "Esko Substrate Queue" %5=IntentGroup Code %6=IntentGroup Comment %7=IntentGroup "External Description" %8=Case "Product Group" %9=Case "Product Configuration Code
Clean OrganisationName	With this field enabled PrintVis will remove special characters from the customer name in the JDF: i.g. "Müller" will become "Muller". This is to avoid problems with Workflow Partners that cannot handle these characters.
MediaIntent Dimension Node	If this field is checked, the plate making grey box within the JDF will get an additional node for thumbnail generation on separation level. This is an optional setting. Note: This will lead to an error in the validation of the JDF with the CPI4 JDF Editor because this setting is not more supported since JDF specification V1.1 but still used from some vendors!
Paper Media Partioned	If this field is checked, the Paper media node within the JDF will get an additional partioned level. This is an optional setting mainly used within workflows using KODAK prepress systems.  Note: This is not supported from all vendors!
Plate Media Partioned	If this field is checked, the Plate media node within the JDF will get an additional partioned level.This is an optional setting mainly used within workflows using KODAK prepress systems. Note: This is not supported from all vendors!
JDF ProductClass GeneralID	PrintVis writes the Product Group into the Root Node) It checks the Product Configuration Code from the case; If empty it takes the Product Group Code.
JDF ProductionType GeneralID	This setting is used for Heidelberg Prinect Smart Automation: (i.g. Triggering basic workflows if JDF/Job data is not very enriched) PrintVis writes the Product Configuration Code from the case; If empty it takes the Product Group. If on Controller AGFA Namespace and AGFA Ticket Template is enabled (Only for AGFA) same value will be written as well into the AGFA Namespace agfa:TicketTemplateName

Fields on TAB JMF Details

JMF ResubmitQueue Supported	Enable this field if the Workflow supports a ResubmitQueue JMF if an order is resend after a change. If disabled always a SubmitQueue JMF will be send.
JMF AcknowledgeURL Attribute
JMF WatchURL Attribute

Fields on TAB AGFA Integration

Use AGFA Ticket template

For the AGFA Package basic JDF intent setup it is not possible in an easy way to specify if a WebUpload or WebApproval is agreed with the customer. But it is possible to select a specific hot or job ticket template by using AGFA tag/namespace called TicketTemplateName. PrintVis transfers the Product Group code or If existing/selected, the Intent Product Configuration code as TicketTemplateName value.

Use Agfa JobDescriptiveName

Run Page Actions

In the example a Controller for AGFA is being used. The steps are the same for all other Workflow Partners!

After the above setup is made the Workflow Partner can be connected. By default run all actions under Queries.

Queries

Subscriptions

By default run all actions under Send Subscriptions. Only if not all Subsriptions are desired you can speify whick one.

Result will be displayed on the Factbox:

On some of the Queries or Subscriptions and error message might be displayed if the workflow partner does not support this option.

If on all actions an error appears this might be an indicator that the connection is not working.

Try to paste the "Target URL" into your browser. If the result looks like this the connection is working:

PrintVis Device Setup

The devices reported by the Workflow Partner can be checked and changed in the device setup. Please search for the "PrintVis CIM Device" because there are more entries when just searching for device!

After running the action on the Controller "Query Known Devices" there might be be a long list of devices that has been created. If it is unclear which one is for which use, Please contact the vendor for the given controller code.

In PrintVis a cost center will be linked to each controller which has to be addressed by the PrintVis calculation!

Device Card

Fields in Device Card Tab General

Code	Code for this device
Device ID	Device ID used in JDF/JMF communication
JMF SenderID	Will be filled on first connection by workflow partner and is being used to map the received messages to the correct controller.
Name	Readable name for this device
Controller Code	The Manufacturing Integration/CIM Controller this device is connected to. To change it you can lookup the existing Manufacturing Integration/CIM Controllers.
Closed	Enabled if this device is not in use.
PrePress Job Creation	Enabled if this device can be used for ESKO PrePress orders.
Cost Centers	Shows the number of cost centers the devices is linked to. A cost center can linked with the action Process -> Assign Cost Centers: Here select in column Manufacturing Integration/"CIM Device Code" the device. The cost center can be also mapped directly on the cost center card
Controller URLs	Will be filled by the Query "Query Known Controllers". Will be used for example in Xerox Freeflow.
Report Total No. of Plates	There are 2 ways to get JMF Responses about the consumption of plates from Prepress: The prepress system is sending only the actual consumed plates for this sheet. Keep the Boolean = False / Do not switch on PrintVis is posting the comsumpion based on the no. of plates that is sent The prepress system is sending always the total of consumed plates for this sheet.  Set the Boolean = True / Switch the field on PrintVis is always posted the difference beteeen the no. of plates sent and plates that have been already posted.
Bitmap Code Big	Displayed on the Device Monitor List
Bitmap code Small	Displayed on the Device Monitor Card
Max Speed	Enter the Max. Speed for this device. It is used for the max. values on the speed gauge on Device Monitor Card.

The fields on the other tabs are for administrative information and might not be in use for this controller.

Special Handling of Workflow Partners

You might have noticed that based on the namespace and others settings the handling of data can differ depending on the Workflow partner brand. We try to avoid special handling but on some be have learned that it is hard to work without. In the following some of those topcie are described.

ChannelID for Subscriptions

PrintVis is creating for every new subscription to a JDF Workflow partner a unique ChannelID. It seems some systems get confused by that. We have changed that for the integration of with ESKO Automation Engine the ChannelID will be stored and used for every new subscription.