Inventor ETO Conveyor Demo
==========================

Version: Inventor ETO 2013, 6.0
$Date: 2012/06/08 $

Description
	This sample is an Inventor ETO application built on the Inventor and Inventor OEM platforms.
	Read this document and follow the instructions to build and run the sample.

Prerequisite
	Install "Inventor ETO Series"


Components
==========

.                -- current directory
|   ReadMe.txt   -- This file.
|   Conveyor.sln -- Microsoft Visual Studio solution. Use this to build the project.
|
+---Conveyor     -- Conveyor application code for the Inventor Add-In.
|   |   *.*
|   |
|   +---bin
|   |   \---{Build_Config}   -- Debug or Release
|   |           Conveyor.dll -- Inventor OEM Primary Add-in
|   |
|   \---Configuration
|       |   Autodesk.Conveyor.Inventor.addin -- Inventor OEM addin descriptor file for Primary Add-in.
|       |
|       \---BrandingResources
|               *.*          -- Image resources for branding the sample application using OEM Configurator.
|
\---InvETO Files             -- Support files for the application.
    |   Conveyor.ipj         -- Custom Inventor project file configured to use the support files.
    |
    +---Design Files         -- Intent Design Scripts and icons
    |       *.iks
    |       *.ico
    |
    +---InventorParts        -- Adopted part files used by the application.
    |       *.ipt
    |
    \---Templates            -- Any custom Inventor template files.
            ConveyorSystem.iam
            *.*


How to debug the project
========================

	1) Set the project to launch Inventor (or Inventor OEM) on start-up.
		a) Open project properties.
		b) Select the "Debug" tab.
		c) Set the "Start Action" to "Start external program".
		d) Select <InstallPath>\Inventor.exe (or InventorOEM.exe) as the start-up program.

	2) Build the Project.

	3) Start debugging.

NOTE: The entry point for the add-in is the "Activate" method in StandardAddInServer.



Deployment
==========

	Primary Add-in (Conveyor.dll)
		This must be co-located with the Inventor ETO Components.
		For development this means by default it needs to go in the following location:
		"%ProgramFiles%\Autodesk\Inventor ETO Components {Year}\Bin"
		The Conveyor.csproj contains a post-build step to copy the target to this location.

	Add-in descriptor file (Autodesk.Conveyor.Intent.addin)
		This tells Inventor OEM where to find the Primary Add-in.
		It should be deployed to the application-specific Application Data folder.
		Ex. {CommonAppData}\{Company}\{AppName}\Addins\
			Where
				{CommonAppData}	is the OS-specific common application data folder (see note below).
				{Company}	is the name of the company that created the add-in.
				{AppName}	is the name of the application followed by the release year.
		For the development environment, the following location is used (copied in a post-build step):
			{CommonAppData}\Autodesk\Inventor OEM {Year}\Addins\

	Branding Resources (BrandingResources\*.*)
		Use the "OEM Configurator" application that comes with Autodesk Inventor OEM to add custom branding.
		OEM Configurator will modify the resources in the BrandRes.dll shipped with Autodesk Inventor OEM.
		The image files located under Conveyor\Configuration\BrandingResources are provided as sample
		resources that can be used for the Conveyor sample.
		The BrandRes.dll must be deployed to the same directory as the executable file (*.exe).
		By default this location in the development environment is the following:
			%ProgramFiles%\Autodesk\Inventor OEM {Year}\Bin\

	Support Files under "InvETO Files"
		These are the files that make up the functionality of the Inventor ETO application.
		They should be deployed to the application-specific Application Data folder.
		Ex. {CommonAppData}\{Company}\{AppName}\
			Where the directories are the same as described above.
		NOTE:	For Inventor OEM-based deployment, this location is defined by the installer.
			For Inventor-based deployment, we can't use Inventor's AppData directory so we use the following location:
				{CommonAppData}\Autodesk\{AddInName} {Year}\
				Where
					{AddInName}	is the assembly name of the add-in (i.e. "Conveyor").
					{Year}		is the Inventor release year.
		For the development environment there is a post-build step to copy these files.



Note on {CommonAppData}
=======================

	{CommonAppData} is determined by the Operating System but there isn't one environment variable for it.
		For Windows XP the location is usually the following:
			%ALLUSERSPROFILE%\Application Data
				%ALLUSERSPROFILE% commonly expands to the following:
					C:\Documents and Settings\All Users

		For Windows Vista and Windows 7 the location is usually the following:
			%ALLUSERSPROFILE%
				%ALLUSERSPROFILE% commonly expands to the following:
					C:\ProgramData

		Using .Net Framework, you can get the {CommonAppData} directory using the following code:
			Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData)