Date: Thu, 28 Mar 2024 20:22:30 +0000 (UTC) Message-ID: <245316395.9535.1711657350577@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_9534_1993601581.1711657350575" ------=_Part_9534_1993601581.1711657350575 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The following sections provide instructions on how to make basic= changes to the Enterprise Tester Web files.
Changes to the web.config file can leave Enterprise Tes= ter inoperable. We advise taking a backup of your web.config file and= database prior to making changes.
Locating the web.config File
The web.config is located in the web subdirectory of the application ins= tallation path, which defaults to c:\Program Files\Catch Limited\Enterprise= Tester\Web\ folder.
By default, the =E2=80=9C|=E2=80=9D is reserved for use as a path = separator for package, requirement and script paths in imports and exports = and cannot be used in Requirement, Script or Use Case names. Should y= ou need to use the =E2=80=9C|=E2=80=9D extensively as part of your naming c= onvention, the path separator can be changed in Enterprise Testers web.conf= ig file as follows.
Open the Web.Config file (usually located in c:\Program Files\Catch Limi= ted\Enterprise Tester\web\) and find the following section near the top of = the file.
<appSettings>
<add key=3D"migration.providerName" value=3D"Migrator.Providers.SqlSe= rver.SqlServer2005Dialect"/>
</appSettings>
Add a new line with the path separator of your choice after =E2=80=9C
<appSettings>
<add key=3D"migration.providerName" value=3D"Migrator.Providers.SqlSe= rver.SqlServer2005Dialect"/>
<add key=3D"PathService.PackagePathSeparator" value=3D"~"/>= ;
</appSettings>
By default the location of the Indexes folder will default to the "Data"= folder of your installation. The indexes folder can grow up to= 1 gigabyte in size, so if you don't have a lot of space free on your insta= llation drive, or prefer to store data in a different location, you will ne= ed to update the web.config file to specify this location.
To change the location, locate the <appSettings>...</appSetting= s> section in the web.config file and add a new value "search.indexes.pa= th" on the line after <appSettings> like so:
<appSettings>
<add key=3D"search.indexes.path" value=3D"c:\savemy\inde= xes\" />
The "value" section of this entry needs to contain the absolute path of = the folder where you want to have the indexes stored.
Enterprise Tester provides the option of storing attachments in a file s= ystem rather than in the Enterprise Tester database. By default Enter= prise Tester will store attachments in the file system. Previously, Enterpr= ise Tester defaulted to storing attachments in the database, in order to mo= ve to file storage of attachments you will be required to migrate your atta= chments.
Enterprise Tester provides a mechanism to migrate between storing = attachments in the file system or database for an existing instance of= Enterprise. Before commencing, the Enterprise Tester website should = be taken offline. The easiest way to do this is to stop IIS or stop t= he application pool Enterprise Tester belongs to.
To store attachments in a location other than /Data/Attachments, you wil= l need to add the "attachment.storage.path" setting to the web.config file = (ensure the attachment storage method remains the same). Next, start a command prompt, a= nd change the Enterprise Tester bin folder:
cd c:\Program Files\Catch Limited\Enterprise Tester\Web\bin\
Now run the following executable:
AttachmentMigrator.exe
A message similar to the following should appear:
Enterprise Tester Attachment Migration Tool Version 1.0.0.0
Current Attachment Storage Configuration: FileSystemCas
This tool will migrate attachments to the new storage location: InData= base
WARNING! This operation cannot be reversed, and if it fails, will leav= e your database in a inconsistent state. Please ensure you have backe= d up the database before proceeding.
To proceed type "yes" and press enter
As the message suggests, you should always backup both your database and= web.config file prior to using this tool - as if it fails halfway through,= it will leave your Enterprise Tester database in an inconsistent state.
When you are ready type "yes" and press enter.
You will then see progress displayed on screen, and eventually the migra= tion will complete.
Initializing...
Initialization Complete.
Plugins Folder: c:\Program Files\Catch Limited\Enterprise Tester\Web\b= in
Attachments Folder: c:\Program Files\Catch Limited\Enterprise Tester\D= ata\Attachments\
Database Type: SqlServer
....................................... Processed 40/265 (15%)= pre>........................................ Processed 80/265 (30%)<= /pre>........................................ Processed 120/265 (45%)=........................................ Processed 160/265 (60%)=........................................ Processed 200/265 (75%)=........................................ Processed 240/265 (91%)=.........................Migration completed and web.config file updated, total time: 4.5294003= sNow restart IIS or the application pool, and your attachments will now b= e stored in the new location.
If you are migrating from file system to in-database storage, you will n= eed to manually delete/archive the attachment files after the migration.
Setting = Maximum File Sizes
To support the attachment of very large files change to the configuratio= n of the application are also required. By default Enterprise Te= ster sets a limit of 64mb for requests. To support attaching larger files y= ou will need to change this value.
In the web.config file, locate this section:
<system.web><httpRuntime executionTimeout=3D"18000" maxReque= stLength=3D"65535" />The value "maxRequestLength" controls the maximum size of requests in ki= lobytes, changing this to value such as 1024000, will allow you to upload f= iles up to 1gb in size.
Garbage Collection= h3>
When you delete an attachment, the associated contents (if stored on say= the file system) won't be immediately removed. Instead a periodic process = occurs called "garbage collection" where any content no longer referenced b= y the database is then removed. By default this process runs onc= e every hour. The frequency can be configured by specifying an additi= onal key "attachment.storage.garbagecollection.dwell":
<appSettings><add key=3D"migration.providerName" value=3D"Migrator.= Providers.SqlServer.SqlServer2005Dialect" /><add key=3D"attachment.storage.method" value=3D"F= ileSystemCas" /><add key=3D"attachment.storage.garbagecollection.dwell= " value=3D"5" /></appSettings>In the example above we have set "dwell" to 5 minutes. Attachments will = be =E2=80=9Ccleaned up=E2=80=9D every 5 minutes. Generally speaking, it is = recommended that unless you are performing tests, this should be set to 30 = minutes or higher.
In addition if you wish to disable garbage collection altogether, you ca= n add the key "attachment.storage.garbagecollection.disable" with the value= "true".
<appSettings><add key=3D"migration.providerName" value=3D"Migrator.= Providers.SqlServer.SqlServer2005Dialect" /><add key=3D"attachment.storage.method" value=3D"F= ileSystemCas" /><add key=3D"attachment.storage.garbagecollection.disab= le" value=3D"false" /></appSettings>Setting= Automatic Refresh Lookups
Enabling/Disabling Automatic Refresh Lookups at start up
By default, Enterprise Tester is automatically set to refresh lookups on= startup of the application. In the web.config file, by default defecttrack= ing.settings.populator.syncuncachedonstartup is set to =E2=80=98tru= e=E2=80=99. This initially triggers a check for =E2=80=9Cunc= ached=E2=80=9D projects. If =E2=80=9Cuncached=E2=80=9D projects are found, = a refresh lookups synchronisation is triggered at startup. To disable= , set defecttracking.settings.populator.syncuncachedonstartup is set to =E2= =80=98false=E2=80=99.
Enabling/Disabling Automatic Refresh Lookup= s when a new project link is created
By default, Enterprise Tester is automatically set to refresh lookups wh= en a new project link is created under the Resources tab. In the web.config= file, by default externaldata.createlink.autorefreshlookups is set to
=E2=80=98true=E2=80=99. This triggers a refresh of all t= he cached custom/inbuilt field data when a project link is created. The ref= resh process will only work if the defect tracker is also enabled. To= disable the automatic refresh lookup, change externaldata.createlink.autor= efreshlookups to =E2=80=98false=E2=80=99. Chan= ging Server Key Generation Method
When upgrading from V3.X or prior to V4.X, the server key generation met= hod will automatically update to this method. When upgrading from V3.x and = prior or when making this change manually to a production system, please co= ntact Catch Limited Support (support@catchlimited.com) to pre= -arrange a time for a new license to be generated, this will minimize any o= utage period.
In versions prior= to 4.0, the server key used by Enterprise Tester was generated from this i= nformation:
In virtualized environments the MAC addresses can often change, causing = a new server key to be generated next time Enterprise Tester starts, displa= ying a message on screen to customers that their license is now invalid or = expired.
A new server key generation method that generates a stable server key ev= en if the MAC address changes over time, to use it you must add the followi= ng line to your web.config file:
<appSettings>
=E2=80=A6
<add key=3D"Licensing.ServerKey.GenerationMode" value=3D"Stabl= e" />
Once added, on the next start up, a new "stable" server key will be gene= rated.
At this point you will need apply a new license text which can be provid= ed by Catch Limited on request. Please provide youre new server key.
If you are using EC2, then by default windows instances will be allocate= d a new hostname every time they start up. This is in the form of "ip= -XXXXXXX" (where XXXXXX is a hexadecimal number), so even when using the st= able server key generation mode this would require that a new license is en= tered every time Enterprise Tester starts up.
To remedy this, access the EC2 server via remote desktop, and then:
Another recommendation is to assign the machine a more meaningful name, = as this will be recorded in log files and can be used to determine which ma= chine they were recorded on (i.e. development or production).
To give the server a more meaningful name:
Once restarted, access Enterprise Tester in a web browser, obtain the se= rver key, request/generate a new valid license, and apply it.
You should now be able to start/stop the EC2 instance without having to = enter a new server key every time.