Microsoft SSRS Barcode CRI User Manual

Application Compatibility
IDAutomation's Reporting Services Barcode CRI is compatible
with the .NET Framework 2.0 and Microsoft Reporting Services 2005 & 2008.
This component is used to create barcode images on reports as an integrated control
that may be bound to SQL Server database fields.
Barcode Compatibility
These barcode generation controls support several linear and 2D barcode symbologies
including Code 39, Extended Code 39, Code 128, Telepen, Interleaved 2 of
5, LOGMARS, Codabar, EAN-128, GS1-128, USS Code 128, UPC-A, UPC-E, MSI,
EAN-8, EAN-13, Code 11, Code 93, Industrial 2 of 5, Postnet, Planet, Intelligent
Mail qne USPS4CB barcode symbologies. The 2D version includes
PDF417, Data Matrix ECC200, Aztec and QR Code.
SQL Server CRI 2005
Installation Application
- Download and unzip the package into a directory on the development
computer.
- Run the IDAutomation CRI Setup V2005 application.
- A navigation window will pop up asking you to navigate to the report
server directory.
This directory is machine-specific, and the directory will change depending on
which features of SQL Server are installed, For example in the following
directory the MSSQL.3 folder may be different
"\Program Files\Microsoft SQL Server\MSSQL.3\Reporting Services\ReportServer"
This folder may be MSSQL.1, MSSQL.2, or MSSQL.4.

- Verify that the directory to the Private Assemblies folder is
correct. The default for Visual Studio 2005 is "\Program Files\Microsoft
Visual Studio 8\Common7\IDE\PrivateAssemblies". Click the Browse button
to change it.

- When the directories are in place, click the Install CRI 2005 button.
This will copy the IDAutomation_ReportingServices_BarcodeCRI.dll
and IDAutomation_ReportingServices_Barcode.dll
files to the private assemblies directory and copy
the
IDAutomation_ReportingServices_BarcodeCRI.dll
file to the ReportServer\bin directory. This will also edit the
three config files necessary for deployment, the rsreportserver.config
and rssrvpolicy.config, which are located in the ReportServer\bin directory
and the rsreportdesigner.config file, which is in the PrivateAssemblies
directory.*
- Please see the
Reporting Services
Barcode Custom Report Item Tutorial for steps on including this in the Visual
Studio tool box.
SQL Server CRI 2008
Installation Application
- Download and unzip the package into a directory on the development
computer.
- Run the IDAutomation CRI Setup V2008 installer application.
- When the application loads there will be two directory paths, make
sure the directory to the Private Assemblies folder and the Report server
is correct. Click the Browse button to change it.

- Once the directories are in place, click the install button. This
will copy the IDAutomation_ReportingServices_BarcodeCRI.dll and IDAutomation_ReportingServices_Barcode.dll
files to the Private Assemblies directory and copy
IDAutomation_ReportingServices_BarcodeCRI.dll
file to the ReportServer\bin directory. This will also edit the
three config files necessary for deployment, the rsreportserver.config
and rssrvpolicy.config, which are located in the ReportServer\bin directory
and the rsreportdesigner.config file, which is in the PrivateAssemblies
directory.*
- Please see the
Reporting Services
Custom Report Item Tutorial for steps on including this in the Visual
Studio tool box.
* A backup of the original configuration
files are made, with a .bak extension, before they are edited. Ex: The backup for the rsreportserver.config file is called rsreportserver.config.bak.
Manual Barcode CRI Installation
- Download and unzip the package into a directory on the development
computer.
- Copy the IDAutomation_ReportingServices_BarcodeCRI.dll
file in the linear package, or the appropriate file ending in *CRI.dll in the 2D
package
from the extracted file to the Visual Studio private assemblies directory.
V2005: "\Program Files\Microsoft Visual Studio 8\Common7\IDE\PrivateAssemblies"
V2008: "\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\PrivateAssemblies"
and to the Microsoft SQL Server Reporting Services bin directory.
V2005: "\Program Files\Microsoft SQL Server\MSSQL.3\Reporting Services\ReportServer\bin".
This directory is machine-specific for SQL 2005. The MSSQL.3 folder
may be different, for example MSSQL.1, MSSQL.2, or MSSQL.4.
V2008: "\Program Files\Microsoft SQL Server\MSRS10.MSSQLSERVER\Reporting
Services\ReportServer\bin"
- Copy the IDAutomation_ReportingServices_Barcode.dll
file in the linear package, or the appropriate file ending in *CRI.dll in the 2D
package to the Visual Studio private assemblies directory.
V2005: "\Program Files\Microsoft Visual Studio 8\Common7\IDE\PrivateAssemblies"
V2008: "\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\PrivateAssemblies"
- Edit the rsreportserver.config and the rssrvpolicy.config files
in the ReportServer directory:
<CodeGroup class="FirstMatchCodeGroup"
version="1" PermissionSetName="Nothing">
<IMembershipCondition class="AllMembershipCondition" version="1"
/>
<CodeGroup
class="UnionCodeGroup"
version="1"
PermissionSetName="FullTrust"
Description="This code group grants IDAutomation_ReportingServices_
BarcodeCRI.dll Full Trust permission. ">
<IMembershipCondition class="UrlMembershipCondition"version="1"
Url="C:\Program Files\Microsoft SQL Server\MSSQL.3\Reporting Services\
ReportServer\bin\IDAutomation_ReportingServices_BarcodeCRI.dll"
/>
</CodeGroup>
etc.......................
</CodeGroup>
</CodeGroup>
- To register the design component, edit the rsreportdesigner.config
file in the PrivateAssemblies directory, and add the following code
before </Extensions>:
<ReportItems>
<ReportItem Name="LinearBarcode" Type="IDAutomation.ReportingServices.
LinearBarcodeCRI,IDAutomation_ReportingServices_BarcodeCRI"/>
</ReportItems>
<ReportItemDesigner>
<ReportItem Name="LinearBarcode" Type="IDAutomation.ReportingServices.
LinearBarcode, IDAutomation_ReportingServices_Barcode" />
</ReportItemDesigner>
- Follow the steps for installation
and deployment.
- If adding the custom assembly to an existing report, skip to
Step 12.
Create a report: Select File - New - Project from the
Visual Studio .NET IDE menu.
In the New Project dialog, highlight Business Intelligence
Projects in the Project Types box and Report
Project Wizard in the Templates box.
Name the sample report appropriately in the Name box and click OK.

- Select the data source. For this example, the AdventureWorks database
is used.
Ensure that the user edits the connection string to properly connect
to the database. Click Next.

- Create the query string for generating the report by using the
Query Builder.
Add the Customer table to the query by right-clicking the upper pane
in the query builder and selecting Add Table.
Highlight Customers and click Add and Close.
Click the CustomerID, TerritoryID, and AccountNumber fields. Click OK.

- Click Next on the Design Query Wizard.
- Choose the type of report (tabular or Matrix) to create and
click Next.
- Leave the default values for the grouping of the report and click
Next.
- Select the style of the table and click Next.
- Select the Report Server (The user will want to leave
the default value. This was setup during Report Services installation.)
and the folder for the deployment of the compiled report. Click Next.
- Name the report Barcode Company ID and click Finish. The report
will now be in Layout mode. The user may run the report to get an idea
of how the output will be displayed. The following steps will add the
barcode image to the report.
- Right click the last column in the table.
Select Insert Column to the right.
Label the column Barcode ID by typing directly into the column header.

- To add the IDAutomation
Reporting Services Barcode CRI component, right click the Report
Items Toolbox and select Choose Items.
In the next window select the .Net Framework Components tab
and click browse.

- For the 2005 version, browse to the IDAutomation_ReportingServices_Barcode.dll
in the "\Program Files\Microsoft Visual Studio 8\Common7\IDE\PrivateAssemblies"
directory, or the "\Program Files\Microsoft Visual Studio 9.0
\Common7\IDE\PrivateAssemblies" directory for version 2008. Click OK.
- The Linear Barcode component should be visible in the Report Items
Toolbox. If it does not appear or an error message is thrown, compare
the code in the rsreportdesigner.config to the code listed in step 5
in the Manual Installation section.
- Select the LinearBarcode CRI component and drag it into the Barcode
field. The properties of the barcode
may be edited in the Properties window.
- Click the Preview tab to ensure that a barcode is
returned. To verify that the data is being encoded properly, print the
report and scan it with a
barcode scanner. If a scanner is needed to verify barcodes, IDAutomation
suggests an easy-to-use
USB barcode scanner.

- To deploy the solution to the Report Server, choose Build
- Deploy Solution.
Sizing
the Barcode CRI Component
The custom report item component cannot be sized by dragging the object
because barcodes must meet specific requirements, such as a precise X dimension
(narrow bar width) and barcode height as specified in the properties of the control. To increase
the barcode width, increase the XDimensionMils property. To increase
the height, increase the BarHeight property.
Linear Properties
|
Linear Properties |
|
IDAutomation recommends using default
values for all properties, unless requirements dictate otherwise. |
| Property Name |
Default |
Property Description |
| ApplyTilde |
False |
When
ApplyTilde is set to "1" in Code 128 with the Auto character set,
the format ~ddd may be used to specify the
ASCII code
of the character to be encoded and several
other tilde options are enabled. |
| AutoSize |
True |
This is only
available in the 2005 version of the CRI. When set to true the size of the
canvas will automatically be fit to the size of the barcode. If the border is
adjusted manually then this will effectively set it to False. |
| BackGroundColor** |
Transparent |
The
background color of the barcode canvas. |
| BarHeightCM |
1 |
The
height of the barcode in
centimeters (CM). |
| BearerBarHorizontal |
0 |
The
width of the horizontal bearer bars as a multiple of the XDimension;
valid options are 0-10. |
| BearerBarVertical |
0 |
The
width of the vertical bearer bars as a multiple of the XDimension;
valid options are 0-10. |
| CaptionAbove |
null |
When
text appears in this property, it is displayed in the margin above
the symbol. |
| CaptionBelow |
null |
When text appears in
this property, it is displayed in the margin below the symbol. |
| CharacterGrouping |
0 |
Determines
the number of characters between spaces in the text interpretation
of the data encoded in the barcode. Supported values are 0 (which
disables grouping), 3, 4 and 5. |
| CheckCharacter |
True |
AddCheckDigit
automatically adds the check digit to the barcode when equal to
"True". The check digit is required for all symbologies except Code
39, Industrial 2 of 5 and Codabar. |
| CheckCharacterInText |
False |
AddCheckDigitToText
automatically adds the check digit that is encoded in the barcode
to the human readable text that is displayed when equal to "True". |
| CodabarStartCharacter |
A |
The
Start Character in the Codabar barcode. |
| CodabarStopCharacter |
B |
The
Stop Character in the Codabar barcode. |
| Code128CharSet |
Auto |
The
set of characters to be used in
Code128.
Valid values are: Auto, A, B or C. IDAutomation recommends using
Auto. |
| DataToEncode |
123456789012 |
DataToEncode
is the data that is to be encoded in the barcode. If the control
is connected to a control source, the source will override this
field. For example; setting DataToEncode to "=Fields!AccountNumber.value"
will encode the values in the AccountNumber field. |
| Font** |
Times New Roman |
Used
to change the font or font point size of the text interpretation
or human readable text. |
| Color** |
Black |
The
color of the bars in the barcode. |
| LeftMarginCM |
0.2 |
The
space of the left margin in
centimeters. |
| NarrowToWideRatio |
2.0 |
The
wide to narrow ratio of symbologies that only contain narrow and
wide bars such as Code 39, Interleaved 2 of 5 and MSI. Common values
are 2, 2.5, 2.75 and 3. |
| PostnetHeightShortBar |
0.1270 |
The
size in
centimeters of the short bars when using Planet and Postnet
symbologies, and the tracker bar when using the Intelligent Mail
(formerly OneCode). |
| PostnetHeightTallBar |
0.3226 |
The
size in
centimeters of the tall bars when using Intelligent Mail (formerly
OneCode), Planet and Postnet symbologies. |
| RenderedImageDPI |
300 |
The
DPI of the image that will be rendered when the report is run.
For version 2008 the default value is 96. |
| RotationAngle
|
Zero_Degrees |
Orientation
indicates the orientation of the barcode. Valid values are Zero_degrees,
Ninety_Degrees, One_Hundred_Eighty_Degrees and Two_Hundred_Seventy_Degrees. |
| ShowText |
Yes |
If
ShowText is yes (the default), the human readable text will be displayed
with the barcode. |
| ShowTextLocation |
Below |
Determines
if the human-readable text is placed above or below the barcode. |
| SuppSeparationCM |
0.5 |
The
distance between the end of the barcode and the beginning of the
supplement for UPC/EAN sybologies |
| SymbologyID |
Code128 |
A
number that selects the symbology or barcode type. To obtain more
information about barcode types, visit the
barcoding for beginners
page. |
| TextMarginCM |
0.10 |
Sets
the distance between the symbol and the text in
centimeters. |
| TextFontColor |
Black |
Color
of the human readable text |
| TopMarginCM |
0.2 |
The
top margin in
centimeters. |
| UPCESystem |
0 |
The
encoding system to be used for UPC-E; valid values are 0, 1, and
Auto. |
| WhiteBarIncrease* |
0 |
A
percentage value to increase the white space between the bars to
improve readability. Common values are 10, 15, 20 and 25.
* |
| XDimensionMILS |
11.8 |
The
width in mils (1/1000 of an inch) of the narrow bars. The X dimension
should be increased if the
barcode scanner
being used does not dependably decode the symbol. |
PDF417 Properties
|
PDF417
Properties |
|
IDAutomation recommends using default values
for all properties, unless requirements dictate otherwise. |
|
Property Name |
Default |
Product Description |
| ApplyTilde
|
True |
When true, the format ~??? may be used to specify the
ASCII code
of the character to be encoded. |
| PDFErrorCorrectionLevel |
0 |
The
Reed
Solomon error correction level encoded in the symbol. More error
correction creates a larger symbol that can withstand more damage.
The default setting of 0 performs automatic selection. |
| MacroPDFEnable
|
False |
When true, indicates
that this barcode is part of a
MacroPDF
sequence. |
| MacroPDFFileID
|
0 |
Assigns a file
id to the
MacroPDF
barcode. Each barcode in the
MacroPDF
sequence must have the same file id assigned to it. Valid options
are 0-899. |
| MacroPDFSegmentIndex
|
0 |
The index number
of each
MacroPDF
symbol must have a unique segment index, starting at zero and incrementing
thereafter by one. |
| MacroPDFLastSegment
|
False |
When true, indicates
that this is the final barcode in the
MacroPDF
sequence. |
| PDFColumns
|
0 |
The number of data columns in
the PDF417 barcode. The default is 0 and the maximum is 30. |
| PDFMode
|
Binary |
The
mode
of compaction used to encode data in the symbol. When set to
"Text," a smaller symbol may be created. Text mode encodes all characters
on the US keyboard plus returns and tabs. |
| PDFRows
|
0 |
Sets the number of rows. It is
recommended to leave this setting at 0, the default. |
| Truncated |
False |
A truncated PDF417 symbol is
more area efficient than normal PDF417. When true, the right hand
side of the PDF417 is removed or truncated. |
| XtoYRatio
|
3 |
The X multiple height of individual
cells; default = 3, usually 2 to 4 times the NarrowBarCM (X). |
Data Matrix Properties
|
Data Matrix
Properties |
|
IDAutomation recommends using default values
for all properties, unless requirements dictate otherwise. |
|
Property Name |
Default |
Product Description |
| ApplyTilde
|
True |
When set to True,
the tilde (~) will be processed as explained in the
DataMatrix Barcode FAQ and the format ~d??? may be used to specify the
ASCII code
of the character to be encoded. For example, "ECC-200~d009Data-Matrix"
encodes "ECC-200 <TAB> Data-Matrix". |
| EncodingMode
|
E_BASE256 |
Valid
Encoding Mode values are E_ASCII, E_C40, E_TEXT or E_BASE256. |
| LeftMarginCM
|
0.10 |
The left and right margin of
the symbol in
centimeters. |
| PreferredFormat
|
Auto |
Sets the
preferred format; valid values are from 0 (10X10) to 23 (144X144)
and from 24 (8X18) to 29 (16X48); the default value of "Auto" is
used for automatic formatting. |
| TopMarginCM
|
0.10 |
The top and bottom margin of
the symbol in
centimeters. |
| XDimensionCM
|
0.06 |
The width in
centimeters of the narrow bars. This value may need to be increased
if the scanner cannot read barcodes with small X dimensions. When
working with a
high-quality Data Matrix barcode
imager, this value may be decreased to create a smaller symbol.
|
Aztec Properties
|
Aztec
Properties |
|
IDAutomation recommends using default values
for all properties, unless requirements dictate otherwise. |
|
Property Name |
Default |
Property Description |
| ApplyTilde
|
True |
When set to "True,"
the format ~d??? may be used
to specify the
ASCII code of the character to be encoded. Commonly used ASCII
codes are ~d009 which is a tab function and ~d013 which is a return
function. |
| MessageAppend |
na |
Specifies the
message appended across multiple symbols. Only valid if NumberOfSymbols
is greater than 1. |
| NumberOfSymbols |
1 |
Invokes MessageAppend
across # symbols |
| XDimensionCM
|
0.06 |
The width in
centimeters of the narrow bars. This value may need to be increased
if the scanner cannot read barcodes with small X dimensions. When
working with a
high quality Aztec barcode
imager, this value may be decreased to create a smaller symbol.
|
QR-Code Properties
|
QR-Code Properties
|
|
IDAutomation recommends using default values
for all properties, unless requirements dictate otherwise. |
|
Property Name |
Default |
Description |
| ApplyTilde
|
True |
When set to "True,"
the format ~d??? may be used
to specify the
ASCII code of the character to be encoded. Commonly used ASCII
codes are ~d009 which is a tab function and ~d013 which is a return
function. |
| EncodingMode |
Byte |
The
mode of compaction used to encode data in the symbol. Valid
values are Byte, Alphanumeric, and Numeric mode. |
| Version |
AUTO |
Sets the
size of the symbol; valid values are from 01 (21X21) to 40 (177X177);
the default value of "Auto" is used for automatic formatting. |
| ErrorCorrection |
M |
The
error correction level encoded in the symbol. Valid values are
L, M, Q, H. Higher error correction creates a larger symbol that
can withstand more damage. |
| XDimensionCM
|
0.06 |
The width in
centimeters of the narrow bars. This value may need to be increased
if the scanner cannot read barcodes with small X dimensions. When
working with a
high quality
QR Code imager, this value may be decreased to create a smaller symbol.
|
* When used with low-resolution devices
such as the display screen, changes in the WhiteBarIncrease property
value may not be visible in the control itself. However, the change will
usually only be visible when printed, if a printer with 300 dpi or greater
is used.
** Due to compatibility issues, some of
the property names have changed in the 2008 version. The 2005 properties
Font, BackGroundColor, and Color are called HRFont, BackColor,
and ForeColor in the 2008 version respectively.
IDAutomation offers many other products for barcoding purposes including:
Known Issues
Additional support may be obtained through the following methods:
Back to Top
|