Merge pull request #794 from dynamsoft-docs/preview

update to internal commit f5c73f95

Author: DMGithubPublisher

_includes/sidelist-faq.html

@@ -1,29 +1,23 @@
 <li>
-    <a class="otherLinkColour">FAQ</a>
+    <a href="{{ site.faq_general }}index.html" class="otherLinkColour">FAQ</a>
     <ul>
 
         <li>
             <a href="{{ site.faq_general }}general.html">General</a>
         </li>
         <li>
-            <a href="{{ site.faq_general }}license-usage.html">Dynamsoft Licensing & Usage</a>
+            <a href="{{ site.faq_general }}license-usage.html">Licensing & Usage</a>
         </li>
         <li>
-            <a href="{{ site.faq_general }}configuration.html">Dynamsoft Barcode Reader Configuration</a>
+            <a href="{{ site.faq_general }}configuration.html">Configuration</a>
 
         </li>
         <li>
-            <a href="https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/faq/">Dynamsoft Barcode Reader for JS</a>
+            <a href="{{ site.faq_general }}multi-platform.html">Multi Platform</a>
         </li>
 
         <li>
-            <a href="https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/objectivec-swift/faq/">Dynamsoft Barcode Reader for iOS</a>
-        </li>
-        <li>
-            <a href="https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/faq/">Dynamsoft Barcode Reader for Android</a>
-        </li>
-        <li>
-            <a href="https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/maui/faq/">Dynamsoft Barcode Reader for MAUI</a>
+            <a href="{{ site.faq_general }}error-debug.html">Error & Debug</a>
         </li>
     </ul>
 </li>

faq/general/configuration.md

@@ -17,10 +17,10 @@ permalink: /faq/general/configuration.html
 
 3. [How to filter incorrect results with the barcode result length?](avoid-incorrect-results.html)
 
-4. [How to Handle Non-printable Characters Like "\u{1D}" or "{GS}" from the Barcode Text?](unprintable-character.html)
+4. [What will happen if licenses are not renewed in time?](what-happens-if-license-expires.html)
 
-5. [How to create custom settings template?](custom-settings-template.html)
+5. [How to Handle Non-printable Characters Like "\u{1D}" or "{GS}" from the Barcode Text?](unprintable-character.html)
 
-6. [How can I sort the barcodes of my image in reading order?](sort-barcodes-image.html)
+6. [How to create custom settings template?](custom-settings-template.html)
 
-7. [How to Scan EAN/UPC with Addon Codes?](how-to-scan-ean-upc-with-addon.md)
+7. [How can I sort the barcodes of my image in reading order?](sort-barcodes-image.html)

faq/general/custom-settings-template.md

@@ -11,7 +11,7 @@ permalink: /faq/general/custom-settings-template.html
 
 One of the strengths of the Dynamsoft Barcode Reader is its wide range of cuztomizable options that can optimize the performance of the SDK. Whether you are looking to prioritize read rate or speed, these settings can be used in many ways to match the targeted use case.
 
-If you are looking to create your own custom template of settings to use with the [InitSettingsFromFile](https://www.dynamsoft.com/capture-vision/docs/server/programming/cplusplus/api-reference/capture-vision-router/settings.html?product=dbr&repoType=server#initsettingsfromfile) method, here are the steps:
+If you are looking to create your own custom template of settings to use with the [InitSettingsFromFile][https://www.dynamsoft.com/capture-vision/docs/server/programming/cplusplus/api-reference/capture-vision-router/settings.html?product=dbr&repoType=server#initsettingsfromfile] methods, here are the steps:
 
 1. Visit the main [online demo](https://demo.dynamsoft.com/barcode-reader/).
 
@@ -23,6 +23,6 @@ If you are looking to create your own custom template of settings to use with th
 
 5. Copy the JSON code under *Template* and paste it into your own JSON file, or you can download the template JSON file straight from the demo.
 
-Note: If you have a JSON file that you previously used in version 9 and would like to keep using that, please note that the format needs to change to be useable in version 10.x of the SDK. Please use the [TemplateConverter Tool](https://download2.dynamsoft.com/dcv/TemplateConverter.zip) to convert the template to Barcode Reader version 10 compatible template.
+6. The template you downloaded is currently Barcode Reader version 9 template and the latest version is version 10. Use the [TemplateConverter Tool](https://download2.dynamsoft.com/dcv/TemplateConverter.zip) to convert the template to Barcode Reader version 10 compatible template.
 
-And with that, you have your own template to use with the `InitSettingsFromFile` method! 
+And with that, you have your own template to use with the `InitSettingsFromFile` method! 

faq/general/ensure-no-overuse.md

@@ -4,17 +4,23 @@ title: How to properly use concurrent instance license?
 keywords: Dynamsoft Barcode Reader, FAQ, Pricing/Licensing, General, ensure no overuse
 description: How to properly use concurrent instance license?
 needAutoGenerateSidebar: false
-permalink: /faq/general/ensure-no-overuse.html
 ---
 
 ## How to properly use concurrent instance license?
 
 [<< Back to FAQ index](index.md)
 
-The standard way(C++) to use concurrent instance license is:
+The standard way to use concurrent instance license is:
 
-* Call method SetMaxConcurrentInstanceCount to set the license count you purchased.
-* Update the parameter MaxParallelTasks to align with the purchased quantity.
+* Call method `SetMaxConcurrentInstanceCount` to set the license count you purchased.
+* Update the parameter `MaxParallelTasks` to align with the purchased quantity.
+
+<div class="sample-code-prefix template2"></div>
+   >- C++
+   >- C#
+   >- Python
+   >
+>
 ```cpp
     int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
     int errorCode = 1;
@@ -31,14 +37,91 @@ The standard way(C++) to use concurrent instance license is:
     setting.maxParallelTasks = licenseCount;
     cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &setting);
     // add further process
+    // CCapturedResult *result = cvRouter->Capture("IMAGE-FILE", CPresetTemplate::PT_READ_BARCODES);
+```
+>
+```csharp
+    int licenseCount = YOUR-PURCHASED-LICENSE-COUNT;
+    int errorCode = 0;
+    string errorMsg;
+    errorCode = LicenseManager.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
+    LicenseManager.SetMaxConcurrentInstanceCount(licenseCount)
+    if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_LICENSE_CACHE_USED)
+    {
+        Console.WriteLine("License initialization error: " + errorMsg);
+    }
+    else
+    {
+        CaptureVisionRouter cvRouter = new CaptureVisionRouter();
+        SimplifiedCaptureVisionSettings settings;
+        cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings);
+        setting.maxParallelTasks = licenseCount;
+        cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg);
+        // add code for further process
+        // CapturedResult result = cvRouter.Capture("IMAGE-FILE", PresetTemplate.PT_READ_BARCODES);
+    }
+```
+>
+```python
+license_count = YOUR-PURCHASED-LICENSE-COUNT
+LicenseManager.set_max_concurrent_instance_count(license_count)
+error_code, error_msg = LicenseManager.init_license("YOUR-LICENSE-KEY")
+if error_code != EnumErrorCode.EC_OK and error_code != EnumErrorCode.EC_LICENSE_CACHE_USED:
+    print("License initialization error: " + error_msg)
+else:
+    cvr_instance = CaptureVisionRouter()
+    error_code, error_msg, settings = cvr_instance.get_simplified_settings(EnumPresetTemplate.PT_READ_BARCODES)
+    settings.max_parallel_tasks = license_count
+    error_code, error_msg = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARCODES, settings)
+    # add code for further process
+    # result_array = cvr_instance.capture_multi_pages("IMAGE-FILE", EnumPresetTemplate.PT_READ_BARCODES)
+```
+
+## Managing Instance Limits and Parallel Tasks on a Device
+
+Sometimes, a device may encounter an error indicating that the instance count has exceeded the permitted limit. This typically occurs when the total number of concurrently used instances surpasses the maximum number allowed for the device, either due to over-requesting instances or initiating more parallel decoding tasks than permitted.
+
+### About `SetMaxConcurrentInstanceCount`
+
+The `SetMaxConcurrentInstanceCount` function is used to **declare the maximum number of instances a device is allowed to use**. This count is **managed per device**, not per program.
+
+- If multiple programs are running on the same device and each calls `SetMaxConcurrentInstanceCount`, the device will be allocated **the highest value** among the calls, **not the sum**.
+
+- If `SetMaxConcurrentInstanceCount` is **not called**, the device will by default request **only one instance**, not the full number available from the purchased license quantity.
+
+### About `MaxParallelTasks`
+
+The `MaxParallelTasks` setting defines how many decoding tasks can run in parallel within a single `CaptureVisionRouter` instance. It controls the level of concurrency during barcode processing.
+
+- Each `CaptureVisionRouter` instance will open up to `MaxParallelTasks` decoding tasks simultaneously.
+- By default, if `MaxParallelTasks` is **not set, 4 parallel tasks** will be opened.
+
+### How Instance Usage Is Calculated
+
+The actual instance usage on a device is calculated using the following formula:
+
+```text
+Total Instance Usage = Number of concurrent programs × 
+Number of CaptureVisionRouter instances per program × 
+MaxParallelTasks per CaptureVisionRouter instance
 ```
+For example, if two programs are running on the same device, and each creates 2 `CaptureVisionRouter` instances with `MaxParallelTasks = 4`, then the total instance usage is:
+
+`2 programs × 2 instances × 4 tasks = 16 instances`
 
-Sometimes, a device may encounter an error message indicating that the instance count has exceeded the limit. This occurs when a device attempts to request more instances than the license pool has available or to initiate more parallel tasks than requested.
+### When Will an Error Occur?
 
-By default, if `SetMaxConcurrentInstanceCount` is not called, your program will obtain the full number of instances from the license. If you request more instances than are available in your license pool, an error will be thrown.
+An error will be thrown if the total instance usage on the device exceeds the maximum instance count declared via `SetMaxConcurrentInstanceCount`. This can happen in the following scenarios:
 
-Additionally, if `maxParallelTasks` is not set, 4 parallel tasks will be opened to decode barcodes. If you configure the barcode reading settings to open up more parallel tasks than the number of instances obtained from `SetMaxConcurrentInstanceCount`, an error will be thrown.
+- The device tries to open more decoding tasks (via `MaxParallelTasks`) than the number of instances allowed.
+- Multiple programs together consume more instances than what the device was granted.
 
-> If you attempt to run two programs on one device, the sum of the number of ParallelTasks opened by the two programs cannot exceed the maximum number of `SetMaxConcurrentInstanceCount` that the two programs set. For example, if one program sets `SetMaxConcurrentInstanceCount`(10) and another program sets `SetMaxConcurrentInstanceCount`(5), and your license has sufficient instances, the device will obtain 10 instances. If one program sets `setting.maxParallelTasks` = 6 and another program sets `setting.maxParallelTasks` = 5, an error will be thrown because the total number of parallel tasks (5+6) exceeds the MaxConcurrentInstanceCount (10).
+>Example:  
+>Program A calls `SetMaxConcurrentInstanceCount(10)` and Program B calls `SetMaxConcurrentInstanceCount(5)`. The device will be allowed to use up to **10 instances**.  
+>If Program A uses `MaxParallelTasks = 6` and Program B uses `MaxParallelTasks = 5`, and both have only one `CaptureVisionRouter` instance, the total becomes `6 + 5 = 11` which exceeds the limit of 10, causing an error.
 
+### Best Practices
 
+- Always call `SetMaxConcurrentInstanceCount` early to explicitly declare your instance needs.
+- Avoid exceeding the limit by carefully managing how many `CaptureVisionRouter` instances and `MaxParallelTasks` for each instance are being used across all running programs on a device.
+- Monitor actual usage during development to avoid runtime errors in production.

faq/general/error-license-buffer.md

@@ -17,25 +17,10 @@ When initializing the license for cloud hosted services, it is common to come ac
 
 This error occurs when Dynamsoft sdk attempts to write the license file to the local usr/home directory or Home directory, but is unable to do so due to lack of permission to read or write the license file in that directory.
 
-To resolve this issue, please set the license file cache path to a directory that your program has read and write permissions for. Please place the code before license initializtion.
+To resolve this issue, please set the license file cache path to a directory that your program has read and write permissions for.
 
 
-C++
+Code snippet in C++
 ```C++
 static int SetLicenseCachePath(const char* directoryPath)
-```
-Python
-```Python
-LicenseManager.set_license_cache_path("DIRECTORY-PATH-FOR-LICENSE-CACHE")
-```
-Java
-```Java
-BarcodeReader.setLicenseCachePath("DIRECTORY-PATH-FOR-LICENSE-CACHE");
-```
-.NET
-```.NET
-LicenseManager.SetLicenseCachePath("DIRECTORY-PATH-FOR-LICENSE-CACHE");
-```
-
-For more language, please refer to [this page](https://www.dynamsoft.com/barcode-reader/docs/core/). Select the language and then navigate to API Reference -> DynamsoftLicense -> LicenseManager
-
+```

faq/general/general.md

@@ -22,3 +22,5 @@ permalink: /faq/general/general.html
 5. [How to scan specific pages of a pdf file?](scan-specific-page.html)
 
 6. [How to scan barcodes on US Driver's Licenses and extract the information?](scan-us-drivers-license.html)
+
+7. [How does your SDK compare to other commercial SDKs?](competitors-comparison.html)

faq/general/how-to-scan-ean-upc-with-addon.md

@@ -41,8 +41,6 @@ permalink: /faq/general/index.html
 
 7. [How can I sort the barcodes of my image in reading order?](sort-barcodes-image.md)
 
-8. [How to Scan EAN/UPC with Addon Codes?](how-to-scan-ean-upc-with-addon.md)
-
 ## [License & Usage](license-usage.md)
 
 1. [Can the SDK work without internet connection?](sdk-works-without-internet.md)

faq/general/index.md

@@ -28,5 +28,3 @@ permalink: /faq/general/license-usage.html
 8. [How does license tracking work with the three standard licensing options - Per Scan, Per Device, Per Concurrent Device?](how-license-tracking-works.html)
 
 9. [When is a new license spot taken when using a per-device licensing model?](new-license-required-per-device-licensing.html)
-
-10. [What will happen if licenses are not renewed in time?](what-happens-if-license-expires.html)

faq/general/license-usage.md

@@ -23,6 +23,7 @@ To explore the latest features and updates of `Dynamsoft Barcode Reader`, please
   * ![Java Icon]({{site.assets}}img-icon/homepage/java.svg){:class="java"} [Java]({{ site.java }}){:target="_blank"}
   * ![.NET Icon]({{site.assets}}img-icon/homepage/dotnet.svg){:class="dotnet"} [.NET]({{ site.dotnet }}){:target="_blank"}
   * ![C++ Icon]({{site.assets}}img-icon/homepage/cplusplus.svg){:class="cplusplus"} [C++]({{ site.cpp }}){:target="_blank"}
+  * ![NodeJS Icon]({{site.assets}}img-icon/homepage/nodejs.svg){:class="nodejs"} [Node JS](https://github.com/Dynamsoft/capture-vision-nodejs-samples/){:target="_blank"}
 
 The documentation for editions `C`, `React Native`, `Flutter`, `Xamarin.Forms` and `Cordova` has been archived, but remains accessible through the following links:
 

index.md

@@ -38,7 +38,12 @@ The following shows how to set the license in the code.
    >
 > 
 ```js
-Dynamsoft.License.LicenseManager.initLicense("YOUR-LICENSE-KEY");
+// Option 1: Initialize using the RTU (Ready-To-Use) BarcodeScanner APIs
+const barcodeScanner = new Dynamsoft.BarcodeScanner({
+  license: "YOUR_LICENSE_KEY",
+});
+// Option 2: Initialize the license using the Foundational APIs
+Dynamsoft.License.LicenseManager.initLicense("YOUR_LICENSE_KEY");
 ```
 > 
 ```c
@@ -116,5 +121,5 @@ else:
     # add code for further process
 ```
 
-If you are using a `concurrent instance license`, see [Concurrent Instance License Initialization](concurrent-instance-license.html) for more information.
+If you are using a `concurrent instance license`, see [How to properly use concurrent instance license]({{ site.faq_general }}ensure-no-overuse.html) for more information.