44
OnFile Version 1.5, April 11, 2016

OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

  • Upload
    others

  • View
    6

  • Download
    0

Embed Size (px)

Citation preview

Page 1: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

OnFileVersion 1.5, April 11, 2016

Page 2: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

2

OnFile

OnFile

Copyright © 2016 InPress Systems AB.

This manual and the software described in it are provided under licence and may only be used subject to the terms of this licence. Any unauthorised duplication or distribution is prohibited by law. The content of this manual is provided for information only, is subject to change at any time and should not be construed as a commitment by InPress Systems AB or its partner companies. InPress Systems AB accept no responsibility for error or omissions that may appear in this document. Unless specifically authorised in the licence agreement, no part of this document may be reproduced, stored in a retrieval system or transmitted in any form without the prior written consent of InPress Systems AB.

Xinet, FullPress, WebNative and WebNative Portal are trademarks of North Plains. Archiware and P5 are trademarks of Archiware GmbHAmazon Glacier is a trademark of Amazon Inc. All other trademarks are the property of their respective owners.

Page 3: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

3

OnFile

OnFile

1 About oNFILE ...............................................................................................41.1 What does OnFile do? .........................................................................41.1.1 Archive Destinations and modules .......................................................41.1.2 Archive Location ..................................................................................4

2 INstALLAtIoN .................................................................................................52.1 Platforms and pre-requisites ................................................................52.3 Installing the software ..........................................................................52.4 Updating the software ..........................................................................62.5 Accessing OnFile admin ......................................................................62.6 Licensing ..............................................................................................6

3 GEttING stArtEd .........................................................................................83.1 Environment setups .............................................................................83.2 OnFile Archive Locations .....................................................................93.3 Configureplugins ...............................................................................103.3.1 General plugin options .......................................................................103.3.2 Archive plugin options ........................................................................113.3.3 Restore plugin options .......................................................................123.4 Configurehotfolders .........................................................................12

4 coNFIGurING oNFILE ................................................................................144.1 Baseconfiguration .............................................................................144.2 Locations ............................................................................................154.2.1 Disk archive Location .........................................................................174.2.2 Archiware P5 Location .......................................................................174.2.3 Amazon Glacier Location ...................................................................194.3 OnFile plugins ....................................................................................224.3.1 General plugin options .......................................................................234.3.2 Archive plugin options ........................................................................234.3.3 Restore plugin options .......................................................................254.3.4 Restoreworkflows..............................................................................264.3.4.1 Restore using browse ................................................................................... 264.3.4.2 Restore using restore map ............................................................................ 274.3.4.2 RestorefilesfromHotfolderarchivesusingrestoremap ............................. 304.3.5 Archive and Restore monitor..............................................................314.4 Hotfolders..........................................................................................334.4.1 Add hot folder ...................................................................................334.4.2 Configurehotfolder ..........................................................................344.4.3 Hotfoldermonitor ..............................................................................354.5 Archiveviafilelists ..............................................................................37

5 ActIvIty ANd LoGs ....................................................................................385.1 Main log .............................................................................................385.2 View monitor ......................................................................................385.3 Location logs ......................................................................................385.4 HotFolderlogs ...................................................................................39

6 AdvANcEd ....................................................................................................406.1 Customizingemailnotifications .........................................................40

A tImE ANd dAtE FormAttING....................................................................41INPrEss systEms soFtwArE LIcENsE ANd crEdIts ...............................42

coNtENt

Page 4: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

4

OnFile

OnFile

1 About oNFILE

1.1 what does onFile do?

OnFile is an add-on to Xinet that acts as a middleware in between the Xinet system and Archive solutions or services. It acts as a link between the Xinet system and the Archive, providing tools to archive and restore as well as maintaining the relationship between the Xinet system and the archived asset. It utilizes the API’s and tools from both Xinet and the Archive system to act as the link between the both.

Archive solutionsonFile sits between Xinet™ and the Archivesolutions and communicate with both to handle archives and restores.

OnFile is an expandable solution that can work with multiple Archive modules to facilitate archiving to different Destination types and solutions. It can handle multiple types of Archive solutions and will grow as new technlogies and services emerge.

onFile consists of a base module and archive modules facilitating connectivity to multiple archive solutions.

1.1.1 Archive destinations and modules

An Archive Destination is another software or service that provides the actual storage of assets. It can be software installed on the same server, cloud-based services offering archiving of assets or other solutions.

Each OnFile supported destination is served by an OnFile Archive Module. The licensing model of OnFile is based on a baselicense with additionally licensed Archive Modules.

Depending on what Destination or Destinations are to be used, the appropriate modules are licensed.

1.1.2 Archive Location

An Archive Location is a logical unit, i.e., a configuration of a certain Archive module. For example, it may be the Archive to disk module setup to archive to a certain filesystem or the Archive to P5 module setup to archive to a certain P5 archiveplan.

Multiple Archive locations can be configured for the same, or different Archive destinations. Archiving processes are configured to connect to a certain, or selection, of Locations.

Page 5: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

5

OnFile

OnFile

2 INstALLAtIoN

2.1 Platforms and pre-requisites

OnFile is available for RedHat Linux, Apple MacOSX and Sun Solaris. The following versions are supported:

• RedHat Linux: 5, 32-bit (and 64-bit with compatibility libs installed)

• RedHat Linux: 6 and 7, 64-bit (the same installer, 6_64)

• Apple OS X Intel 10.5 +

OnFile requires Xinet® with a Xinet Portal server and a database license. Required releases for Xinet software are

• Xinet version 17.6.A, Recommended version is 17.7.1 or better

• Xinet Portal version 4.6.1

When using the OnFile Archiware P5 module, P5 needs to be installed on the Xinet server and either configured as a client to a main P5 server or running as its own P5 server. InPress Systems recomment using the latest version of Archiware. The minimum required version is

• Archiware P5 version 5.1.1, recommended version is at least 5.1.7

2.2 where do I get the software

To get the latest OnFile software, use the downloads page at www.inpress.se.

The installation package is a gzipped unix tar file named “onf” followed by the version and plat-form and ending in “tar.gz”. For example onf.1.5.redhat6_64.tar.gz refers to OnFile version 1.5 for the RedHat 6 (and 7) operating system.

2.3 Installing the software

Transfer the packages in a binary format from the ftp server to the servers where it should be installed. Put the file in a temporary location for the installation and unpack (gunzip and tar).

Make sure you are logged in as the root user when performing the installation. Uncompress by using the gunzip command and untar the installation file.

[root@xinet17 /]# cd /root/installs/inpress/int[root@xinet17 int]# lsonf.1.1.redhat5.tar.gz[root@xinet17 int]# gunzip onf.1.1.redhat5.tar.gz [root@xinet17 int]# tar xf onf.1.1.redhat5.tar [root@xinet17 int]# lsinstallinterphase README onf.1.1.redhat5.tar installonfile

The following installation script will be available: installonfile. Run the installation script.

Note that on OSX Servers you should always unzip and untar using the command line tools. Do not unpack “automatically” via an ftp client.

Perform the installa-tion logged in as the root user. Use com-

mand line tools.

Page 6: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

6

OnFile

OnFile

2.4 updating the software

The installation script is designed to handle both original and update installations of existing OnFile software. To update an existing installation, just run the installonfile script as when making the original installation. All existing configurations will be preserved.

2.5 Accessing onFile admin

OnFile Administration is a plugin (accessed from Xinet admin).

Access the onFile admin utility from the Xinet nativeadmin : volumes/users : Plugins tab

the onFile admin home page

In order to access OnFile admin, you need to be logged in as nativeadmin.

2.6 Licensing

OnFile needs a 16 digit license string and a 4 digit serial number provided by InPress Systems or a reseller. The license and serial number should both be entered in the licensing section of the OnFile admin.

To be able to provide a license, the Hardware ID of the server is needed. It is displayed above the entries for serial number and license string in the licensing section.

Page 7: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

7

OnFile

OnFile

Access the Licensing section from the Home onFile page

Page 8: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

8

OnFile

OnFile

3 GEttING stArtEd

This section gives a quick overview of the steps needed to configure OnFile. More information and details on each subject can be found in chapter 4.

Setting up a basic OnFile installation can be done in a few steps:

1) Make needed setups in the environment and in OnFile base configuration

2) Configure OnFile Archive Locations

3) Configure OnFile Plugins (Archive and Restore)

4) Configure OnFile hot folders (as an alternative to plugin driven Archive)

3.1 Environment setups

OnFile requires a restore temp area. This restore temp area needs to be a Xinet system volume. It should not have the Database enabled and it should not be shared to users.

Create a system volume to use.

create a system volume to be used as a restore temp area.

The restore temp area is used to temporarily collect files that are being restored before they are distributed to the designated destination. Restore of large files and a large number of files will require much storage space. Make sure the restore temporary area is on a filesystem with lots of available space.

Access the OnFile Base config and select the restore temporary area that has been created . Use the select menu to choose a Xinet systemvolume. It is also possible to use a subfolder inside a volume.

Page 9: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

9

OnFile

OnFile

select a restore temp area

If you plan to use the Archive module to archive to Archiware P5 you should also configure the path to the Archiware base directory where you made your Archiware installation. Type in the Archiware base path as in the example above. When you save, OnFile will check the connection to P5 and return the status and version number.

When using an Archiware network server as the main archive server specify the address, user-name and password and the name of the OnFile server as setup on the main Archiware server.

3.2 onFile Archive Locations

At least one Archive location is requred before it is possible to configure users/groups or hot fold-ers. Use the Locations tab to load the Locations page. Enter a name for the location and select the Archivemodule to be used for the Location. Click Add.

Add a location

When the location has been added, the interface automatically changes to editing the location. The location setup is different depending on which Archive module was selected.

The Archiware path is required for

archiving to P5

Page 10: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

10

OnFile

OnFile

Edit an existing location

OnFile support three different Archive modules as of version 1.3: Disk Archive, Archiware P5 and Amazon Glacier. See chapter 4 for full information on each archive module and their con-figuration options.

3.3 Configureplugins

The OnFile plugins are used to archive and restore from the basket. There is one plugin for Archiving and another for Restoring. The plugins are used to initiate archive and restore as well as for monitoring running archive and restore requests. It is also possible to enable control of hot folders via the archive plugin.

The first step is to enable the plugins on the user/group on the plugins tab in Xinet admin. When that has been done, access the Users & Groups tab in the OnFile admin. The plugins can be configured on single users or on groups. Select the user or group to be configured from the select. It is possible to type into the select to narrow down the possible selections.

There are three sections on the setup: General options, Archive options and Restore options. If only one of the Archive or Restore sections is displayed up it means that the user/group only has that particular option enabled in the Xinet admin.

3.3.1 General plugin options

The general options are shared between the archive and restore plugins and includes setting for language and email. If any customized email notifications have been enabled, The selection be-tween customized email setups will also show up here if there are any. See section 6.1 for creating custom emails.

Page 11: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

11

OnFile

OnFile

General plugin options

3.3.2 Archive plugin options

The archive options define the way the plugin behaves when archiving.

The most important configuration is the selection of what locations to choose from. If only one location is checked, that selection will be automatically chosen. If there are several locations selected, they will be displayed as a select menu for the user, making it possible to decide what location to archive to at the time of sending the Archive request.

Archiving options using multiple locations and enabling archive time control

sample plugin setup from Archiving options above

Page 12: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

12

OnFile

OnFile

3.3.3 restore plugin options

The restore options define the way the plugin behaves when restoring. The options include the Restore method which decides where assets will be restored to, quotas for restores, keyword handling and approval settings.

restore options using restore method browse, user supplied foldername and other settings

sample plugin setup from restore options above

3.4 Configurehotfolders

Hot folders can be used for archiving by dragging assets and folders to be archived into watched folders. There are two methods whereby OnFile can identify what folders to look in:

• Hot folders are identified by name. OnFile will look for folders with the designated name inside a base path and archive assets inside those folders.

• Create a list of static hot folder paths where to look for the assets to archive.

Use the Hot folders tab to load the Hot folders page. Enter a name for the hotfolder and click ‘Add’. Setup the hot folder as needed and select Active.

Hot folders are run by a schedule. The schedule can be either at a certain time of day or using an interval. It is also possible to trigger the hot folder from the hot folder administration page using the “Run now” button. In that case there is no need to use a schedule.

Page 13: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

13

OnFile

OnFile

Adding hot folder

Hot folder options using search mode

See chapter 4 for full infomation regarding hot folder options.

Page 14: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

14

OnFile

OnFile

4 coNFIGurING oNFILE

This section explains the base Configuration and setups for Locations, Hot Folders and User/Groups in detail.

4.1 Baseconfiguration

The base configurations are used to setup some basic configurations for the application.

Baseconfig

coNFIGurAtIoN dEscrIPtIoN

debug Set to Yes to generate more information in the main and hot folder logs. Note that when debug is enabled, logging to the main log will drastically increase. Logging to the locations are always made using full details.

restore temp directory Use the navigator to select a temporary area to be used for restore processes.The restore temp should reside on a Xinet volume that is not enabled for database, web or fpo. It should not be accessible to normal users.

NOTE: The volume needs to have a lot of free space since all restores will be placedherebeforebeingroutedtothefinalrestoredestination.

replyto email address The replyto address used in the emails sent by OnFile.

Portal link urL Portal server to use when sending approval requests for archive and restore orders. The URL is used to generate a link that the admin can click to get to the request monitor to approve or deny.

Archiware setups. only available when the ArchiveP5 module is licensed:

Archiware basepath Enter the path to the Archiware base path. OnFile will show if the path is correct.Thepath/usr/local/awisusedbydefaultifnotconfigured.

run as archiware client Enabletheabilitytorunasclient.Thisrequirethefieldsbelowtobesetupaswell.The “test” button can be used to test the network connection to the Archiware server.

Page 15: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

15

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

Archiware server HostnameoripoftheArchiwareserver

username / Password Username and password to use for accessing the Archiware server

client name This client’s name given in the Archiware server setup

Amazon Glacier setups. only available when the ArchiveGLAcIEr module is licensed:

concurrent uploads Number of concurrent uploads to Glacier that is allowed. Default 5

concurrent downloads Number of concurrent downloads to Glacier that is allowed. Default 5

The Restore temp directory is used as a temporary storage location for restored files before they are restored back to the final location. It has to be a Xinet volume and preferably one that has no database, web or fpo setups. Also, it should not be published to normal users. See section 3 for an example of the volume setup.

Archiware setups are only visible when OnFile is licensed with the ArchiveP5 module. Enable network setup to another Archiware server only if applicable.

Glacier setups are only visible when OnFile is licensed with the ArchiveGLACIER module. Note that enabling more concurrent uploads/downloads will utilize more of the network bandwidth.

4.2 Locations

As mentioned in the introductory chapter, a Location is a logical unit used by OnFile. A location is a configuration of a certain Archive module to which it is possible to send Assets for archiving.

It is possible to define multiple Locations using the same Archive module, for example archiving to disk to several physical locations or using the P5 module to archive to different Tape groups defined in different Archiveplans in P5.

Each location is created using the Add new Location section under the Locations tab. Type in the name to use, select the module and click Add. The name can not be changed afterwards.

Add a location

When the location has been added, the interface automatically changes to editing the location. The location setup is different depending on which Archive module was selected.

Page 16: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

16

OnFile

OnFile

Edit an existing location

To edit an existing location, simply select it from the Select Location pull-down. A location has to be active in order to be selected for use for a user or hot folder. Following configurations are common for all Locations and Archive modules:

coNFIGurAtIoN dEscrIPtIoN

Archive module What module is associated with the location

Location name The name of the location given when created. Can not be changed.

Location title A text passed into Xinet for display purposes only. Location Name is used if this value is empty

comment A comment for admin use only

Active Toggle to activate or deactivate a location. A non-active location cannot be associated with a user/group or hot folder

Mainconfig Depend on the Archive module

Pre-archiving script Path to a script to run before the archive starts. The script needs to be a full path to a exectuable script of program.The “pre” script will run before the archive starts. The arguments passed to the scripts are:1: The id of the archive request2:Apathtoafilelistasdescribedbelow.ThelistisautomaticallydeletedbyonFileafter being used.3: Optional argument

optional argument An optional argument to be used from within the pre-script

Post-archiving script Pathtoascripttorunafterthearchivehasfinished.Thescriptneedstobeafullpath to a exectuable script of program.Arguments are passed as with the pre-script above

optional argument An optional argument to be used from within the post-script

Passfilelistintoscript FormatandcontentofthefilelistpassedtothescriptsListoffilepaths-alistofallpathspassedtoOnFile.Oneitemperline.ListofXinetfileids-alistofallfileidspassedtoOnFile.Oneitemperline.Expanded lists: Any folder passed in will be expanded to a full directory structure andeachfolderandfilelistedseparately.

Page 17: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

17

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

Prune list Typeinnamesoffoldersandfilesthatshouldbedeletedpriortoarchiving.Several names can be added using commas to separate. Do not add any addi-tional spaces around the commas.Wildcard * can be used in the names as well.

Beforeanarchiverequestisexecuted,itwillbesearchedforfilesandfoldernamesin the prune list and when found, these will be both deleted from the server and not be part of the archive.

Totherightoftheinputfield,thereisabuttonthatcanbeusedtotesttheprunelist. Click the button and select a folder where to test the function.

Example of prunelist: TEMP*,JUNKThe prune list is case sensitive

At the bottom of the page there are buttons to Test the location and to view the Location log.

Test will check that the location setup is valid and will connect via the Archive module. When clicking test, a panel opens up at the bottom showing the result. The Close button is used to close the panel. Any script will be checked to be executable.

test of an Archiware P5 archive location

View log will go to the Activiy & Logs tab with the particular location selected. See section 5 for more information about logs.

4.2.1 disk archive Location

A disk archive uses a locally mounted disk to store the archives. Archives are stored in a zipped format to preserve the Xinet file format.

The only required setting is the path which needs to be pointing to an existing directory, locally accessible with write permissions.

type in path to where the disk archive should be located

coNFIGurAtIoN dEscrIPtIoN

base path for archive Path to the directory where the archive should be written to.The directory needs to be writable.

minimum free space (mb)

TheminimumnumberofMBthatneedstobeavailableonthefilesystem.OnFilewill stop archiving to this archive when the free space drops below this number.

4.2.2 Archiware P5 Location

The OnFile Archiware module adds archives to an existing P5 archiveplan. Note that the setting described earlier for the Archiware base path needs to be set (see 4.1) for the Archive module to work.

Page 18: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

18

OnFile

OnFile

The only required setting is the id of the archiveplan as created in P5. Before adding the OnFile Location, an archiveplan needs to be created in P5.

type in the PresstorE archiveplan id

coNFIGurAtIoN dEscrIPtIoN

Archive plan id The archiveplan id given by the Archiware P5 application.

The Archiveplan needs to be created in P5. A couple of options make a difference when used from OnFile:

1. Be sure NOT to enable Deletion of files in the plan. OnFile will submit the archive request to Archiware P5. When the archive has been verified, OnFile will use the Xinet API to update the Xinet database and remove the original asset. Removal of the asset by P5 will result in a Xinet database that is out of sync.

2. Since Xinet will be used for previewing archived items and to handle the restores, there is no need to enable preview creation in P5. Although making a preview for P5 is possible and does not interfere with OnFile, it takes time in the archive process.

See an example of P5 setup for a diskbased Archiveplan below. For more information about Archiware P5, please see http://www.archiware.com

Archiveplan setup in Archiware P5

Page 19: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

19

OnFile

OnFile

do not delete after archive

Preview generation is not needed

4.2.3 Amazon Glacier Location

The OnFile Glacier archivemodule adds archives to an existing Glacier archive vault.

The Amazon Glacier setup needs to be made on amazon.com prior to setting up the OnFile Glacier module. The setup includes registering an Amazon Web Service (AWS) account with Glacier, creating an AWS Glacier vault in the proper region and requesting access and secret ac-cesskeys for the Amazon AWS account.

Amazon Glacier is a service offering “Cold storage” meaning it is intended for use when assets are rarely restored. Restoring an asset involves first requesting an asset, followed by a wait time

The Amazon Glacier needs to be setup and

configured before setting up OnFile to

archive to Glacier

Page 20: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

20

OnFile

OnFile

for about 4 hours prior to download. This means that a restore from an OnFile Glacier archive location will take at least 4 hours + the download time of all assets in the request.

The OnFile Glacier module use a disk buffer where files are stored prior to being sent to Glacier. An archived asset will stay in the buffer for a certain time before being uploaded and removed from the buffer. This time - Retention time - is configurable with a default of 24 hours. There is a limit to how many concurrent uploads that can happen. The default is 5 and it can be changed under base configuration. Note that raising the number will increase the network bandwidth used by OnFile.

The buffer is also used on restores. Everytime a restore happens the asset will be downloaded from Glacier and placed back in the buffer for the restore to happen. It will then remain in the buffer for the retention time. OnFile will use a minium Retention time of 24 hours for restores no matter what the actual setting is. Just like for uploads, there is a setting for cuoncurrent downloads. It has a default of 5

The path to where the disk buffer is located is also a required setup. Note that this storage area may need to be large since it should hold a significant amount of data. The current status of the Glacier location can be viewed on the activity and logs page.

Amazon GLACIER is a service that is ideal for scenarios of cold storage. The service cost is sub-stantially higher when many restores are being made, especially on recently archived items. Study the pricing module on your AWS account.

Restoring an archive, is performed in several stages:

1) a restore request is added to the onfile queue from the plugin 2) the archive is requested from Glacier unless it is already in the buffer 3) onfile periodically checks if the archive is available 4) the archive is downloaded to the buffer 5) the complete restore request is gathered when ALL the archives in request has been down-

loaded

Based on the above list, consider these general guidelines to restores from Glacier locations:

• only restore items you need

• dont restore full folders unless necessary

• keep restore batches small

TypeintheAmazonGlaciersetupaswellasBasepathforarchivebufferandretentiontime.

Avoid too high number of concurrent uploads/downloads since it may impact server network

access.

Page 21: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

21

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

base path for archive buffer

Path to the directory where the archive should be written to.The directory needs to be writable.

minimum free space (mb)

TheminimumnumberofMBthatneedstobeavailableonthefilesystem.OnFilewill stop archiving to this archive when the free space drops below this number.

retention time (in hours)

Theminimumnumberofhoursthatanarchiveditemwillstayinthebufferbeforebeing pushed out to Glacier. The default retention time is 24 hours.

The same time applies to an asset that has been restored. In this case there is a minimum time of 24 hours.

Amazon Glacier region The Amazon region where the archive vault resides.Note: Changing this value may result in not being able to restore assets

Amazon Glacier vault name

The Amazon vault where to put the archived assets. The vault is not created by OnFile and has to exist before use.Note: Changing this value may result in not being able to restore assets

Amazon Glacier Ac-count id

The account associated with the Glacier vaultNote: Changing this value may result in not being able to restore assets

Amazon Glacier Access Key

The Glacier Access key given by the AWS account setup

Amazon Glacier secret Access Key

The Glacier Secret Access key given by the AWS account setup

Use the Test button at the bottom of the location window to test the Location setup. A message will appear at the bottom of the screen with the results. OnFile will attempt to connect to Ama-zon Glacier with the given credentials.

test of an Amazon Glacier archive location

Note that the region, vault and account cannot be changed for archived items.

Page 22: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

22

OnFile

OnFile

4.3 onFile plugins

The OnFile plugins are used to archive and restore from the basket. There is one plugin for Archiving and another for Restoring.

The plugins are controlled the same way as all other Xinet plugins, from the plugins tab in Xinet admin. Archive and Restore are enabled individually and the OnFile admin gui reflect the set-tings from Xinet admin.

Enable onFile archiving via Xinet admin

OnFile configuration can be applied to either a user or to a group. When launching the Archive or Restore plugin, OnFile will first check if there is a user unique setup and if so always apply that before a group configuration. That means that for users that has a primary group and where there are configurations made both on the user individually and on the group, the user setup will take precedence. By launching the user configuration page it i possible to see if a user configura-tion will override a group configuration or not.

Launch the plugin configuration from the Users & Groups tab and select either a group or a User to configure. The pulldowns can be typed in to limit the options to select.

select user or group

There are three sections in the plugin setup: General, Archive and Restore options.

If only one of the Archive or Restore sections show up when selected on a user it means that the user only has that particular option enabled in Xinet admin. When applying setups on groups, both the Archive and Restore sections are always available.

User configurations take precedence over group configurations

Page 23: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

23

OnFile

OnFile

4.3.1 General plugin options

The general options are shared between the archive and restore plugins:

General plugin options

coNFIGurAtIoN dEscrIPtIoN

Language Plugin language

user email Selection of:No user email - No user emailDisplayEmailfield-InputfieldinPluginwithWebNativeemailasdefaultUsedefinedEmailaddress-Hardcodetogivenemail.NouserinputAuto-assign user Email address - Use username or WebNative email. No input

InputfieldisusedwhenselectingUsedefinedEmailaddress

Administrator email Email address for associated administrator

Emails will be sent in a number of situations:

• To administrator when Approval is required and on certain error situations

• To user when a request has been denied, on certain error situations and when a restore has happened.

4.3.2 Archive plugin options

The archive options define the way the plugin behaves when archiving.

A key configuration is the Locations to choose from. This option decides what Archive locations that a particular user or group has access to. At least one location needs to be checked in order for the plugin to operate.

It is only possible to check locations that have been set to active.

Archiving options

Page 24: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

24

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

Plugin title Title displayed in the plugin and in Xinet Portal (when using IPIK 6.6 and above)

Locations to choose from

Check one or more locations that the user gets to choose from.If several are checked, the user will be presented with a select.NOTE: At least one location has to be checked.

require approval When checked, the request will need approval by a user that has monitoring and approvalrights.Anemailwillbesenttotheadministratoremailconfiguredunderthe general options.

control archive time Select to enable ability to decide when the archive request is to be executed. Choose between 12 or 24 hour system. When selected, the user will be presented with two pull-downs: one for the time of day and one for what day to execute on.

monitor requests Select option to enable monitoring for user, group or all requests.Also, select if user should have right to approve requests from the monitor.See more about the monitor below.

monitor title Title displayed in the plugin in monitor mode and in Xinet Portal as a toplevel link (when using IPIK 6.6 and above)

Filelist name FullorpartoffilenametomatchtoenableOnFiletoreadthefileasalistoffilestoarchive.WhenafileselectedviatheXinetbasketmatchthiscriteria,itwillbeopenedandeachlineinterpretedasafullfilepathtoaddtoarchive.

Example:Archivelist*wouldforexamplematchthefileArchivelist-20140630

Thisenablesausertopreparelistsoffilesandfolderthatshouldbearchivedandpass them in via the basket.

monitor hotfolders SelectoptiontoenablemonitoringofHotfoldersforthisuser/group.Select the option yes, limit plugin to hot folders if the user should only have ac-cesstoHotfoldermonitoringandnotbeabletorequestarchivesviatheplugin.

run hotfolders Set the option to yes to allow user/group to initiate hot folder execution via the monitor.

sample plugin setup from the Archiving options above

Page 25: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

25

OnFile

OnFile

4.3.3 restore plugin options

The restore options define the way the plugin behaves when restoring.

restore options

The restore method decides where the assets to be restored are restored to. It is possible to setup the restore process in several ways: completely controlled restore targets, ability to create folders, navigate through the user’s Xinet volumes and so on.

Additional controls can be applied to check for maximum restore size (quota) and how to handle Xinet database keywords on restored items.

Approval setups and monitoring of requests can also be assigned.

coNFIGurAtIoN dEscrIPtIoN

Plugin title Title displayed in the plugin and in Xinet Portal (when using IPIK 6.6 and above)

restore method The method of how Assets are restored back to the server. Selection of: Restore to original path - Files are restored to their original locationUse restore map - A hard coded or dynamic path decides where to restoreAllow user to browse - The user will use a browser to select restore location

Depending on the selection above, some other options will be displayed

static restore map A static path where to place the restored assets. The path can contain certain dynamic elements: User, Group, Date() and Replace()See restore map examples below

Available for Restore method = Use restore map

Let user save path Enables a check box to save the browse path. Next time it will be shown in a pull-down menu for quick access.Available for Restore method = Allow user to browse

create enlosing folder Put restored assets in an enclosing folderSelection of: No - No enclosing folder createdYes-Enclosingfolderwithnamegivenininputfieldisauto-createdUser supplied - Enclosing folder with name supplied by user is auto-created User supplied required - As above but required input

Available for all Restore methods except Restore to original path

control archive time Select to enable ability to decide when the restore request is to be executed. Choose between 12 or 24 hour system. When selected, the user will be presented with two pull-downs: one for the time of day and one for what day to execute on.

restore quota Type in limit (in MBytes) that the user is allowed to restore.Also select what action to take when limit is exceeded: No action (warn the user), Prevent request or make request need approval.

require approval When checked, the request will need approval by a user that has monitoring and approvalrights.Anemailwillbesenttotheadministratoremailconfiguredunderthe general options.

Page 26: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

26

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

monitor requests Select option to enable monitoring for user, group or all requests.Also, select if user should have right to approve requests from the monitor.See more about the monitor below.

monitor title Title displayed in the plugin in monitor mode and in Xinet Portal as a toplevel link (when using IPIK 6.6 and above)

sample plugin setup from restore options above

4.3.4 Restoreworkflows

Restoring files can be done to different locations on the server using different methods:

• Restore to original path

• User browse - The user can browse in the assigned Xinet volumes for a location

• Restore map - Restores will go to a predefined location

4.3.4.1 restore using browse

When this option is enabled the user will be able to see the Xinet assigned volumes and navigate to the location where to save the restored files. Also, using the option to save the path, the user may create a selection of folders to choose from.

When the browse method is used, a restore can only take place to a Xinet volume where the user submitting the request has access to.

use the browser to select where to restore to

Page 27: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

27

OnFile

OnFile

saved folders become available when they have been saved

It is possible to combine browse with the ability to create an enclosing folder. See the example below:

restore request using browse and creating a folder

the restore as submitted above

4.3.4.2 restore using restore map

A restore map is a predefined path where to restore files. It can either be a completely static path or a path that includes some dynamic elements. The path used for the restore can be anywhere on the server and the user submitting the request does not need to have access to the location.

To help the administrator to setup a static path, the input field for Restore map has a built-in navigator that helps navigate the Xinet volumes. When the field is empty, all System Volumes show as a select beneath the field. As selections are made or paths typed, the select updates show-ing folders in the current directory.

Page 28: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

28

OnFile

OnFile

Navigate to a static restore path

A dynamic restore path is built up by segments concatenated by the & character, and together builds a path. Example: /raid/somepath/restores/&date(%Y-%m)&/&USER

The segments can be static path elements, the keywords USER and GROUP and the functions described below:

• USER - inserts the username from the user that submitted the request

• GROUP - inserts the primary Xinet group from the user that submitted the request

• date(FORMAT) - inserts the date and time using an optional format. Example: date(%Y-%m). Default format is the iso date format: YYYY-MM-DD. See appendix X.X for formats

• SOURCEVOLUME - Inserts the path from the file’s original volume. Note that it will be the shortest path if there are nested volumes

• SRCVOL - Same as SOURCEVOLUME

• replace(FROM;TO) - takes the original archive path and replace the token FROM to the token TO. Example: replace(To_Archive;From_Archive)

• replace(FILE) - opens a tabdelimeted FILE that contains find/replace patterns like in replace(FROM;TO). The file can have multiple options where OnFile will use the first matched option. It is also possible to use the keyword DEFAULT for a default restoremap path in case there is no match. Example, A sample of the format (with <tab> for clarity): /Raid1/Main Clients/To_archive <tab> /Raid1/From Archive /Raid2/Main Clients/To_archive <tab> /Raid1/From Archive /Raid2/Other Clients/To_archive <tab> /Raid1/Pickup DEFAULT <tab> /Raid1/Pickup

• subpath(START;[END]) - get a section of the archive path. The first parameter is start and second (optional) is end Example: Restoring the file /archives/jobs/customer/acme/job1/file.jpg subpath(4;5) > acme/job1

Page 29: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

29

OnFile

OnFile

• closest(FOLDERNAME;[DEFAULT]) - Find the first named folder by searching all parents going backwards. If not found, a default can be used. Example: archivepath /my/raid/jobs/client/ajob/thisfile.jpg closest(_RESTORE) will look for _RESTORE in the parent folders in the order described below. If there is no such folder, /disk/_RESTORE will be used instead /my/raid/jobs/client/ajob /my/raid/jobs/client /my/raid/jobs /my/raid /my

setting up a dynamic restore map that includes a username and the date formatted as year-week-day

the restore form using a restoremap and few other options

the resulting restore having submitted the request as the user “john.doe”

Restore maps can be combined with the ability to create an enclosing folder. In that case, the new foldername will be appended to the end of the path given by the restoremap.

Using the same restoremap as above, but enabling Create folder (user supplied) would result in the following restore:

Page 30: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

30

OnFile

OnFile

resulting form using a restoremap and enabling the folder creation by user

the resulting restore having submitted the request as the user “john.doe” and created the folder “Project 123”

4.3.4.2 RestorefilesfromHotfolderarchivesusingrestoremap

A common workflow is to archive via named hot folders and when restoring restore to a match-ing restore folder, for example: To_Archive and From_Archive. In this type of workflow, the archive and restore folders need to be on the same folder level. See next section for information about setting up Hot Folders.

The replace() function that can be used in the restore map handle this type of workflow. In the Restore map field, type in the function together with the archive and restore folder names:

Example of restore map using replace(to_Archive;From_Archive)

When a restore is made, OnFile will look a the original archive path and replace the first param-eter with the second. For example, the path “/raid/jobs/ABC/To_Archive/12345/file.jpg“ will be changed into “/raid/jobs/ABC/From_Archive/12345/file.jpg“ using the aforementioned restore map.

See the following example using the restoremap from the section above.

Page 31: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

31

OnFile

OnFile

Added asset to the basket for restore.

restored to the folder From_Archive

4.3.5 Archive and restore monitor

Access to the Archive/Restore monitors is controlled by the Monitor requests setups above. Access can be enabled to the user’s own requests, the group’s requests or all requests. It is also possible to enable the ability to Approve requests when monitoring is active. Monitoring and approving is enabled separately for Archive and Restore.

The monitor functions of the Archive and restore plugins are very similiar and show a list of archive/restore requests that can be selected by statuses using a number of tabs and sorted by different critera by clicking the headers.

Select by tab

Sort by header

Archive monitor screen

In the list it is possible select to see different statuses where the default is handle which shows the requests that need approval or requests that failed and are in error mode.

Page 32: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

32

OnFile

OnFile

Depending on the selection (user, group or all) and what requests are available, there will be a number of tabs available:

• All - Show all requests

• Handle - Show requests that require intervention. This can be either errors or waiting for approvals

• Approvals - Show all requests awaiting approval

• Done - Show the requests that have been successfully processed

• Processing - Show the requests that are currently being processed by an Archiver

• Waiting - Show requests that are waiting, i.e. either having been scheduled for a later time or waiting to be picked up by an archiver

• Error - Show requests that encountered an error while being processed

This list shows requests along with the most important attributes. The user can click the request id to see more information about a certain request.

detail view on archive request in Processing status.

A link to the request details is also emailed to the given administrator email address for requests that require approvals.

Archive request email sent to administrator. the link goes to the details of the request in the monitor.

Page 33: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

33

OnFile

OnFile

4.4 Hot folders

Hot folders can be used for archiving by dragging assets and folders to be archived into one or more watched folders.

Using the hot folder method reduces the operator intervention and is easy to administer from a Job management view: when the job is done, simply drag it to the appropriate archive folder.

When the hot folder configuration is executed the found files and folders are added to an archive request which is then handled by the OnFile system.

OnFile supports several hot folder setups simultaneously, each with a different configuration.

The watched folders can either be identified via a search for a certain foldername under a certain Xinet volume and folder, or it is possible to manually point to several static folder locations to use for ingesting archives.

A hot folder setting can be run manually, as an ongoing cycle or scheduled at a certain time of day or week.

typical structure where each client folder contains a “to_Archive” folder

When a search based hot folder setup is checked, OnFile will look for folders with the designated name under the defined base path and archive all assets inside those folders. There is no need to do any type of pre-scan for hot folders. OnFile will make the scan each time it checks the specific hotfolder and will automatically include any folders that were created since the last time the hot folder was executed.

When using static paths, OnFile will check those paths for assets to archive.

4.4.1 Add hot folder

Use the Hot folders tab to load the Hot folders page. Enter a unique name for the hotfolder in the Add new Hot folder section and click Add.

There is no need to pre-scan for hot folders

on the server

Page 34: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

34

OnFile

OnFile

Adding hot folder

When the Hot folder has been added to OnFile, the interface automatically changes to the editing mode.

4.4.2 Configurehotfolder

The hot folder setup has a few configuration options, where the name, base path, folder name and location are required settings.

Configuringhotfolderoptions

coNFIGurAtIoN dEscrIPtIoN

Configurationname Name of the hot folder setup. Not to be confused with the Folder name for search-ing below.

comment Administrator comment about the hot folder setup.

Active Toggle to activate or deactivate a hot folder setup.A non-active hot folder is ignored by the OnFile system.

Administrator email Administrator email. Currently not used

Page 35: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

35

OnFile

OnFile

coNFIGurAtIoN dEscrIPtIoN

Archive to Location Select the location this hot folder will archive to. A hot folder setup can only archive to one Archive location.

time to archive Select type of shedule and scheduling options:Manual - Initiate archive via “Run now” buttonAs soon as possible - Execute at a regular interval (around 10 minutes)Daily-ExecuteataspecifictimeeverydayWeekly-Executeataspecifictimeonacertainday

Hot folder method Select the hot folder method to use:Search - Find all named folders under a base path (Xinet volume and subfolder)Specify list of paths - Specify paths individually by browsing Xinet volumes and adding to list

base path(search method)

Use the browse tool to select the area where the search for the watched folders should take place. OnFilewillonlyfindnamedfolderswithinthispath.

Folder name(search method)

Type in the folder name of the watched folders to search for. All folders with this name that are located within the base path will be searched for assets to archive.

Add hot folder path(static paths method)

Typeinthepathusingthedynamicnavigationintheinputfield.When the path is found, click the + button to add to the list.Eachpathwillbewatchedforassets(filesandfolders)toarchive

Pre-hot folder script A script can be run prior to the hot folder ingestion. This script works in a way that is similar to the Location scripts.The script will be run with three automatic arguments:1:Thehotfolderconfigurationname2:Apathtoatemporaryfilethatincludesallthesetupsfromtheconfiguration3: The optional argument from below

A sample script is shipped with the installation of onFile and is installed in the onfilebinsubdirectory.

optional argument Argument passed to hot folder as arg 3. See above

Readasfilelists Whensettoyes,everyassetfoundinthishotfolderconfiguationwillbeassumedtobeafilelist.SeeArchivingusingfilelistsinsection4.5When this option is set to yes a new set of selections appear to the right. These selectiondecidewhatwillhappentoafilelistthathasbeenused:Delete lists when used Leave lists as they are - lists will stay in same placeMarklistsasprocessed-thelistfilenamewillbeappendedwith“.processed”Moveliststootherfolder-thelistwillmovetothespecifiedfolder

The hot folder configuration can be tested using the Test button at the bottom of the page. Clicking the button will perform a basic test on the setup (without actually creating an archive request) and a console will open at the bottom of the page with the result of the test:

4.4.3 Hot folder monitor

Access to the Hot folder monitor is controlled by the Hot folder monitor selection on the Ar-chive plugin on user/groups.

The access itself is done via the Archive basket plugin. That means that for a user that need ac-cess to the Hot folder monitor, the Archive plugin needs to be enabled in Xinet nativeadmin. If the user should ONLY have access to the monitor and not be able to archive directly via the plugin, set the Monitor hot folders setting to Yes, limit plugin to hot folders.

Page 36: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

36

OnFile

OnFile

Limiting archive plugin to monitor hot folders

The hot folder monitor show all enabled hot folders with their next execution time and if run-ning, show the last status reported. If enabled, it also gives the user the ability to initiate the hot folder from the monitor.

Enabling the user to run hot folders

Initiating a hot folder via the monitor will give added feedback to the user being able to see the status of the hot folder ingestion until it has finished its operation. As soon as the request has been created, the user will be able to see archive request via the archive monitor.

Listing the hot active hot folders

clicking run now will intitate the hot folder

.. and the status will be updated as it moves along.

Page 37: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

37

OnFile

OnFile

4.5 Archiveviafilelists

Both hot folder and archive plugin archive requests normally assume that what is given are the actual assets that should be archived. As an alternative to this method it is possible to supply lists of the actual assets instead.

Using the plugin, the list needs to conform to a certain naming convention that is configured on the plugin setup. see Archive plugin options above.

Using a hot folder, one needs to set the Read as filelists option to yes. That means that ALL the assets passed in via that Hot folder will be considered to be lists as opposed to actual assets to archive.

The list is read and each line of the list should point to an asset to be archived. The format of the list should be one line per asset terminated with a UNIX newline character. The path needs to be exactly as in the filesystem and when using non-ascii characters encoded as the Xinet filesystem. No trailing slash characters should be used for directories.

Example: Supplying this list in a file would archive 3 folders and one file:

/Raid/Jobs/Done/Job-123/Raid/Jobs/Done/Job-456/Raid/Internal Jobs/Winter Party/Raid/Production PDFs/Winter_party_123456.pdf

It is possible to add directories to the lists ending with /*. In that case OnFile will look inside the folder instead of archiving the folder itself.

Example: Supplying this list in a file would archive the contents of the following folders:

/Raid/Jobs/Done/*/Raid/Internal Jobs/Done/*

Page 38: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

38

OnFile

OnFile

5 ActIvIty ANd LoGs

The Activity and logs page contain detailed logs for Locations and Hot folders as well as the Main log. It also show some basic information and a snapshot of the database contents (requests and archived files) for the selected log area.

The main monitor that can be accessed from the user plugin can also be accessed from the activ-ity and logs page.

5.1 main log

The main activity and log page show the total number of Archived files and folders as well as sta-tistics on the Archive and Restore requests tables. Requests are divided into numbers for Done, Errors, Approve, Waiting, Pending, Monitored and Queued.

The current process if of the OnFile daemon (onfiled) is showed as well.

5.2 view monitor

The plugin monitor can be accessed from this page (Archive, Restore and Hot folders).

The admin user (nativeadmin) has full access to all functionality of the monitor.

5.3 Location logs

Each Location has its own activity and logs page. It shows the total number of Archived files and folders as well as statistics on the Archive and Restore requests tables related to that Location only. Requests are divided into numbers for Done, Errors, Approve, Waiting, Pending, Moni-tored and Queued.

All the basic activity is shown in the location logs. The request id that show up for each request can be used to access details of that specific request.

For Glacier locations there are a couple of specific selections on the view log select:

view log for a Glacier location

The File transfer selection will show a list of the most current file transfers that were made to and from Amazon Glacier.

The Glacier Status selection will generate an overview of the Glacier location listing number of files in buffer, awaiting upload, awaiting download and so on. It will also list any restores cur-rently being monitored with links to get more details.

Page 39: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

39

OnFile

OnFile

5.4 Hot Folder logs

Each Hot folder has its own activity and logs page. It shows statistics on the Archive tables related to that Hot folder only. Requests are divided into numbers for Done, Errors, Approve, Waiting, Pending, Monitored and Queued.

The status area also show the next time the Hot Folder is due to execute.

Page 40: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

40

OnFile

OnFile

6 AdvANcEd

6.1 Customizingemailnotifications

The emails that are sent after restores and for archive errors are based on email templates using the same templating technology as other InPress Systems products.

The templates are text files saved to the server into a directory inside the onfile home directory:

/usr/inpress/onfile/notifications

Although the default templates can be edited, it is not recommended since they will be overwrit-ten when the installation is updated with new versions. The right procedure to customize the emails is to make a subfolder inside the notifications folder. Then copy the email files and the mail.css from the main folder into the subfolder:

# cd /usr/inpress/onfile/notifications# mkdir my_custom_emails# cp approval notice mail.css my_custom_emails/# ls -l my_custom_emails/-rw-r--r-- 1 root root 973 Apr 11 09:14 approval-rw-r--r-- 1 root root 877 Apr 11 09:14 mail.css-rw-r--r-- 1 root root 1008 Apr 11 09:14 notice

Then edit the files in the subfolder.

When this has been done, go back to the admin gui and select the group or user where the email should be applied. There is now a new setting under the common settings. Select the notification setting and save.

Page 41: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

41

OnFile

OnFile

A tImE ANd dAtE FormAttING

When using the date() function as a part of a restore path or in other types of tasks, OnFile uses the standard UNIX/C time_t type formatting of times and dates. As an example, using date() with the follwing formatter “%Y-%m-%d-%H.%M.%S”

date(%Y-%m-%d-%H.%M.%S)

Assuming that the current date is March 6, 2014 and the current time is 11.22.15, the output produced is

2014-03-06.11.22.15

Below is a partial list of sequences that can be used

%a Locale’s abbreviated weekday name%A Locale’s full weekday name%b Locale’s abbreviated month name%B Locale’s full month name%d Day of month [1,31]; single digits are preceded by 0%D Date as %m/%d/%y%e Day of month [1,31]; single digits are preceded by a space%h Locale’s abbreviated month name%H Hour (24-hour clock) [0,23]; single digits are preceded by 0%I Hour (12-hour clock) [1,12]; single digits are preceded by 0%j Day number of year [1,366]; single digits are preceded by 0%k Hour (24-hour clock) [0,23]; single digits are preceded by a blank%l Hour (12-hour clock) [1,12]; single digits are preceded by a blank%m Month number [1,12]; single digits are preceded by 0%M Minute [00,59]; leading 0 is permitted but not required%p Locale’s equivalent of either a.m. or p.m%r Appropriate time representation in 12-hour clock format with %p%R Time as %H:%M%S Seconds [00,61]; the range of values is [00,61] rather than [00,59] to allow for the occasional leap second and even more occasional double leap second%T Time as %H:%M:%S%u Weekday as a decimal number [1,7], with 1 representing Monday. See NOTES below%U Week number of year as a decimal number [00,53], with Sunday as the first day of week 1%V The ISO 8601 week number as a decimal number [01,53]. In the ISO 8601 week-based system, weeks begin on a Monday and week 1 of the year is the week that includes both January 4th and the first Thursday of the year. If the first Monday of January is the 2nd, 3rd, or 4th, the pre ceding days are part of the last week of the preceding year. See NOTES below%w Weekday as a decimal number [0,6], with 0 representing Sunday%W Week number of year as a decimal number [00,53], with Monday as the first day of week 1%x Locale’s appropriate date representation%X Locale’s appropriate time representation%y Year within century [00,99]%Y Year, including the century (for example 1993)

Page 42: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

InPress Systems Software License

This InPress Systems end user software license agreement (“agreement”) is the legal agreement that governs your use of the software made available by InPress Systems AB (together with its accompanying documentation, the “software”). This agree-ment is between you, the customer who has acquired the software (“you”), and InPress Systems AB (“InPress Systems”). Please read this agreement carefully.

InPress Systems is only willing to provide the software to you on the condition that you accept all of the terms contained in this agreement. You accept this agreement by installing or using the software or installing a license for the software. By ac-cepting this agreement or by installing the software, you represent and warrant that you have the authority to enter into this agreement, personally or if you have named a company as customer, on behalf of the company named as customer, and to bind either yourself or such company to the terms of this agreement.

If you did not acquire the software from InPress Systems or from an authorized InPress Systems integrator or a InPress Systems affiliate then you may not enter into this agreement or use the software. No other party has the right to transfer a copy of the software to you.

If you are unwilling to accept this agreement, do not use the software. If you have already paid for the software without having a prior opportunity to review this agreement and are now unwilling to agree to these terms, you may, within ten (10) days after the date on which you acquired the software, return it to InPress Systems or the authorized integrator from whom you acquired it, along with its original packaging and proof-of-purchase, for a full refund.

Notwithstanding anything herein to the contrary, no authorized InPress Systems integrator acts as an agent of InPress Systems, and no such party may enter into any contracts on behalf of InPress Systems. no authorized integrator has the authority to modify the terms of this agreement.

1. Grant of LicenseInPress Systems grants to you a nonexclusive, non-transferable license to use the Software on one computer system and to make one copy of the software solely for backup purposes. You must place the same copyright and other proprietary rights notices on any copy of the Software as appears on the original. You must not transfer, sell, assign, rent or distribute any copies of the Software to others. InPress Systems reserves all rights not expressly granted to you.

2. Proprietary RightsAs a licensee, you own the media on which the Software is originally recorded. The Software is copyrighted by and proprietary to InPress Systems and its suppliers. InPress Systems and its suppliers retain title and ownership of all copies of the Software. The nonexclusive license set forth in this Agreement is not a sale of the Software or any copy. You agree that you will not assign, sublicense, transfer, pledge, lease or share your rights under this Agreement and agree to take all reasonable steps to prevent unauthorized use. You agree you may not reverse assemble, reverse compile, or otherwise translate the software.

3. License Maintenance and Support One year of support is included when purchasing InPress Systems products. The year of support is calculated from the product licensing date or 30 days after the InPress Systemsinvoice is issued, whichever occurs first. Additional support is purchased at yearly intervals for 15% of the Current retail price of the software. (Please Note: Product modules that are added to the primary license after the original purchase, will be added to the existing support contract of the primary product license and therefore a full year of support will not be included in such cases).

4. No Other RightsExcept as stated above, this Agreement does not grant you any rights to patents, copyrights, trade secrets, trade names, trade-marks (whether registered or unregistered), or any other rights, franchises, or license in respect of the Software. You MAY NOT MODIFY TRANSLATE, DISASSEMBLE, OR DECOMPILE THE SOFTWARE OR ANY COPY, IN WHOLE OR IN PART.

5. TermThe license is effective until terminated. You may terminate the license at any time by destroying the Software (including the related documentation) together with all copies or modifications in any form. InPress Systems will have the right to terminate your license immediately if you fail to comply with any term or condition of the Agreement. Upon any termination you must destroy the Software together with all copies or modifications in any form.

Page 43: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

6. LIMITED WARRANTY

6.1 InPress Systems warrants to you that the Software will perform substantially in accordance with the user’s manual for a period of thirty (30) days after delivery to you (“Warranty Period”). If the Software fails to comply with this limited warranty, InPress Systems will at its option and at no cost to you, correct errors you discover which you report during the Warranty Period, or replace the Software, or refund the license fee paid for the Software provided you return the Software.

6.2 INPRESS SYSTEMS AND ITS SUPPLIERS DO NOT AND CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY OBTAIN BY USING THE SOFTWARE. YOU UNDERSTAND THAT, EXCEPT FOR THE EXPRESS WARRANTY SET FORTH IN SECTION 6.1, INPRESS SYSTEMS AND ITS SUPPLIERS MAKE NO WAR-RANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR STATUTORY, WITH RESPECT TO THE SOFT-WARE, INCLUDING ANY WARRANTIES AS TO PERFORMANCE, NON-INFRINGEMENT OF THIRD PARTY RIGHTS, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.EXCEPT FOR THE EXPRESS WAR-RANTY STATED IN SECTION 6.1, THE SOFTWARE IS PROVIDED “AS IS” WITH ALL FAULTS, AND THE EN-TIRE RISK AS TO SATISFACTORY QUALITY, ACCURACY, AND EFFORT IS WITH YOU. YOU ACKNOWLEDGE AND AGREE THAT YOU HAVE NOT RELIED ON ANY ORAL OR WRITTEN INFORMATION OR ADVICE, WHETHER GIVEN BY INPRESS SYSTEMS OR ANY AUTHORIZED INTEGRATOR, AGENTS OR EMPLOYEES.

7. LIMIT OF LIABILITYIN NO EVENT WILL INPRESS SYSTEMS OR ITS SUPPLIERS BE LIABLE TO YOU FOR ANY CONSEQUENTIAL, INDIRECT, EXEMPLARY, SPECIAL, OR INCIDENTAL DAMAGES, OR DAMAGES FOR ANY LOST DATA OR LOST PROFITS, ARISING FROM OR RELATING TO THIS AGREEMENT, EVEN IF INPRESS SYSTEMS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. INPRESS SYSTEMS’ TOTAL CUMULATIVE LI-ABILITY IN CONNECTION WITH THIS AGREEMENT AND THE SOFTWARE, WHETHER IN CONTRACT OR TORT OR OTHERWISE, WILL NOT EXCEED THE AMOUNT OF LICENSE FEES PAID TO INPRESS SYSTEMS OR YOUR AUTHORIZED INTEGRATOR, AS APPLICABLE, HEREUNDER. YOU ACKNOWLEDGE THAT THE LICENSE FEES REFLECT THE ALLOCATION OF RISK SET FORTH IN THIS AGREEMENT AND THAT IN-PRESS SYSTEMS WOULD NOT ENTER INTO THIS AGREEMENT WITHOUT THESE LIMITATIONS ON ITS LIABILITY. IN ADDITION, INPRESS SYSTEMS DISCLAIMS ALL LIABILITY OF ANY KIND OF INPRESS SYS-TEMS’ SUPPLIERS.

8. Integration. You acknowledge that you have read this Agreement, understand it, and that by installing the software you agree to be bound by its terms and conditions. You further agree that it is the complete and exclusive statement of the agreement between InPress Systems and you which supersedes any proposal or prior agreement, oral or written, and any other communications between InPress Systems and you relating to the subject matter of this Agreement. No variation of the terms of the Agreement or any different terms will be enforceable against InPress Systems unless InPress Systems gives its express consent, including an express waiver of the terms of this Agreement, in writing signed by an officer of InPress Systems.

9. Governing LawThis Agreement shall be governed by and construed in accordance with the laws of Sweden without giving effect to the choice of law principles thereof.

10. ArbitrationAny dispute, controversy or claim arising out of or in connection with this Agreement, or the breach, termination or invalidity thereof, shall be settled by arbitration in accordance with Göteborgsklausulerna om skiljeförfarande (simplified rules of arbitra-tion). The arbitral tribunal shall be composed of one arbitrator.

Page 44: OnFile - Amazon S3 · installinterphase README onf.1.1.redhat5.tar installonfile The following installation script will be available: installonfile. Run the installation script. Note

InPress Systems Software Credits

InPress Systems AB use the commonly available software libraries listed below.

JQueryhttp://jquery.comjQuery is provided under the MIT license.

JQuery UIhttp://jqueryui.comDual licensed under the MIT or GPL Version 2 licenses.

TipTiphttp://code.drewwilson.com/entry/tiptip-jquery-pluginThis TipTip jQuery plug-in is dual licensed under the MIT and GPL licenses.

JQZoomhttp://www.mind-projects.it/projects/jqzoom/This software is licensed under BSD.(read the license inside the archive)

jCrophttp://deepliquid.com/content/Jcrop.htmlJcrop is free software released under MIT License.

Fancyboxhttp://fancybox.netLicensed under both MIT and GPL licenses

Chosenhttp://harvesthq.github.io/chosen/Chosen is licensed under the MIT license.

libcurlhttp://curl.haxx.se/docs/copyright.htmlCurl and libcurl are licensed under a MIT/X derivate license

libsqlitehttp://www.sqlite.org/copyright.htmlPublic domain

libmysqlclientGNU General Public License

libqrencodeGNU Lesser General Public License