PrintShop Web MIS Integration Guide
PrintShop Web MIS Integration Guide Document version: PSW 2.1 R3250 Date: October, 2007 Objectif Lune - Contact Information Objectif Lune Inc. 2030 Pie IX, Suite 500 Montréal, QC Canada H1V 2C8 Tel.: 514-875-5863 Fax: 514-342-5294 www.objectiflune.com To find an Objectif Lune office near you and for more information on our products and services, visit: www.objectiflune.
Table of Contents Introduction................................................................................................................................................. 4 XML to File connector................................................................................................................................. 4 MIS Connectors......................................................................................................................................... 5 Enabling a MIS connector..
Introduction PrintShop Web comes with a framework for managing and describing modules. Modules are used to add or customize functionality in specific areas of the application. One of these areas is the integration of Management Information Systems (MIS) The MIS Connector Framework is build on top of this module framework and is called at order creation and order status changes. MIS Connectors are used to automatically transfer order information from PrintShop Web to external MIS systems.
MIS Connectors MIS connectors add functionality to the PSW order creation and order status change processes. The following diagram outlines these processes. Order process flow diagram The system performs the following tasks: 1 Order information is stored in the PSW database. 2 The system defines if email notification messages should be send. 3 The system checks for the active MIS connector, if found the functions of this connector are called. 4 The user interface (UI) of the system is updated.
Enabling a MIS connector In order to activate the XML to File connector, carry out the following steps: 1 Click on Settings in the PSW menu bar, the Settings sections appears. 2 Click MIS Integration in the Settings sub menu. The MIS Integration page appears and shows information about the current MIS connector (if one is selected). 3 Click Edit. 4 Select a connector from the Active Module pull down menu. The list shows the available MIS connectors. 5 Click Save to activate the module.
Properties The properties of a connector differ from connector to connector. They depend on the options and functions of that specific module. To view and modify the properties of a connector (module) do the following: 1 Click on Settings in the PSW menu bar, the Settings sections appears. 2 In the Settings sub menu click Modules. The Modules overview page is shown. 3 Open MIS Modules entry in the overview by clicking the plus-icon in front of its name.
XML to File connector Previous versions of PSW contained a hard coded connector that wrote order information to XML files at order creation and status changes. This functionality has been migrated to the XML to File connector that comes with PSW 2.1 or later. This connector can perform the following tasks: • • • • Write order information to a XML file. Use a HTTP POST call to submit XML data to a predefined URL.
XML (eXtensible Markup Language) XML stands for eXtensible Markup Language. Since XML data is stored in plain text format, XML provides a software- and hardware-independent way of sharing data. This makes it much easier to create data that different applications can work with. It also makes it easier to expand or upgrade a system to new operating systems, servers, applications, and new browsers. The XML to File connector collects the order information and writes this data to XML files.
Push method The Push method defines the method used for providing the order information to the outer world. You can select one of the following options: • • • Write to folder Post Write to folder and Post The Push method section of the XML to File properties Write to folder When the Write to folder option is selected an XML with the order information is created in a central location. The element names in the XML data match the fields names in the PrintShop Web database tables (tblorder).
XML options XSLT is a language for transforming XML documents into XML documents or even plain text. With XSLT you can add/remove elements and attributes to or from the output file. You can also rearrange and sort elements, perform tests and make decisions about which elements to remove and keep. More information can be found at: http://www.w3schools.com/ By activating the Apply XSLT style sheet option the connector will apply the XSLT style sheet stated in the Style sheet text area to the XML output.
The sample XSLT code creates the following XML output: 2007-10-08 16:01:41 Post options The URL field lets you state the HTTP server address that is used when the POST method is selected. File options The File extension field lets you specify the extension that is used for the data file.
Sample POST receive script The following script is a sample on how to receive POST data in PHP. The code receives the XML data sent by the XML to File connector and writes this information to disk using the ID of the order. The sample file is supplied with PSW 2.1 and can be found at the following location: C:\Program Files\PrintShop Web\Website\modules\mis\1\sample\receive.php
ELECTRONIC END USER LICENSE AGREEMENT FOR PRINTSHOP WEB NOTICE TO USER: THIS IS A CONTRACT. BY INSTALLING THIS SOFTWARE YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT. This Objectif Lune End User License Agreement accompanies the PrintShop Web product and related explanatory materials ("Software"). The term "Software" also shall include any upgrades, modified versions or updates of the Software licensed to you by Objectif Lune. Please read this Agreement carefully.
