EMC ApplicationXtender Application Generator 5.40 Quick Reference P/N 300-005-630 REV A01 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com
Copyright 1994-2007 EMC Corporation. All rights reserved. Published November, 2007 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. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners. 2 2
Contents ApplicationXtender Application Generator Quick Reference... 4 AppXtender AppGen Toolbar Buttons... 4 Creating a New Application... 5 Creating a New User... 8 Creating a New Group... 9 User and Group Security Profile Privileges... 10 3
ApplicationXtender Application Generator Quick Reference This document is designed to provide quick reference and setup information for ApplicationXtender Application Generator (AppXtender AppGen) to experienced administrators and is not intended to take the place of the ApplicationXtender Core Components Administrator s Guide. AppXtender AppGen Toolbar Buttons The following table describes each of the toolbar buttons in AppXtender AppGen: Table 1 ApplicationXtender Application Generator Toolbar Buttons Button Function Creates a new application. Creates a new user. Creates a new group. Creates a new annotation group. Deletes the selected application. Deletes the selected user. Deletes the selected group. Deletes the selected annotation group. Shows Domains for imported users and groups. Displays Help About dialog box. 4 4
Creating a New Application 1. Start and log into Application Generator (AppGen). 2. Right-click the Applications node in AppGen s tree. From the shortcut menu, select New. 3. On the Application page, enter an Application Name and Description. You also have the following choices: To store each document once but make it available for indexing many times, enable the Multiple indexes option. To prompt users to check out documents from the current application when they open them for display and to enable the final revision feature, enable the Prompt for checkout when open documents option. To require users to enter a comment whenever they check a document in or out of the current application, enable the Checkin comments required and/or Checkout comments required options, respectively. To require users to enter comments that will be written to the Audit Trail and select the functionality they intend to use whenever they create, display, export, print, or email a document in the current application, enable the Reason Code option. To cause users to be prompted to sign for each newly created BIN file, enable the Document signing option. 4. Select a full-text engine from the Full-text Engine drop-down list. You have the following choices: ProIndex full-text engine or K2 full-text engine. 5. If you selected K2 full-text engine, enter the server name, port, and collection name for the K2 server. 6. Click Next. The Paths page appears. Configuring the Paths Page 1. If you plan to use an EMC Centera storage device for document storage, do the following. Otherwise, skip to step 2: a. Select Enable Centera Storage. b. Select the Centera cluster for document storage in the Cluster Name list. c. Specify where you want document page files to be stored in the Centera Staging Path text box. All annotations associated with a document are stored to the same path. d. Specify where you want OCR output text to be stored in the OCR Write Path text box. It must be a UNC share on a file server. OCR data is not written to Centera because it can be regenerated, if necessary. 5
e. Specify the location (or path) of the full-text database where you want the full text of your documents to be stored in the Full-Text DB Path text box. It must be a UNC share on a file server. Full-text data is not written to Centera because it can be regenerated, if necessary. Skip to step 3. 2. If you plan to use a storage device other than EMC Centera, do the following: a. Specify where you want document page files to be stored in the Document Write Path text box. b. Specify where you want annotations to be stored in the Annotation Write Path text box. c. Specify where you want OCR output text to be stored in the OCR Write Path text box. d. Specify the location (or path) of the full-text database where you want the full text of your documents to be stored in the Full-Text DB Path text box. It cannot be a Volume Label drive path ($VOLUME_NAME\PATH), a DiskXtender path (\\SERVERNAME\PATH), or ArcX-ASE path (ARCHX:// ABC). 3. Click Next. The Fields page appears. Adding Fields 1. In the Field Name text box, type a name for the field. 2. From the Data Type drop-down list, select the data type you want to associate with this field. 3. Specify a length in the Length text box (required for Currency, Decimal/Numeric, Integer, or Text data types). 4. Choose a format in the Format list box (for Currency, Date, Dec/ Num, Integer, SSN, Telephone, or Zip data types). 5. Under Flags, enable or disable the flags that you want to apply to the field. For a description of each flag, see AppXtender AppGen Field Flags on page 7. 6. After entering all the information for a field, click Add. Note: If User-defined List selected as the Data Type, the User-defined List dialog box appears after clicking Add. For more information, see Creating a User-defined List on page 8. 7. Repeat steps 1-6 for each field you want to add. 6 6
AppXtender AppGen Field Flags The following table describes each available field flag: Table 2 ApplicationXtender Application Generator Field Flags Flag Required Search Read-Only Doc Level Security Part of Unique Key Dual Data Entry Key Reference Data Reference Auto Index Validation Mask Leading Zeroes Date Stamp Time Stamp Purpose When the Required flag is enabled, the index field is required (i.e., must be filled in before saving a new document). When the Search flag is enabled, the index field can be searched. When the Read-Only flag is enabled, the index field will be read-only. When the Document Level Security flag is enabled for an index field, the Document Level Security tab will appear. The Document Level Security tab enables you to allow or disallow user or workstation access based on the index field s contents. When the Part of Unique Key flag is enabled, unique data is required for each document. When the Dual Data Entry flag is enabled, users must enter index information twice for the index field as a validation measure. When the Key Reference flag is enabled, the index field will be used for key reference indexing. If you set a Key Reference field, you must also define at least one Data Reference field. When the Data Reference flag is enabled, it allows the index field to be used for key reference file indexing. If you set a Data Reference field, you must also define a Key Reference field. When the Auto Index flag is enabled, it allows the index field to be used for auto-indexing (i.e., enable document indexes to be populated using imported data). When the Validation Mask flag is enabled, a template format can be set for the index field. When the Leading Zeroes flag is enabled, leading zeroes are preserved in an integer field. When the Date Stamp flag is enabled, the index field of a document will be populated with the date the document was added to AppXtender. When the Time Stamp flag is enabled, the index field of a document will be populated with the time the document was added to AppXtender. That time remains read-only. 7
Creating a User-defined List 1. If you selected User-defined List as the Data Type, the Userdefined List dialog box appears. In the Item text box, type an item to add to the list, and then click Add. 2. There are several functions available in the User-defined List dialog box: To change an entry, double-click the item, make the necessary modifications, and then click Modify. To remove an entry from the list, highlight it and click Delete. To import text from a file for use as a list item, click Import. Choose a file from the Open dialog box and click Open. To change the order of items in a user-defined list, highlight the item to move. Hold down the left mouse button, drag the item to the new position, and release the mouse button. To alphabetize the list, click once on the User-Defined List Item heading with the left mouse button to alphabetize in ascending order or twice (double-click) to alphabetize in descending order. 3. Click OK to accept your list entries and then click Finish when complete. Creating a New User 1. Right-click the Users node in AppXtender AppGen s tree. From the shortcut menu, select New. 2. On the User page, enter a unique user name (for Windows security provider, the user name must include a domain name) and personal password for the user (32-character maximum for each). Verify the password by typing it again. Specifying the user s full name is optional (132-character maximum). (If using Windows security provider, the user name must be configured in Windows before it can be created in AppGen.) 3. Click Next. On the Groups page, you can specify the user s group membership now, or later. To add a group to the Member Of list, drag the group name from the Not Member Of list to the Member Of list. Repeat for each group that you want to add to the Member Of list. (If you are using Windows security provider, you will not see a Groups page, as group membership is configured in Windows.) Note: If no groups appear on the list, groups have not been created. For instructions, see Creating a New Group on page 9. 4. To remove a group from the Member Of list, drag the group name from the Member Of list to the Not Member Of list. Repeat for each group that you want to remove from the Member Of list. 8 8
5. Click Next. The Profile page appears, which allows you to assign security profiles for particular applications. 6. In the Application drop-down list on the Profile page, select <Global Profile> to assign the same privileges for all AppXtender applications or, to define privileges for a single application only, select that application from the list. 7. Under Privileges, select the items appropriate to the user s responsibilities. 8. To configure more application profiles for the user, repeat the previous steps for each profile. 9. Click Finish when complete. Note: It is easier to import users from Windows when using Windows security provider. For more information on Windows security provider features, refer to the ApplicationXtender Core Components Administrator s Guide. Creating a New Group 1. Right-click the Groups node in AppXtender AppGen s tree. From the shortcut menu, select New. 2. On the Group page, enter a unique name for the group (for Windows security provider, the group name must include a domain name ñ for example, DCTM\GroupName) (32-character maximum). Specifying a description for the group is optional (132- character maximum). (If using Windows security provider, the group must be created in Windows before it can be created in AppGen.) 3. Click Next. On the Users page, you can specify the group s membership now, or later. To add a user to the Members list, drag the user name from the Non-Members list to the Members list. Repeat for each user you want to add to the Members list. (If you are using Windows security provider, you will not see a Users page, as group membership is configured in Windows.) 4. To remove a user from the Members list, drag the user name from the Members list to the Non-Members list. Repeat for each user that you want to remove from the Members list. 5. Click Next. The Profile page appears. (By default, when a group is being added, it has no security profiles configured.) 6. On the Profile page, you assign security profiles to the group for particular applications. In the Application drop-down list, select <Global Profile> from the Application drop-down list to assign the same privileges to all AppXtender applications or select a particular application from the list to define privileges for a single application. 9
7. Under Privileges, select the items appropriate to the responsibilities of the users in the group, or when applicable, accept the default settings. 8. To configure more application-specific profiles for the group, repeat the previous steps for each application profile. 9. Click Finish when complete. Note: It is easier to import groups from Windows when using Windows security provider. For more information on Windows security provider features, refer to the ApplicationXtender Core Components Administrator s Guide. User and Group Security Profile Privileges The following table describes each privilege available for users and groups: Table 3 User and Group Security Profile Privileges Option Scan/Index Online Enhance Pages Batch Scan Batch Index Modify Index Display Print Configure WS Delete Doc Delete Page Add Page Create App Modify App Delete App Migrate App COLD Import Allows you to Index scanned documents online. Deskew, inverse text correction, and dot shading removal. Batch Scan, Batch Create, Batch Import. Batch index. Modify document indexes. Display documents. Print, fax, email, export, cut/copy. Access all tabs of the AppXtender Desktop Configuration dialog box. Delete documents. Delete pages. Add pages. Create new applications. Modify applications. Purge or delete applications. Migrate applications. Perform COLD extracts. 10 10
Table 3 User and Group Security Profile Privileges (Continued) Option COLD Import Maint COLD Batch Extract Administrator Multiple Logins DLS Maint Key Ref Maint Auto Index Maint User Security Maint Key Ref Import Auto Index Import Index/Image Import Create Annotations Edit Annotations Create Redactions Edit Redactions Global Annotations Full Text Index Full Text Query OCR PAL User Allows you to Maintain COLD extract definitions. Perform batch extractions. Access AppXtender Admin/AppXtender AppGen; Use AppXtender Archive/Migration Wizards; Modify applications that begin with underscore; Delete documents filed for RM retention. Log into AppXtender from different workstations simultaneously. Configure Document Level Security. Configure Key Reference File Setup. Configure AppXtender Auto Index Import Setup. Maintain user security. AppXtender Import Key Reference files. AppXtender Import Auto Index files. Configure AppXtender Index Image Import Setup and import Index Image files. Add annotations. Edit, delete, or hide own annotations. Add redactions. Edit, delete, or hide own redactions. Add, edit, delete, or hide annotations created by others. Submit documents to the AppXtender Admin Index Server. Perform a full-text search for documents. Process documents with optical character recognition (OCR). Privileges are restricted when using AppXtender Web Access. 11
Table 3 User and Group Security Profile Privileges (Continued) Option Report View Retention Administrator Allows you to Query for and view the AppXtender Reports Mgmt report associated with an AppXtender Reports Mgmt/COLD document. Enable Centera retention for an application. If EMC Centera is enabled for the AppXtender application and you have a valid license for retention, the user can perform the following retention-related tasks: File a document for retention Place and remove a retention hold Manage expired documents under retention The Display privilege is also required for these tasks; additionally, the Delete privilege is required to delete expired documents. Retention User If EMC Centera is enabled for the AppXtender application and you have a valid license for retention, the user can file a document for retention. The Display privilege is also required for this task. 12 12