This appendix describes an ExtraView command-line utility that moves file attachments from internal storage within the database, to the file system.<\/p>\n
By default, file attachments uploaded to ExtraView are stored as binary objects in the database. The ExtraView Administrator has the choice to configure the system to store some or all of the uploaded attachments to a file system accessible by the application server.<\/p>\n
Within ExtraView, the program keeps track of where all particular attachments are located. Prior to the conversion, all attachments are marked as being stored \u201cinternally\u201d \u2013 within the database. As part of the migration process, as each individual file is extracted and copied to the final location on the external file system, the system marks that attachment as now being stored \u201cexternally\u201d. This allows the migration process to be done as a background task, without impacting the availability of ExtraView or its attachments to the end users.<\/p>\n
This provides flexibility \u2013 the Administrator can choose to have all files stored internally in the database, all files stored externally in the file system, or have a mixture of some file types stored within the database, and some file types stored on the file system.<\/p>\n
To configure attachment storage options, log in to ExtraView with the Administrator role. Click on the Admin<\/b> navigation button, then the System Controls<\/b> tab, then select All Behavior Settings<\/b>, and edit the following settings:<\/p>\n For example, if you set the value of this setting to txt, doc, docx, htm, html<\/b> then files of these types will be stored within the database. This strategy leaves the files stored internally in the database, while image and video files with extensions such as jpg<\/b> and mp4<\/b> are stored externally.<\/p>\n Regardless of the setting, ExtraView will continue to store dynamically generated thumbnail-sized image files in the database as these are relatively small files and for performance reasons must be more readily available.<\/li>\n You should ensure that there is adequate space for future growth when sizing the file system to be used for storing attachments externally. To do this, have your DBA connect to your ExtraView database using Query Analyzer (MSSQL) or SQL Plus (Oracle) and run the following queries:<\/p>\n — bring back the total size of the attachments stored in the database, in bytes. <\/span> There are several forms of the doAttachmentMigration<\/span> command. The utility is found in the directory named WEB-INF\/data<\/span>. All require one or more parameters passed as part of the ExtraView command line utility:<\/p>\n doAttachmentMigration instanceName -type %binary% -type %zip%<\/span><\/li>\n Attachment ID values can be found by having your DBA run the following SQL query against the ExtraView database:<\/p>\n select min(attachment_id), max(attachment_id) from attachment;<\/span><\/p>\n Optional parameters can be added inside the double quotes:<\/p>\n -report <filename><\/span> – Generates a specific location for the report file. By default the report will be dumped into ExtraView log file.<\/p>\n -delete<\/span> – If specified, deletes the attachment content blob from the database after migration. We would not generally recommend this if you have a large number of attachments, as it is much more efficient to simply have your DBA truncate the table when you have completed the migration and you have validated your results.<\/p>\n -testOnly<\/span> – This allows a dry run migration of the attachments without any modification to the database or the repository.<\/p>\n -noValidation<\/span> – This prevents the CRC-32 check on the stored migrated attachments, and will be somewhat faster. Use of this parameter is not recommended, because the extra time to validate the file content vis-\u00e0-vis the blob content is nominal, and the consequences of storing a blob in the file system incorrectly due to I\/O error or network error could include a loss of valuable data. If the CRC-32 validation fails, the attachment is not migrated and an error is posted to the log and\/or report file.<\/p>\n The migration command line utility is included in the ExtraView application package. It requires Java be installed on the application server to run. We provide shell and batch file scripts that you can use to run the utility.<\/p>\n If you have deployed ExtraView in a WAR\/EAR file, you will need to set up an exploded directory to run this script. The scripts are located in the evj\/WEB-INF\/data<\/span> folder on your application server.<\/p>\n Edit the doAttachmentMigration.bat<\/span> file<\/p>\n Locate the lines<\/p>\n set JAVA_HOME=C:\\ExtraView\\java\\jdk1.7.0 and modify the paths to match your installation<\/p>\n Save and exit the edit session.<\/p>\n Open a Command window in the evj\\WEB-INF\\data<\/span> folder and type the following command:<\/p>\n doAttachmentMigration instanceName “parameters”<\/span><\/p>\n where “parameters”<\/span> is a double-quote enclosed list of parameters as per the options listed above.<\/p>\n Edit the doAttachmentMigration.sh<\/span> file<\/p>\n Locate the lines<\/p>\n TOMCAT_HOME=\/usr\/local\/extraview\/tomcat Save and exit the edit session.<\/p>\n At the command prompt, type the following command:<\/p>\n sh doAttachmentMigration.sh instanceName “parameters”<\/span><\/p>\n where “parameters”<\/span> is a double-quote enclosed list of parameters as per the options listed above.<\/p>\n Run the script you just edited.\u00a0 You must provide some additional parameters as shown here:<\/p>\n If you do not know the attachment IDs you may run this query:<\/p>\n You might also simply substitute 1 and a very high number.<\/p>\n While the migration utility runs, it will print out information to the console. It will also write detailed log entries to a file in the evj\/WEB-INF\/log<\/span> folder or to the file defined in the -report<\/span> parameter option. Once the process has completed, you can check the log file to determine if there were any problems.<\/p>\n If all attachments were migrated, you can verify that the attachments are available to download and view through the ExtraView web interface. Once you are satisfied, you can have your DBA remove the binary attachments from the database.<\/p>\n If you have selected the option to have all attachments stored in the file system, your DBA can simply run the command<\/p>\n update attachment set thumbnail_id = null where thumbnail_id is not null; If you have selected the option of having some types of file stored in the database and some files stored externally, your DBA will need to run some variant of<\/p>\n delete from attachment_content This appendix describes an ExtraView command-line utility that moves file attachments from internal storage within the database, to the file system. By default, file attachments uploaded to ExtraView are stored as binary objects in the database. The ExtraView Administrator has the choice to configure the system to store some or all of the uploaded attachments…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24211,"menu_order":11,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24220","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\n\n
Sizing the file system<\/h3>\n
\nselect sum(file_size) from attachment; <\/span>
\n— bring back the number of attachments in the database
\nselect count(*) from attachment; <\/span><\/p>\nMigration Utility Options<\/h3>\n
\n
Running the Migration Utility<\/h3>\n
Microsoft Windows with Apache Tomcat<\/h4>\n
\nset TOMCAT_HOME=C:\\ExtraView\\Tomcat7.0
\nset EV_BASE=C:\\ExtraView\\Tomcat7.0\\webapps\\evj<\/span><\/p>\nLinux \/ Unix with Tomcat<\/h4>\n
\nJAVA_HOME=\/usr\/local\/extraview\/java
\nEV_BASE = $TOMCAT_HOME\/webapps\/evj<\/span>
\nSet TOMCAT_HOME,<\/span> JAVA_HOME <\/span>and EV_BASE<\/span>\u00a0to the correct paths for your installation.<\/p>\nFor All Platforms<\/h4>\n
REM required:\nREM -from (the starting attachment id for the migration) and -to (the ending attachment \nid for the migration)\nREM or\nREM -id (an attachment id for the migration)\nREM or\nREM -type content_type [-type content_type2[ ...]] (content type may be a wild card using\n database wild cards -- i.e. '%')\nREM or\nREM -id_list <file> (the name of a file containing attachment id's - one per line)\n\n<\/pre>\n
select min(attachment_id), max(attachment_id) from attachment;<\/pre>\n
Validation and Completion<\/h3>\n
\ntruncate table attachment_content;<\/span><\/p>\n
\nwhere attachment_id in
\n( select attachment_id from attachment where STORED_INTERNAL = ‘N’ );<\/span><\/p>\n