Streaming Barcode Server for IIS User Manual

• Streaming Barcode Implementation
  
• Barcode Parameters and Properties
• Symbology Specific Notes
  • Code 128
  • USPS Barcodes
  • UPC and EAN
• Barcode Image Resolution
• Performance
• Technical Support Issues
• Streaming Integration Tutorials
  
• 2024 Product Update: QR-Code in this product includes new built-in support for Auto Mode, ECI, UTF8 Encoding, TLV and Base64, Swiss QR-Bill, Center Override, and GS1 QR Code. Data Matrix now includes a faster and more efficient auto-encoding algorithm and supports GS1 and UTF8.

Buy License Support Download Demo Release Log

Overview

The IDAutomation Streaming Barcode Server for IIS adds barcode generation capability to Microsoft Windows Server. These barcodes are streamed to web browsers and applications without saving temp images on the server. The barcode is created in an application as a dynamic IMG tag and is modified from the parameters passed. After installation, the streaming barcode server generates barcodes as a dynamic image for many applications and on multiple operating systems, including mobile devices.

Installation

This product tutorial outlines the Linear Streaming Barcode Server installation for IIS. If installing other versions, such as QR Code, for example, consider the difference in file names.

1. Determine which folder in the IIS website the streaming barcode component will generate images from; this will be part of the URL used to acquire the barcode. If you are creating a separate folder to generate barcodes, use the folder name "idautomation", for example, \inetpub\wwwroot\www.yoursite.com\idautomation.
2. Extract all files from the downloaded package, which will contain the following files in the linear version:
   

   File Name	Folder	Copy to GAC
   IDAutomationStreamingLinear.aspx	idautomation\
   LinearStreamCS.dll	idautomation\bin\
   IDAutomation.LinearServerControl.dll	idautomation\bin\	(if necessary)

3. Copy the files to the root of the "idautomation" folder keeping the same directory structure; the DLLs should be in the "bin" folder under the main folder that contains the ASPX file as shown above. 
4. Right-click on the "idautomation" folder, choose Properties, and make sure IIS_IUSRS and NETWORK SERVICE have the rights of Read and Execute, List Folder Contents, and Read. If they do not, add these rights.
   
5. In the IIS Management Console, this folder must also be an application. If this is not the case, right-click on the folder and choose Convert to Application.
   
   
6. To verify the project is working correctly, view the streaming page in the browser from the local machine; for example http://localhost/idautomation/IDAutomationStreamingLinear.aspx
   
7. If the barcode does not appear, try placing IDAutomationLinearServerControl.dll in the Global Assembly Cache (GAC) and restart IIS. Some configurations of IIS require the server control files to reside in the GAC. This may be performed by opening two instances of Windows Explorer. In one, choose the files ending in ServerControl.dll (ex: IDAutomationLinearServerControl.dll). In the other, navigate to C:\Windows\Assembly and copy the files into the Assembly folder. Explorer must be used to copy the files from one window to the other. If problems are encountered, refer to Microsoft documentation about copying files into the GAC.
8. The barcode may now be created in another application as an IMG tag from parameters passed; for example:
   <img src="http://yourserver.com/idautomation/IDAutomationStreamingLinear.aspx?barcode=123456789012&H=1.7"/>
9. If using the product on a production server with other applications, consider implementing IIS Application Pool Barcode Streaming Best Practices.

The following video tutorial is similar to the instructions above, except it uses QR Code instead of the linear generator and a "test" folder instead of the "idautomation" folder.

Streaming Barcode Integration into Other Applications

Parameters in the URL of streaming barcode products determine the data that is encoded as well as other properties. To transition from the examples provided, replace the SaaS demo streaming URL https://www.bcgen.com/demo/linear-dbgs.aspx with the unique URL of your streaming barcode generation product. Several implementation examples are provided on the Streaming Barcode Generator SaaS Integration Tutorials page.

Additional implementation examples:

ASP

<HTML><P>This web page uses ASP code to create a barcode.<P>
<% @ LANGUAGE = VBScript %> <% BarcodeData = "123456789012" %>
<img src="<%="https://www.bcgen.com/demo/linear-dbgs.aspx?D=" & BarcodeData %>"
</P></body></HTML>

HTML

The following code generates a Code 39 barcode in HTML as an IMG tag that is 2 CM tall with the check character disabled:

<img src="https://www.bcgen.com/demo/linear-dbgs.aspx?D=123456789012&H=2&S=0&CC=F"/>

PHP

<html><body><p>This web page uses PHP code to create a barcode.</p>
<?php $BarcodeData = "123456789012"; ?><p>
<img src="http://www.yourwebserver/idautomation-code128.php?D=<?php echo $BarcodeData ?>">      
</p></body></html>

Reporting Applications

Barcodes may be streamed into applications that support dynamic image objects, including Crystal Reports and FileMaker.

JavaScript and Web Applications

Barcodes may be dynamically generated and displayed as demonstrated on the IDAutomation Software Return Form which uses JavaScript to create a printable page displaying barcodes used to automate data entry. Within the JavaScript function, the order number is encoded in the symbol with the following code:

message += "<img src='https://www.bcgen.com/demo/linear-dbgs.aspx?D="
message += document.form1.orderNum.value;

Barcode Parameters and Properties

IDAutomation recommends using default values for all properties unless requirements dictate otherwise.

Parameters must be separated by the & character and cannot include spaces.

General Barcode Properties for all Symbologies

Linear Specific Barcode Properties

Data Matrix

DotCode

PDF417-Specific Barcode Properties

MaxiCode-Specific Barcode Properties

Aztec-Specific Barcode Properties

QR Code-Specific Barcode Properties

DataBar, Composite, and MicroPDF417 Barcode Properties

Additional properties may be changed in code if necessary when implementing Streaming Mode for ASP.NET Project Integration.

Barcode Image Resolution

The default resolution generated image is 96 DPI which allows the image to be displayed properly in a web browser although it may be necessary to increase the resolution of the image for printing purposes. This can be easily accomplished in Server Control Mode by changing the ImageResolution property. Increasing the resolution in Streaming Mode can cause the image to display proportionally larger in the browser. To resolve this issue in Streaming Mode, the size of the image may be reduced or expanded using HTML.

Technical Support Issues

For testing purposes, IDAutomation offers the Barcode Decoder App, which may be used to verify encoded data.

Free lifetime Level 1 support may be obtained by reviewing the knowledgebase articles that are documented and by searching resolved public forum threads or the stream-barcode tag. One incident of Level 2 support for a period of 60 days is included with the purchase of any license. Level 2 support and upgrades may be provided beyond 60 days if the Level 2 Support and Upgrade Subscription is purchased when making the order.

Documented Solutions:

• 404 "File Not Found" Error With Barcode Server Control DLLs in IIS
• How To Achieve a Precise X Dimension For Printed Barcodes
• How To Encode Reserved Characters Used in HTML
• IIS Application Pool Barcode Streaming Best Practices
  
• Barcode Images Do Not Consistently Display or Print Correctly
• Barcode Image is Too Large After it is Created
  
• Streaming to 203 dip thermal printers

Popular Forum Post Resolutions:

• IIS Application Pool Barcode Streaming Best Practices
  
• Server Error in '/' Application - Parser Error
• Barcode displays 'Powered by IDAutomation.com' in the Licensed Version
• Forms authentication failed for the request
• Blank Barcode In Crystal Reports when Streaming

Common Support Issues for Streaming Barcode Server for IIS

Creating a Virtual Directory in IIS

• Using Windows Explorer, create a physical directory below the website directory that will be part of the URL. Example: c:\Inetpub\wwwroot\IDAutomation
• Open Internet Information Services or Information Services Manager (IIS). This tool can be found under Administrative Tools.
• Right-click Default Web site and choose New - Virtual Directory.
• Click Next on the Welcome screen of the Virtual Directory Creation Wizard.
• Enter an Alias name that maps a physical directory that will be part of the URL. Example: http://www.mydomain.com/IDAutomation.
• Choose Next and Browse to the physical directory created earlier.
• Select the physical directory, choose Next to grant the default permissions,  and click Finish.
• NOTE: In Windows Server 2008 and above, including Windows Server 2012, the Virtual Directory must also be an application in IIS. If this is not the case, right-click on the Virtual Directory and choose Convert to Application.

Error - "Server Error in Application" Runtime Error:

• The error may look similar to this:
  

  Server Error in '/' Application. Runtime Error Description: An application error occurred on the server. Details: To enable the details... <! -- Web.Config Configuration File -->

• This error is generated when .aspx is not executed from a virtual directory under IIS with the ability to run applications. In Windows Server 2008 and above, including Windows Server 2022, the Virtual Directory must also be an application in IIS. If this is not the case, right-click on the folder that contains the aspx file and choose "Convert to Application" as mentioned in step 4 above.

Error - "Server Error in Application" Parser Error:

• The error may look similar to this:
  

  Server Error in '/' Application. Parser Error Description: An error occurred during the parsing of a resource required to service this request. Please review the following specific parse error details and modify the source file appropriately. Parser Error Message: File or assembly name IDAutomation.QRCodeServerControl, or one of its dependencies, was not found.

• This can be generated when the .aspx is not executed from a virtual directory under IIS with the ability to run applications. In Windows Server 2008 and above, including Windows Server 2022, the Virtual Directory must also be an application in IIS. If this is not the case, right-click on the Virtual Directory and choose Convert to Application.
• If this error is received in ASP.NET Project Integration, a reference to the server control DLL was not found. Add a reference to the IDAutomation Server Control in the project. For example: Right Click on References, Choose Browse, and select the server control DLL.

ASP.NET Project Barcode Integration

When a Developer License is purchased with a signed Source Code Agreement, the ASP.NET solution of streaming DLLs can be provided for custom integration, modification, and code-behind in ASP.NET. When using products other than the linear version in this example, the difference in file names should be considered.

1. Extract all files from the package.
2. After the files are extracted, additional ZIP files will be found in the destination directory. Extract all files from the zip ending in CS as the IDAutomation_StreamingLinear_CS.zip is used for a C# project.
3. Locate the image-generating web page .aspx file from the extracted files. Copy this file and all associated files to the ASP.NET project directory. The image generating ASP.NET page for the linear control is IDAutomationStreamingLinear.aspx and its associated files are IDAutomationStreamingLinear.aspx.resx and IDAutomationStreamingLinear.aspx.cs.
4. Copy the appropriate Server Control DLL file to the ASP.NET project directory. In this example, IDAutomation.linearservercontrol.dll is copied.
5. Add a reference to the IDAutomation Server Control in the project. For example: Right-Click on References, choose Browse, and select the server control DLL.
6. Add the IDAutomationStreamingLinear.aspx file to the ASP.NET project by right-clicking the name of the project in Solution Explorer and selecting Add Existing Item. The following graphic illustrates the reference to the DLL and the image-generating web page aspx file in a solution.
   
   
7. Rebuild the solution or project.
8. To verify the project is working correctly, view the actual streaming aspx page in the browser. Example: http://localhost/WebApplication1/IDAutomationStreamingLinear.aspx
9. Choose the method that will update the properties of the barcode:

Dynamic IMG Tag Method:

• The following demonstrates how to pass parameters to the streaming barcode generator from a URL.
  <img src="IDAutomationStreamingLinear.aspx?barcode=0123456789012&S=0&H=1.5"/>
  IDAutomation provides examples of creating barcodes in this way with JavaScript and Crystal Reports.

Code-Behind Method:

• To implement code-behind using Visual Studio .NET, reference the sample project included in the ZIP file and the LinearStreamCS.csproj file. Add the image tag referencing the image generating aspx page, which was added to the project, to the aspx page that needs to display the barcode image. Example:
  <img src="IDAutomationStreamingLinear.aspx"/>
  The Page_Load event for the image generating .aspx page may be changed to hard-code specific values for the image that is to be displayed.