ZL File Archiving Administrator s Guide

Transcription

1 ZL File Archiving Administrator s Guide Version August 2012

2 ZL Technologies, Inc. Copyright 2012 ZL Technologies, Inc.All rights reserved ZL Technologies, Inc. ( ZLTI, formerly known as ZipLip ) and its licensors retain all ownership rights to the software programs offered by ZLTI (referred to herein as Software ) and related documentation, (together, the Products ). Use of the Software and related documentation is governed by the license agreement accompanying the Software and applicable copyright law. Your right to copy the Products is limited by copyright law and the license agreement. Making unauthorized copies, adaptations, or compilation works is prohibited. ZLTI may revise this documentation occasionally without notice. THIS DOCUMENTATION IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL ZLTI BE LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY ERROR IN THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS, REVENUE, USE, OR DATA. Other product and company names appearing in ZLTI products and materials are used for identification purposes only and may be trademarks or registered trademarks of their respective companies. Third party trademarks used in any ZLTI products and materials are the exclusive property of their respective owners. 2

3 Contents Preface:...7 What to Expect From This Guide... 7 Conventions Used in this Document... 8 Audience... 9 Related Documentation... 9 Chapter 1: Introduction Overview of ZL File Archiving What is ZL File Archiving? Standard Archiving Manage-in-Place Access Control List Mirroring Why ZL File Archiving? The ZL UA Solution ZL Unified Vault ZL File Archiving Architecture Accessing Archived Files in ZL File Archiving Stubbing Access through the Web Portal ZL File Archiving Deployment Scenarios Required Software Chapter 2: Installation and Configuration Installing the ZL File Connector Installing the ZL File Connector on a Windows ZL UA Server Contents 3

4 Installing the ZL File Connector on a Stand-Alone Remote Server Installing the ZL File Connector on a Linux ZL UA Server 22 Installing the ZL File Connector on a Linux Remote (non-zl UA) Server Installing the ZL File Connector from the ZL File Connector Installer Package Windows Installation Prerequisites Attended Installation Unattended Installation Installing ZL Icons Windows Installation Prerequisites Attended Installation Unattended Installation Configuring the ZL Unified Archive File Archiving Module Enabling File Archiving File Archiving Configuration Chapter 3: Managing File Servers Overview Managing File Nodes Creating a File Node Managing File Node Properties Viewing File Server Information Managing Agents Reading the Server Summary Report Managing Projects Deleting File Nodes Filtering File Nodes Chapter 4: Managing File Projects Creating a Project Creating a Project Using the Web UI Creating a Project from a Text File Contents

5 Deleting Projects...33 Viewing Project Details...34 Project Info Tab...34 Project Policies Tab...34 Project Directory Spec Tab...34 Project Runs Tab...34 Project Archive Report...35 Project Folder Stats...35 Chapter 5: File Access Introduction Overview File Archiving Application Overview Managing Projects Viewing Projects List...38 Browsing Projects...39 Global Search...39 Setting Display Options Changing Account Password Viewing the About Page Chapter 6: Browsing Files Overview Navigating Subscribed Projects Viewing Folder ACL...41 Navigating Project Folder Files...41 Using Project Search...42 Sharing Folders...42 Chapter 7: Global Search Overview Search Archived and Manage-in-Place Files Advanced Search...43 Raw Query File Search...48 Term Modifiers...48 Contents 5

6 Navigating Search Results Viewing Search Results Applying Item Level Actions Applying Bulk Level Actions Exporting Data for Archived Files Archive Files Now for Manage-in-Place Files Appendix A: Using the Item Pane Overview Using the HTML View Pane Using the Audit Trail Pane Using the Versions Pane Using the Item ACL Pane Using the Legal Holds Pane Using the Headers Pane Appendix B: Troubleshooting Tips on Troubleshooting ZL File Archiving Contacting ZL Support Glossary Contents

7 Preface The ZL Unified Archive (UA) system module provides organizations with the ability to archive file servers and workstations with enterprise-level capabilities, enabling retention and disposition management, litigation risk management, and enterprise search capabilities. ZL File Archiving is one of the modules within the ZL Unified Archive (ZL UA). Unstructured files, such as Microsoft Office documents and other files that typically reside on file servers and workstations, are coming to the forefront of enterprise content management focus as changing requirements redefine the problems facing organizations. New challenges include meeting increasing regulations on retaining electronically stored information (ESI), reducing information risk by disposing of information properly when regulatory periods have elapsed, locating information effectively and completely for legal discovery requests, and making information more easily available to employees to leverage corporate assets for competitive advantage. These challenges are in addition to the traditional requirements to back up file systems and reduce storage costs through tape backup systems and hierarchical storage management. ZL File Archiving is designed to handle large volume file archiving with integrated retention management, responsive search, and information access, making it an ideal solution to meet the unstructured files challenge. What to Expect From This Guide This guide describes how to configure and manage the ZL UA module for comprehensive file archiving. What to Expect From This Guide 7

8 Conventions Used in this Document This guide uses the following notational conventions to help you locate and identify information. Note: A note describes actions or conditions that can help you obtain optimum performance from the application. In addition to the notational conventions, this guide also uses the following formatting. Italic text Identifies document titles, new terminology, alternate terms, and generic terms representing names to be devised by you. Bold text Identifies dialog box options (buttons, check boxes, and lists), window or page options (menus, menu options, and toolbars), and names of keys. Manage > Cases This sequence defines choosing a menu then choosing an option from that menu. The sequence here means to click the Manage menu then click the Cases option from that menu. Square brackets [ ] Indicates that the information inside of the brackets is optional. Braces { } Indicates that you must choose from the options listed inside of the braces. If there is only one option listed, the braces indicate that the option can be repeated. Backward slash (\) If a command line does not fit across the page, a backward slash appears at the end of the line, and the command continues on the next line. Text in Courier indicates: Filenames, commands, and programs. Text that you enter. Text that the system displays. Where steps ask you to do something as root, log on as a user with superadministrator privileges. 8 Conventions Used in this Document

9 Audience This guide is for administrators in charge of setting up the ZL File Archiving module. Table 1 describes the audience types. Table 1: Audiences for the Audience Super Administrator System Administrator Domain Administrator Description Individuals in your organization granted the role of Super Administrator. The Super Administrator role has access to all functionality in ZL UA. Individuals in your organization granted the role of System Administrator. The System Administrator role is responsible for configuring storage units and application vaults and monitoring mail processing and database queues in ZL UA. Individuals in your organization granted the role of Domain Administrator. The Domain Administrator manages the domains and routing methods between them for all machines running ZL UA. Note: The functionality granted to some system roles may overlap. For example, the Super Administrator might also perform the tasks related to the System Administrator. However, we suggest that large organizations distribute tasks by assigning and using as many system roles as possible. Related Documentation Table 2 describes other documentation that may be relevant to this guide. Table 2: Related Documentation Document Name ZLUA Technote System Requirements ZL UA Installation Guide ZL UA Archiving Administration Guide Description Describes hardware and software prerequisites for installing ZL UA. Describes how to install ZL UA on the 32-bit and 64-bit Windows Server 2003 and 2008 operating system. Describes how to manage mail servers, departments, users, policies, archiving, and journaling. Audience 9

10 This page intentionally left blank. 10 Related Documentation

11 Chapter 1 Introduction Overview of ZL File Archiving What is ZL File Archiving? ZL File Archiving is part of the ZL enterprise-class content archiving system, which helps enterprises have a central repository for files. Once files are archived, they will be available for searching, reporting, exporting, and discovery. End-users can search their own data while privileged users, such as Archive Administrators, can search for data throughout the whole repository. Along with single instance technology, which de-duplicates the same documents on multiple locations, ZL File Archiving also provides the ability to stub the files that are already archived to save storage space on file servers and to reduce the backup burden for corporate administrators. To summarize, ZL File Archiving archives files for storage management and enduser access and search, compliance, and discovery purposes. Documents that are archived and stubbed can be easily and seamlessly accessed and searched through a Web interface using Internet Explorer and WebDAV without requiring any additional software. Standard Archiving In standard file archiving, ZL File Archiving archives the files from the source repository (such as the file server) to the ZL archive. After archiving, ZL UA will build the index and allow all of the archived files to be searched, categorized, placed under records management policies, and preserved under legal hold requirements. Overview of ZL File Archiving 11

12 Manage-in-Place Manage-in-Place (MIP) is a feature that is part of the File Archiving module in ZL UA. This feature allows organizations to create a search engine over their file systems without archiving the files, requiring minimum storage resources in the ZL Vault. This feature is mainly useful for organizations in the following scenarios. 1. For Discovery: Organizations can use the MIP feature to quickly crawl a file system and create an search index on the data. They can then use this search engine to analyze and decide the relevant files they want to archive and use those archived files to set retention policies or set the files on legal hold. 2. For Analysis: Organizations with very large unstructured data in their file systems can quickly create a search index using MIP and analyze the data to make an informed decision on how they want to set their archiving, stubbing, and deletion policies on the file system. 3. For better End-User productivity: Organizations can use the MIP search engine to provide their end-users with advanced search facilities to find files in their file system. The MIP search engine comes with file name searches, file content searches, date searches, and so on that can help end-users save time when they need to find files. Access Control List Mirroring The Access Control List (ACL) determines which documents the users can access. During the archiving process, ZL captures the ACL from the file server s Active Directory (AD) and imports it into ZL UA. ZL UA maps the AD permissions to ZL permissions. So users who use ZL UA will have the same rights to archived files as they have to the original files on the file server. ZL File Archiving captures the ACL on folders and files for users and groups. Why ZL File Archiving? Historically, organizations have relied on Hierarchical Storage Management (HSM) to relieve the pressures of high cost storage. HSM applications are designed to move older and less accessed data onto less expensive storage mediums and move the data back to faster, more expensive disks when the information is accessed again. This type of solution is ideal when the primary goal is to lower storage expenses; however, information access requirements have experienced major changes recently to include search, discovery, regulatory compliance, and corporate governance. 12 Overview of ZL File Archiving

13 Today, the demands on the enterprise have changed dramatically from simply lowering storage costs to include leveraging information for competitive advantage, legal discovery, and information risk management. Organizations of all sizes face challenges such as: Retention Compliance and Risk Management: Much of an organization s data currently is being untapped and will never be used again, however, that information is still a legal liability. Without the ability to classify and delete information, the information risk exposure the organization faces continues to grow. Organizations need a way to scan, index and classify information so they can limit and understand their risk exposure in the event of anticipated litigation. Organizations store large amounts of historic electronic data that is no longer used or applicable for their operations. Under normal circumstances, that data would just produce an increasing financial burden as storage requirements grow; however, that data can become a liability during legal proceedings. In ZL File Archiving, retention policies can be used to limit an organization's legal exposure by deleting files that meet certain criteria, such as files that are associated with a certain project and/or over a certain age. Retention policies can also be associated with a minimum retention period to keep the file within the archive to meet regulation requirements, automatically deleting the file after the retention period has elapsed. Retention management is managed through the Unified Archival Admin Web console. When a retention period has elapsed, the files can be automatically deleted by running the Retention Manager global task. Leveraging Information: The marketplace is getting more competitive and organizations need to access the right information faster to stay ahead. With the increasing number of online servers and file servers, and the changing responsibilities of employees, it becomes harder to find what information is available in the enterprise and where it is located, often requiring people to spend time recreating information that already exists. Additionally, organizations continue to face their original storage issues, at an even higher level. Storage Optimization: The amount of electronic information organization s generate and store continues to grow. Instead of replacing the original requirement of lowering storage costs, this requirement has become more important. E-Discovery: In the event of pending legal action, organizations are now required to include electronic documents in the discovery process. Organizations need the ability to preserve documents through legal hold, search and identify relevant documents, apply attorney client privilege classification, and produce the documents. These new demands change the landscape for storage management because they require electronic documents be tracked for retention purposes, accessed quickly, and on an ad-hoc basis. These are tasks for which HSM solutions are ill suited. Overview of ZL File Archiving 13

14 The ZL UA Solution The ZL Unified Archive platform is specifically built to address the demands of large scale content management including the file archiving provided by ZL File Archiving. The ZL Unified Archive was built as a single, flexible, and scalable solution to support extremely large-scale unstructured document archival. It is proven to support terabytes of data while maintaining high ingestion and access performance. Specific technologies that address the file archiving requirements include: Consolidation: When information is spread across hundreds of file servers and tens or hundreds of thousands of workstations and laptops, it can be difficult to understand the information available inside the company from both a risk and competitive advantage perspective. ZL Unified Archive is a scalable system that allows organizations to manage their unstructured file content in a central location to understand what they have and what it means for the organization. Discovery: It is well established that full text search across unstructured documents is the most effective and productive method for finding unfamiliar documents. ZL Unified Archive provides several levels of discovery and search capabilities: enterprise wide, per department, and on an individual user level. The ZL Search Engine can index over 1000 different file formats, leveraging a scalable architecture to enable fast indexing and document retrieval. ZL File Archiving can also make file management available through the Discovery Manager module. Retention Management: In addition to storing the information, ZL File Archiving can assist in managing an organization s information risk exposure by classifying and applying retention policies to documents, even when different people and departments fall under different policies and regulations. Retention policies can be set to automatically delete old files that have not been used and can be deleted from a regulatory perspective to ensure that the organization does not keep unused files longer than required. Storage Optimization: ZL File Archiving can address increasing storage costs through the Unified Archive vault storage system, global single instance storage, and file stubbing. The ZL Vault handles HSM by shifting data from fast tier 1 NAS- and SAN-based devices to devices such as tier 2 disk-based systems and WORM content addressable storage systems. ZL can also support optical jukeboxes and tape-based devices through integrations. Additionally, ZL File Archiving performs single instance storage across the entire organization, covering multiple file servers, workstations, operating systems, locations and departments. Finally, the files can be removed from the physical disk and replaced with a shortcut after they have been archived through a process known as stubbing. 14 Overview of ZL File Archiving

15 ZL Unified Vault Backup and Restoration: The ZL Unified Archive also acts as an alternative file source in the event of a system outage while the Disaster Recovery (DR) plan is being executed. The Unified Archive can make the contents available in real time compared to many tape back-up systems that require costly time and labor, the costs of which often preclude actual restoration of files. ZL File Archiving provides selective restore, giving users the self-service ability to restore their own files on demand. Access: Users can find it daunting to traverse the file systems of many file servers across the enterprise, filling up their Windows drive letters with mapped shared folders. The ZL Unified Archive makes the archived documents from multiple data sources available through a single Windows Explorer or Web portal that includes a powerful search function. Global Single Instance Storage: Organizations often store the same file across their network 10 or more times, often reaching over 30 times for popular documents that have been ed, saved to workstations, and many file servers. The storage impact can be exacerbated when the document is a large Microsoft PowerPoint presentation or PDF file. Other large documents can be saved multiple times for reference purposes. While Single Instance Storage (SIS) has been introduced in many products, many implementations only perform SIS across a limited portion of the solution, making design trade-offs that dramatically reduce the applicability of single instancing in their solutions. ZL Unified Archive provides a single instance storage solution that is enterprise-wide and globally applicable, without trade-offs that eliminate the SIS benefit through containerization and the creation of duplicates. ZL File Archiving allows files to be stored a single time no matter who the owner is, where the file was originally located, when the file was encountered, and so on. ZL Unified Archive includes several technologies to dramatically reduce the costs of storage above and beyond that provided by traditional HSM solutions. These capabilities are built into the ZL Vault and include Vault Replication, the Dual Write Vault, and the Encrypted Vault. Vault Replication is ZL s native HSM capability to move data from one device to another, either immediately or after some time, with an optional delayed delete feature. Delayed delete is useful to allow faster access for a specified period of time after the data has been written to a slower device such as a SAN versus a WORM device. The Dual Write Vault performs instantaneous synchronous replication to two-disk based storage devices such as NAS and SANs. Overview of ZL File Archiving 15

16 ZL File Archiving Architecture ZL File Archiving uses the ZL Unified Archive application servers to handle scheduling, policies, writing to the archive, document indexing, browser access, and search access. In addition to the ZL UA application servers, ZL File Connector is installed on ZL File Servers. ZL File Servers run the ZL File Connector, which performs file system crawling against the archiving and Manage-in-Place target servers. A File Server can either be a ZL UA application server or a stand-alone server. Each File Server can be configured to archive and stub a set of directories called File Projects. Figure 1 describes the ZL File Archiving architecture. Figure 1: ZL File Archiving Architecture 16 Overview of ZL File Archiving

17 Accessing Archived Files in ZL File Archiving Stubbing ZL File Archiving provides several ways to access files that have been archived. In an archive-only scenario without storage optimization, the files will be untouched on the file systems and can be accessed the way they always have been in addition to WebDAV and Web browser interfaces provided by ZL File Archiving. The Unified Archive can also replace files on the file system with shortcuts to the archive location and provide users with a Web portal from which to browse and search their files. ZLUA File Archiving offers stubbing that can be used to replace the actual files on the file servers with a stub or a shortcut. This stub file is smaller in size and when accessed, will bring the data from the ZL archive and show the original content of the file. Stubbing helps reduce the file server s size, providing relief in terms of storage and higher performance for the file server. ZL supports URL shortcutbased stubbing. The stub file that is created is a Windows shortcut that contains a URL to the content on the ZL s archive. When you double-click the stubbed file, it downloads the original file. Stubbing is similar to creating shortcuts in Windows. ZL File Archiving can archive files, remove them from the local storage system, and leave a pointer behind so applications can find the file in the archive. A stub is a Windows link file that has the.ink extension and includes information on where to retrieve the file from UA. The user will see the standard document icon with a small arrow to indicate the file is a shortcut. When the user clicks the shortcut, the file will be retrieved and interpreted by the Web browser, which will then proceed to the UA location to retrieve the file. The user will be prompted to open the file in the associated application if there is one, for example, Microsoft Word. Since stubbing exists on the file system, users are subject to the same access control permissions granted at the folder level. The ZL Unified Archive server also enforces permissions at the archive server level. Access through the Web Portal ZL Unified Archive provides Web portal access for end-users to access their archived files. This method provides several ways to retrieve files. Windows Explorer: The Web portal fully supports Windows Explorer integration and allows users complete Windows Explorer integration through WebDAV. Users will see it as another Explorer window. From here, users can drag and drop files into any directory using tools they know and use today. Web Search: A major benefit to end-users through the Web portal is the ability to search on their archive. If they have projects spanning multiple file servers, workstations, and laptops, the ZL search will be able to query files across all systems that have been archived. Accessing Archived Files in ZL File Archiving 17

18 Web Browsing: When users log into their Web portals, they see the files associated with their projects. They can download their file by clicking a download icon. The user s hierarchical directory structure is maintained by Unified Archive for familiarity and ease of use. A major benefit of this approach is that files can be removed entirely from the file server, workstations, and other systems so that those systems can be re-purposed. This is especially attractive for files that have not been accessed in a long time. If enabled, the Web portal can become the organization's single view into their historic data repository, allowing the information to be accessed globally, at the department level, and on an individual user level. ZL File Archiving Deployment Scenarios The File Connector service and ZL UA application server grid architecture allows several deployment options and benefits for enterprise file servers, remote offices, and disconnected users. Enterprise File Servers: The ZL File Connector can either be deployed on remote servers and access the file server shares over the network, or they can be deployed locally on the file servers themselves. This flexibility allows organizations to choose between running the File Connector services remotely or locally on the file servers. In addition to archiving file servers, the ZL File Connector architecture supports archiving of remote office computers and end-user computers including PCs and laptops. Remote Offices and Telecommuters: Distributed organizations often have remote offices and telecommuters. The ZL File Connector architecture allows these users to be covered for archiving, discovery, and backup purposes. When these are off the corporate WAN, ZL File Archiving can still archive the local file systems as long as a port is made available for the ZL File Connector. Note: Refer to the Glossary to understand the terms and definitions before you proceed further. It will help you better understand the setup described in the following sections. 18 Accessing Archived Files in ZL File Archiving

19 Required Software Table 3: Required Software Table 3 lists the required software for ZL UA. Software ZLFileConnector ZLServer Web Browser Description A client software for the ZL server, which performs crawling, archiving, stubbing, and searching. Distributed file archiving and server. Any number of ZL servers can be deployed depending on specific workload and performance requirements. Microsoft Internet Explorer. Most features work on other browsers such as Firefox; however, WebDAV may not be supported on non-microsoft browsers. Accessing Archived Files in ZL File Archiving 19

20 This page intentionally left blank. 20 Accessing Archived Files in ZL File Archiving

21 Chapter 2 Installation and Configuration This chapter covers installation and configuration of ZL File Archiving and Manage-in-Place (MIP) for File Systems. ZL File Connector: The File Connector runs on servers that perform file system crawling and scanning. The File Connector is a required installation on a File Server. ZL Icons: The ZL Icons are installed on Microsoft Windows client computers that are used to read stubbed files. The ZL Icons are an optional component. In addition, the ZL Unified Archive registry must be edited to enable and configure File Archiving. This is covered later in this chapter. Installing the ZL File Connector The ZL File Connector can be installed on Windows and Linux-based servers that are running ZL Unified Archive or on stand-alone remote servers that do not run ZL Unified Archive. Instructions for each configuration is included in the following sections. Installing the ZL File Connector on a Windows ZL UA Server To install the ZL File Connector on a Windows-based ZL UA server: 1. Go to command line on Windows by clicking Start > Run. 2. Type cmd and press Enter. 3. Type cd%ziplip_home%\zlfileconnector\bin 4. Type zlfileservice.bat install The command line shows The service zlfilesvc configuration has been completed. This indicates that the ZL File Connector service (zlfilesvc) has been installed. 5. Type net start zlfilesvc to start the Windows service for ZL File Connector. Installing the ZL File Connector 21

22 6. To set the right log on permissions for the service: a. Click Start > Run, type services.msc, and press Enter. The Windows Service Manager console opens. b. Locate the ZL File Connector service. Right-click on the service, and go to Logon tab to set the right user permissions to be used by the ZLFileConnector service to run as. Installing the ZL File Connector on a Stand-Alone Remote Server To install the ZL File Connector on a Windows-based remote (non-zl UA) server: 1. Copy the %ZIPLIP_HOME%\ZLFileConnector directory from the ZL Server to a directory on the remote server where you want to install the ZL File Connector to a directory say, C:\ZL Technologies\ZL File Connector. 2. Go to command line on Windows by clicking Start > Run. 3. Type cmd and press Enter. 4. Type cd C:\ZL Technologies\ZL File Connector 5. Type zlfileservice.bat install The command line shows The service The service zlfilesvc configuration has been completed. This indicates that the ZL File Connector service (zlfilesvc) has been installed. 6. Type net start zlfilesvc to start the windows service for ZL File Connector. 7. To set the right log-on permissions for the service: a. Start > Run. b. Type services.msc and press Enter. The Windows Service Manager console opens. c. Locate the ZL File Connector service. Right-click on the service, and go to the Logon tab to set the right user permissions to be used by the ZLFileConnector service to run as. Installing the ZL File Connector on a Linux ZL UA Server To install the ZL File Connector on a Linux-based ZL UA server: 1. Type $ZIPLIP_HOME/bin/zlfile.sh start to start the ZL File Connector process. 2. Make sure that a non-root user called zltech exists on the Linux server/ machine on which the ZL File Connector process is running. This is the default user that the ZL File connector process uses when it runs. In case there is a different user that you want to use, perform the following steps: a. Navigate to / $ZIPLIP_HOME /ZLFileConnector/bin directory and open zlfileprofile.sh. 22 Installing the ZL File Connector

23 b. Edit the line in the file that says: ZLFileConnector_USER=${ZLFileConnector_USER:-zltech} to ZLFileConnector_USER=${ZLFileConnector_USER:-<User that you want to specify>} 3. Save the file and exit. To run the process, type $ZIPLIP_HOME/bin/ zlfile.sh start. Installing the ZL File Connector on a Linux Remote (non-zl UA) Server To install the ZL File Connector on a Linux-based remote (non-zl UA) server: 1. Copy the $ZIPLIP_HOME%/ZLFileConnector directory from the ZL Server to a directory on the remote server where you want to install the ZL File Connector to a directory say, /opt/zl/zlfileconnector 2. Type /opt/zl/zlfileconnector/bin/zlfile.sh start to start the ZL File Connector process. 3. Make sure that a non-root user called zltech exists on the Linux server/ machine on which the ZL File Connector process is running. This is the default user that the ZL File connector process uses when it runs. In case there is a different user that you want to use, perform the following: a. Navigate to /opt/zl/zlfileconnector/bin directory and open zlfileprofile.sh. b. Edit the following line in the file: ZLFileConnector_USER=${ZLFileConnector_USER:-zltech} to ZLFileConnector_USER=${ZLFileConnector_USER:-<User that you want to specify>} 4. Save the file and exit. To run the process, type /opt/zl/zlfileconnector/ bin/zlfile.sh start. Installing the ZL File Connector from the ZL File Connector Installer Package The ZL File Connector is used by the ZL Archive to access target file systems. The ZL File Connector needs to be installed on a server that has access to the target file system. The server can either be a dedicated server or a ZL Archive server. Follow these instructions if this is the first installation of the ZL File Connector. The installer does not support upgrading an existing ZL UA Server. Installing the ZL File Connector from the ZL File Connector Installer Package 23

24 Windows Installation Prerequisites x86 x64 All prerequisites are available in the delivery directory. Java Visual C Runtime libraries. Attended Installation Java x64 Visual C Runtime libraries. To install the ZL File Connector: 1. Run Setup.exe located in the ZL File Connector Installer package. This package is separately provided from the actual ZL server installation. The prerequisites will be checked and installed if necessary when you execute setup.exe. 2. If prompted for prerequisites, select accept, yes, or agree. 3. Follow the dialog box prompts for the prerequisite packages. The installer installs the ZL File Connector and configures the prerequisite packages as necessary. 4. Select a directory to install ZL File Connector (for example, D:\Program Files\ZL Technologies\ZLFileConnector). ZL recommends using a different drive from the Windows system drive. Unattended Installation To install the ZL File Connector in the unattended mode: 1. The prerequisites need to be installed before installing the ZL File Connector. See the respective prerequisites instructions on performing unattended installation. 2. Launch ZLFileConnectorSetup.msi or ZLFileConnectorSetup_x64.msiwith the selected target directory (TARGETDIR) from the installation directory with the following command line: 3. For 32-bit: msiexec /I ZLFileConnectorSetup.msi TARGETDIR=<selected directory> 4. For 64-bit: msiexec /I ZLFileConnectorSetup _x64.msi TARGETDIR=<selected directory> 24 Installing the ZL File Connector from the ZL File Connector Installer Package

25 Installing ZL Icons The ZL Icons creates a map on a client machine of file icons to file extension. The map is used to display to the end-user the system dependent icon to the stubbed file. Once the map directory is created, the program does not need to be executed or run again. Windows Installation Prerequisites All prerequisites are available in the delivery directory. X86: and X64 Microsoft.NET 3.5 Attended Installation To install the ZL Icons: 1. Run Setup.exe located in the ZL File Connector Installer package. This package is separately provided from the actual ZL server installation.in the distribution. The prerequisites will be checked and installed if necessary when you execute setup.exe. 2. If prompted for prerequisites, select accept, yes, or agree. 3. Follow the dialog box prompts for the prerequisite packages. The installer installed ZL Icons, and configures the prerequisite packages as necessary. 4. Select a directory to install ZL UA (for example, C:\Program Files\ZL Technologies\ZLIcon). Unattended Installation To install the ZL Icons in the unattended mode: 1. The prerequisites need to be installed before installing ZL Icons. For convenience, the prerequisite installation files are provided in directories. See the respective prerequisites instructions on performing unattended installation. 2. Launch ZLIconSetup.msi with the selected target directory (TARGETDIR) from the installation directory with the following command line: For 32-bit and 64-bit: msiexec /I ZLIconSetup.msi TARGETDIR=<selected directory> Configuring the ZL Unified Archive File Archiving Module Two steps are required to configure ZL Unified Archive for File Archiving or Manage-in-Place for File Systems. 1. Enabling File Archiving through the ZL Unified Archive Registry. 2. Configuring the ZL Unified Archive Registry File Archiving settings. Installing ZL Icons 25

26 Enabling File Archiving File Archiving is disabled by default when the ZL server is installed. To enable File Archiving: 1. Log in to ZL UA and go to the system administration module. 2. On the system administration module, go to System Configuration > Registry > Web Applications > File Archiving. 3. Select the File Archiving Application check box. 4. To enable Manage-in-Place, select the Enable Sync Item Index Creation check box. File Archiving Configuration The file archiving module can be configured with the Sysadmin module: System Configuration > Registry > Archival/Journaling > File Archiving A description is provided for each of the settings. Changing any of these settings requires a system restart. 26 Configuring the ZL Unified Archive File Archiving Module

27 Chapter 3 Managing File Servers Overview ZL File Servers are servers that crawl file systems for File System Archiving and Manage-in-Place for File Systems. These servers run the ZL File Connector and archive target file systems. They must be configured in ZL Unified Archive (UA) as File Servers. After the server has been created, file archiving projects can be created on the servers to determine which file system directors are to be archived or managed in place. File Servers are managed in the Unified Archival Admin Web application. This document covers areas of Unified Archival Admin that are related to File System Archiving and Manage-in-Place for File Systems. Note: In this document, the terms File Node and File Server are used interchangeably. Managing File Nodes To manage File Nodes: 1. Log in to the Unified Archival Admin Web application by logging into ZL Unified Archive. 2. Select the Unified Archival Admin Web application from the box in the upper right corner of the Web page. 3. Click the Servers > File Servers menu item to open a list of File Nodes. From this screen you can: Create a File Node Manage File Node Properties Delete File Nodes Filter File Nodes Overview 27

28 Creating a File Node A File Node is a reference to a machine identified by a display name and an IP address or a network addressable node name. Each File Node must have the ZL File Connector running on it. To create a File Node: 1. Click the Create File Node menu item in the File Node(s) tab after opening the list of File Nodes. 2. The New File Node dialog box opens and includes the following fields: 3. Submit the information by clicking the Create button. The File Node is created in the system and viewable in the Node(s) list. Managing File Node Properties To view information on a specific File Node, double-click the File Node row in the File Node(s) list. The File Server information tab opens and includes menu items for the following information: Server Info Agents View Report View Projects Viewing File Server Information The Server Information tab includes information the server corresponding to the information submitted at server creation time. Managing Agents Node name text box Node IP text box Port Node name Node IP Port Enter the display name for this node. Enter the IP address or network addressable node name. The port number is the port used by the ZL File Connector. The default value of 9975 is shown. Leave the default value unless you are changing this port in the ZL File Connector as well. Agents are required to perform the file system crawling during archiving and Manage-in-Place operations. The Agents tab allows users to create agents, delete agents, modify agents, and view agent runs. To create, delete, or modify an agent, click Agents > View. 28 Managing File Nodes

29 Creating a New Server Agent To create a new server agent: 1. Click the Create New menu item. The New Server Agent window opens. 2. Enter the following information: Agent Name text box Agent Type select box Mask select box Use System Default check box Run Interval (sec) text box 3. Click Create to create the new Server Agent. Deleting a Server Agent The Agent Name is used to identify the agent in the agent list. Select File for file archiving or Managein-Place for file systems. The mask determines which File Agent Global Task will control when the File Agent runs. This is useful to spread out the times when file system crawling will be performed. Select the number of the mask to use. This check box determines whether the system should use the default interval time or a custom time set in the Run Interval text box. If a custom run interval is to be used, enter a custom run interval in this text box. In the Agents tab list, select the check box for the server agent(s) and click the Delete menu item. Modifying a Server Agent and Viewing Server Agent Runs Double-click the server agent display name in the Agents tab list for the server agent to view. This opens the Archive Agent properties pane. The configuration set up during Agent creation can be updated here. Additionally, information is presented on run iterations at both a summary level and for individual runs in a run report covering start date, end date, status, and other parameters. Managing File Nodes 29

30 Reading the Server Summary Report The Summary report includes a number of reports and statistics to assist in managing server file systems. Server Summary Status Chart The Status Chart includes a pie chart and statistics for files in the following categories. Not Archived Archived Archived & Stubbed Restored Managed in Place Server Summary Size and Size Comparison Charts The Size and Size Comparison Charts provide information on the total size of the files on the target file systems without stubbing and with stubbing, and singleinstance storage to provide a report on storage savings. To best visually convey the storage savings provided, the Summary Size Chart represents the data in a pie chart, and the Size Comparison Chart presents the data in a bar chart. Server Summary Report The bottom of the report provides a detailed table of files in each state per project. This report can be printed or downloaded in Microsoft Excel format. Managing Projects Projects determine the file systems that are archived or managed in place. Detailed information on managing projects is provided in the next chapter. Deleting File Nodes To delete File Node(s), select the check box next to the File Node(s) to be deleted and click the Delete menu item. WARNING: Do not delete a File Node that has already been archived. Improper deletion of a File Node may cause a variety of unintended consequences including, but not limited to, orphaned stubs, inflated memory usage, and server crashes. ZL Technologies is not responsible for any issues caused by the deletion of a File Node. Filtering File Nodes To filter the displayed File Nodes, enter text to match in the text box to the right of the Find word in the menu, and click the Enter key on the keyboard. 30 Managing File Nodes

31 Chapter 4 Managing File Projects File Projects determine which target file systems are archived and managed in place. Projects are managed in the Unified Archival Admin Web application under the File Server that runs the project. This chapter describes creating and managing file projects. Creating a Project File Projects can be created two ways: User Interface (UI) Text file Creating a Project Using the Web UI To create a project using the Web UI: 1. From the Unified Archival Admin Web application, navigate to the server of interest, and click the View Projects menu item. From here, you can perform the following actions. Create a Project Delete a Project View Project Details 2. In the Projects tab pane, click Create. The Create Project pane opens. 3. Enter the following information: Project Owner Text Box Project Name Text Box Display Name Text Box Node Name Text Box Type the address of the project owner. Type a unique project name. Type a display name to show in the user interface. Type the node, or use the Find Node button to locate the node to run the agent. Creating a Project 31

32 Lexicon Menu Main Options Check Boxes Owner Privileges Check Box Default User Privileges Check Boxes Folders - Inclusion and Exclusion Select a lexicon created through the ZL UA Categorization module to categorize content. Select the options that should be enabled on this project. Select whether the project owner should be granted project administration privileges. Select whether users should be granted the following permissions. Read View Audit Trail Share WebDAV Add and remove folders using the Include New folder and Exclude a folder menu items. Delete a folder by selecting the check box for the folders to be deleted, and click the Delete folder menu item. Including a new folder prompts you to enter a Display Name and Path. The Display Name is displayed in the File Project root hierarchy. The Path is a path accessible from the File Server. The path can be a local path (for example, C:\My Documents ) or a UNC path (for example, \\MyServer.MyDomain\C$\My Documents ). Excluding a folder requires you to highlight an existing inclusion folder and click the Exclude a Folder menu item. In the Exclude Folder pane, enter the sub-folder to exclude to prevent archiving items in that folder. 32 Creating a Project

33 Creating a Project from a Text File To create a project from a text file, from the Unified Archival Admin Web application main menu bar, click Manage > File Archiving > Import Projects from File(s). This opens a pane to enter the name of the file to use for importing project definitions. The file format uses a tab-delimited text file format with the following columns. _ProjName _ProjDisplayName _ProjType _ProjFileServer _ProjUser _ProjRootDir _ProjExcludeDir _ProjLexicon The first line should start with // followed by a tab-delimited list of the column names above. There should be no space or tab between the // and the first column name. For more information on the file format, an example Project import file with example entries is located on the ZL server at: %ZIPLIP_HOME%\zlserver\WEB- INF\config\runnable\testing\TestProject.txt Deleting Projects To delete projects, first navigate to the information for the File Server. From the Unified Archival Admin Web application, navigate to the server of interest. Select the projects to be deleted by clicking the check boxes to the right of each project to be deleted and clicking the Delete menu item. WARNING: Do not delete a File Project that has already been archived. Improper deletion of a File Project may cause a variety of unintended consequences including, but not limited to, orphaned stubs, inflated memory usage, and server crashes. ZL Technologies is not responsible for any issues caused by the deletion of a File Project. Creating a Project 33

34 Viewing Project Details To view project details: 1. Navigate to the project by first navigating to the File Server or by clicking Manage > View/Edit Project(s) from the Unified Archival Admin main menu bar. 2. Once the project has been located, double-click on the row to bring up the Project Details pane. This includes the following tabs: Project Info Policies Directory Spec Project Runs Archive Report Folder Stats Each tab is explained in detail below. Project Info Tab This tab presents the current settings used in creating the project aside from the inclusion and exclusion folders that are located in the Directory Spec tab. You can modify the parameters on this page and save the results to update the project information. Project Policies Tab This tab allows you to view and set the file archiving policies for the project. The policies can either be inherited from the listed department using the auto-resolve feature, or they can be overridden using the select box. The four policies include: Manage-in-Place Files File Archiving Policy File Stubbing Policy File Archive Retention Policy Project Directory Spec Tab This tab lists the inclusion and exclusion folders for the project with the ability to add additional folders. The method for adding and removing folders is the same as when creating the project. When the spec has been updated, click the Save this configuration link to commit the changes. Project Runs Tab The project runs tab lists the agent runs including start date, end date, and status. 34 Creating a Project

35 Project Archive Report The project archive report presents the overall status for the project including the following figures. Project Report Status Chart The Status Chart includes a pie chart and statistics for files in the following categories. Not Archived Archived Stubbed Restored Project Report Size Chart Managed in Place The Size Chart provides information on the total size of the files on the target file systems without stubbing and with stubbing, and single-instance storage to provide a report on storage savings. Project Summary Report The bottom of the report provides a detailed table of files in each state per project. This report can be printed or downloaded in Microsoft Excel format. Project Folder Stats The folder stats tab presents file statistics by file status on a per-folder level. Creating a Project 35