Application Programming Interface API User Guide | Mackie V7.0

Related publications

[1]Xprint V7.0

Application Programming Interface (API) User Guide

Target group

This manual is for programmers who want to make use of the Xprint V7.0 functionality in their programs.

Contents

The manual describes how you can use the functions of Xprint V7.0 API in your own programs. Furthermore, it contains a reference of all Xprint V7.0 API functions and the corresponding macros and functions.

[2]Xprint V7.0

Reference Manual

Target group

Users and Administrators of Xprint V7.0.

Contents

This manual describes all the Xprint V7.0 commands and files and serves as a reference book which contains all the information required to use and administer Xprint V7.0.

[3]Xprint V7.0

Graphical User Interface User Guide

Target group

Users, system administrators, printer managers and programmers of Xprint V7.0

Contents

Description of Xprint V7.0 Mercator User Interface for operation, admin- istration and maintenance.

U23841-J-Z915-6-76

279

Image 291

Mackie V7.0 manual Application Programming Interface API User Guide, Reference Manual, Graphical User Interface User Guide

Contents

Edition June Xprint Comments… Suggestions… Corrections… Copyright and TrademarksCertified documentation according DIN EN ISO Page Page Glossary Related publications Index Page Contents Deleting print jobs ContentsIntroduction to administering Xprint V7.0 Configuring Xprint V7.0 148 150174 235 279 239Xprint V7.0 for Windows 249 Glossary 273Page Target groups Preface Structure of the manual Structure of the manual PrefaceIntroduction to Xprint V7.0 starting on Notational conventions Convention UseBold Xprint V7.0 Reference Manual Other publications in this setOther publications in this set Preface Xprint V7.0 Application Programming Interface API Xprint V7.0 from the user’s point of view Introduction to Xprint Xprint V7.0 from the user’s point of view Using Xprint Xprint V7.0 from the user’s point of view Mercator MercatorXprint V7.0 R/3 kit Xprint V7.0 elements Xprint V7.0 objects Xprint V7.0 elements Introduction to Xprint Xprint V7.0 elements Automatic adjustment of the document type Options for printing documentsSelecting the output device of your choice Xprint V7.0 elements Available Xprint V7.0 commands Command UseBasic information Structure of Xprint V7.0 commands Basic informationOnline help Section Printing files with special Suitable for the printer Content types onPrinting files If you want to Read Printing on Printing filesSection Copying print files before Printing and deleting them after Addressing a printer via a gateway Selecting a printerSpecifying a printer or printer group for a print job Pc pcl Examples Defining a default destinationTo configure printer printer2 as the default destination Selecting a printer Using Xprint V7.0 options Printing parts of a documentTo print file1 on printer printer2 Using Xprint V7.0 options Printing files with special content types Otherwise, the content type is set to Compatible Printing a document with different font settingsCreating printouts with special formats Layup can be changed with the following option Selecting the layup Margin settings Defining the margin settings Lllinelength Sdside specification Switching double-sided printing on/off Selecting specific character sets Data document Using Loadable Resources Using Public Loadable Resources Jobs can use the loadable resources as follows Using Private Loadable Resources Producing Output with Xprint Example Defining separator pages Printing several copies of a document Evevents Requesting notification of the result Printing a document directly Using further optionsPrinting in raw mode Retention period of print jobs States of print jobs Extended options Producing Output with Xprint Using other Xprint V7.0 objects Using other Xprint V7.0 objects To print a document with a Manual form, proceed as follows Printing a document with a Manual form To display all defined forms Following menu query is displayedInput Input y Again the confirmation is displayed on the screenXprint V7.0 confirms with the following message Job templates Printing a document via a globally defined job templateJob templates Job is spooled in with the priority Following example shows several simple job templates Defining customized job templates Producing Output with Xprint Page Job identifier Selecting a print job You can select this print job using the following methods Selecting a print jobJob ID might, for example, read as follows Permanent job identifier Managing print jobs Wildcards * and ? are allowed for non-numerical arguments Selection criteria lists Managing print jobs You will obtain the following display Examples of the output formats Short and Long Displaying print jobs List of print jobsDetailed information on print jobs To display the permanent job ID Displaying print jobsSelected information on print jobs To display the global job ID Defining a display template Status of print jobs You will obtain a display similar to the following Display examplesJob status display Short Job status display Long XPFS= Export Xpfw Xpfs Modifying a submitted print job To redirect a print job Modifying a submitted print job Active job is to be deleted Redirecting print jobs RESTART-BEGINNING Redirecting print jobs Deleting print jobs Page Users / Xprint V7.0 users System administratorLocal Xprint V7.0 administrator sub-root Responsibilities Responsibilities Xprint V7.0 administrator Term Type of user Introduction to administering Xprint Xprint V7.0 architecture Xprint V7.0 architecture Xprint V7.0 architecture Character set German, English, International, USA etc Introduction to administering Xprint Xprint V7.0 architecture Introduction to administering Xprint Recovery rules -rec Introduction to administering Xprint Xprint V7.0 architecture Configuring Xprint V7.0 objects Administrative tasks under Xprint Deleting Xprint V7.0 objects Modifying Xprint V7.0 objects Changing the status of Xprint V7.0 objects Displaying information on Xprint V7.0 objectsDisplaying the status of an Xprint V7.0 object Displaying the attributes of an Xprint V7.0 object This could return the following output Examples in this case for printer groupsThis returns, for example, the following output To display a short list of all the printer groups available Starting Xprint Administering Xprint Enter no when asked if this is a new installation Stopping XprintReinitializing the Xprint V7.0 database German Selecting the languageEnvironment definition Language English Defining an Xprint V7.0 domain Rules for configuring the system Configuring hosts Configuring printersOther computers are defined as Slave hosts Automatic server and supervisor object creation Description maximum number of devices by default supervisorServers Supervisors Printers Configuring gateways BSD gatewaysGIP2 gateway U23841-J-Z915-6-76 Page Facilities Manage fonts Manage forms Section Administering forms Manage filters Administering hosts Configuring the first hostAdministering hosts Configuring Xprint Configuring the primary master host First study the network structureDetermining the network structure Configuring a new host Configuration hintsStart the Xprint V7.0 system Procedure Xpmod -usrxprintadm -ho+hostnames Administering hosts users only Configuring Xprint V7.0 on a stand-alone systemConfiguring an Xprint V7.0 administrator Renaming the host computer Administering hosts users only Configuring Xprint Introducing Xprint V7.0 into a network Determining the network structure Configuring a new host in an existing Xprint V7.0 network Configuring the other hosts105 Procedure 107 Predefined printers Configuring Xprint Predefined printers108 Selected entry is then marked, e.g Configuring predefined printersDisplayed screen should read similar to the following All the printers contained Type device address, ’q’ to quit or ’?’ for help 111 Display similar to the following appears on the screen Field Meaning Extending the list of predefined printers 113 Administering devices Configuring Xprint Administering devices 115 Adding a printer Selecting a serverDefining a supervisor 117 Configuring printers Deactivating a printer completely Deactivating a printer -sooption stands for spoolout Deactivating spoolin-sioption stands for spoolin Deactivating printing 120 Reactivating a printer Removing a printer Reconnecting a printer to a different port Reconnecting a printer to another system 123 Replacing an existing printer with a new one Administering devices Configuring Xprint Example Assigning a security level to a printer124 125 Printer group Users access to a printer group on Administering printer groupsAdministering printer groups Configuring Xprint Section Setting up a new printer Setting up a completely new printer group Setting up a new printer group 128 Removing a printer from a printer group Adding a printer to a printer group To deactivate all printer groups Deactivating a printer group 131 Reactivating a printer group Deleting a printer group User on Administering usersDefining a user Section Defining a user on Administering users Configuring Xprint Entering a defined user for other hosts134 Deleting a host from a user’s host list Modifying user privileges135 ALL 137 Deleting a user Resetting user print quotas Changing the number of consumed pages Changing the number of consumed print jobs139 Displaying information on users Displaying privileges and print quotasStatus display of the current print quotas Assigning a security level to a user To display the current print quotas for smith141 Administering users Configuring Xprint Examples Message similar to the following is displayed142 Create a permission list Administering permission listsForm Users access to a form on As supervisor administrators Istration of supervisors on Administering permission lists Configuring Xprint Creating a permission listCreating a new permission list 145 Copying a permission list Modifying a permission list Adding entries to the listRemoving entries from the list Deleting a permission list Listname is the name of the selected permission list Granting or denying specific users access to a printer Granting or denying specific users access to a form Granting or denying specific users access to a printer group Listname is the name of the selected permission list 150 Granting or denying specific printers access to a form Xpmod -srv selection -uppermissionlist Allowing or prohibiting administration of supervisors Defining a completely new font Administering fontsAdministering fonts Configuring Xprint Adding a font 153 Defining a font by copying an existing font 154 Deleting a font Modifying the attributes of a font Define a new form Section Adding a form on Delete a form Administering formsAdministering forms Configuring Xprint To a form Printers access to a form on Adding a form Defining a new form from scratchDefining a form on the basis of an existing form To copy a form, use the following command Cm, and default font font4Deleting a form 159 Modifying the attributes of a form Default forms for printers 161 Creating a new slow filter Administering filtersAdministering filters Configuring Xprint Adding filters 163 Otherwise no option is passed on to the filter Or in centimeters as with the -lpicoption Another possibility is as follows164 165 Creating a new fast filter Tpfiltertype cannot be modified with the xpcopy -fltcommand Copying and modifying an existing filter166 Deleting filters Modifying the attributes of a filter For filtername specify the name of the relevant filter Assigning a filter to a printer To remove a filter from a printer, proceed as follows Removing a filter from a printer Administering public loadable resources Defining a loadable resourceDefining a loadable resource ’from scratch’ Xpshow -lrs Displaying the definition of a loadable resource Deleting a loadable resource Defining a completely new job template Administering global job templatesAdministering global job templates Configuring Xprint Defining a job template Adding a job template on a remote host Represents the name of the job template175 Represents the name of the existing template Stands for the new, maybe modified template176 Customizing job templates Deleting a job template 178 179 Administering PCLsAdd a PCL Section Adding a PCL on Delete a PCL Define a PCL yourself Section Defining a PCL yourself on Adding a PCL from another host Administering PCLs Configuring XprintAdding a PCL Adding a PCL via its unique name Deleting a PCL To display all the PCLs available in the system Providing a PCL with a comment for the administratorAssigning a comment to a PCL Providing a PCL with a comment for users Assigning a PCL to a printer To assign the user commentSELFDEFINED, which already exists in the system 184 185 Defining a PCL yourself Administering recovery rules Defining a recovery ruleAdministering recovery rules Configuring Xprint 187 Error code Description Default Action 188 Action Description 189 Canceling the assignment of a recovery rule to a printer Assigning a recovery rule to a printer 191 Modifying recovery rules Deleting a recovery rule Delete a server Section Deleting a server on Administering serversAdding a server Add a server Adding a completely new server Administering servers Configuring Xprint Procedure 195 Copying and modifying a server Administering servers Configuring Xprint Deleting a serverTo add a new server nashua on the remote host colorado Changing the status of a server Deactivate the server197 Modifying the attributes of a server Change the status198 199 -mj option stands for maximum jobs Defining a new supervisor Administering supervisorsAdministering supervisors Configuring Xprint Adding a supervisor 201 Adding a supervisor by copying an existing supervisor Administering supervisors Configuring Xprint Examples 203 Activating or deactivating supervisors 204 Modifying the attributes of a supervisor Deleting a supervisor To deactivate and delete the supervisor delaware205 Page 207 Introduction Type of interoperation Description Introduction 209 Accessing BSD printersBasic information Interoperability Accessing BSD printers Interoperability Configuring printers for BSD Xprint 211 212 Troubleshooting Type of gateway Description Gateway characteristicsSetting up a gateway connection Gateways Gateways Gateways to BSD spoolers 215 Requirements Modecompatible Defining the local gateway Provides a way to enforce YES or suppress no the header Defining the partner gateway217 218 Allowing print jobs to be submitted by the BSD spooler Gateways to other Xprint V7.0 domains Activating the gateway connection219 Gateway connection to another printer domain Gateways Interoperability 221 Restrictions of gateways to other Xprint V7.0 domains 223 Gateways to Dprint spoolers 224 Partner gateway is defined as follows 225 Adjusting the local Xprint V7.0 domain 226 Restrictions of gateways to Dprint spoolers Administering gateways Section Configuring an additional227 Administering gateways Only returns the gateway GTWnashua228 229 Deleting a gateway connection Deactivating a gateway Deactivating a local gateway completely Deactivating the import of jobs via a local gateway231 Activating the local gateway Activating job export mode for a local gatewayActivating job import mode for a local gateway Activating a gateway Displaying the status of partner gateways Obtaining information on a gatewayDisplaying the definition of gateways Displaying the status of local gatewaysPage Considerations Configuring the local area network LAN Setting the language for the Xprint V7.0 system Installation new Installing Xprint237 Start the installation with the following command Installing with cpioInstalling with pkgadd Installation new Installing with sd method Initializing the Xprint V7.0 database Automatic configuration of printers Installation process Reliant Unix users U23841-J-Z915-6-76 Installation users only Installation users only Installation with pkgadd Types of licenses Product licensing Extra feature licenses Device upgrade licensesDevice Upgrade to Unlimited Device Upgrade Installing a license key Where to install a license key245 How to install a license key 247 Installation with xpkeyPage Approach Xprint V7.0 for Windows Installation and license key RequirementsDifferences from Xprint V7.0/UNIX Integration with Wprint Xprint V7.0 for Windows251 Start-up and shutdown ResponsibilitiesDifferences from Xprint V7.0/UNIX 253 Printer supportLAN printers Workgroup Shared printers Logged messages are the same as on Unix LoggingInteroperability with the BS2000 Dprint system Directly attached printers serial or parallel connection Printing encrypted files Windows 2000 special files User manager can print the file d\bills\june.prt 256 Migrated files Limitations and restrictionsPage 259 Section Supervisors used WorksheetWorksheet Connected printers Filling out the worksheet Appendix261 Port type Device address Remark Checklist for adding a printer Checklist for adding a printer Questions264 265 General requirements Selection criteria list Print jobs Special casesAll objects Printer groups Options -poand -pdcannot be used for selecting hosts Snmp AgentSnmp Agent Hosts 269 Axis box support ConfigurationAxis box support TV-CC integration Fax and mail support Page Encrypted files BackendCharacter set Direct printing Job Glossary GatewayHome directory Host Parasite host Glossary Master hostObject Option Printer group Glossary Permission listPrint job Printer capability list Server Glossary Raw modeRecovery rule Scsi driver Xprint V7.0 domain Glossary Snmp agentSupervisor Xprint V7.0 database Application Programming Interface API User Guide Reference ManualGraphical User Interface User Guide User Guide Windows administrators and Wprint NT usersRelated publications Wprint Default identifier print job Define Filter 165 Job template Change281 Index Modify font Print Print directly Print partsUse job template for printing Identifier ObjectsPages Printer Security level 163 Grant access 148 Permanent ID Move 122Partner gateway Add to printer group 129 179 Display 117 Name 180 User Index 287 Page Comments Suggestions Corrections Page Comments Suggestions Corrections