==Installation==

To install Transfer, the following steps must be followed.

<ol>
<li>[http://www.transfer-orm.com/?action=transfer.download Download Transfer.] </li>
<li>Either place the directory '/transfer/' in the webroot of your server, or create a mapping called '/transfer' to the '/transfer/' folder. </li>
<li>Write an xml config file that outlines the database connectivity details.<br/>[[Datasource Configuration File]]
</li>
<li>Write an xml config file that outlines the objects and classes for transfer to manufacture.<br />[[Transfer Configuration File]]</li>
<li>Create a singleton of [http://docs.transfer-orm.com/html/transferapi/transfer/TransferFactory.html transfer.TransferFactory]. 

<messagebox type="warning">
The paths that are passed in as arguments to [http://docs.transfer-orm.com/html/transferapi/transfer/TransferFactory.html transfer.TransferFactory] are all relative, and should be passed from root, i.e. starting with '/'.<br/>This is particularly important for the definitions directory, as it is used to cfinclude files from, so it must either be from the web root, or point to a ColdFusion Mapping
</messagebox>

For example: 

<source lang="coldfusion">
application.transferFactory = createObject("component", "transfer.TransferFactory").init(
 							"/myapp/configs/datasource.xml", 
 							"/myapp/configs/xml/transfer.xml",
 							"/myapp/definitions");
</source>



The TransferFactory can also be instantiated by passing a [http://docs.transfer-orm.com/html/transferapi/transfer/com/config/Configuration.html transfer.com.config.Configuration] object to the TransferFactory, for example:  

<source lang="coldfusion">
config = createObject("transfer.com.config.Configuration").init(
 							"/myapp/configs/datasource.xml", 
 							"/myapp/configs/xml/transfer.xml",
 							"/myapp/definitions");
 
application.transferFactory = createObject("component", "transfer.TransferFactory").init(configuration=config);
</source>

</li>

<li>All interaction with Transfer is now done through the instantiated [http://docs.transfer-orm.com/html/transferapi/transfer/TransferFactory.html transfer.TransferFactory].</li>
</ol>

<messagebox type="info">
If you change any of your configuration, you will need to re-create your TransferFactory as it retains a memory resident copy of it..
</messagebox>

==Updating from a previous version==

If you are updating from a previous version of Transfer,

# You will need to delete all of your .transfer generated files. In each version of Transfer it is likely that the details written in these files will differ greatly from the previous version.
# If the previous version of Transfer contains a Java Library (.jar) file, it is likely that you will not be able to delete it. Simply place the newer Transfer .jar files in the same library, and the previous version will be ignored by Transfer. Once the ColdFusion server is reset, or the garbage collector picks up the Object that references the file, you will be able to delete it.

[[Category:Installation]]