Assembly Upload Add-In for Visual Studio

For those developers working with Tridion Modular Templating this tool is very useful. It let you upload the dlls from your visual studio projects in a custom way, it means, no post-build event needed to upload the dll and the developer can choose which dlls to upload when needed.

This tool is a Visual Studio Add-In which allows the developers to upload their dll into Tridion in a simple manner. Once the Add-In is set up the developer has the two following options under the �Tools� menu in the Visual Studio IDE:

Before running any of the options, the user should open a Solution in Visual Studio. Once it�s open the user can configure the settings for the upload clicking in �SDL Tridion � Upload Assembly settings�� option under the �Tools� menu within Visual Studio.

Then the developer is prompted with the settings form where the configuration takes place:

TcmUpload (*Mandatory): Upload tool location:     TcmUploadAssembly.exe 
CMS(*Mandatory)
: URL to access the CMS, 
 
 
http://SERVER_NAME:PORT
User(Optional):  User name to access the CMS
Password(Optional):  Password to access the CMS
Verbose:  determines whether the tool shows verbose info or not
Upload pdb:  determines whether the pdb file associated to the dll is uploaded or not
 
 

Note: If no user/password is defined the current credentials are used.   

Current Projects Functionality

The following table stores the configuration for each project in the current solution:

Checkbox: enables/disables project dll upload. If checked the specified project dll will be uploaded
Project: Name of the project
DLL: Location of the dll for the specified project
Last Update: Last time the dll was updated.

 

The dll for each project in the table is set by the tool. The tool searches for every dll within the project root folder with the name specified in the project properties page within Visual Studio, this is, imagine we have a project called MyTemplates in C:\MyProyects and the dll we�ve configured to be created is MyTemplates.dll. The tool will search in C:\MyProjects for every dll in the folder and its children with the name: MyTemplates.dll. If it finds more than one, it will set the last updated one.

If no dll found �NOT FOUND� is displayed in the cell. In this case, or just if the develolper wants to associate another dll to the project, and this dll is located in another folder, this value can be configured manually by double clicking over the current dll location:

If we want to go back to the default dll, we can click in the cell containing the dll path, remove the content and then press enter. The tool will set the last updated dll found within the Project folder again.

Settings File Label

The settings file label shows the location of the configuration file for the current solution:

This file contains all the settings for the current solution and can be modified manually with a text editor as well. By default its location is under the root folder of the current solution.


 

Form Functionality

From the form we have several options:

Reset Form: Resets the form to the last saved status. It means that if we change something in the form and we have made a mistake and we want to go back to it previous configuration, we just need to click over �Reset Form� and it will load the configuration from the file again.     

Reload Project List:  It allows to add/delete new/old projects to the list within the form. Imagine we add a new project to our solution and we want the project to be available in our configuration settings. We just have to click over �Reload Project List� and it will synchronize the settings with the Visual Studio solution tree:     

 

As shown in the above picture, the dll location is �NOT FOUND�. This is because we haven�t generated the dll yet. After we compile the project and we create a dll, the next time we open the form, this cell will be updated.

When a project is deleted from the Visual Studio Solution, the reload option will synchronize the settings as well.

Save: saves the current configuration. It is recommended to save the configuration after performing changes in the dll location and the fields in the form. When checking/un-checking the project items, the settings are saved automatically.     

Upload:performs the upload of the assemblies based in the current settings. Al the logs and information about of the status of the upload is displayed in the output window within Visual Studio.     

SDL Tridion � Upload .Net Assemblies option

This option allows performing the upload of the assemblies based in the current settings. Al the logs and information about of the status of the upload is displayed in the output window within Visual Studio. This is the same functionality we can find in the upload button within the settings form.

Output Screenshots

 


Company
License agreement
Tags
:    Modular Templating,  Visual Studio
Version
:   1.0
Source
:   No

About the Author
Jaime Santos Alcon
Technical Consultant

Originally from Madrid, Jaime is working from SDL Tridion's office in New York, US. He started as a Java developer and moved into the Web Content Management space. Has been working with Tridion's CMS for the past 6 years.

SDL CMT division