Skip to main content

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

Image
By
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.

Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
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...
2 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...
10 comments
Read more