Optional Parameters
[Optional parameters]
Specify any optional parameters below.
* For "text_object_name" and "barcode_object_name", type the name you assigned to the text or barcode specified in the P-touch Editor layout file. For example, if you want to print a text string with the object name "TEXT", the parameter name must be "text_TEXT".
* If the same parameter is described more than once in a URL scheme, the last parameter value is used. Parameter changes are applied to all objects with the same object type (text or barcode) and object name.
* For "rotate" parameter, RJ-2035B, RJ-2055WB, RJ-3035B, RJ-3055WB, TD-4T and TJ series support rotate0 and rotate180 only.
* The "printQuality" parameter is available for QL and TD-2 series.
* If a parameter is not supported by the printer or a parameter setting is outside the allowed range, the setting is considered invalid and the printer will use a default setting instead.
* For multiple layout printing, the index of text_filename[index].[OBJECT_NAME], barcode_filename[index].[OBJECT_NAME] and image_filename[index].[OBJECT_NAME] are the index of template filename (required parameter).
* For multiple layout printing, each parameter is common among all the layouts besides text_filename[index].[OBJECT_NAME], barcode_filename[index].[OBJECT_NAME] and image_filename[index].[OBJECT_NAME].
* When "formatarchiveupdate" is set to 1 (=On) and the attached file name is the same as the name of the existing file, newer files will overwrite the existing files.
* The "forceStretchPrintableArea" , "feedMode", and "rollCase" are available for PJ series.
* RJ-2035B, RJ-2055WB, RJ-3035B, RJ-3055WB, TD-4T and TJ series do not support the following parameters:
- "halftone"
- "printQuality"
- "orientation"
- "printMode"
- "scaleValue"
| Parameter | Description | Default setting |
|---|---|---|
| copies | Set the number of copies you want. | 1 |
| halftone | Set one of the following options: threshold (Binary) pattern_dither (Dither) error_diffusion (Error Diffusion) |
pattern_dither |
| rjDensity | Set the brightness between -5 (light) and 5 (dark). | 0 |
| rotate | Rotate the printed image 90, 180 or 270 degrees. Rotate0 Rotate90 Rotate180 Rotate270 |
Rotate0 |
| peelMode | Automatically peel labels while printing. 0 = Off 1 = On |
0 |
| printQuality | Set one of the following options: Normal = higher quality, but slower printing. Double_speed = lower quality, but faster printing. |
normal |
| orientation | Set the paper orientation: portrait = vertical landscape = horizontal. |
LBX files: depending on the settings Other files: landscape |
| printMode | Set one of the print sizes: original = actual print size fit_to_page = adjust to the page size scale = increase or decrease the print ratio fit_to_paper = adjust the paper size |
fit_to_page |
| scaleValue | Set a numeric value to scale the print out. * Valid when printMode is set to "scale" * Set 1 or less for PDF printing |
1 |
| text_object_name | Type an object name you specified for the text in P-touch Editor. (single layout) |
|
| barcode_object_name | Type an object name you specified for the barcode in P-touch Editor. (single layout) |
|
| image_object_name | Type an object name you specified for the image in P-touch Editor. (single layout) Supported format: jpg, jpeg, bmp, png |
|
| text_filename[index].[OBJECT_NAME] | Type an object name you specified for a text name in P-touch Editor. (multiple layouts) |
|
| barcode_filename[index].[OBJECT_NAME] | Type an object name you specified for a barcode in P-touch Editor. (multiple layouts) |
|
| image_filename[index].[OBJECT_NAME] | Type an object name you specified for an image in P-touch Editor. (multiple layout) Supported format: jpg, jpeg, bmp, png |
|
| fileattach | Set the base64 data as a print file to attach to a URL scheme. (single layout) |
|
| sizeattach | Set the base64 data as a media information file to attach to a URL scheme. | |
| fileattach_filename[index]. | Set the base64 data as a print file to attach to a URL scheme. (multiple layout) |
|
| formatarchiveupdate | Update and save files. 0 = Off 1 = On |
0 |
| forceStretchPrintableArea | Set a value (in pixels) to extend the length of the print area. | 0 |
| feedMode | Set one of the following options: NoFeed FixedPage EndOfPage EndOfPageRetract |
NoFeed |
| rollCase | Set one of the following options: None PARC001_NoAntiCurl PARC001 PARC001_ShortFeed KeepPrinterSetting |
KeepPrinterSetting |
| imageFitMode | Set one of the following options: fitCurrentSize keepHeight |
fitCurrentSize |
[Optional parameters (media settings)]
Specify any optional parameters below when you want to set media information in URL scheme.
The "paperType" parameter is required for all models.
* The following settings are available only for RJ, TD-2 and TD-4D series:
- "roll"
- "dieCut"
- "markRoll"
* The following setting is available only for PJ series:
- "custom"
If you set the "paperType" parameter as "custom", the "tapeWidth" and "tapeLength" parameter values are measured in dots.
* The following setting is available only for TD-4T series and TJ series:
- "typeB"
If you set the "paperType" parameter as "typeB", all parameter values are measured in mm.
* If there are multiple media settings parameters in the URL scheme, only the last parameter is used.
| Parameter | Description | Configurable setting | Default setting |
|---|---|---|---|
| paperType | Paper types | roll dieCut markRoll custom typeB |
- |
| tapeWidth | Media width | 0 or higher | 2 |
| margin_top | Top margin | 0 or higher | 0 |
| margin_left | Left margin | 0 or higher | 0 |
| margin_bottom | Bottom margin | 0 or higher | 0 |
| margin_right | Right margin | 0 or higher | 0 |
| unit | Unit | inch mm |
inch |
| tapeLength | Media length (Die-cut label/Media with marks only) |
0 or higher | 0 |
| gapLength | Label spacing (Die-cut label only) |
0 or higher | 0 |
| markVerticalOffset | Distance from paper leading edge to marks (Media with marks only) |
0 or higher | 0 |
| markLength | length of marks (Media with marks only) |
0 or higher | 0 |
| conveying_offset | Set the feed offset (in mm) between -25.4 and 25.4. | Between -25.4 and 25.4 | 0 |
"paperType" parameter settings
✓: supported, -: not supported
| paperType | roll | dieCut | markRoll | custom | typeB |
|---|---|---|---|---|---|
| tapeWidth | ✓ | ✓ | ✓ | ✓ | ✓ |
| margin_top | ✓ | ✓ | ✓ | - | ✓ |
| margin_left | ✓ | ✓ | ✓ | - | ✓ |
| margin_bottom | ✓ | ✓ | ✓ | - | ✓ |
| margin_right | ✓ | ✓ | ✓ | - | ✓ |
| unit | ✓ | ✓ | ✓ | - | - |
| tapeLength | - | ✓ | ✓ | ✓ | ✓ |
| gapLength | - | ✓ | - | - | - |
| markVerticalOffset | - | - | ✓ | - | - |
| markLength | - | - | ✓ | - | - |
| offset | - | - | - | - | ✓ |
| sensor | - | - | - | - | ✓ |
| conveying_offset | - | - | - | - | ✓ |
[Optional Parameters "successCallback" and "failureCallback"]
Set this parameter if you want to check the print result from the user's web app or mobile app.
If you set this parameter, the printing outcomes will not be displayed in Smooth Print.
Both callback parameters must be specified and connected with "&". If only one parameter is specified, the setting will be invalid.
| Parameter | Description |
Values |
Example values (URL-encoded values) |
Example values (before URL encoding) |
|---|---|---|---|---|
| successCallback | URL scheme is launched when printing is successful. | URL string | sendurlscheme%3A%2F%2FsuccessCallback%3Fresult%3D | sendurlscheme://successCallback?result= |
| failureCallback | The URL scheme shows an error when printing fails. | URL string * Set any value to the parameter. |
sendurlscheme%3A%2F%2FfailureCallback%3Fparam%3Dabc%26result%3D | sendurlscheme://failureCallback?param= abc&result= |
To run the example value above, the web app or mobile app must support the URL scheme of "sendurlscheme".
If the web app or mobile app fails to launch, the result will be shown in Smooth Print. * When printing is successful, the URL scheme used by Smooth Print is "sendurlscheme://successCallback?result=SUCCESS". * When printing fails, the URL scheme used by Smooth Print is "sendurlscheme://failureCallback?param=%E3%81%82%E3%81%84%E3%81%86&result=ERROR_PRINTER _NO_SETTING".
For the list of error codes to use with callback parameters, see error codes.
URL Encoding
Parameter settings must be UTF-8-encoded and URL-encoded, including colons and slashes.
File names are case-sensitive except when they are used in Android™ local paths.