Skip to main content

Why Should You Use the /uploadpdb Option with TcmUploadAssembly.exe ?

A Bit of Background

TcmUploadAssembly.exe is a utility program that allows you to upload a DLL into the SDL Tridion Content Manager. It does the following:
  • Create a TBB (of type .NET Assembly) that holds the actual .NET DLL;
  • Create a TBB (of type C# Code Fragment) for each class in the .NET DLL that implements the ITemplate interface;
  • Optionally, creates Parameter Schemas and associates them with the individual template TBBs;
  • Optionally, uploads the PDB corresponding to the .NET DLL;
The following command line arguments are accepted:

Usage: TcmUploadAssembly [options] [ConfigurationFilePath] [AssemblyPath]
  ConfigurationFilePath    The location where the configuration file for this
                           tool can be found.
  AssemblyPath             The location of the assembly to be uploaded.

Basic Options:
  /verbose                 Output extra debug information.
  /help                    Print this message.
Overriding Options (overriding either assembly or configuration file values):
  /folder:tcmuri           Override the folder to store the assembly
                           specified in the assembly.
  /targeturl:cmsurl        Override the target url of the CMS
                           specified in the configuration file.
  /username:nameofuser     Override the username to use in authentication
                           with the web service.
  /password:clearpassword  Override the password to use in authentication
                           with the web service.
  /uploadpdb:true|false    Override whether the PDB should be uploaded from
                           together with the assembly.
  /timeout:in seconds      Override the time it needs to upload the assembly
                           to the web service.


Why the PDB?

To put it simply, without the PDB, you won't be able to debug your code. A PDB file contains information about the source file names with line numbers and the local variable names. So, without a PDB, you won't know in which file the particular class is and at which line your execution pointer is. You will only know the name of the class and method you are in. That is not enough information a debugger can go by.

You can find a techie, yet excellent article here PDB Files: What Every Developer Must Know.

Without a PDB, a stack trace would look something like this (I'm attempting a division by zero in my code to yield an exception):

Attempted to divide by zero.
   at CwaReferenceImplementation.Templates.Generic.FormatDate.Transform(Engine engine, Package package)

While with the PDB present, the exact same code shows the following stack trace:

Attempted to divide by zero.
   at CwaReferenceImplementation.Templates.Generic.FormatDate.Transform(Engine engine, Package package) in C:\Reference Implementations\CWA Reference Implementation\Tridion Templates\Reference Implementation Templates\Generic\FormatDate.cs:line 25

TcmUploadAssembly will upload the PDB either to C:\temp or to %TRIDION_CM_HOME%\temp.

Comments

Popular posts from this blog

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Event System to Create Mapped Structure Groups for Binary Publish

As a continuation of last week's Publish Binaries to Mapped Structure Group , this week's TBB is in fact the Event System part of that solution. Make sure you do check out the previous post first, which explains why and what this Event System does. To reiterate, the Event System intercepts a Multimedia Component save, take its Folder path and create a 1-to-1 mapping of Structure Groups. The original code was written, again, by my colleague Eric Huiza : [ TcmExtension ( "MyEvents" )] public class EventsManager  : TcmExtension {     private Configuration configuration;     private readonly Regex SAFE_DIRNAME_REGEX = new Regex ( @"[\W_]+" );     public EventsManager() {         ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap ();         fileMap.ExeConfigFilename = Path .GetDirectoryName( Assembly .GetExecutingAssembly().Location) + "\\EventSystem.config" ;         configuration = ConfigurationManager