SmartTip! <\/strong>This API will be sent to all device types in the system by entering the wildcard \u201c*ALL\u201d into the \u201cDevice Type\u201d field. If we want to target this API to two or more specific device types, we would then duplicate the API using the same API number, but with a different device defined in the \u201cDevice Type\u201d field.<\/p><\/blockquote>\n\n\n\nIn \u201cRequired Parameters\u201d double click on \u201cWorker Instruction Line 1\u201d.<\/li> Here we can enter an instruction for the user to capture one or more images of the damaged goods. For this example, we have entered \u201cPLEASE TAKE A PHOTO OF THE DAMAGED GOODS\u201d.<\/li> Click on \u201cOK\u201d.<\/li> For this exercise Optional Parameters are left at their default settings. Information on these can be found in Appendix B<\/strong> – Using Optional Parameters in the Image Capture API<\/strong> <\/li><\/ul>\n\n\n\nSmartTip! <\/strong>There are no limits on the number of characters for the Worker Instructions in this API definition. Mobile devices will differ on the number of characters supported based on their form factor and display resolution. You will need to test the different target devices for this feature to ensure all of the characters in your worker instruction fit and are readable; and adjust as necessary. <\/p><\/blockquote>\n\n\n\nClick \u201cFile\u201d > \u201cSave Changes\u201d.<\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
In the Administrator under \u201cDevice Groups\u201d, ensure the \u201cAuto Add Evolve Device Access\u201d is checked for each device group that will be capturing images.<\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
Now we can test what we have configured for Image Capture within a live Telnet session.<\/p>\n\n\n\n
Cancel any live sessions on the mobile device you are using for image capture.<\/li> Start a new session on the mobile device so it loads our new settings and navigate to the screen where the worker enters the quantity they picked.<\/li> Navigate to the screen in your WMS application that is configured to trigger the Image Capture UI.<\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
Step 3: Capture and Send Image(s) with the Image Capture UI<\/strong><\/h2>\n\n\n\nThe Image Capture user interface shown below should rapidly appear over top of the screen defined to trigger it.<\/li> To take a photo, tap <\/i><\/li>To cancel the Image Capture process and delete the cache on this screen, tap <\/i><\/li>If no pictures have been saved in the cache, the \"No Images\" message appears; offering another opportunity for the worker to try again by tapping <\/i><\/li><\/ul>\n\n\n\n <\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
Once we take a photo we are brought to the Image Preview screen below.<\/li> To retake the photo for better results tap <\/i> <\/li>When you are satisfied with the photo, tap <\/i><\/li>To cancel the Image Preview and move to the Image Cache Screen, tap <\/i><\/li><\/ul>\n\n\n\n <\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n\n
The Image Capture user interface allows us to take multiple photos of damaged goods and collects them in an Image Cache Screen before sending them on to an FTP server.<\/li> To add more photos to the Image Cache Screen, tap <\/i> <\/li>Tapping on a photo will enlarge the image and allow us to delete it by tapping <\/i><\/li>Once you have all the photos to send to the FTP server, Tap <\/i> <\/li>To dump all the images and exit the Image Capture UI, tap <\/i><\/li><\/ul>\n\n\n\n <\/p>\n\n\n\n
<\/p>\n\n\n\n
On your PC using Windows Explorer, navigate to the folder you assigned the FTP server to send the \u201csldemo\u201d user\u2019s files to.<\/li> We can see our files in the screen shot below.<\/li><\/ul>\n\n\n\nThe default filename structure for the images is shown in the diagram below.<\/li> Typically, warehouse operations will include the Order Number, Time, Date, and perhaps the User within the filename.<\/li> More examples of using the filename structure are covered in the Appendix B<\/strong> of this Tutorial. <\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
Appendix A<\/strong>: .ini File Optional Settings<\/strong><\/h2>\n\n\n\nThe FTP server details are configured in the evolve.ini file. The possible options are: <\/p>\n\n\n\n
[defaults]<\/p>\n\n\n\n
server = 0<\/strong><\/p>\n\n\n\nIf an Evolve server (BETA) is in use, then the value should be set to \u201c1\u201d<\/li> If 0 or not specified, this value defaults to no Evolve server in use<\/li><\/ul>\n\n\n\nftp_server = 85.215.188.38<\/strong><\/p>\n\n\n\nValue is the IP address of the FTP or SFTP server in use<\/li> Required for successful functioning<\/li><\/ul>\n\n\n\nftp_server_port = 3456<\/strong><\/p>\n\n\n\nValue defines the port number used to communicate to the FTP server<\/li> Required for successful functioning<\/li><\/ul>\n\n\n\nsftp = 1<\/strong><\/p>\n\n\n\nValue defines type of server in use (FTP or SFTP)<\/li> If 0 or not specified, this value defaults to FTP<\/li><\/ul>\n\n\n\nftp_server_username = sldemo<\/strong> <\/p>\n\n\n\nValue represents the user name defined in the FTP\/SFTP server<\/li> Required for successful functioning<\/li><\/ul>\n\n\n\nftp_server_password = sldemo<\/strong><\/p>\n\n\n\nValue represents the user password defined in the FTP\/SFTP server<\/li> Required for successful functioning<\/li><\/ul>\n\n\n\nftp_server_pasv_mode = 1<\/strong><\/p>\n\n\n\nFTP can work in either active or passive mode.<\/li> The administrator will specify which one is being used.<\/li> Evolve defaults to Active mode. To configure for passive mode, set the value to 1.<\/li><\/ul>\n\n\n\npicture_callback = 1<\/strong><\/p>\n\n\n\nSome devices (I.E. Honeywell CT40 running Enterprise Home Screen) will return the user to the SmartTE splash screen instead of their session after exiting the Image Capture UI. If this occurs please insert this setting into the .ini file.<\/li><\/ul>\n\n\n\nftp_queue_delete_response_codes = 226<\/strong><\/p>\n\n\n\nSometimes disconnection with the FTP server will result in a non-graceful recovery and cause issues with queuing of new images. Different FTP servers may send different response codes in this situation. This line will reset the queue upon reconnecting to the FTP server after the specified response code is received. <\/li><\/ul>\n\n\n\nAppendix B<\/strong>: Using Optional Parameters in the<\/strong> Image Capture API<\/strong><\/h2>\n\n\n\nWorker Instruction Line 2<\/strong><\/p>\n\n\n\nThe Image Capture API provides an option for a second worker instruction line.<\/li> In \u201cOptional Parameters\u201d double click on \u201cWorker Instruction Line 2\u201d.<\/li> For this example, we have entered \u201cSAY CHEESE!\u201d<\/li> Tap \u201cOK\u201d.<\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
In order to enable any changed settings in \u201cOptional Parameters\u201d it is necessary to check the boxes next to them. Check the box next to \u201cWorker Instruction Line 2\u201d.<\/li><\/ul>\n\n\n\nImage Destination<\/strong><\/p>\n\n\n\nIn \u201cOptional Parameters\u201d, double click on \u201cImage Destination\u201d. <\/li><\/ul>\n\n\n\nA \u201cParameter Details\u201d menu appears with choices on where to send or save the image.<\/li> Only one box can be checked. <\/li> Images are configured by default to be sent via FTP to a server for further processing.<\/li> When the box is checked for \u201cPictures Folder on Device\u201d, the images are saved to the \"DCIM\" directory on the mobile device in use. <\/li> \u201cEvolve Server\u201d and \u201cAlternative Server\u201d are BETA features as this time.<\/li> Press \u201cOK\u201d to save changes.<\/li> Back in \u201cOptional Parameters\u201d if a non-default Image Destination was chosen, ensure the box is checked for \u201cImage Destination\u201d to enable the parameter.<\/li> Press \u201cOK\u201d to save changes.<\/li><\/ul>\n\n\n\nAs shown in the screen shot below, images are saved in the mobile device's \"DCIM\" folder.<\/p>\n\n\n\nImage Capture Method<\/strong><\/p>\n\n\n\nIn \u201cOptional Parameters\u201d double click \u201cSelect a way to capture the image\u201d. <\/li> A \u201cParameter Details\u201d menu appears.<\/li> Two modes are available, which are \u201cUse Snapshot\u201d and \u201cUse Camera\u201d.<\/li> \"Use Snapshot\" is the default mode. In this mode, the Evolve agent scrapes a screenshot of the Image Capture UI screen and creates a small file (10's of KB) which is typically sent via FTP to a remote server for further processing.<\/li> The \"Use Camera\" mode employs the automatic flash control (if supported by the manufacturer) and leverages the onboard camera; outputting a higher resolution image (1,000's of KB).<\/li> The default mode (Use Snapshot) is sufficient for most operations and transmits quickly over WiFi. The \"Use Camera\" mode option can be leveraged if a higher resolution image is required or the operation decides that AUTOMATIC flash control is a better fit for the users and environment.<\/li> Press \u201cOK\u201d in the \u201cParameter Details\u201d menu to save changes.<\/li> In \u201cOptional Parameters\u201d, ensure the box is checked to enable the parameter.<\/li> Press \u201cOK\u201d to save changes.<\/li><\/ul>\n\n\n\nThese screenshots below of the Image Capture UI in use are generated using the \"Use Snapshot (Default)\"<\/strong> option in the Image Capture API definition. Using this setting the worker can set the flash ON or OFF.<\/p>\n\n\n\nThe resulting image files for the image capture examples above are shown below.<\/p>\n\n\n\nThese screenshots below of the Image Capture UI in use are generated with the \"Use Camera\"<\/strong> option in the Image Capture API definition. Using this setting the worker can set the flash ON, OFF, or AUTOMATIC.<\/p>\n\n\n\nThe resulting image files for the image capture examples above are shown below.<\/p>\n\n\n\nScreen Orientation<\/strong><\/p>\n\n\n\nWhen the Image Capture UI starts up in the Evolve agent, it defaults to auto screen rotation mode; even if the SmartTE client is locked in landscape or portrait mode. This can be useful with a hand-held device, as in some instances, a landscape image may be desired over a portrait image. However, when capturing an image using a landscape wearable, it can be difficult due to the form factor of the device and its constant switching of the screen orientation.<\/li> For this situation, it is possible to set the Image Capture UI to lock in portrait mode or landscape mode.<\/li> In \u201cOptional Parameters\u201d double click on \u201cScreen Orientation\u201d.<\/li> A \u201cParameter Details\u201d menu will appear. Check the box for the desired option.<\/li> Press \u201cOK\u201d.<\/li> In \u201cOptional Parameters\u201d ensure the box is checked for \u201cScreen Orientation\u201d to enable the parameter.<\/li> Press \u201cOK\u201d to save changes.<\/li><\/ul>\n\n\n\n<\/p>\n\n\n\n
Allow Cancel Button<\/strong><\/p>\n\n\n\nBy default, this parameter is set to \"Yes\". In order to override the image capture process, the worker is presented with a Cancel Button <\/i> <\/li>It is possible to ensure an image is captured by the worker before they can continue in the workflow. By setting this value to \"No\", the Cancel Button will not appear as an option to the worker on the Image Cache Screen.<\/li> The Cancel Button will still appear on the Image Preview Screen, but tapping this will bring the worker to the Image Cache Screen which will not provide the Cancel Button <\/i> <\/li><\/ul>\n\n\n\nSource Device<\/strong><\/p>\n\n\n\nThis setting specifies the hardware used to capture the image. The camera on the device is the default. However, some devices do not feature a camera, so the imager is used to take pictures. <\/li><\/ul>\n\n\n\nSmartTip!<\/strong> Some devices support image capture using the onboard imager instead of a camera. You will need to test whether this functionality is available on your device of choice. Note that pictures taken with the imager will normally be of poorer quality and may be in monochrome. <\/p><\/blockquote>\n\n\n\n<\/p>\n\n\n\n
<\/p>\n\n\n\n
\n
\n
File Name Structure<\/strong><\/p>\n\n\n\nScroll down in the list and double click on \u201cFile Name Structure\u201d<\/li> The following \u201cParameter Details\u201d window should appear<\/li><\/ul>\n<\/div><\/div>\n<\/div><\/div>\n\n\n\nIf no file name structure is specified, this structure is used by default: <\/li><\/ul>\n\n\n\n
![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/imagecapturea.jpg\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/image002.png\")
![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/S6-1024x474.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s7.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s8.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s10.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s11.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s12.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s14-4-1024x708.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s15-1-1024x728.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s16-2-1024x393.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s17-1-1024x467.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s18-1024x345.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s23-1024x559.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s24-1-1024x722.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-1-1024x586.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/intelliwikiprodstorage.blob.core.windows.net\/prod\/orgs\/ee1edad6-1037-4e08-9b73-7bff21dfcd44\/wikis\/1e324902-1014-446b-9f09-08dd2579a70e\/IMAGE-dce31d6e-d978-4d3c-9092-31622ca91aa8.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-2-1024x673.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-10.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-12.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-13.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-14-1024x480.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2025\/04\/image-17-1024x678.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s25-2-1024x453.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s26-1024x526.png\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2024\/08\/s28-1024x533.png\")
<\/figure><\/div>\n\n\n\n