Home

xDashboard Enterprise Edition User Guide Build 39

1. Prog 1 Step 2 step Progress Querying for Information About Your xPublish Batch Job xPression stores information about your xPublish batch jobs in a table in your xPression database called T_IDocTable Before you begin using the DocTable functionality be advised that the implementation of the IDocTable may change in future releases These future changes may require you to update or change your applications You can query T_ Doc Table to retrieve the following information DocumentTrackingID The unique document ID The DocumentTrackingID field serves as the primary key of the T_ IDocTable DocumentName The name of the document PublishName The name of the batch job as recorded in the xAdmin Job History page or in the T Jobs table The ID of the batch job as noted in the T_Jobs table or the xAdmin Job History page which displays the contents of this table CustomerKeys This value identifies the customer key in the following format FieldName Value The customer key can be used with the PublishID to uniquely identify a customer record for the document represented in the table Document Sciences Corporation 44 Chapter 4 Job Monitor em mon Identifies the current processing state of the document with the following status codes Processing Indicates that xPression has begun processing the document Error Indicates that the document failed Success Indicates that the document was processed wi
2. Tool Options P Add Query eer cee Guern albiile Field Operaton Value I o z a This scenario Jurisdiction CA would submit only California customers for batch assembly in this job step You can create more complex query statements by adding additional lines to the query table and using the AND OR and Parenthesis functions The AND OR function joins one query statement to another Using AND tells xPression to extract customer records that satisfy both query statements The OR function tells xPression that it may select customer records that satisfy just one of the query statements The Parenthesis function groups your query statements together so they are read as one statement For example JURISDICTION CALIFORNIA or JURISDICTION NEVADA and POLICY_TYPE LIFE This query statement tells xPression that qualifying customer records must have a Life policy and must reside in either California or Nevada jurisdictions Document Sciences Corporation 29 Chapter 3 Job Management If parenthesis were not used the query statements would evaluate differently because xPression would not know if the OR operator applies to the Jurisdiction statement or to the Jurisdiction and Policy_ Type statements In the latter case xPression would incorrectly return all records from the California jurisdiction regardless of Policy_ Type and all Life policies from Nevada Selecting the Document Name
3. Marne FIRST_NAME iv Customer Keys SF Add parameter Customer Key Field AUTOPAY_KEY ka Document Sciences Corporation 39 Chapter 3 Job Management Job Steps for xPRS Packages To access the job steps page click Add Step from the job steps section on the job definition page The job step options appear in the following pop up page Figure 35 The job step pop up page Step Details appears when you click Add Step from To modify the job definitions general properties edit the information below then press the Save the job steps section button when you are finished Name h Type Assemble r Document Type xPRS Document Source Category please choose category Customer Data Source Group please choose group Data Source please choose datasource At the top of the job step page you will see settings for Name Type and Document Type As for the job type there are several different job types to choose from and each type contains unique options and functions Supply a name for the Name box The name must be between 1 and 255 alphanumeric characters Type For xPRS packages you can only select Assemble jobs An Assemble job type enables you to directly specify which package you want to assemble This job type enables you to directly specify the pacakge category package name and data source Document Type You can choose xPression and xPRS To create an xPRS package job step
4. The Job History Detail page displays the following elements Job Name The name of the job definition This information may not be displayed depending on the value selected in the Job Level field of the Job Definition Document Name The name of the document that was processed for the customer key Document Sciences Corporation 55 Chapter 6 Job History DataSource Name The name of the data source used to assemble the document Displays the success or failure of the customer record Step Name The job step that processed the document for the customer record Step Type The job step type If you click the Advanced Search button you can perform job level or document level searches on the customer key list The Actions Toolbar The Actions toolbar enables you to delete jobs from the job history list and search for jobs in the job history list Delete a Job from the History List To delete a job from the job history list select the checkbox next to the job you want to delete and click the Trash button Search the Job History List You can perform two levels of searches from the Actions toolbar You can perform a basic search directly from the toolbar or click Advanced Search to specify more detailed search criteria Basic Search You can perform basic searches for Job Name Status and Failure Records Figure 46 Select the type of search Job History List you want to perform To look over job history detail and its
5. server Successful customer data The number of successful customer records processed during the life of the server Failed customer data The number of failed customer records processed during the life of the server Fatal error records The number of fatal errors received Fatal errors are very serious errors that cause the entire job to terminate For example a fatal error will occur if xPression cannot connect to the xPressiondatabase Doc level error records The number of document level errors received A document level error often means there is a problem related to the customer data When a document level occurs xPression skips the customer record that caused the error and continues to process the remainder of the job Lock Management xPression client applications create locks throughout the course of a session as users access the various documents associated with routine system administration and application use Locks are set when users update documents rules content groups and content items If communication with the server is interrupted during a session any locks that xPression created while the server was active may still be present when the user reconnects The Lock Management utility enables you to remove locks that result from server communication interruptions Be aware that xPression doesn t differentiate between the locks left when a user s computer stops responding and those created by users still
6. 1 The Concurrency Management page also displays a list of current users From the Actions toolbar you can stop the current user s session by selecting the checkbox for the user record and clicking the Stop button Users who are logged on will lose their seats momentarily but won t experience any interruption xPression automatically grabs a new seat when the user performs the next action in the application To refresh the Concurrency Controls page at any time click the Refresh button on your Web browser or press F5 Handling Session Time outs If your company is using its full complement of licensed seats and an extra user attempts to log on xPression server looks for available seats If it doesn t find any it then examines the idle times of each connected user xPression does not automatically drop a seat when it times out A timed out seat only drops when a new user tries to log on when no seats are available If a user s idle time exceeds the timeout value in the SessionControl properties file the server disconnects the idle user and allocates the freed seat to the new user If xPression doesn t locate any idle users the new user will be unable to connect to the server until a seat is available Document Sciences Corporation Chapter 5 Server Management The SessionControl properties file resides in your xPressionHome directory On Windows systems this default location is C Windows xPression Note If you re not
7. History Details for that particular batch job depending on the value selected in the Job Level field of the Job Definition Shows the final status of the batch job This column will display Success Failure or Success with failure records Failure Records Records Shows the number of records that failed Shows the number of records that failed during the batch run the batch run Records meneere Sme onanio eee ta aa ronen OOOO column identifies the total number of customer records that xPression attempted to process for the job Output Profile Output Profile Displays the name of the output profile in use the name of the output profile in use Changeing the Start or End Time In the xDashboard Advanced Search interface when you select one of the Start time End time fields and select a date the current time is selected by default You can change the time by typing a valid time and then reclicking the selected date To set a time in the xDashboard Advanced Search interface 1 Select one of the Start time End time fields select a date The current time is offered by default Replace the default time with the time you would like to use p Re click the selected date Document Sciences Corporation 54 Chapter 6 Job History Job History Detail Page You can click the job name to see the Job History Details for that particular batch job Figure 45 The Job sea ie acl iin ee i aera ee Job History Detail Autopa
8. can run batch jobs in three ways e Schedule batch jobs to run as unattended jobs e Manually initiate the batch job from the command line e Run the batch job directly from Job Management How Does xPression Handle Batch Jobs When running in batch mode xPression produces one or more personalized documents from a set of customer data records When you run a batch job you are executing the Batch Runner command passing along parameters and a job definition Understanding Job Definitions The job definition is the key component of a batch job in xPression It controls everything about your batch job except when and where it executes You can manually create batch job definitions or create job definitions through The Job Management Page A basic job definition contains the following pieces of information e Your choice of publisher e The input data source to use trigger file literal or customer data Document Sciences Corporation 13 Chapter 3 Job Management e The output profile to use An output profile defines the output streams that must be generated the format definition of each stream and how they re distributed e How to produce the personalized documents You create job steps to specify which documents you want to publish You can identify documents by name or from a customer data source publish all documents waiting in the batch queue or use queries to publish documents that satisfy certain criteria To crea
9. eves iennlndaetiecoeeemuadateceesacs 9 TEJO NIOAIOr FAJE are nee ne ete eet er mene nee ee ere ee ee see oe ee ee een eee 9 The Job History Page ccecccemscwsetnereceauanneceqsenesionnenuetionsdnacelealidnanedsatebeuasevaceuequapsatian nce tdadenecabenenoreveunmesmeedaedeanecesteaees 10 The Server Management Page cccccsccccccccesseeceeeceeeseceeeeeaeeeseeeeeesseeeeeeeeseeseeeeeeesaeeseeeeesseeeaeeeeesessaaeseseesseeaeees 11 BOD Maade MENI sssrin aE 12 Pe E E E E A E E E EE E E EEE ENE E E E E ES 12 How Does xPression Handle Batch Jobs nannnnnnnnnnnnnnnennnnnensnrrnnsnnnnsenrnrsnnrnrsrnrnrrnnrrrnrnrrrrsnrerssnrernne 12 Understanding Job Definitions cccccccccccsseceeccceseeeecaeeeeeecseueceessuaeeeessaaeceessuaeeeessaaseeesseaaeeesessseeeeeaas 12 How to Customize Batch Reports and Batch Logs ccccceceeesceccaeeeeeeeeeeeeeeeeeeeeeseeeeeessaeeeeeeseeeeeeeaas 13 CompuSet and xPublish Job Definitions 0 0 ccecccccceseseeeeceeceeeeeeeeeseeeeeseeeeeeeeeseceessseeeeeeeeesaeseeeeeenaas 13 The Job Management Page cevecescsscevaniecasicsensisinaceconesan deaaissinadtncencket scitesunsdelvanctiessasstensiedeuetesbeene tudesehencdesnaxndepeennees 14 TOCJODVEANTON F AGC seem iraan A E EA EE E EE 15 Job Definition The General Section cccccccccccseeeeeeceeeceeceeeeeeeseseeeccaeueceesaeseeeeesaueeessaaeseesageeesseaaees 16 Job Definition The Job Log Section ccccceccccccsecceeceeeeeeceaeeeeeeeeceeessaueeeeseaeceese
10. job document history s click the job name in the list To delete one or more job history s check the box next to the Job Name and click delete icon To look for special job history s using Look For textbox and the drop down list to indicate the query condition or click Advance from the drop down list Search to do a more detailed search Job Name Status Failure Records R tye r Profile Start Time End Time C Benefit Booklet Customer Success 0 3 oenene Booklet Customer 2007 08 03 04 53 19 2007 08 03 04 54 25 C Benefit Booklet Customer Success 0 3 Benefits Booklet Customer 2007 07 11 01 31 21 2007 07 11 01 32 05 Document Sciences Corporation 56 Chapter 6 Job History See the following table for instructions on performing basic searches Job Name Select Job Name from the drop down box and type the name that you want to search for in the Look For box You can type a partial word in the Look For box and the search utility will return all jobs that contain that string In the example above typing the word auto enables the search utility to find Autopay Select Status from the drop down box and select one of the following items from the Look For box e Success e Success with failure records Failure SUCCES ETI Status wi H Success meee SUCCES with Failure recorda Failure E Records Failure Records Enter a positive integer to search for a job with a
11. p E A E A E E A E 52 Job History Detail Page sesissacsccceet accisdawach neste neacsncacdnacsssacveseee saatnengvovexeneouslsasietenns sede dsadestiavenenasdseeeseeiesers 54 TEACO TOODI orrera e E E E EE E E T E EE 55 Delete a Job from the History List ccccccccccssscceeceeeeeecceeeceeeseseeesseeseeeeeseeesseuseeesseeeesssaeseeeseeeeeeeaas 55 DCI Ol Me WOO ISOM ES o eae E E E A EEE sue aeeed 55 Time Format for Advanced Search xDashboard ccccccceeeecceeeeeeeeceeeeeseeeeeeeeeseaeeeeeeseeuaaeeeeesssaaeees 59 Document Sciences Corporation Welcome to the xDashboard Enterprise Edition User Guide This book shows you how to use xDashboard to create and administer jobs monitor your batch processes and keep track of your job history Boxes and Revision Bars The following colored boxes alert you to special information in the documentation Revision bars help you locate new or changed information Look for these revision bars in the right margin of each affected page Document Sciences Corporation Chapter 1 Introduction Solution Support For more information or to solve a problem contact Document Sciences Solution Support Telephone 760 602 1500 Fax 760 602 1515 World Wide Web http support docscience com E mail support docscience com Document Sciences Corporation xDashboard is a thin client application that enables you to run and administer the batch capabilities of xPression and manage
12. the xPression Server Figure 1 This le S figure shows NESS xPression Dashboard Job Management Job Management Jobs To add a new job definition click Add To delete one or more jobs check the box next to the job name and click Delete To copy one or more job definitions check the box next to the job definition name and click Copy To modify an existing job definition click the job name in the list Actions gt F 3 p Name Fj Autopay E CSET AP Simple E Simple You can access xDashboard by opening the following URL from a networked computer http lt xPression_Server_name_or_IP gt lt port_number gt xDashboard where lt xPression_Server_name_or_IP gt is the name or IP address of the xPression Server Document Sciences Corporation Chapter 2 Introduction to xDashboard and lt port_number gt is the http port for your xPression Server This port number is configured during installation To determine the value for this port number contact your xPression Server Administrator or see thexPression Enterprise Edition Installation Guide For example http xPressionServer 9081 xDashboard The default xDashboard page displays four tabs that enable you to access different areas of functionality The Job Management Page xDashboard displays the Job Management page Figure 1 on page 8 by default Job Management enables you to create job definitions and execute your batch jobs The job definition pages con
13. who live in a certain jurisdiction and have a specific group policy number The query tool enables you to qualify customers based on the values in specified fields in your data source Figure 22 Query Tool MF Add Query PRemove Query AND OR if Field Operation Value To create a query click Add Query The query tool options appear A basic query statement compares a field from the Primary table of your customer data source against a value that you define For example if you wanted to query for customers who reside in California you would compare the Jurisdiction field in your data source against the value CA as shown in Figure 23 Figure 23 Query Tool Options P Add Query Remove Query d _ AND OR le Field Operation _ Yale dD Oo Oo Jurisdiction x cA Oo This scenario Jurisdiction CA would submit only California customers for batch assembly in this job step Document Sciences Corporation 31 Chapter 3 Job Management You can create more complex query statements by adding additional lines to the query table and using the AND OR and Parenthesis functions The AND OR function joins one query statement to another Using AND tells xPression to extract customer records that satisfy both query statements The OR function tells xPression that it may select customer records that satisfy just one of the query statements The Parenthesis function groups yo
14. 1472834323224000103569561511000 shows further details To look over full information of job document history s click the triangle symbol next to the Customer Key click it again to hide the information To delete one or about your batch jobs more job document history s check the box next to the Customer Key and click delete icon Job Name Autops Start Time 2006 06 30 02 27 33 Total Record 1100 Job Run ID 1472834323224000103569561511000 End Time 2006 06 30 02 30 23 Success Record 375 A next last _ Customer Key DocumentName DataSourceName _ Status Step Name __ Step Type AUTOPAY_KEY 1 Automatic Payment Letter Autopaylk Success Stepi Assemble p E AUTOPAY_KEY 1 Automatic Payment Letter Autopay100 Success step2 Assemble gt Fi AUTOPAY_KEY 10 Automatic Payment Letter utopayik Success Stepi Assemble gt Fi AUTOPAY_KEY 10 Automatic Payment Letter Autopayl00 Success step2 Assemble AUTOPAY_KEY 100 Automatic Payment Letter Autopaylk Success Stepi Assemble AUTOPAY_KEY 100 Automatic Payment Letter Autopay100 Success step2 Assemble gt d AUTOPAY_KEY 1000 Automatic Payment Letter utopayik Success Stepi Assemble gt Fi AUTOPAY_KEY 101 Automatic Payment Letter Autopaylk Success Stepi Assemble AUTOPAY_KEY 102 Automatic Payment Letter Autopaylk Success Stepi Assemble p CL AUTOPAY_KEY 103 Automatic Payment Letter Autopaylk Failure Stepi Assemble E next last
15. All batch configuration work is done from The Job Management Page in xDashboard Document Sciences Corporation 14 Chapter 3 Job Management The Job Management Page The Job Management page appears by default when you log on to xDashboard To navigate to this page from another xDashboard page click the Job Management tab at the top of the page Figure 5 The Job X IRESSQION Help Logout Management page _ lists all existing job definitions Job Management Job Management Jobs To add a new job definition click Add To delete one or more jobs check the box next to the job name and click Delete To copy one or more job definitions check the box next to the job definition name and click Copy To modify an existing job definition click the job name in the list Actions E 5 gt docum ntsciences This page lists all existing job definitions From the Actions toolbar you can perform the following actions Add Button Enables you to create a new job definition After clicking Add xDashboard will display The Er Job Definition Page Creates a copy of any selected item To create a copy of an item select the checkbox next to that item and click Copy The copy will be identified as Copy 1 of xxxx Delete Deletes any selected item To delete an item select the checkbox next to the item and click Delete Printer Definition Name List TO edit the settings of an existing item click th
16. Batch Parameters Pre Processing Scripts Job Steps Post Processing Scripts Document Sciences Corporation Indicates what type of information will be collected for your job Statistics Collects only batch statistics such as start time end time and publish type Statistics with errors Collects all the statistics information and information about failed customer documents Statistics with details Collects all the statistics information and customer document information for all documents Select this option for information to appear on the Job History tab This information is displayed on the Job History tab after clicking the Job Name This box enables you to specify a string value that can be appended to your print file name batch log file name CompuSet log and CompuSet emitter log When creating your file names xPression enables you to add the batch parameter to your naming convention Each time you run batch from xDashboard while using the batch parameter xPression appends this string to the beginning of your CompuSet and emitter log files names This helps you locate all the log files for a particular batch run This section enables you to define scripts that will be executed by the xPRS Server prior to executing the batch process See Adding Pre and Post Processing Scripts to Your Job Definition for more information This section enables you to add job steps Each step identifies a set of documents you wa
17. Completed Work Items list The Completed Work Items list shows items for the selected category that have been modified by xPression Revise Select the document you want to add to the job definition 3 Finally select the customer data source Select the data source group and data source that contains the customer records you want to process xPression processes each record in the defined customer data source If you are using a relational database and want to process only a subset of records in the data source use the query tools Document Sciences Corporation 38 Chapter 3 Job Management Customer Data Source Use the Customer Data Source feature to query the completed work queue for the documents To use this feature you must store a list of document names in your data source Figure 33 Document Source Select the document category data Completed work Customer Data Source source group data source and the field Category Automatic Payment Letter iv re ali Grp document name Data Source SAUTOP AY XMIL na Mame ha hE iv Customer Keys SF Add parameter Customer Key Field Customer keys are fields in the current DataSource that will match the Customer Keys in the Completed Work queue Select the customer keys from the drop down list Figure 34 Document Source Ensure that the keys are added in the Completed work Customer Data Source order that will match Le ategary oe con A ls yy queue
18. Items next H Last Modified Thu Jun 10 2006 11 44 02 Ah Mame Customer Key Automatic Payment Letter next HH Customer Data Source Group Automatic Payment Letter Data Source Automatic Payment Letter kd Custom Documents enables you to select a document name in the following two ways ww p o Completed Work Enables you to select documents from the xRevise completed work queue Customer Data Enables you to query the completed work queue for documents Source Document Sciences Corporation 37 Chapter 3 Job Management Completed Work To select a document by name click Completed Work Figure 32 Document Source This page displays a list of completed Completed Work Customer Data Source work items for the selected category Category Automatic Payment Letter Completed Work Items next Name Customer Key Last Modified Automatic Payment Letter a Thu Jun 10 2006 11 44 02 4AM next E Customer Data Source Groupi Automatic Payment Letter Data Source Automatic Payment Letter To select a completed work item complete the following steps 1 First choose your category The category section contains a list of all available categories Select the category that contains your document When you select a category xPression fills the Completed Work ltems table with all of the completed work items for the selected category 2 Next select a document from the
19. N docum nt sciences xPression 3 xDashboard Enterprise Edition User Guide 2001 2008 by EMC Document Sciences Corporation All rights reserved The copyright protection claimed includes all formats of copyrightable material and information governed by current or future statutory or judicial law This includes without limitations any material generated by the software programs that display icons or other screen interfaces You may not copy or transmit any part of this document in electronic or printed format without the express written permission of Document Sciences Corporation xPression CompuSet and all other Document Sciences Corporation products mentioned in this publication are trademarks of Document Sciences Corporation For complete copyright information please see the file xPression Licensing Document pdf located on your eBook Library CD EMC Document Sciences Corporation 5958 Preistly Drive Carlsbad CA 92008 www docscience com Document Sciences Corporation Table of Contents O T ceicieca casas pndeinecisese cae ery oncesnien sents asmasetesrasaanacesnaaaenienssmaatinneueeocsamenmeeanecss 6 Boxes and SV ISOM Bars aecaccrsesiseenecencssacencaehre ecesedeseenecnaeniienoeciedeeepanceseoneuancceeaneuane da aaa a i aai aaia 6 SOUL UPPOO aar E E E E A E E A 7 introduction t0 Bi 1 9 ele ge sisir 8 The Job Management Page crc sccacsiiesescccustescnexcevisnaescueteveesscoedsalencade teaeaneqessenrapsadedtiewesece
20. Profile 2 0 0 0 cc ecccceeeeeeeeeeeeeeseeeeeeeeseeeeeeeseaeeeesaaeeeees 34 Queued Documents by Name cccccccsssseeececesesseceeeeenesseeeeeeeeaesseeceeesenseeceeeeeaneeeseeeeeneeceseeeaeeeeeeeaas 34 Job Steps for Previously Run Jobs scsiscsdcsecitedcedcasaietaneciaesbedeecarssuatduesaebns secperecieacacexeuieteneeseedeccuseuastecesseastesasereuee 35 Job Steps for Custom Documents ese cssectcctceesaciestenmncsestuccoseqamnenauteactcecoanncoseiaeyesqdesaaubocaastartesedadtobersdeneeteenceenteass 36 COMPIE GOIN OIK ernea a A E E O E 37 Customer Data Source sssacstenedeccsvnccenesaetutencdesisveddsiodasSacnedgiaundedienaestedenerenietesoncece eanddabacetiedenecesecextuxeseddies 38 JOD SLEDS TOI XERO PACKAGES siirre rain r ONF EE OTO OESE E A E 39 Assemble Job Steps for xPRS Packages ccccccsseecececeeeeeeeceuseeecceaseeeeaueceeseeaeeeeeeeaesessssageeeseeaaseeeesaneeeeesas 40 RCH Bath doD ssresisreniin a a ER a EEE EEA EEE ia eia SEa 40 Running Batch from xDashboard cccccceccceeceeeeeeeeeeeeeesaeeeeeeseeeeeeessaseeeseeeeeeeesaeeeeesseaeeessseeeessaeeeeeaas 41 Manually Composing or Editing Job Definitions 00 0 0 eccccccseeeceeeeeeeeeceeeeeeeeaeeeeeessaeseeeeseaeeeeseaeseeeesasseeeessaaseees 41 Oe NNO ceases ecco ee geen rem sateen meseatnmee recs seacedpaneeceueneseeusaentas 42 The xPression Job Monitor cccsincrercaedecsndcineesxceascnawnsantdiesunie sodcanciecisaeteicculsaieedep senuierstendeninaobencesesawtancus saudnew lt t
21. aaseeeseageeesseaaeessanaaaees 19 Adding Pre and Post Processing Scripts to Your Job Definition cccceecccseeeeeneeeeeeeeeeesaeeeeeseeeeenees 22 ADOULJOD IODS ee oe ee ae ee ee EE EEEE E OEE eee 23 Job Steps for xPression Documents ccccccccceeecceeaeeeeeeeseeeeeeeeeeeeeseeeeeeeseeeeeeeseeeeeesseseesseeaeeeesagseeesseaaeeeessaess 24 Assemble Job Steps for xPression Documents cccccccccceeeeeceeeeeaeeeeeeeeeeeeseeceeeeseeeeeeeeessesseeeeeessaeseeeeeseaeeses 26 The Document Source and Customer Data Source 0 ec ccecccceece eee eeeeeeeeeeeeeesaeeeeeeesaeeeeeeaeneeeesaaaaeees 26 Literal Using a Literal Value to Select Your Document ccccccsescceeeeeeeeeecaeeeeeeeeeeeeesaeseeeseneeeeeeas 27 Document Sciences Corporation Table of Contents Selecting the Document Name from a Data Source ccccecccccceeeeeeccaeeeeeeeeeeeeeeeaeeeeeesseaeeeeaeaeeeessaaeess 29 Selecting the Document Name By Trigger Data Source ccccccccccseseeeecaeeeeeeeaeeeeeeeueaeeeeeeeseeessaaeees 31 Job Steps for Queued Documents cceccccccceseseeeeeeeeeeeeeeeeeeseeeeeeeeceaeseeeeeseeeeeceeeseeeeeeeeeeseeaeeeeseeseaaeeeeessangeess 33 All Queued Documents with Stored Output Profiles 2 0 0 ececcceceseseeeeeeeeeeeeeeeeeseeeeeeeesesaaaaeeeeeseaaaees 34 All Queued Documents Overridden with Job s Output Profile cceeeecceeeeeeeee eects sees eeeeeeeeeeeeeeeeaaes 34 All Queued Documents with Matching Output
22. age The server management page enables you to administer the xPression Server Figure 4 This figure shows the Server Management Server Management View job output error statistics It is helpful to know state of current server clearly page Server Statistic Lock Management Concurrency Management Distribution Service Management Job Statistics Output Statistics Error Statistics First run time 2007 05 25 09 04 23 Processed customer data 0 Fatal error records 0 Latest run time 2007 05 25 09 04 23 Successful customer data 0 Doc level error records 0 Successful job runs 0 Failed customer data 0 Failed job runs 1 This page enables you to remove locks on documents that result from server communication interruptions view current xPression software usage view information about distributed documents and view server statistics For more information see Server Management Document Sciences Corporation Chapter 3 Job Management 3 This chapter details the functionality of xDashboard Job Management Job Management enables you to create and configure your xPression batch jobs Almost all settings for your batch job reside in a job definition More advanced settings reside in your BatchRunner Properties file For more information see the Enterprise Edition Batch Processing Guide What is Batch Running jobs in batch mode enables you to produce large volumes of personalized xPression documents in a single batch run You
23. ame as descriptive as possible but keep in mind that you will be referencing this name from batch scripts and shorter names are easier to work with you are processing xPresso documents you must choose xPublish Select your publisher type CompuSet and xPublish have slightly different job options If Output Profile Select the output profile that you want to associate with this job definition This output profile will apply to all the documents included in the batch run unless you are using queued documents which enables you to override it An output profile is a set of output streams each of which is associated with a format or printer definition and a distribution definition Output profiles for CompuSet and xPublish provide different features and are not interchangeable The only output profiles available to you from this list are those that match your publisher type Job Options DIF Diagnosis xPublish only This feature enables Document Sciences Solution Support to diagnose publishing problems It enables you to save the Device Independent Format DIF file a composed but unpublished xPression document to a file before sending it to the emitter DIFs are placed in the directory specified in the DIF Diagnosis Path The DIF saved in this path is named after the output profile name with a counter appended to the end Job Options Save to Creates the intermediate output required by job steps using Job Steps for Previously Run Inte
24. autdeantaaceds 42 Togo a cs eae er EEEE E E EEEE E E E EA EE E 43 Querying for Information About Your xPublish Batch JOD ccccccccccceeeeeeeeeeeseeeeeaeaaaaeeeeeseeeeeeeeeeeeeeeeeeeeeeeeees 43 MOWING IDOC Table TAnGIGS JOD SIOPS sgecrcocacesidanesorataatadssnanagtacgunctacteaegsteteaccusstanantguatttsantadstateendessiie 44 DOCUMEN E sath ce te te se etal a eles te dae Bete Mande eee baleacedtstectadadaate 44 Deleting Documents from the IDocTable 0 0 ceeccccccaeeeeeeeaeeeeeecaeeeeeesseeeeeeseeeeeeesaeseeesaeaeeessaeeeeeaeas 44 Disabling IDocTable Functionality c ceccccccseecceceeseeeecceeeceeeseeeeesaaeeceeeaeeseeessaeeeessuaeeesssaeeeesesneeesaas 44 Server ea SG apc rates eernets sees tee em cee een recaseeweunubae deeded ecendesenccuveauseaedesueees 45 oeer 2c 6 an oe neon eee en ee ee eee eee ee ee eee 46 EG VS NSIC sisareen na A Ea inion E E aAA EEE AE EN EEAS 47 Concurrency Management ccseeeecccceceeeeececeeceeeeeeceeeeseeeeeeeeeeseeeeeeeeseeeesceeeeeseeeeeeeeeseaeeeeeesseeseceeessaeaseeeeesaaas 48 Handing SCSSIOMN LME GUIS ca natcusinmtauteniantuel cmpauniitsesica EEE E 49 Distribution Service Management ccccsescceccseesceccenseeeceaecececsueeeeseeeuceesausseeesseueeessueaseeeseeeeessaaeeessaaaeeessaages 50 Queued Document Management Tab sicsiccsspecaceoenttocdacseccetecaaurkejadssceenetdeheqesssdedcdesnaceceadanessdeelicacsinnccele 51 Document Sciences Corporation 5 Table of Contents Oy UU
25. b Management At the top of the job step page you will see settings for Name Type and Document Type As for the job type there are several different job types to choose from and each type contains unique options and functions Supply a name for the Name box The name must be between 1 and 255 alphanumeric characters Type Assemble An Assemble job type should be used when you want to directly specify which documents you want to assemble This job type provides several methods for identifying your document e Directly specifying the document category name and data source e Retrieving the document name from a data source e Using a trigger file data source For more information see Assemble Job Steps for xPression Documents Type Queued Use the Queued Documents job type when you want to process documents that have already Documents been queued for batch by a transactional distribution request sent by xPression Response or any application built with xPression Framework For more information see Job Steps for Queued Documents Type Previously Run This option is only available for CompuSet job definitions You should use this job type if you are JobsPreviously Run merging intermediate output from a previous batch run Job For more information see Job Steps for Previously Run Jobs Type Custom Use Custom Documents when you want to pull completed work items from the xPression Revise Documents Completed Work queue or fro
26. b history s using Look For textbox and the drop down list to indicate the query condition or click 4dvance Search to do a more detailed search executed batch jobs first E prev next last Actions gt E Look For p in n Advanced Search Job Name Status Failure Records Records Output Profile Start Time End Time D Claims Failure 3 3 Claim Reimbursement 2007 05 25 09 04 23 2007 05 25 09 04 37 Job Run ID 1292557235915002933609010811000 Log File C xPressionfJob 1292557235915002933609010811000 loq Job Run Message Fail to publish for all documents please check the detail information E Autopay Success 0 3 Claim Reimbursement 2006 07 07 05 55 09 2007 07 07 05 58 31 Job Run ID 1006999623224003029010232511000 Log File C xPression 20060707Job 1006999623224003029010232511000 loq first BE prev next last The Job History details will not contain any information that was created or altered by a print script For example if your print script is designed to rename the output files generated by xPression the job history page will not show the updated names It will show the output file names as they were when they left the xPression system The Job History details will also not contain the output file name for CompuSet jobs Document Sciences Corporation 53 Chapter 6 Job History This page contains the following elements Job Name The Job name is the name of the job definition This information may appear on the Job
27. ce against a value that you define You can create more complex query statements by adding additional lines to the query table and using the AND OR and Parenthesis functions Document Sciences Corporation 33 Chapter 3 Job Management The AND OR function joins one query statement to another Using AND tells xPression to extract customer records that satisfy both query statements The OR function tells xPression that it may select customer records that satisfy just one of the query statements The Parenthesis function groups your query statements together so they are read as one statement For example 2 Select the Customer Data Source You also need to tell xPression which customer records you want to process Each customer record will be used to generate a personalized version of the document you selected above You can only use relational database RDB data sources for the customer data source Use the drop down lists to select a data source group and RDB data source that contains the customer records you want to process Figure 2 Customer Data Source Customer Data Source Group AUTOMATIC PAYMENT LETTER ae Dats Source xPression processes every customer record in the trigger data source in the order that they are presented in the trigger file Note When you run xPression Batch using multiple customer data sources we recommend that you turn on cache to improve performance In the xPressionCache propert
28. concerned about concurrent log on issues you can disable this feature by setting the timeouts timeout4 and timeout7 values in SessionControl properties to zero Distribution Service Management This section enables you to view all the jobs waiting in the batch queue All queued jobs reside in either the Mail Queue Print Queue or Archive Queue info table in your xPression database You can view the queued jobs in any of these tables Figure 43 Eee The Distribution Server Management Services The Distribution Service Management enables you to manage jobs that are distributed to mail print or archive management tab enables you to view jobs in the batch queue Server Statistic Lock Management Concurrency Management Distribution Service Management Job Name Job Run ID File Name Status To Address To view the queued jobs in one of the tables select the table from the View drop down box A list of queued jobs appears in the table You can delete or submit any jobs in the table Deletes the selected record from the output queue Updates the status of the selected record from PENDING or FAILED to READY The xPression distribution service will attempt to process and deliver all records with a READY status Document Sciences Corporation 51 Chapter 5 Server Management Queued Document Management Tab This section enables you to sort queued CompuSet documents by output profile and delete individual documents from t
29. cribed in this publication requires an applicable software license EMC2 EMC and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United State and other countries All other trademarks used herein are the property of their respective owners
30. e fully qualified path and filename of the intermediate output you want to merge into the current job The path you define here is the same path that you used when saving intermediate output from your previous job definitions Figure 30 Supply path and filename to intermediate output Mame Merge Job Step Type Previously Run Job iw l Source CYxPressionintermediateoutput Document Sciences Corporation 36 Chapter 3 Job Management 3 Click Save The job definition page shows the new job step Each job step can only contain a reference to one piece of intermediate output To merge in another intermediate output file create an additional job step using the same instructions 4 Next you must use an Assemble job step as the final job step for your Previously Run Job job definition The Assemble job step provides a key for merging the intermediate output from the previous documents into the final document Job Steps for Custom Documents This feature only works with xRevise documents For more information see the xRevise User Guide Custom documents are customized documents from the xPression Revise Completed Work queue You can add documents to your job step by selecting the name and category or you can query the document from the completed work queue by customer key Figure 31 This Document Source figure shows Custom Documents Completed Work Customer Data Source Category Completed Work
31. e item name Document Sciences Corporation 15 Chapter 3 Job Management The Job Definition Page The job definition page enables you to create and execute a job definition Add Pre Processing Script Command idd Step Type Figure 6 The job Job Management Add Job Definition definition page Suet tea Se ih tie a g To modify the job definitions general properties edit the information below then press the Save button when you are finished contains two sections General and Job Log Actions E Start F General COURE Pre Processing Scripts Name Type xPression Publish Job Steps Output Profile Benefits Booklet Customer Name Job Options _ DIF Diagnosis Post Processing Scripts Performance Parameters Name Thread Poal Size Customer Record Buffer Job Level statistics Batch Parameters Job Log display Add Post Processing Script Command The General section contains basic settings for your job definition such as name publisher output profile and job steps The Job Log section is collapsed by default Click display to see the Job Log options Figure 7 Job Log Job Log hide Section Job Log Path Preview Log File Name Error Threshold Job Log File Naming Conventions Order Function Literal Log Options C Append to Existing Log File Document Sciences Corporation MP Add Literal F Add Function 16 Chapter 3 Job Management This page a
32. e job definition An individual job step can select xPression documents or xPRS packages for the job definition Job steps for xPression documents can select xPublish and CompuSet documents created in xDesign Job steps for xPRS packages can include xPresso packages created in xPresso for InDesign xPresso for Dreamweaver and xPresso for Word and imported into your xPression enterprise edition server The options for xPression and xPRS job steps are different For xPression job steps see Job Steps for xPression Documents For xPRS job steps see Job Steps for xPRS Packages Document Sciences Corporation 24 Chapter 3 Job Management Job Steps for xPression Documents To access the job steps page click Add Step from the job steps section on the job definition page The job step options appear in the following pop up page Figure 14 The job step pop up page Step Details appears when you click Add Step from To modify the job definitions general properties edit the information below then press the Save the job steps section button when you are finished Name Type Assemble ka Document Type Pression Document Source f Literal Customer Data Source Trigger Data Source Category please choose category Document please choose document Customer Data Source Group please choose group Data Source please choose datasource Status Any Document Sciences Corporation 25 Chapter 3 Jo
33. eld in your data source Customer Data Source or you can use a trigger file Trigger File to define the document names e Literal Using a Literal Value to Select Your Document e Selecting the Document Name from a Data Source e Selecting the Document Name By Trigger Data Source You must also tell xPression which records in your customer data source you want to process you do this by defining the Customer Data Source You can define a data source table a trigger file or conditionally qualify specific records from a data source table The Customer Data Source options differ for each Document Source Document Source Method Available Customer Data Source Options Literal You must define a customer data source table that contains the customer records you want to process You can also define a trigger file to pre select a sub set of records in this table Customer Data Source The same data source you use to provide the document name will be used to provide xPression with customer records Document Sciences Corporation 21 Chapter 3 Job Management Document Source Method Available Customer Data Source Options Trigger Data Source Define a customer data source table that contains the customer records you want to process Literal Using a Literal Value to Select Your Document Use this option to select an individual document by name This limits your batch job to a single document type To create an Assemble Job Step using a li
34. ensure you select xPRS Document Sciences Corporation 40 Chapter 3 Job Management Assemble Job Steps for xPRS Packages An Assemble job steps enables you to directly select the category package name data source group and data source name To access the job step options for xPRS packages click Add Step from the Job Steps section of the Job Definition page and select xPRS in the Document Type list box This page shown in Figure 35 on page 39 contains the following elements Job jJobType Description D E a name for the Name box The name must be between 1 and 255 alphanumeric characters Type Assemble This job type enables you to directly select the category package name data source group and data source Document Type You can choose xPression or xPRS To create an xPRS package job step ensure you select xPRS Document Source Select the name of the category that contains the xPresso package you want to select Category Document Source Select the name of the xPresso package you want to define in this job step xPresso Packages Customer Data Select your Customer Data Source Group Now that you ve selected the document you need to Source Group tell xPression which customer records you want to process For each customer record that it processes xPression will generate a personalized version of the document you selected above Customer Data Select the name of the customer data source By default xPression proces
35. from a Data Source This option enables you to select the document name from a field in your customer data To use this option select Customer Data Source Figure 20 Document Source Selecting a document name C Literal Customer Data Source O Trigger Data Source from a data source L Group Data Source please choose dataSource Marne please choose field Status To create an Assemble Job Step using a data source to select your document name complete these steps 1 To use the Customer Data Source feature you must store a list of document names in your data source This section enables you to access the data source that contains the document name Figure 21 Document Source Select your Document Source CO Literal Customer Data Source O Trigger Data Source and Customer Data Dats Source please choose datasource Marne please choose field To enable xPression to select the document name identify the data source group the data source and the field which contains the list of your document names xPression will retrieve the document name from the specified field at assembly time By default xPression processes every customer record in the selected data source However if you select a relational database data source rdb you have the option of processing a smaller subset of customer records by querying the data source This option is not available for XML data sources For XML data sources xPression wi
36. gement This option also takes into consideration your output profile You have two options for controlling the output profile of the processed document ee Selects only those documents whose output profile matches the output profile associated with the job definition Override Selects ALL documents from the current batch queue and overrides the document output profile with the output profile associated with the job definition Select the document name from the Document Name drop down box and choose either Match or Override from the Match Override drop down box The Document Name list displays a list of all document names currently in your batch queue Job Steps for Previously Run Jobs Previously Run Job is a CompuSet only feature Previously run jobs are jobs that were intercepted by xPression before the final output was created This intermediate output is saved to a network location defined by the user The purpose of saving the intermediate output is to merge it with another batch job through the use of a Previously Run Job step A Previously Run Job step performs the sole action of merging intermediate output into your current job definition For instructions on configuring your Previously Run Job from beginning to end see the Enterprise Edition Batch Processing Guide To merge the intermediate output 1 Click Add Step to create a new job step 2 From the job step page select Previously Run Job from the Type list Supply th
37. he list This list shows all queued CompuSet documents by default To sort the list by output profile select the output profile from the View By OP drop down box This page contains the following elements Element Name Name Description View Se OP Select the a Profile for the CompuSet documents that you want to delete from the queue Select All to show all documents in the queue Delete Click this icon to delete the selected documents You must view each document that you want to delete before you can delete it boc ID The documents ID document s ID C Profile Name The name of the document s output aaa View Click this button to view the document You must view the document before you can delete it from the queue You must view a document before you can delete it To delete a document 1 Click View to review it in the viewer 2 Click Back to return to the Queued Document Management list when you have finished reviewing the document 3 Select the document checkbox and click Delete Document Sciences Corporation xPression enables you to view a detailed listing of recently executed batch jobs Click Job History tab to display the job history list Figure 44 The Job contains information To look over job history detail and its job document history s click the job name in the list To delete one or more job history s check the box next to the J about the recently Name and click delete icon To look for special jo
38. ick delete icon To look for special job history s using Look For textbox and the drop down list to indicate the query condition or click Advance Search to do a more detailed search iy dob Name JobName Status Failure Records Records Output Profile StartTime End Time Claims Failure 3 3 Claim Reimbursement 2007 05 25 09 04 23 2007 05 25 09 04 37 F ob 1292557235915002933609010811000 Fi utopay Success 0 3 Claim Reimbursement 2006 07 07 05 55 09 2007 07 07 05 58 31 251100 The job history page displays the following information e Job Name You can click the job name to see details of the batch job e Job Run ID The ID of the batch run e Job Run Message Displays error messages e Log File Displays the location of the job log file You can click this path to directly open the log file e Status Displays the final status of the job Success Failure or Success with failure records e Failure Records Displays the number of customer records that failed to produce output e Records Displays the total number of customer records that were processed e Output Profile Displays the name of the output profile e Start and End Time Displayed below each record this value shows the time the job was started and completed as recorded by the xPression Server For more information see Job History Document Sciences Corporation 11 Chapter 2 Introduction to xDashboard The Server Management P
39. ies file set CacheSwitch ON 3 The Status option enables you to limit the documents your job steps can produce based on their approved status Set the status option to Approved to qualify only items with a workflow status of approved Set the status option to Any to qualify content items of any status Select Any when you want to perform test assemblies or if you don t have a status field in your attribute set Job Steps for Queued Documents Use a Queued Documents job step to process output that has been queued for batch from a transactional distribution request sent by xResponse or any application built with xFramework Use this option by selecting Queued Documents from the Job Step Type list Document Sciences Corporation 34 Chapter 3 Job Management A Queued Documents job step may be used for both CompuSet and xPublish job definitions However xPublish job definitions provide one additional option not available to CompuSet Figure 28 This figure shows the Queued Documents job step options all Queued Documents overridden with Jobs Output Profile O All Gueued Documents with stored Output Profiles O All Gueued Documents with Matching Output Profile CO Queved Documents by Mame You can select from the four options for processing queued documents xPression uses your selection to choose documents of the proper type from the queue All Queued Documents with Stored Output Profiles This option instructs xPre
40. ing the DocInfoSystem setting in Batchrunner properties Document Sciences Corporation Chapter 5 Server Management 5 Server Management enables you to remove locks on documents that result from server communication interruptions view current xPression software usage view information about distributed documents and view server Statistics To access Server Management click the Server Management tab from xDashboard Figure 38 The Server Management server management page enables you to View job output error statistics It is helpful to know state of current server clearly administer the X Pression Server Server Statistic Lock Management Concurrency Management Distribution Service Management Job Statistics Output Statistics Error Statistics First run time 2007 05 25 09 04 23 Processed customer data 0 Fatal error records 0 Latest run time 2007 05 25 09 04 23 Successful customer data 0 Doc level error records 0 Successful job runs 0 Failed customer data 0 Failed job runs 1 The Server Management page contains four tabs Server Statistic Displays statistics for your jobs output and errors See Server Statistics for more information Lock Management Enables you to remove locks that result from server communication errors See Lock Management for more information Concurrency Management Displays the concurrent usage of the software by the number of seats used for any application See Concurrency Managemen
41. ions for processing a batch job and an output profile for distributing the job It may also contain the status of your instructions for merging jobs Select the links below or the left hand menu to navigate the tasks you wish to complete batch jobs Job Name Job Run ID Start Time Current Step Autopay 1426090952240054224671615110000 2006 06 29 02 47 22 Step 1 Stepl O T The job monitor page contains the following information about current jobs running on your system Job Name The name of the job definition Job Run ID The system generated job run ID Start Time The date and time when the job started Current Step The current job step being executed the job step name and the percentage complete Document Sciences Corporation 43 Chapter 4 Job Monitor Toggle Statistics To see more in depth details click the toggle button located in the far left column When activated xPression will display all of the job steps scheduled in the batch run and the percentage complete of each Figure 37 Click the Jab Monitor toggle button to see NAIR ENAER Da more details job definition contains the instructions for processing a batch job and an output profile for distributing the job It may also contain instructions for merging jobs Select the links below or the left hand menu to navigate the tasks you wish to complete m gt Autopay 1428090932240054224671615110000 2006 06 29 02 47 22 Step 1 Stepi 1 i Step 1 Stepi
42. ll process every customer in the data source Document Sciences Corporation 30 Chapter 3 Job Management Passing a customer data file to xPression Batch differs from the trigger file approach in that instead of pointing to your data you re actually sending xPression all of the customer data necessary to produce your documents Relational databases allow you to query the data in order to know which records to process Queries can be valuable if you process renewals or other events driven by the contents of your customer data If you don t provide a query for relational database input xPression Batch processes the entire contents of the primary table See Querying an RDB Customer Data Source for more information 2 Filter Documents by Status The Status option enables you to limit the documents your job steps can produce based on their approved status Set the status option to Approved to qualify only items with a workflow status of approved Set the status option to Any to qualify content items of any status Select Any when you want to perform test assemblies or if you don t have a status field in your attribute set When you complete your Assemble Job Step click Save to save your changes Querying an RDB Customer Data Source The query tool enables you to conditionally extract a set of customer records from your data source for processing by the xPression batch run For example you may want to print only those customers
43. lso contains an Actions toolbar that enables you to perform the following actions for the current job definition Save Button The Save button saves the new job definition Cancel Button The Cancel button cancels the creation of the new job definition This button closes the job definition page without saving your changes and returns you to the Job Management page The Start button executes the current job definition Please see Running a Batch Job for more information about running a batch job Job Definition The General Section The general section of the job definition page contains basic information about your job definition Figure 8 The General section of Job Management Add Job Definition the Job Definition To modify the job definitions general properties edit the information below then press the Save button when you are finished page General ie Pre Processing Scripts PAdd Pre Processing Script amei Name Command Type xPression Publish 4 Job Steps aAdd Step Output Profile Benefits Booklet Customer Name Type Job Options DIF Diagnosis Post Processing Scripts PAdd Post Processing Script Performance Name Command Parameters Thread Pool Size Customer Record Buffer Job Level Batch Parameters Job Log display Document Sciences Corporation 17 Chapter 3 Job Management The general section contains the following options Type a 1 255 alphanumeric job name Make the n
44. m a field in a data source and add personalization data to each The data must be provided in a trigger file and is restricted to a single record of information for each customer For more information see Job Steps for Custom Documents Document Type You can choose xPression and xPRS To create an xPression document job step ensure you select xPression Document Sciences Corporation 26 Chapter 3 Job Management Assemble Job Steps for xPression Documents The two main components of an assemble job is the document source and a customer data source Figure 15 This figure shows the Document Source Literal and Customer Data Source options inan roupi please choose group w Assemble Job Step Date Source please choose dataSource v Harrie Document Source OQ Customer Data Source 5 Trigger Data Source flease choose field Customer Data Source Group please choose group Bi Data Source please choose dataSource The document source provides xPression with the name and location of the document you want to process The customer data source enables xPression to associate your document with data The Document Source and Customer Data Source The Document Source enables you to select the documents for your job You can select documents for the job step in three ways you can select from a list of existing documents Literal you can pass the document name to xPression from a fi
45. nitions The easiest way to manually create a job definition is to use xDashboard to create a simple sample job definition export it with xAdmin and use the Job Definition XML file located in the exported pdpx file To manually create a job definition ss Log on to xDashboard Create a job definition See The Job Definition Page for more information Save the job definition after adding a job step Log on to xAdmin Click Migration Utilities Click Export From the export list select job definition From the Available Job Def list select the sample job definition you created and click Add O ono M e 2 bP Clear the Include Output Profile checkbox O Set the PDP path to a directory and file name of your choice Click Start Locate the exported PDPX file and open it Inside the PDPX you will find an XML file with the following naming convention lt job_definition _name gt XML This is the job definition XML file You can use this file as a baseline for creating your own job definition file meek MD gt Document Sciences Corporation This chapter introduces you to the xPression Job Monitor The Job Monitor enables you to view details about active batch jobs The xPression Job Monitor To access the xPression Job Monitor start xDashboard and click the Job Monitor tab at the top of the page Figure 36 The Job Monitor displays Job Monitor information about 4 job definition contains the instruct
46. nt included in the batch run Choose the type of batch job the document source and the data source Job steps allow you to execute multiple document sources at once See About Job Steps This section enables you to define scripts that will be executed by the xPRS Server after the batch process completes See Adding Pre and Post Processing Scripts to Your Job Definition for more information 19 Chapter 3 Job Management Job Definition The Job Log Section The job log section enables you to create a job log for the current job definition and to set the error threshold for the job Figure 9 A job log Job Log hide provides information about the errors Ioh Log PAD Preview Log File Name generated during Error Threshold Job Log File Naming Conventions Add Literal Add Function your batch run Log Options Append to Existing Log File Order Function Literal From this screen you can define the following elements Job Log Path Specify the name and path where you want xPression to save your error logs By default xPression saves error logs to C xPression Error Threshold Enables you to set the xPression error threshold level for your batch job xPression will abort the batch run if the batch job generates more errors than defined here Log Options Append to Existing Log File xPression can either append new errors to an existing error log or overwrite the old log with the new errors Select this option to append er
47. ommand xPression creates a new row in the section This row enables you to specify a name for the script the script path and parameters and enables to you remove the script reference from the job definition In the Name box supply an identifying name for the parameter 4 Inthe Command box supply the command to execute the script This command should contain the path script filename and needed parameters For example C startup bat log true path C startuplog log Document Sciences Corporation 23 Chapter 3 Job Management 5 To add another script click Add Pre Processing Script or Add Post Processing Script When finished click Save The following image shows a sample of how your definition might look Figure 13 To define a script Pre Processing Scripts Midd Pre Processing Script supply a name for Rents pit ies the script and Start up Ci startup bat log true command j Server path C startuplog lag T clean Cuol exe screen T Send email ci email ad email email cam Job Steps hidd Step Name Type T First assemble step Assemble Post Processing Scripts hidd Post Processing Script Name Command T Stop server Cif stop bat app xPression T Clean screen Ciffcls exe About Job Steps A job definition must contain one or more job steps A job step selects documents and defines customer data for your job definition You can use multiple job steps to select different types of documents and publish them in the sam
48. ration 21 Chapter 3 Job Management When you click Save xPression concatenates these literal values into the following single literal definition Report_Receipts_October The Add Function button enables you to name your job log using the job ID job name the BatchParameter or the current date Figure 11 Select Job Log hide the function that you want to use in your job name Error Threshold Job Log File Naming Conventions MF Add Literal F Add Function Job Log Path Preview Log File Name log Log Options Fi Append to Existing Log File From this section you can add the following elements Current Job ID Adds the Job ID to the job log name Current Job Name Adds the name of the job definition to the job log name BatchParameter The BatchParameter enables you to add an identifier to your log files This identifier helps you identify output files for a particular job This is especially helpful when output from more than one job resides in the same directory When you select the BatchParameter function xPression will add the BatchParameter value to the job log name The BatchParameter value is set at the time the batch job is executed from the command line For more information about setting the BatchParameter values please see Job Definition The General Section When you use the BatchParameter in your job log name xPression also appends the parameter to the beginning of your CompuSet and emitter log files Thi
49. ression returns the seat to the pool for use by another user lf communication between the user s computer and the server is interrupted during a session either the computer or server stops responding a licensed seat could hang up and be unavailable for use Document Sciences Corporation 49 Chapter 5 Server Management The Concurrency Management tab enables you to free a hung up license to view at a glance what xPression components you have licensed and to see how many seats are in use for each application Figure 41 Ge Coe ene Server Management Management tab View concurrent usage of the software View the current number of seats used for any application enables you to manage your Lock Management Concurrency Management Distribution Service Management Server Statistic licensed seats Application YY Seats In Use Uy Seats Available fA xPression Design 0 Pression Response 0 xPression Revise 1 User Application Session ID d Fri Jun 30 09 42 22 PDT 2006 xpression xPression Revise 9502 The Concurrency Management page displays a list of installed applications and identifies the seats in use and seats available for each application Figure 42 This tab Lock Management Concurrency Management Distribution Service Management Server Statistic shows seats available for e Application Seats In Use Seats Available application EZ La Z Pression Design 0 xPression Response 0 xPression Revise
50. rmediate Output only Jobs You can specify the location where the intermediate output should be saved If the output profile you choose produces only HTML xPression won t produce intermediate output Job Options Save Saves CompuSet tagged text to the location of your choice Tagged text can be used to CompuSet tagged text verify that the CompuSet publishing engine is functioning properly Use this option only for troubleshooting your output Job Options Override the This feature is for highly specialized situations where a user may want to override the OP Setup File default OP Setup file created by xPression The OP setup file defines the master page group template describes the sort order objects and designates OP fields as merge keys It also contains commands that define the tasks to be performed by Output Processing xPression automatically generates the OP setup file To override this file select this option and type the fully qualified path and file name for the override file in the provided box Document Sciences Corporation 18 Chapter 3 Job Management Defines the number of worker threads available for each batch run The Customer Data Reader and xPression Assembly components of the batch process use this setting to Thread Pool Size distribute customer records across parallel threads to improve performance Customer Record Buffer Number of customer records the main batch thread reads in at a time Job Level
51. rors to the existing log Job Log File Naming Build your error log naming convention using the options in this section You can type a Conventions literal name for the log by clicking the Add Literal button and add a built in function by clicking the Add Function button For a full explanation of error log naming see Job Log File Naming Conventions xPression provides a preview of your error log name above the Job Log File Naming Conventions table Error logs are automatically given a log extension Job Log File Naming Conventions Use one or both of the following options to create a method for naming your job log A preview of your job log appears at the top of the job file naming table You can manually type a name for your error log by clicking Add Literal and typing the name in the provided box Figure 10 Type Job Log hide your literal value in the provided box ILE Pays Preview Log File Name Error Threshold Job Log File Naming Conventions MP Add Literal F Add Function CSA O C Append to Existing Log File Order Tuncuon Literal t Document Sciences Corporation 20 Chapter 3 Job Management If you create a job log file name using two or more consecutive literals xPression will combine those literal definitions into a single literal definition when you click Save For example if you create a job log file name using three separate literals as follows Report_ Receipts_ October Document Sciences Corpo
52. s makes it very easy to locate all of the job files for a particular batch run Date Adds the current date to the job log name Use the up and down arrows to move the selected item up or down in the list Items at the top of the list appear first in the job file name and items at the bottom appear last Document Sciences Corporation 22 Chapter 3 Job Management Adding Pre and Post Processing Scripts to Your Job Definition xPression enables you to define a set of pre processing and post processing scripts to be run either before or after your batch job For example you could create a pre processing script to clear the screen before the job is executed or create a post processing script to send emails notifying personnel that the batch job has completed You can define more than one script in the pre processing and post processing sections Note If the path for your script contains spaces in it you must place the script in quotes To add a Pre or Post Processing Script 1 Create a new job definition or click a job definition name from the Job Definition List page 2 Inthe Pre Processing or Post Processing section click Add Pre Processing Script or Add Post Processing Script Figure 12 To define a script Pre Processing Scripts idd Pre Processing Script supply a name for Name Command the script and command 7 Job Steps Name Type Post Processing Scripts kidd Post Processing Script Name C
53. ses every record in Source Data Source the selected data source Running a Batch Job xPression s batch function is a Java application that is provided as a set of Java classes anda platform specific executable command called BatchRunner You can execute a batch run in a number of ways e BatchRunner operations can be scheduled with your operating system s scheduling tool e You can use xDashboard to run an immediate batch job Document Sciences Corporation 41 Chapter 3 Job Management e You can execute an immediate batch job from the command line For instructions on running batch from the command line see the Enterprise Edition Batch Processing Guide Note Batch e mail jobs can be run from Windows DOS or UNIX batch or shell scripts If a CompuSet PDF batch job encounters an e mail recipient whose e mail address To variable is missing the job fails and does not identify the record that had the missing e mail address If an xPublish job encounters the same situation and fails the log will indicate the bad record Running Batch from xDashboard To run a batch job from xDashboard simply access the job definition page for the job you want to process If you have just created your job definition and job steps you must save your job definition after you have created your job step To start the job click Start View your batch logs and the xPression log file to check for errors Manually Composing or Editing Job Defi
54. specific number of failure records For example if you want to search for a job with 10 failure records enter 10 in the Look For box Document Sciences Corporation 57 Chapter 6 Job History Advanced Search Click Advanced Search to perform a search with a greater level detail The Advanced Search feature appears in a pop up window Figure 47 The Advanced Search Advanced Search window enables you to define more Switch the Search Scope and input proper condition to do 4 advance search advanced search Advanced Search criteria Search Scope Job Level Document Level Job Name Job Run ID Failure Records Status all ina Start Time Between S and 5 End Time Between 5 and O E You can perform a Job Level search with any combination of the following criteria e Job Name e Job Run ID e Failure Records e Status e Start Time e End Time Document Sciences Corporation Chapter 6 Job History You can also perform Document Level searches Figure 48 The Document Level Advanced Search Advanced Search l window contains Switch the Search Scope and input proper condition to do a advance search document related Advanced Search options to define your search criteria Search Scope Job Level G Document Level Job Name Job Run ID Document Name lustamer key Output Profile Publish Type all iw DataSource Mamei Output Filename Status all iw S
55. ssion to process all the queued documents using the output profile that they were Originally queued with and not the output profile defined in the job definition If you select this option this step must be the only step in the job this option cannot exist in a job with other steps All Queued Documents Overridden with Job s Output Profile This option instructs xPression to process all the queued documents using the output profile defined in the job definition This option overrides the output profile originally saved with the document All Queued Documents with Matching Output Profile This option instructs xPression to process only queued documents whose output profile matches the output profile you associated with the job For example if you defined an output profile in your job definition named AFP Printer this option will only process documents from your batch queue that were originally saved in the queue with the AFP Printer output profile Queued Documents by Name This option is only available for xPublish jobs and selects documents by name from the current batch queue When you use this option xPression processes queued documents whose document name matches the document name you define in the Documents by Name table Figure 29 The Documents by Name Documents by Name section Document Name Match Override Output Profile Automatic Payment Letter Match w Document Sciences Corporation 35 Chapter 3 Job Mana
56. t Trigger Data Source to use this option Figure 24 Trigger Document Source Data Source O Literal O Customer Data Source Trigger Data Source Groups please choose group wt Data Source please choose datasource a Narre please choose field Customer Data Source Group please choose group wt Data Source please choose dataSource Status ny kal To select documents with a trigger data source complete the following steps 1 Select the data source group the data source and the data source field that contains the document name Figure 25 Select your document with a Trigger Data O Literal DO Customer Data Source E Trigger Data Source Source Group please choose group Data Sources please choose datasource W Name please choose field Document Source If you are using a relational database as the trigger data source you can use the query tool to select and process a subset of document names in the trigger data source The query tool enables you to conditionally extract a set of records from your trigger data source for processing by the xPression batch run The query tool enables you to qualify records based on the values in specified fields in your data source Figure 26 Query Tool dh Add Query MRemove Quer Operation To create a query click Add Query The query tool options appear A basic query statement compares a field from the Primary table of your trigger data sour
57. t for more information Document Sciences Corporation 46 Chapter 5 Server Management Distribution Service Enables you to view the email print and archive distribution tables in your xPression Management database See Distribution Service Management for more information Server Statistics You can view Server Statistics by clicking the Server Statistics tab Figure 39 The Server Statistics tab Server Management displays job output text here and error statistics Lock Management Concurrency Management Distribution Service Management Server Statistic Job Statistics Output Statistics Error Statistics First run time 2006 06 30 02 27 33 Processed customer data 1100 Fatal error records 125 Latest run time 2006 06 30 02 27 33 Sucessed customer data 975 Doc level error records 0 Sucessed job run 0 Failed customer data 125 Failed job run 0 w documentsciences The Server Statistics tab displays three sections of server statistics Job Statistics First run time The time of the first job run on during the life of the server Latest run time The date and time of the most recent job run on the server Successful job runs The number of job runs that completed successfully Failed job runs The number of failed job runs Document Sciences Corporation 47 Chapter 5 Server Management Output Statistics Processed customer data The number of customer records processed during the life of the
58. tain settings for your input data source output profile document personalization and job logging For complete details about Job Management see Job Management The Job Monitor Page The job monitor page contains information about current jobs running on your system Figure 2 This figure shows the Job Job Monitor Monitor page 4 job definition contains the instructions for processing a batch job and an output profile for distributing the job It may also contain instructions for merging jobs Select the links below or the left hand menu to navigate the tasks you wish to complete Job Name Job Run ID Start Time Current Step gt Autopay 1428090932240054224671615110000 2006 06 29 02 47 22 step Ie Stepi 0 So Jobs are listed by job name and contain the following information e Job Run ID The ID of the batch run e Start Time Displays the time the job was started as recorded by the xPression Server e Current Step Displays the current status of the job For more information see Job Monitor Document Sciences Corporation 10 Chapter 2 Introduction to xDashboard The Job History Page The job history page contains a searchable list of previously run batch jobs Figure 3 This figure shows the Job History page Job History List To look over job history detail and its job document history s click the job name in the list To delete one or more job history s check the box next to the Job Name and cl
59. tart Time Between E and oOo O End Time Between 4 and Ss B You can perform a Document Level search with any combination of the following criteria e Job Name e Job Run ID e Document Name e Customer Key e Output Profile e Publish Type e DataSource Name e Output Filename e Status e Start Time e End Time Document Sciences Corporation 59 Chapter 6 Job History Time Format for Advanced Search xDashboard The Start and End time fields in the xDashboard Advanced Search interface uses the 24 hour time format The 24 hour time format also called military time and international time expresses the time of day without reference to AM or PM For example four o clock in the morning is 4 00 but four o clock in the afternoon is 16 00 So to search a range of time between four o clock in the morning and four o clock in the afternoon select 4 00 to 16 00 Document Sciences Corporation 2011 2013 EMC Corporation All Rights Reserved EMC believes the information in this publication is accurate as of its publication date The information is subject to change without notice THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE Use copying and distribution of any EMC software des
60. te a job definition you must configure three main components General Information Describes the basic settings for the job definition such as job name choice of publisher output profile job options and batch parameters You define these settings on the job definition page in The Job Definition Page Job Step s Identifies the type of batch process you are running the documents you want to process and the data source you want to use in the process You define these settings on the job steps page Job Log Settings Enables you to configure the logging process for the batch job You define these settings in Job Definition The Job Log Section How to Customize Batch Reports and Batch Logs Job definitions can be created through Job Management or composed manually using a text or XML editor Job definitions generated by Job Management are stored in the xPression database Manually composed job definitions are stored on your file system as an XML file To learn more about creating job definitions see The Job Definition Page CompuSet and xPublish Job Definitions The Job Management page handles job definitions for both CompuSet and xPublish documents When creating a job definition you can identify the job as a CompuSet or xPublish job Ensure you pay close attention to this designation as CompuSet and xPublish job definitions are not interchangeable and only documents that match the job type will be available in Job Management
61. teral value for document selection select Literal from the Document Source section and complete these steps i Select your Document Source When using the Literal method you specify an exact document by name From the drop down lists select the category where the document resides then select the document name Figure 16 Select your Document Source Literal 5O Customer Data Source O Trigger Data Source Category Automatic Payment Letter w Document Automatic Payment Letter wt Document Source Select your Customer Data Source Now that you ve selected the document you need to tell xPression which customer records you want to process For each customer record that it processes xPression will generate a personalized version of the document you selected above Use the drop down lists to select the data source and data source group that contains the customer records you want to process Figure 17 Select Customer Data Source your Customer Data Data Source AUTOR 4h yt By default xPression processes every customer record in the selected data source However if you select a relational database data source rdb you have the option of processing a smaller subset of customer records by querying the data source This option is not available for XML data sources For XML data sources xPression will process every customer in the data source See Querying an RDB Customer Data Source for more information Filter Documen
62. thout error If an error occurs details will appear in the Error field If an error occurs the exception message is recorded in this field Otherwise this field is blank xPression begins writing information to the IDocTable when a task to process a document is identified These tasks are generated by Assemble Queued Documents and Custom Documents How the IDocTable Handles Job Steps Queued documents are identified in the CustomerKeys field by the queue ID in the following format PQAssemb1edID n where n is the queue ID Queued documents will not be deleted from the queue in the event of a document error Document Failure If you receive a fatal error in a batch job you must assume that all documents in the batch job are bad because it may not be possible to determine which documents successfully completed and which documents were not fully completed Deleting Documents from the IDocTable You can delete documents from the IDocTable by deleting the job that contains the documents from xDashboard Disabling IDocTable Functionality You can prevent xPression from writing information to the IDocTable by disabling the DocTable functionality To disable this functionality set the DoclInfoSystem property in the batchrunner properties file to OFF DocInfoSystem of f You can still delete document entries from the Job History page with the IDocTable functionality disabled You do not have to restart the xPression Server when chang
63. ts by Status The Status option enables you to limit the documents your job steps can produce based on their approved status Set the status option to Approved to qualify only items with a workflow status of approved Document Sciences Corporation 28 Chapter 3 Job Management Set the status option to Any to qualify content items of any status Select Any when you want to perform test assemblies or if you don t have a status field in your attribute set When finished making your selections click Save to save your changes Querying an RDB Customer Data Source The query tool enables you to conditionally extract a set of customer records from your data source for processing by the xPression batch run For example you may want to print only those customers who live in a certain jurisdiction and have a specific group policy number The query tool enables you to qualify customers based on the values in specified fields in your data source Figure 18 Query Tool Add Query Remove Query a AND OR Cc Field Operation alue h To create a query click Add Query The query tool options appear A basic query statement compares a field from the Primary table of your customer data source against a value that you define For example if you wanted to query for customers who reside in California you would compare the Jurisdiction field in your data source against the value CA as shown below Figure 19 Query
64. ur query statements together so they are read as one statement For example JURISDICTION CALIFORNIA or JURISDICTION NEVADA and POLICY_TYPE LIFE This query statement tells xPression that qualifying customer records must have a Life policy and must reside in either California or Nevada jurisdictions If parenthesis were not used the query statements would evaluate differently because xPression would not know if the OR operator applies to the Jurisdiction statement or to the Jurisdiction and Policy_ Type statements In the latter case xPression would incorrectly return all records from the California jurisdiction regardless of Policy_ Type and all Life policies from Nevada Selecting the Document Name By Trigger Data Source You can generate a batch job by passing through the names of documents in a trigger data source A trigger data source enables you to draw your document names from a data source that is separate from your customer data Source Trigger data sources enable you to use xPression to produce many different document types from many different categories as long as all the categories use the same data source group When using an XML trigger data source xPression reads data from start to finish processing records in the order in which they appear in the file To view a sample XML trigger file see the Enterprise Edition Batch Processing Guide Document Sciences Corporation Chapter 3 Job Management Selec
65. using an xPression client application Be extremely cautious when you unlock content and resources Document Sciences Corporation 48 Chapter 5 Server Management To view the list of locked documents click the Lock Management tab Figure 40 TheLock Server Management Management tab l View job output error statistics It is helpful to know state of current server clearly enables you to view the list of locked Server Statistic Lock Management Concurrency Management Distribution Service Management documents Job Statistics Output Statistics Error Statistics First run time 2007 05 25 09 04 23 Processed customer data 0 Fatal error records 0 Latest run time 2007 05 25 09 04 23 Successful customer data 0 Doc level error records 0 Successful job runs 0 Failed customer data 0 Failed job runs 1 To unlock a resource select the check box next to the name of the item you want to unlock and click the Unlock button To unlock all documents in the list click the Select All button and then click Unlock Concurrency Management Your xPression license agreement grants you a certain number of seats for the server for xPression batch capabilities and for client applications such as xDesign and xResponse When a user logs on to a client application xPression validates that a seat is available for use If a seat is available the authentication process passes a call to remove one of the available seats When the user logs off xP

xDashboard Enterprise Edition User Guide Build 39

Contents

Download Pdf Manuals

Related Search

Related Contents