Datawatch Server Administrator's Guide

Transcription

1 Datawatch Server Administratr's Guide

2 Datawatch Server Web Admin by Datawatch Datawatch Server Web Admin prgram cpyright 2015 by Datawatch Crpratin. Datawatch Server Web Admin Administratr's Guide cpyright 2015 by Datawatch Crpratin. All rights reserved. This dcument may nt, in whle r in part, be cpied, phtcpied, reprduced, translated, r reduced t any electrnic medium r machine-readable frm withut written cnsent frm Datawatch Crpratin.

3 Datawatch Server Administratr's Guide Table f Cntents Intrductin... 6 Abut... Datawatch Server 6 Datawatch... Server Prduct Cmpnents 7 Overview... f DSAdmin Tasks 7 Launching... Datawatch Server Web Administratr 9 Navigatin... Tree 10 Functinal... Buttns 13 Page... Navigatin 13 Using... the Calendar 14 Relatinal... Operatrs 14 Blean... Operatrs 17 Cntent... System 19 Strage... Management 19 Maintenance... Management 27 Dcument... Management 45 Dcument... Retrieval 79 Transfer Autmatr Server... Status 94 Standard... Prcesses 95 Visual... Prcesses 140 Script... Editr 169 Cnnectin... Definitins 176 Using... the Naming Macrs 177 Offset... Expressins in Macrs 180 When... a Jb Fails t Run 181 Runtime... Fields 182 Prject... Inputs via Manifest 183 Prtlets Prtlets Prtlet... Grups 187

4 Datawatch Server Administratr's Guide Definitin... Objects 189 Grups Prjects Mdels Templates Bulk... Edits 200 Rights and... Privileges 201 Assigning... Privileges 201 Assigning... Access Rights 203 Setting... Security Prvider 206 Abut... Security Keywrds 207 Glbal... Security Keywrds 207 Assigning... Security Keywrds t Rles, User Grups r Users 208 Dcument... States Security 209 Rles User... Grups 213 Users Dcument... State Grups 220 System... Settings 222 System... Preferences 222 Virtual... Paths 236 Lcale... Management 237 Theme... Management 238 Preprcess... Cnverters 238 News All News Expired... News 240 Glbal... News 241 Adding... a News Message 242 Editing... a News Message 242 Deleting... a News Message 243 System... Reprts 244 Cnfiguratin... Reprts 244 Transactin... Reprts 250

5 Datawatch Server Administratr's Guide Anntatin... Reprts 261 Cnverting... a reprt t anther frmat 262 Remved... Reprts 262 Activity... Mnitr 263 Active... Users 263 Exceptin... Lgs 264 Technical... Supprt 265 Glssary

6 Datawatch Server Administratr's Guide Intrductin Intrductin Welcme t Datawatch Server (DS), Datawatch Crpratin's latest Reprting slutin. Datawatch Server is the smart business intelligence sftware that gives yu the pwer t keep the data and lse the paper. That's because Datawatch Server pwerful reprt-mining technlgy can unlck data buried in reprts and dcuments and turn it int data that yu can use nw. The tpics in this sectin prvide basic infrmatin abut: Datawatch Server (DS) DS Prduct Cmpnents DSAdmin Tasks Launching DSAdmin Navigatin Tree Functinal buttns Page Navigatin Relatinal Operatrs Blean Operatrs Abut Datawatch Server Mdeler is a data access tl that lets yu view, print, extract and analyze data frm existing cmputer reprts. Any reprt used in yur rganizatin can be accessed via Mdeler. Whenever a cmputer prduces a reprt, it creates a reprt file that cntains all the characters and cntrl cdes that are sent t the printer t prduce the actual printut. Mdeler reads these reprt files, but instead f prducing a hardcpy printut with wrds and numbers frzen n the page, Mdeler creates a sftcpy f the reprt n screen, with live data yu can wrk with. In mst rganizatins, Mdeler users access reprt files acrss a netwrk r via terminal emulatin sftware. Cmpanies already cllect, prcess, and interpret large amunts f data as a matter f curse, which is generated in standard business reprts. A hidden treasure-trve f analytical infrmatin exists in the varius reprts that are generated every day, week, mnth, and year. Managers can use these reprts (withut fear f altering the actual crprate data) as a starting pint fr the next level f analysis t help them evaluate and respnd t business situatins. Analyzing data buried in reprts is called reprt mining. Datawatch Server uses Mdeler's pwerful reprt-mining technlgy t unlck the data buried in reprt files. Mining prvides executive- and mid-level managers with the infrmatin and tls t supprt the decisin-making prcess. In additin, reprt data can be exprted t ther sftware prgrams, such as spreadsheets and frecasting sftware, fr further analysis. At the heart f Datawatch Server is a reprt warehuse subsystem fr efficient string and managing large vlumes f crprate reprts. Reprts prduced in any hst envirnment can be brught int Datawatch Server. These reprts are autmatically identified, indexed, cmpressed, and stred in the warehuse system. Datawatch Server 6

7 Datawatch Server Administratr's Guide Intrductin uses an industry-standard SQL database t manage strage and prvide fast, efficient access t reprt data. Datawatch Server allws end users t retrieve infrmatin frm reprts, search fr data in several reprts simultaneusly, and manipulate data fr further analysis. This nline system makes reprt data available mre quickly, ecnmically, and effectively than is pssible with traditinal hardcpy reprts. Datawatch Server Prduct Cmpnents The DSAdmin is a part f the Datawatch Server system, which cnsists f these majr cmpnents: SQL database. Datawatch Server wrks with industry-standard SQL databases. It supprts Micrsft SQL Server A database server can be chsen frm a list f supprted devices based n yur reprt vlume and existing netwrk architecture. This database supplies the underlying mechanisms fr managing the internal data structures. Datawatch Server Administratr (DSAdmin). It is used by the system administratr t define the parameters f the system. DSAdmin identifies where reprts are t be fund, hw they are t be prcessed int electrnic dcuments, and where the results (that is, dcuments) will be physically stred. It calls Mdeler t set up mdels fr indexing and extracting data frm dcuments. DSAdmin prvides capabilities fr enfrcing system security, establishing user rights and privileges, and handling maintenance issues. Datawatch Server Client (DSClient). It cntains the functinality necessary fr retrieving dcuments. It allws users t query the reprt warehuse in a number f ways t find the dcuments that they are lking fr. Once fund, these dcuments are launched int Mdeler with the apprpriate mdel file fr viewing and analysis. DSClient is als used t prcess reprts int dcuments. Using the parameters established in DSAdmin, new reprts are recgnized, indexed, brken int dcuments, and stred away, creating a warehuse f dcuments and indexes. Overview f DSAdmin Tasks Datawatch Server prvides autmatic indexing, instant retrieval f selected pages, and cmprehensive security features. In rder t understand hw Datawatch Server wrks, yu need t understand its terminlgy. Althugh the terms are familiar, they have specific meanings in the cntext f Datawatch Server. In Datawatch Server, reprts are the electrnic versins f the reprts generated by yur cmpany's reprting systems. They have a cnsistent, structured layut and generally are stred as ne file. Fr instance, an Emplyee Insurance Reprt is a reprt that might be stred in a single file called EMPINSUR.TXT. A dcument is a sectin f a Datawatch Server reprt that can be lgically independent frm ther sectins f the reprt. The Emplyee Insurance Reprt might be srted by ffice, with a subttal fr each department. Each sectin f the reprt that represents a reginal department is lgically independent f the thers. Breaking the reprt int smaller lgical dcuments allws users t retrieve nly thse pages f the reprt that they want. A keywrd type is defined when yu create a Mdeler mdel, specified by a Mdeler mdel file. In ther wrds, when creating a mdel, ne r several keywrd types are defined. A keywrd type is a field within a mdel that identifies the dcument. Dcument retrievals are based upn these fields f infrmatin. A dcument type may have several keywrd types assciated with it. These keywrd types are set up by a system administratr and are made available t users autmatically. While a keywrd type is the general 7

8 Datawatch Server Administratr's Guide Intrductin categry, a keywrd is the specific value f a keywrd type. Fr example, 'Q ' wuld be a keywrd fr the keywrd type f Purchase Order Number. The keywrd type f Scial Security Number wuld cntain the keywrds ' ' and ' '. An index field is actually a keywrd type but kept in the database. When Mdeler begins prcessing reprts (filing), the system matches index fields with crrespnding keywrd types. All values f keywrds fr a dcument are saved in the database and are assciated with index fields. Then a user can begin searching fr dcuments, setting apprpriate values f index fields. An index field pints t the start f the dcument, with which the given keywrd is t be assciated. Datawatch Server uses index fields t lcate and retrieve dcuments accrding t keywrds. Fr example, when yu type in the keywrd ' ' fr Scial Security Number, the index is used t lcate dcuments fr the individual with that scial security number. The fllwing scheme represents the main relatinships between the parts f the system at the cnceptual level. Here the Dcument Type is a base cncept, which defines hw the system functins as a whle. Yu may acquaint yurself with it further by reading the sectin titled Dcument Types. Dcument types cmpse a Dcument Type Grup, described in the sectin titled Dcument Grups. 8

9 Datawatch Server Administratr's Guide Intrductin When yu create r edit a dcument type, the system allws yu: T select a mdel frm the list f available mdels. Befre yu can select a mdel, yu need t define it with the help f the Mdel page, described in the sectin titled Adding a Mdel. Each mdel described by the md- r xmd-type files defines the keywrd types. T define the aut-name scheme using the AutName page, which autmatically assigns dcument names based n any cmbinatin f indexes and dcument identifiers. Fr mre infrmatin, see Aut-naming dcuments. T define filing tasks, which begin t prcess the reprts. Fr infrmatin n hw t manage filing tasks see Filing Tasks. T set trustees (users) fr dcuments in the system defined by their rles and a user grup they belng t. Fr details refer t Rights and Privileges. T define dcument templates fr dcuments extracted frm the reprts. On hw t define dcument templates, see Templates. T select the index mdel files with the help f the Mdel page described in the sectin titled Adding a Mdel. These files define the index fields used t search fr dcuments in the database. T bring index fields in accrdance with keywrd types with the help f the Dcument Type page. Fr mre infrmatin, see Adding a Dcument Type. Launching Datawatch Server Web Administratr Since DSAdmin perates in an Intranet/Internet envirnment, users shuld be familiar with the standard techniques used t wrk in Internet envirnment. Nte: Only users with administratr privileges have access t the system. T initiate DSAdmin 1. Launch Micrsft Internet Explrer r any ther brwser by clicking its shrtcut. 2. Type the DSAdmin address in the Address bar, which may lk like this: DSAdmin. 3. Press Enter. Yur brwser will lad the Lgin page. 4. Select a lcale in the upper right crner f the page. The list includes lcales that were selected during the installatin. 5. Type in yur name as an administratr, the passwrd and click Sign In. If yu enter yur passwrd crrectly, the main page f Datawatch Server Administratr is displayed n yur screen. Nte. If yur passwrd has expired, the system displays the expired passwrd page. Yu have t change yur passwrd. Type in yur ld passwrd, a new passwrd, cnfirm the new passwrd and then click Save. If the new passwrd yu entered des nt crrespnd t the requirements (fr example, the length f a new passwrd is less than the value defined by administratr), the system displays a crrespnding message. Nte. If yu try t lg in t the applicatin again, while running it, a message will appear n the Lgin page, infrming yu that yu have already lgged in t the applicatin. T clear the current sessin and lg in t a new ne, select the check bx belw the message, and click Sign In. This ptin is available nly fr the Named license type. 9

10 Datawatch Server Administratr's Guide Intrductin Navigatin Tree After launching Datawatch DSAdmin, at the left f the main windw yu see the Navigatin Tree. It serves as navigatin thrugh the site. All items are expandable. It means that if yu click a tree item r click an arrw by its name, the item will be expanded t the next tree level. When yu click a secnd-level ptin in the left pane, the right pane f the windw displays the crrespnding tab (s) with a list f items. The Navigatin Tree f DSAdmin cntains links t the fllwing sectins f the system: My Hme: This page is displayed by default, when yu lg n t DSAdmin. The right pane cntains links t all sectins f the system. Cntent System Strage Strage Vlumes: This link allws yu t manage strage vlumes. Fr mre infrmatin, see Strage Vlumes. Strage Grups: This link allws yu t manage strage grups. Fr mre infrmatin, see Strage Grups. Maintenance Maintenance Tasks: This link allws yu t manage maintenance tasks. Fr mre infrmatin, see Maintenance Tasks. Lg Clearance Tasks: This link allws yu t manage lg clearance tasks. Fr mre infrmatin, see Lg Clearance Tasks. Maintenance Prcesses: This link allws yu t manage prcesses. Fr mre infrmatin, see Maintenance Prcesses. Full Text Search: This link allws yu t search fr reprts cntaining the specified text. Dcument Management Index Fields: This link allws yu t manage indexes. Fr mre infrmatin, see Index Fields. Dcument Grups: This link allws yu t manage dcument grups. Fr mre infrmatin, see Dcument Grups. Dcument Types: This link allws yu t manage dcument types. Fr mre infrmatin, see Dcument Types. Filing Tasks: This link allws yu t manage filing tasks. Fr mre infrmatin, see Filing Tasks. Filing Prcesses: This link allws yu t manage filing prcesses. Fr mre infrmatin, see Filing Prcesses. Dcument Retrieval Search Grups: This link allws yu t manage search grups. Fr mre infrmatin, see Search Grups. Searches: This link allws yu t manage searches. Fr mre infrmatin, see Searches. Search Ntificatins: This link allws yu t manage search ntificatins. Fr mre infrmatin, see Search Ntificatins. 10

11 Datawatch Server Administratr's Guide Intrductin System Ntificatins:This link allws yu t manage system ntificatins. Fr mre infrmatin, see System Ntificatins. Filing Ntificatins:This link allws yu t manage filing ntificatins. Fr mre infrmatin, see Filing Ntificatins. Offline Tasks: This link allws yu t manage ffline tasks. Fr mre infrmatin, see Offline Tasks. Offline Prcesses: This link allws yu t manage ffline prcesses. Fr mre infrmatin, see Offline Prcesses. Transfer Autmatr Prtlets Exprt: This link allws yu t exprt dcument types and dcument-related items. Fr mre infrmatin, see Exprt. Imprt: This link allws yu t imprt dcument types and dcument-related items. Fr mre infrmatin, see Imprt. Server Status: This link allws yu t check the current status f the Datawatch Autmatr server. Fr mre infrmatin, see Server Status. Standard Prcesses Prcesses: This link allws yu t handle Autmatr prcesses. Fr mre infrmatin, see Prcesses. Schedules: This link allws yu t view schedules f Autmatr prcesses. Fr mre infrmatin, see Schedules. Jbs: This link allws yu t manage Autmatr jbs. Fr mre infrmatin, see Jbs. Distributins: This link allws yu t specify distributins fr items used in Autmatr prcesses. Fr mre infrmatin, see Distributins. Alerts: This link allws yu t set up alerts n Autmatr prcesses, jbs, and ther items. Fr mre infrmatin, see Alerts. Scripts: This link allws yu t view scripts supprted by Datawatch Autmatr. Fr mre infrmatin, see Scripts. Prject Editr: This link allws yu t create prject files. Fr mre infrmatin, see Prject Editr. Visual Prcesses Prcess Prcess Templates Prcess Lgs Cnnectin Definitins: This link allws yu t add predefined/saved cnnectin definitins that can be reused in multiple prjects. Fr mre infrmatin, see Cnnectin Definitins. Prtlets: This link allws yu t manage prtlets. Fr mre infrmatin, see Prtlets Management. Prtlet Grups: This link allws yu t manage prtlet grups. Fr mre infrmatin, see Prtlet Grups. Definitin Objects Prjects: This link allws yu t add existing prject files created with Mdeler t the system and edit a prject files. Fr mre infrmatin see Prjects. 11

12 Datawatch Server Administratr's Guide Intrductin Mdels: This link allws yu t manage mdels. Fr mre infrmatin, see Mdels. Templates: This link allws yu t manage templates. Fr mre infrmatin, see Templates. Rights and Privileges Security Prvider: This link allws yu t define a security prvider. Fr mre infrmatin, see Setting Security Prvider. Rles: This link allws yu t manage rles. Fr mre infrmatin, see Rles. User Grups: This link allws yu t manage user grups. Fr mre infrmatin, see User Grups. Users: This link allws yu t manage users. Fr mre infrmatin, see Users. Dcument State Grups: This link allws yu t manage dcument state grups. Fr mre infrmatin, see Dcument State Grups. System Settings News System Preferences: This link allws yu t set system preferences. Fr mre infrmatin, see System Preferences. Virtual Paths: This link allws yu t manage virtual paths. Fr mre infrmatin, see Virtual Paths. Lcale Management: This link allws yu t manage lcales. Fr mre infrmatin, see Managing Lcales. Theme Management: This link allws yu t manage clr themes fr bth DSAdmin and DSClient. Fr mre infrmatin, see Theme Management. Preprcess Cnverters: This link allws yu t cnvert files with freign, nn-standard frmats fr prcessing them by the system. Fr mre infrmatin, see Preprcess Cnverters. News Management: When clicked displays three tabs: All News, Expired News and Glbal News. Fr mre infrmatin, see Wrking with News. System Reprts Cnfiguratin: This link allws yu t generate cnfiguratin reprts. Fr mre infrmatin, see Cnfiguratin Reprts. Transactin: This link allws yu t generate transactin reprts. Fr mre infrmatin, see Transactin Reprts. Anntatins: This link allws yu t generate anntatin reprts. Fr mre infrmatin, see Anntatin Reprts. Remved Reprts: This link allws yu t view the list f remved reprts. Fr mre infrmatin, see Remved Reprts. Activity Mnitr: This link allws yu t mnitr the filing and maintenance activities ver a perid f time. Fr mre infrmatin, see Activity Mnitr. Active Users: This link allws yu t mnitr active users in the system. Fr mre infrmatin, see Active Users. Exceptin Lgs: This link allws yu t mnitr exceptins ccurring in the system. Fr mre infrmatin, see Exceptin Lgs. 12

13 Datawatch Server Administratr's Guide Intrductin Functinal Buttns The fllwing functinal buttns are present thrughut the applicatin in the right pane: Allws yu t add a new item t the list displayed in the right pane. Allws yu t edit items (dcuments, dcument types, maintenance tasks and s n) frm the list displayed in the right pane. Select the item t be edited, by clicking anywhere n a rw, and click. Nte. Instead f clicking this buttn yu may click the name f an item in a list. Allws yu t remve items frm the list displayed in the right pane. T remve an item 1. Click at the end f the rw with the item yu want t delete. 2. Click Delete t remve the crrespnding item. Nte. If an item des nt cntain any data, it will be remved frm the list. If there are dependent items, yu will nt be allwed t delete it (fr example, yu cannt delete an index field if it is used fr defining reprt types). Page Navigatin In DSAdmin, whenever an item list (fr example, the list f dcument types n the Dcument Types page) exceeds the Cunt f Items Per Page setting, items are listed n subsequent pages. Yu can access these additinal pages via page navigatin icns. Fr example, let's say the specified Cunt f Items Per Page setting is 10. If there are 20 Datawatch Server users and yu attempt t view them n the Users page, nly the first 10 users will be visible. At the bttm f the users page, the page navigatin icns wuld appear like this: T see the remaining 10 users, yu wuld have t click ne f the page navigatin icns. Nte: The tw left icns are dimmed, because there are n preceding pages. Nte. Yu can als change the number f items t be displayed n ne page, by selecting an ptin (10, 20, r 50) frm the Items per Page drp-dwn list. T navigate between pages, type a page number in the Page bx, at the bttm f the table, r use the page navigatin buttns: T navigate t the next page, click. T navigate t the last page, click. T navigate t the previus page, click. T navigate t the first page,click. 13

14 Datawatch Server Administratr's Guide Intrductin Nte: If there are n additinal pages t view all page navigatin icns are disabled. The current page is the nly page available. Using the Calendar When cmpleting input infrmatin requirements f sme pages yu are required t define the date. T access the Calendar windw, click the icn next t a date field, r click the date field itself. The Calendar windw appears n yur screen: The left arrw navigat es t the previu s mnth, and the right arrw navigat es t the next mnth. T set a date Select a mnth n the Calendar using arrws and then select the date. Select ne f the fllwing predefined relative date values frm the Dynamic Date list: Yesterday, End f Last Week, Start f This Quarter and s n. Set a date as a number f days ag. Enter the crrespnding value in the bx and click Days Ag. Yu can als use the fllwing buttns, placed next t a date field: T decrease the date by ne day, click. T enter the current date, click. T increase the date by ne day, click. Relatinal Operatrs Relatinal peratrs let yu specify the relatinship between an index field and an index value in yur search criteria. The relatinal peratrs are lcated in the Operatr drp-dwn list, n the Search page. 14

15 Datawatch Server Administratr's Guide Intrductin Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn under the Search Criteria heading. The fllwing relatinal peratrs are available: Equal t (=) Nt equal t (<>) Less than (<) Greater than (>) Less than r equal t (<=) Greater than r equal t (>=) When using relatinal peratrs in cnjunctin with Blean peratrs, make sure that yur search criteria make sense. Fr example, if yur search criteria is Emplyee Name = Jhn Smith and yu add the search phrase Emplyee Name = Jane De t it, yu cannt link the tw phrases with the AND peratr, because nne f the Emplyee Name index fields wuld cntain bth Jhn Smith and Jane De index values. (The AND peratr specifies that all search phrases linked by it must be true.) T use these tw search phrases in yur search criteria, yu wuld have t link them with the OR peratr. Equal t (=) Operatr When cnfiguring a search, the equal t (=) peratr is ne f the relatinal peratrs yu can use t specify the relatinship between an index field and an index value in yur search criteria. Thugh the equal t (=) peratr is the default relatinal peratr used, yu can select any f five ther relatinal peratrs frm the Operatr drp-dwn list, n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the equal t (=) peratr t retrieve nly thse dcuments that cntain, in the specified index field, the index value cntained in the search phrase. Examples: Custmer Name = Bb's Recrds retrieves all dcuments with an index value f Bb's Recrds in the Custmer Name index field. Ship Date = 01/31/2001 retrieves all the dcuments with an index value f 01/31/2001 in the Ship Date index field. Nt Equal t (<>) Operatr When cnfiguring a search, the nt equal t (<>) peratr is ne f the relatinal peratrs that lets yu specify the relatinship between an index field and an index value in yur search criteria. The nt equal t (<>) peratr is lcated in the Operatr drp-dwn list, n the Search page. 15

16 Datawatch Server Administratr's Guide Intrductin Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the nt equal t (<>) peratr t retrieve nly thse dcuments that d nt cntain, in the specified index field, the same index value as the ne in the search phrase. Examples: Custmer Name <> Betty s Music Stre retrieves all dcuments with index values ther than Betty s Music Stre in the Custmer Name index field. Ship Date <> 01/31/2001 retrieves all dcuments with index values ther than 01/31/2001 in the Ship Date index field. Less Than (<) Operatr When cnfiguring a search, the less than (<) peratr is ne f the relatinal peratrs yu can use t specify the relatinship between an index field and an index value in yur search criteria. The less than (<) peratr is lcated in the Operatr drp-dwn list, n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the less than (<) peratr in a search t retrieve nly thse dcuments that cntain, in the specified index field, an index value that is less than the ne in the search phrase. Examples: Ship Date < 06/01/2001 retrieves all dcuments with an index value f 05/31/2001 r earlier in the Ship Date index field. Invice Amunt < retrieves all dcuments with an index value f 19, r less in the Invice Amunt index field. Greater Than (>) Operatr When cnfiguring a search, the greater than (>) peratr is ne f the relatinal peratrs yu can use t specify the relatinship between an index field and an index value in yur search criteria. The greater than (>) peratr is lcated in the Operatr drp-dwn list, n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the greater than (>) peratr t retrieve nly thse dcuments that cntain, in the specified index field, an index value that is greater than the ne in the search phrase. Examples: Ship Date > 06/01/2001 retrieves all dcuments with an index value f 06/02/2001 r later in the Ship Date 16

17 Datawatch Server Administratr's Guide Intrductin index field. Invice Amunt > retrieves all dcuments with an index value f 20, r mre in the Invice Amunt index field. Less Than r Equal t (<=) Operatr When cnfiguring a search, the less than r equal t (<=) peratr is ne f the relatinal peratrs yu can use t specify the relatinship between an index field and an index value in yur search criteria. The less than r equal t (<=) peratr is lcated in the Operatr drp-dwn list, n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the less than r equal t (<=) peratr t retrieve nly thse dcuments that cntain, in the specified index field, an index value that is less than r equal t the ne in the search phrase. Examples: Ship Date <= 07/01/2001 retrieves all dcuments with an index value f 07/01/2001 r earlier in the Ship Date index field. Invice Amunt <= retrieves all dcuments with an index value f 15,000 r less in the Invice Amunt index field. Greater Than r Equal t (>=) Operatr When cnfiguring a search, the greater than r equal t (>=) peratr is ne f the relatinal peratrs yu can use t specify the relatinship between an index field and an index value in yur search criteria. The greater than r equal t (>=) peratr is lcated in the Operatr drp-dwn list, n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn, under the Search Criteria heading. Use the greater than r equal t (>=) peratr t retrieve nly thse dcuments that cntain, in the specified index field, an index value that is greater than r equal t the ne in the search phrase. Examples: Ship Date >= 07/01/2001 retrieves all dcuments with an index value f 07/01/2001 r later in the Ship Date index field. Invice Amunt >= retrieves all dcuments with an index value f 15,000 r mre in the Invice Amunt index field. Blean Operatrs Blean peratrs enable yu t define searches that include mre than ne search phrase. Searches made up f tw r mre search phrases can include multiple index fields and index values. 17

18 Datawatch Server Administratr's Guide Intrductin The Blean peratrs are lcated n the Search page. Nte: This list is nt visible, until yu select a dcument grup and dcument type, and click the Add cnditin buttn under the Search Criteria heading. Click the drp-dwn arrw t select a Blean peratr frm the list. Nte: While the AND peratr can be used t link search criteria cntaining different index fields, the OR peratr can nly be used t link search criteria cntaining the same index field. The fllwing Blean peratrs are available: AND Operatr: The AND peratr specifies that, in rder fr a dcument t be retrieved, all search phrases linked by it must be true. The search phrases linked with the AND peratr can cntain different index fields. Examples: Ship Date > 01/31/2001 AND Ship Date < 03/02/ This retrieves all dcuments with ship dates frm February 1, 2001 thrugh March 1, Custmer name = Betty's Music Stre AND Ship Date = 01/31/ This returns nly dcuments fr Betty's Music Stre that have a ship date f January 31, OR Operatr: Use the OR peratr t cnfigure a search, in which nly ne f the search phrases linked by it must be true fr a dcument t be retrieved. The OR peratr will als retrieve any dcuments that meet bth r all f the search phrases. Nte: The OR peratr can nly be used t link search criteria cntaining the same index field. Fr example, the search phrase Emplyee Name = Jhn Smith OR Department = Accunting wuld nt wrk because Emplyee Name and Department are tw different index fields. (This search phrase wuld wrk if yu linked the search criteria with the AND peratr, hwever.) Examples: Custmer Name = Bluegrass Recrds OR Custmer Name = The Glass Harmnica - This search returns dcuments fr either Bluegrass Recrds r The Glass Harmnica (r bth, if the dcument type selected cntains dcuments fr bth stres). Invice Number = OR Invice Number = This search will return dcuments fr either invice r invice r bth. 18

19 Datawatch Server Administratr's Guide Cntent System Cntent System The tpics in this sectin prvide infrmatin abut: Strage Management Maintenance Management Dcument Management Dcument Retrieval Transfer Strage Management DSAdmin prvides a system administratr with tls t define hw and where Datawatch Server cmpresses and stres reprts. Hw and where thse reprts are stred has a direct impact n the verall speed and flexibility f the system. Reprts put int the Datawatch Server system are stred in lgical strage bins referred t as strage grups. All data in a strage grup is stred tgether, s keep this in mind when establishing these grups. Yu may want t stre all accunting reprts in ne strage grup and all persnnel reprts in anther. All reprts having the same retrieval requirements might be stred tgether. Or, yu may want t stre all reprts in a single strage grup. Each rganizatin will have different requirements based n its specific cmpany plicies and prcedures. Each strage grup may be cmpsed f several strage vlumes, each vlume having a specific, user-defined size. Yu may create several cpies f each vlume, each cpy with its wn physical lcatin. A single strage grup is actually a vlume set, and each vlume set includes multiple sub-vlumes. Vlumes are used as a means f segmenting the increasing amunt f stred reprts in a strage grup. Segmenting the amunt f stred dcuments int smaller, mre manageable pieces facilitates the migratin f lder data t nearline r ffline strage media. Each vlume cntains minimum f ne cpy. This cpy is where the cmpressed reprt files that have been prcessed by Datawatch Server are recrded initially. Additinal cpies may be recrded t ther strage lcatins fr data redundancy and lng-term archival purpses. Each strage grup cntains a set f vlumes f the First Cpy r Secnd Cpy. When creating a strage grup, the sub-vlume size is defined. All the files fr the current strage grup will be gruped by sub-vlumes, each f which will have the fixed maximum size defined by a strage grup. A strage grup is als defined by such term as current sub-vlume. This is the sub-vlume all the new files are created n. If the current sub-vlume is cmpleted (r reaches the maximum size), it is clsed and a new subvlume is created. It becmes the current sub-vlume. A new sub-vlume may be created n any vlume with the same type (First Cpy r Secnd Cpy), which is cntained in the strage grup. The system chses the first vlume, which has enugh space fr creating anther full sub-vlume. Fr mre infrmatin abut strage grups, see Strage Grups. Fr mre infrmatin abut strage vlumes, see Strage Vlumes. 19

20 Datawatch Server Administratr's Guide Cntent System Strage Vlumes A strage vlume is a physical lcatin n a server, t which reprts can be archived, and frm which dcuments can be retrieved. Yu can use strage vlumes t segment the cntinually grwing amunt f data in a strage grup. Segmenting stred data int smaller, mre manageable pieces facilitates the migratin f lder data t nearline r ffline strage media. Nte: Vlumes are subdivided int sub-vlumes. Each strage vlume in the Datawatch Server system is either a First Cpy r a Secnd Cpy vlume. When yu assign a strage vlume t a strage grup, yu must specify the cpy number f the vlume (either 1 r 2). The first vlume yu add t the Datawatch Server system shuld be designated a First Cpy vlume. This First Cpy vlume is where the cmpressed reprt files that are archived int the system are initially written t. First Cpy vlumes usually reside n fast devices. They shuld prvide quick access, because they use the mst ften retrieved dcuments. Secnd Cpy vlumes may reside n slwer devices (such as magnet-ptical) and can be used fr data redundancy and lng-term archival purpses. Each dcument may reside n the vlumes f the First Cpy r Secnd Cpy, r n bth. When perfrming dcument retrievals, the system attempts t extract data frm the vlumes f the First Cpy initially. If the data n the First Cpy was either mved (Maintenance Task - Mve) r cpied (Maintenance Task - Cpy) int Secnd Cpy AND was purged (Maintenance Task - Purge), it will attempt retrieval frm the vlumes f the Secnd Cpy. See Abut Cpies fr additinal infrmatin. Yu can mve a dcument frm ne cpy t anther using maintenance tasks. All strage vlumes used in the system are listed n the Vlumes page. T display this page, click Cntent System n the Navigatin Tree, then click Strage and select Strage Vlumes. Use this page t add, edit, r remve a strage vlume. T add data t a strage vlume 1. Cnfigure a filing task. 2. Run it via a filing prcess. T remve data frm a strage vlume 1. Cnfigure a maintenance task. 2. Run it via a maintenance prcess. The vlume can be clsed t prevent further writing and cpying peratins t this vlume, r can be set as Read Only t restrict access t deletin f this vlume. Abut Cpies A cpy is a strage vlume that receives data (reprts r dcuments) when it is archived int the system. Each vlume in the Datawatch Server system is either a First Cpy r a Secnd Cpy vlume. When yu assign a strage vlume t a strage grup, yu must specify the cpy number f the vlume (either 1 r 2). The first vlume yu add t the Datawatch Server system shuld be designated a First Cpy vlume. This First 20

21 Datawatch Server Administratr's Guide Cntent System Cpy vlume, which shuld reside n a mass strage device, is where the cmpressed reprt files that are archived int the system are initially written t. Subsequent vlumes (that is, Secnd Cpy vlumes) may reside n any kind f strage medium, and can be used fr data redundancy and lng-term archival purpses. When perfrming dcument retrievals, the data n a First Cpy vlume will be accessed befre the data n a Secnd Cpy vlume. First Cpy Vlume If the data is t be accessed frequently, yu may chse t cntinue t retain the First Cpy vlume until data retrieval requirements subside. As reprts are filed t this lcatin, they are maintained in sub-vlumes accrding t the specified sub-vlume size. Yu may specify mre than ne First Cpy vlume. The first First Cpy vlume in the list will be used until it is full. Then the secnd First Cpy vlume will be used, etc. Nte: Data shuld nt be mved r cpied t a Secnd Cpy vlume until yu are sure it is "errr-free", as data in a Secnd Cpy vlume cannt be remved frm the system. Secnd Cpy Vlume A Secnd Cpy vlume is a strage lcatin where reprts are archived fr lng-term strage. Typically, this is an ptical strage device (fr example, CD-ROMs, CD-ROM drive, etc.). If yu dn't specify a Secnd Cpy vlume, data remains in a First Cpy vlume indefinitely. In practice, the way it wrks is this: A reprt is filed int a First Cpy vlume fr temprary strage. If there was an errr in a reprt r the archive prcess, the data can be deleted frm the First Cpy vlume. Once the data has been determined t be crrect (and/r nce the retrieval demand fr it decreases enugh), it can be cpied r mved t a Secnd Cpy vlume. Nte: Once data has been mved r cpied t a Secnd Cpy vlume, it cannt be deleted frm the system. There are tw ways, via maintenance tasks, t permanently archive data in a Secnd Cpy vlume: 1. Cpy 1 t 2 maintenance task: Cpies the data t a Secnd Cpy vlume, but retains it in a First Cpy vlume. 2. Mve maintenance task: Mves the data frm a First Cpy vlume t a Secnd Cpy vlume. After that it is pssible t delete the First Cpy vlume (First Cpy vlumes can nly be deleted if they are empty, that is, if they cntain n data). The Secnd Cpy vlume will be used fr all subsequent retrievals. Nte: If data that has been mved t a Secnd Cpy vlume needs t be accessed frequently again, the data culd be cpied back t mass strage fr faster retrievals. Adding a Strage Vlume When yu add a strage vlume t the system, yu designate a physical lcatin n a server fr archiving reprts. Every time yu add a vlume, yu must assign the vlume t a strage grup and specify whether it is a First Cpy r a Secnd Cpy vlume. 21

22 Datawatch Server Administratr's Guide Cntent System Nte: The first vlume yu add shuld be designated as a First Cpy vlume. (See Abut Cpies fr mre infrmatin.) T add a strage vlume 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Vlumes. 2. Click n the Vlumes page. The Strage Vlume page appears. Nte: Field value defaults fr sme f these fields can be preset in DSAdmin. T d this, click System Settings n the Navigatin Tree, select System Preferences and click the System Defaults tab. Setting these defaults can save time and errrs in definitin f strage vlumes. Enter a unique name f a new strage vlume int the Strage Vlume Name field. Enter the text defining the strage vlume int Descriptin field. This step is ptinal. Select the name f a server frm Lcatin list. Select the Any Lcatin ptin, if yu will specify a UNC path in the Path field. Select the name f a server frm a list. Yu can select the Any Lcatin ptin, if yu specified a UNC path in the Path field. Nte: If the required server is nt n the list, refer t Lcatins Management tpic t add a new lcatin. 7. Path: Enter a path t the vlume r use the Brwse buttn. This path must be unique. In sme cases such as defining a path using UNC paths, it may be required t manually create the path n the server. Typically, Datawatch Server will create the strage path if needed. 8. Enter the maximum size f the vlume int the Maximum Vlume Size field. Vlume size is measured in megabytes r gigabytes depending n the value yu select frm the list. Current Size in bytes: Displays the current vlume size when editing nly. This value will nt be displayed fr a new vlume. Nte: The Lcatin, Maximum Vlume Size, and Path bxes are available nly when adding a new vlume. 9. Select Read nly check-bx if yu want t prevent deletin f a vlume. 10. Select Clsed check-bx t t prevent further writing and cpying peratins t this vlume. Strage Vlume is Assigned T Cpy #: This list cntains a strage grup with an assciated cpy number. This is an infrmatin bx nly. The cntents f this bx cannt be edited. 11. T save a new strage vlume, click Save. If the peratin is cmpleted successfully, the system saves the new strage vlume t the database and displays the updated Vlumes page. 12. T clear the recent changes, click Clear. 13. T cancel the peratin and return t the Vlumes list withut saving data, click Cancel. Keep in mind that n changes will be saved. 22

23 Datawatch Server Administratr's Guide Cntent System Assigning Strage Vlumes t Strage Grups After adding a strage vlume yu can assign it t a strage grup. If n strage grups exist, yu will need t create ne and then add the strage vlume t it. T assign a strage vlume t a strage grup 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. Click the name f a strage grup yu want t add a vlume t r click anywhere n its rw and then click. 3. Drag a strage vlume frm the Available Strage Vlumes pane t the Assigned Strage Vlumes Cpy# pane. 4. Under the Assigned Strage Vlumes Cpy #, select either #1 r #2 t specify a cpy number fr the vlume. 5. T assign the vlume t the grup, click Save. Editing a Strage Vlume T edit a strage vlume 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Vlumes. 2. On the Vlumes page, click the name f the strage vlume yu want t edit r click anywhere n its rw, and then click. The Strage Vlume page appears. Fr details abut hw t change its items refer t Adding a Strage Vlume. 3. Make the necessary changes and click Save. The system saves the mdified strage vlume t the database and displays the updated Vlumes page. Deleting a Strage Vlume If yu n lnger need a strage vlume, yu can delete it. Befre yu can delete a vlume, hwever, yu must remve all data frm it. Vlumes that cntain any data cannt be deleted. In additin, if the vlume yu want t delete is the nly vlume assigned t a strage grup, yu will nt be able t delete it, because a strage grup cannt exist unless a strage vlume is assigned t it. T delete a strage vlume 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Vlumes. 2. Click at the end f the rw with the strage vlume yu want t delete. A dialg bx will appear. 3. Click Delete t delete the strage vlume frm the list. Nte: Yu cannt delete a strage vlume, if it cntains data files. Strage Grups A strage grup is a lgical strage lcatin fr reprts filed int the Datawatch Server system. Each strage 23

24 Datawatch Server Administratr's Guide Cntent System grup may include several strage vlumes. All the strage grups used in the system are listed n the Strage Grups page. T display this page, click Cntent System n the Navigatin Tree, then click Strage and select Strage Grups. Use Strage Grups page t add, edit, r remve a strage grup. The page displays a strage grup name, the maximum sub-vlume size and the cunt f existing sub-vlumes fr each strage grup n the list. Adding a Strage Grup When adding a strage grup, yu need t specify the maximum size (in megabytes r gigabytes) fr any subvlumes that are subsequently assigned t it. Yu als need t assign at least ne strage vlume t the strage grup (a strage grup must cntain at least ne vlume). If n strage vlumes exist, yu need t create ne befre yu can add a strage grup t the system. Yu als need t specify a cpy number fr the vlume. Befre specifying this infrmatin, yu shuld determine what device type will be used fr archiving dcuments. The media size must be accunted fr when defining the sub-vlume size. Yu shuld als take int accunt when the media is t be recrded, and whether it is t be recrded ver multiple sessins (requiring a dedicated device) r all at nce (fr backup). T add a strage grup 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. Click n the Strage Grups page. 3. Strage Grup Name: Enter a unique name f a new strage grup. 4. Descriptin: Enter any text defining the strage grup. This step is ptinal. 5. Maximum Sub-Vlume Size: Enter the maximum size f any sub-vlumes measured in megabytes r gigabytes. The size shuld be n greater than 80% f the media r device size that will serve as the smallest archive strage fr the reprts cntained in this strage grup. Fr example, if yur selected archive media is CD-ROM, which has a strage capacity f 650 Megabytes, yu wuld enter 520 Megabytes in this bx. ntificatins can be cnfigured t alert administratrs when a strage vlume is running ut f space. The ntificatin will be sent when the available free space f a vlume is less than 2 x Strage Grup size. See System Ntificatins fr additinal instructins. Nte: Yu cannt change the maximum sub-vlume size fr an existing strage grup. 6. Frce sub-vlume prmtin: Select this check bx t frce sub-vlume prmtin after a specified number f files. When the number f files in the current (active) sub-vlume reaches the specified value, this sub-vlume will be frced t clse and a new active sub-vlume will be created autmatically. The number f files can be cnfigured in the Mdeler Server prperties cnfiguratin file. The default value is It is recmmended t select this ptin t ensure prper perfrmance. 7. Number f Sub-Vlumes: Displays the number f existing sub-vlumes fr a strage grup. This field is empty fr a new strage grup. 24

25 Datawatch Server Administratr's Guide Cntent System 8. Available Strage Vlumes: Displays the available strage vlumes, created earlier by an administratr. T assign a strage vlume t a strage grup, drag it frm the Available Strage Vlumes pane t the Assigned Strage Vlumes Cpy# pane. 9. Assigned Strage Vlumes Cpy#: Displays the assigned strage vlumes with the assciated cpy number. These strage vlumes will be included in the current strage grup. Include at least ne strage vlume f the First Cpy. Yu can assign nly vlumes, whse size is greater r equal t the Maximum Sub-Vlume Size value. T remve a strage vlume frm the strage grup, drag it t the left pane. T change a cpy number fr a vlume, select either #1 r # T save a new strage grup, click Save. If the peratin is cmpleted successfully, the system saves the new strage grup t the database and displays the updated Strage Grups page. 11. T clear the recent changes, click Clear. 12. T cancel the peratin and return t the Strage Grups page withut saving data, click Cancel. Keep in mind that n changes will be saved. Assigning Strage Vlumes t Strage Grups After creating a strage vlume, yu can assign it t a strage grup. If there are n strage grups, yu need t create ne and then add the strage vlume t it. T assign a strage vlume t a strage grup 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. Click the name f the strage grup yu want t assign a vlume t r click anywhere n its rw and then click. 3. Drag a strage vlume frm the Available Strage Vlumes pane t the Assigned Strage Vlumes Cpy# pane. 4. Under the Assigned Strage Vlumes Cpy #, select either #1 r #2 t specify a cpy number fr the vlume. 5. T assign the vlume t the grup, click Save. Editing a Strage Grup T edit a strage grup 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. On the Strage Grups page, click the name f the strage grup yu want t edit r click anywhere n its rw, and then click. The Strage Grup page appears. Fr details abut hw t change its items, refer t Adding a Strage Grup. 3. Yu can prmte a sub-vlume fr the current strage grup. T d this, select the Sub-Vlume Infrmatin tab, and click Prmte. Nte. This tab displays infrmatin abut the strage grup's sub-vlumes and is available nly fr existing strage grups. (Fr details, see Viewing Infrmatin On a Sub-Vlume.) 4. Make the necessary changes and click Save. The system saves the mdified strage grup t the database and displays the updated Strage Grups page. 25

26 Datawatch Server Administratr's Guide Cntent System Deleting a Strage Grup T delete a strage grup 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. Click at the end f the rw with the strage grup yu want t delete. A dialg bx will appear. 3. Click Delete t remve the strage grup frm the list. Sub-Vlumes A sub-vlume, like a strage vlume, is a physical lcatin n a server, t which reprts can be archived and frm which dcuments can be retrieved. A sub-vlume is a subdivisin (that is, a subdirectry) f a strage vlume. When yu first archive reprts int a vlume, the reprts are autmatically stred in the first sub-vlume. (Initially, vlumes cntain nly ne sub-vlume.) If yu prmte the sub-vlume, r if the sub-vlume is autmatically prmted - fr example, when the maximum sub-vlume size (specified n the Strage Grup page) is reached - the first sub-vlume is clsed and a secnd sub-vlume is pened. Reprts will be archived t this secnd subvlume until it is prmted t. A new sub-vlume may be created n any vlume f the same type (First Cpy r Secnd Cpy), which is cntained in the strage grup. The system selects the first vlume, which has enugh space fr creating anther full sub-vlume. Vlumes can cntain an unlimited number f sub-vlumes. The nly limiting parameter is the vlume size (specified n the Strage Vlume page when adding a vlume). Once the specified maximum vlume size is reached, n additinal sub-vlumes can be pened n that vlume. A strage vlume may be clsed by an administratr t prevent further writing. Yu can view detailed infrmatin abut the strage grup's sub-vlumes n the Sub-Vlumes Infrmatin tab. Prmting a Sub-Vlume A sub-vlume is autmatically prmted (that is, clsed) when it reaches its maximum allwed size. (This maximum size is specified n the Strage Grup page, when the strage grup is created.) Once a sub-vlume is clsed, yu can n lnger archive reprts int it. Sub-vlumes are numbered sequentially, s each time a subvlume is prmted, the next sub-vlume in the sequence begins. A sub-vlume cannt be backed up r remved frm the system until it has been prmted. There may be situatins where yu wuld like t frce DSAdmin t begin a new sub-vlume even thugh the current ne is nt cmpletely full. Fr example, yu may want t keep all reprts fr a particular mnth n a single sub-vlume. Or yu may nt want t start a new fiscal year n a sub-vlume that cntains infrmatin frm the previus year. In such cases, yu can manually prmte a sub-vlume and begin a new ne. T manually prmte a sub-vlume 1. On the Navigatin Tree, click Cntent System, then click Strage and select Strage Grups. 2. On the Strage Grups page, click the name f the strage grup that cntains the sub-vlume t be prmted r click anywhere n its rw, and then click. 3. Select the Sub-Vlumes Infrmatin tab at the tp f the page. This tab lists all sub-vlumes f a 26