ApplicationXtender Reports Management Extract Definition Script (XDS) 5.30 Quick Reference EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com
Copyright 1994-2005 EMC Corporation. All rights reserved. Printed November 2005 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 described in this publication requires an applicable software license. Portions of the software are copyrighted by Verity, Inc. 1988-2005. Powered by ABBYY FineReader. ABBYY FineReader OCR 1993-2005 by ABBYY Software House. All rights reserved. ABBYY, FineReader are trademarks of ABBYY Software House. Adobe, Acrobat and the Acrobat logo are trademarks of Adobe Systems Incorporated. Includes Adobe PDF Library technology. Portions contain an implementation of the LZW algorithm licensed under U.S. Patent 4,558,002. Trademark Information EMC 2, EMC, EMC ControlCenter, AlphaStor, ApplicationXtender, Catalog Solution, Celerra, CentraStar, CLARalert, CLARiiON, ClientPak, Connectrix, Co-StandbyServer, Dantz, Direct Matrix Architecture, DiskXtender, Documentum, EmailXtender, EmailXtract, HighRoad, Legato, Legato NetWorker, Navisphere, OpenScale, PowerPath, RepliStor, ResourcePak, Retrospect, Smarts, SnapShotServer, SnapView/IP, SRDF, Symmetrix, TimeFinder, VisualSAN, VSAM Assist, Xtender, Xtender Solutions, and where information lives are registered trademarks and EMC Developers Program, EMC OnCourse, EMC Proven, EMC Snap, EMC Storage Administrator, Access Logix, ArchiveXtender, Authentic Problems, Automated Resource Manager, AutoStart, AutoSwap, AVALONidm, C-Clip, Celerra Replicator, Centera, CLARevent, Codebook Correlation Technology, Common Information Model, CopyCross, CopyPoint, DatabaseXtender, Direct Matrix, DiskXtender 2000, EDM, E-Lab, EmailXaminer, Enginuity, eroom, FarPoint, FLARE, FullTime, Graphic Visualization, InfoMover, Invista, MirrorView, NetWin, NetWorker, OnAlert, Powerlink, PowerSnap, RepliCare, SafeLine, SAN Advisor, SAN Copy, SAN Manager, SDMS, SnapImage, SnapSure, SnapView, StorageScope, SupportMate, SymmAPI, SymmEnabler, Symmetrix DMX, UltraPoint, Viewlets, VisualSRM, and ApplicationXtender Web Access are trademarks of EMC Corporation. All other trademarks used herein are the property of their respective owners. 2 2
Contents ApplicationXtender Reports Management Extract Definition Script Quick Reference...4 Creating a Procedure for a Report Type...4 Editing a Procedure...4 Displaying AppXtender Reports Management XDS Visual Tester for a Report Type...4 Displaying AppXtender Reports Management XDS Visual Tester for a Failed Report...5 Testing the Processing of a Report...6 AppXtender Reports Management XDS Instruction Syntax.7 AppXtender Reports Management XDS Instructions...8 3
ApplicationXtender Reports Management Extract Definition Script Quick Reference This card is designed to provide quick reference and setup information for ApplicationXtender Reports Management Extract Definition Script (AppXtender Reports Management XDS) to experienced administrators and is not intended to take the place of the ApplicationXtender Reports Management Administrator s Guide. For more information about XDS scripting in AppXtender Reports Management, see the ApplicationXtender Reports Management Scripting User s Guide and the XDS Reference Online Help. Creating a Procedure for a Report Type 1. Expand the Report Types node. Right-click the report type for which you want to create a procedure. Select Start Update. 2. Expand the report type's node. Right-click Procedures. Select New Procedure. 3. When you have completed the procedure, click Finish. 4. Right-click the report type to which the new procedure belongs. Select Accept Changes. Editing a Procedure 1. Expand the Report Types node. Right-click the report type for which you want to edit a procedure. Select Start Update. 2. Expand the report type's node. Select the Procedures node. From the list of procedures on the right, right-click the procedure that you want to edit. Select Properties. 3. When you have completed your changes, click OK. 4. Right-click the report type to which the new procedure belongs. Select Accept Changes. Displaying AppXtender Reports Management XDS Visual Tester for a Report Type 1. Expand the Report Types node. Select the report type for which you want to start AppXtender Reports Management XDS Visual Tester. 2. Make sure that a sample report file and at least one extraction procedure have been configured for the report type. 4 4
3. Right-click the report type. Select View and then select Visual Tester. Displaying AppXtender Reports Management XDS Visual Tester for a Failed Report 1. Expand the Report Processors node, the Local Computer node, and then the Logs node. Select the Failed Reports node. 2. Right-click the log for which you want to start AppXtender Reports Management XDS Visual Tester. Select Run Visual Tester. Table 1 AppXtender Reports Management XDS Visual Test Buttons and Shortcuts Button Shortcut Key Start prepares the Visual Tester to start testing. <F5> Indexing tests the indexing process for current page. <F9> Run to End runs testing to the end of the report. Pause pauses the Visual Tester s testing of procedures. <CTRL + BREAK> Next Page moves the testing to the next page. <F10> Run to Page runs testing to the specified page. Stop stops the testing and returns the Visual Tester to initial state. Extract Page tests the extraction process for the current page. <F7> Run to Line runs testing to the specified line. 5
Table 1 AppXtender Reports Management XDS Visual Test Buttons and Shortcuts Button Shortcut Key Next Step tests the next step (the next instruction). <F8> Skip Instruction skips testing of the next instruction. <SHIFT+F8> Help accesses the Visual Tester Online Help. <SHIFT+F1> Testing the Processing of a Report 1. Click the Start toolbar button. Click the Run to End toolbar button. 2. Scroll through the index records in the Index Table View and examine the results. If you find a problem with a record in the Index Table View, take note of the page number from which the record was extracted. Also, if an icon appears next to a record, double-click the icon to display a message and take note of that message. 3. Click the Stop toolbar button. Click the Start toolbar button. 4. In the Run to Page text box, type the page number. Click the Run to Page toolbar button. 5. Click the Next Step toolbar button and examine the results in the various views. Repeat step until the problem reoccurs. From AppXtender Reports Management XDS Visual Tester s demonstration of how the instructions extract and store values from the report, you should be able to determine where corrections need to be made in the extraction procedure or in the report type s configuration. 6 6
AppXtender Reports Management XDS Instruction Syntax The following table lists the instructions and instruction syntax for AppXtender Reports Management XDS. Table 2 AppXtender Reports Management XDS Instruction Syntax Instruction ADDTO VarName{Value STAMP SCRIPT VarName2} BEGIN CALL ProcedureName CANCEL {PAGE LINE PROC REPORT} COL [+ -] Number DOC {START END} ELSE END EXTRACT VariableName [Length Pattern] [TRIM] [INLINE INFIELD] [GOTOEND] FIELD [+ -] Number IF {MATCH Function FOUND Function EMPTY Function SCRIPT Function} LINE [+ -] Number LINEPROC ProcedureName [PageNumber] [LAST] [ODD] [EVEN] LOG LogMessage PAGEPROC ProcedureName [PageNumber] [LAST] [ODD] [EVEN] SET VarName{Value STAMP SCRIPT VarName2} STOP {PROC LINE PAGE REPORT} STORE VariableName AppField [StartPosition] [Length] [USEPREV] [NOPREV] SUBPROC ProcedureName USEFORM FormName 7
AppXtender Reports Management XDS Instructions The following table lists and describes the AppXtender Reports Management XDS instructions. Table 3 AppXtender Reports Management XDS Instructions Instruction ADDTO BEGIN CALL CANCEL Description Allows for concatenating a user-defined value or variable or one of a variety of stamps to a selected variable. You can also specify the starting character and character length for the concatenated variable. Since this instruction requires using predefined variables (i.e., variables identified in preceding instructions for the same procedure), it can only be used following one or more EXTRACT or SET instructions. In addition, a specified function from within a script file (VBScript or JavaScript) may be called to generate a value to add to the variable (Note: The script file must be added under the Procedures node for the associated report type). Takes no additional parameters and is used to designate a compound instruction. It allows considering a group of following instructions as one instruction. The group of instructions should be closed with the END instruction. It currently is used only in conjunction with the IF instruction. Recalls a SUBPROC procedure, which must have been created as a separate procedure for the same report type. The user would create a new procedure, begin the procedure with the SUBPROC instruction, add additional instructions to complete the procedure as desired, save the procedure, then use the CALL instruction from within a different procedure to execute the previously created SUBPROC procedure. Cancels a PAGEPROC or LINEPROC procedure for a page or line or for the entire report file. Any index values extracted from the page, line, or procedure before the CANCEL instruction is encountered will be canceled and the AppXtender Reports Management XDS interpreter will proceed to the next page, line, or procedure without interpreting any more instructions. If a LINEPROC procedure is canceled for every line on a page, then any PAGEPROC procedure for that page is also canceled. This instruction would most likely be used following an IF instruction that specifies a condition for canceling a line, page, or entire procedure. COL Specifies the location of report data according to its corresponding column number within a line. The column number can be determined by clicking the desired location on the Text Image dialog box for the sample report file. The position pointer location is then specified in the text boxes at the top of the form for Line, Column, Length (if highlight a cluster of characters), and Field. Since the COL instruction indicates a position within a line moving from left to right, it need not be used in addition to a FIELD instruction. 8 8
Table 3 AppXtender Reports Management XDS Instructions Instruction DOC ELSE END EXTRACT FIELD IF LINE Description Specifies boundaries for a document file in AppXtender. Two DOC instructions can be entered: DOC START, to indicate where the first page of the document file starts, and/or DOC END, to indicate where the last page of the document file ends. It is not necessary to use both instructions. If a DOC START instruction is entered at some point after a previous DOC START was entered, it would be assumed that the previous DOC START ends and a new one begins. This instruction can be used if you want to store a particular sequence of pages as one document file in AppXtender. The ELSE instruction is used in conjunction with the IF instruction to specify instructions to execute if the conditions specified in the preceding IF instruction are false. Closes an extraction procedure begun with the PAGEPROC, LINEPROC, or SUBPROC instruction. It is also used to close a compound instruction begun with the BEGIN instruction. The END instruction should always be used to close the extraction procedure. If no END instruction is entered, a syntax error message appears that states "Unexpected end of procedure." Extracts specified data from a designated position on a page or line and assigns a variable name to the extracted data. The assigned variable name is then used as part of a STORE instruction for designating an index field for the extracted data. Specifies the location of report data according to its corresponding field number within a line. The field number can be determined by clicking the desired location on the Text Image dialog box for the sample report file. The position pointer location is then specified in the text boxes at the top of the form for Line, Column, Length (if a cluster of characters is highlighted), and Field. Each field contains a string of data, usually a complete word on the line, and the contents of the field are displayed in the text box to the right of the field number. Is used in conjunction with both FOUND and MATCH functions to locate desired data or, by adding a NOT parameter, to exclude unwanted data. It may also be used in conjunction with the EMPTY function, which helps to locate the absence of any data (such as a blank page), or the SCRIPT function, which executes a function within a VB or Java script that must return True. The IF instruction allows you to specify a condition for identifying data to be extracted, thus avoiding the possibility of extracting unnecessary data. If the condition is not met, the next instruction or compound instruction (see BEGIN instruction) will not be executed. Specifies the location of report data according to its corresponding line number within a page. The line number can be determined by clicking the desired location on the Text Image dialog box for the sample report file. 9
Table 3 AppXtender Reports Management XDS Instructions Instruction LINEPROC LOG PAGEPROC SET STOP STORE SUBPROC USEFORM Description Specifies an extraction procedure that will be applied to every line on every page of a report file (unless additional restrictive parameters are applied) and should be the first instruction entered for the extraction procedure. If the LINEPROC instruction is used to begin an extraction procedure, neither the PAGEPROC nor the SUBPROC instructions may be used within the same extraction procedure. Enters a specified message in the report log at the time the instruction is encountered by the AppXtender Reports Management XDS interpreter. It is provided mostly for debugging purposes and should be used judiciously so as not to overfill the log file. Specifies an extraction procedure that will be applied to every page of a report file (unless additional restrictive parameters are applied) and should be the first instruction entered for the extraction procedure. If the PAGEPROC instruction is used to begin an extraction procedure, neither the LINEPROC nor the SUBPROC instructions may be used within the same extraction procedure. Used to define an index value that is not part of the report text. The defined value is assigned a variable name so it can then be included in the index table through the STORE instruction. A STAMP option may be used to assign various date, time, and report name stamps to the variable as well as all or part of a second, already defined, variable. In addition, a specified function from within a script file (VBScript or JavaScript) may be called to generate a value for the new variable (Note: The script file must be added under the Procedures node for the associated report type). Halts the current procedure for the rest of the report file or just for a page or line. It is most useful for increasing extract performance by eliminating the processing of nonessential sections of the report file. This instruction would most likely be used following an IF instruction that specifies a condition for stopping a procedure for a line or page. Connects the value of a specific extracted variable with a specific index field in the associated AppXtender application index table. As an option, the stored value can be a specified part of the variable value rather than the complete variable value. When using the STORE instruction, you should also consider any index fields that are set as propagating fields under the Index Fields node for the report type. Begins an extraction procedure that will be used as part of either a PAGEPROC or LINEPROC extraction procedure. The SUBPROC procedure is created as a separate script that is then called from another extraction procedure using the CALL instruction. Enables displaying a form overlay when viewing a page of the report file in AppXtender. The specified form overlay document (from the _FORMS application in AppXtender) will be displayed only for each page of the report file that was indexed with the USEFORM instruction. 10 10
11
12 12