OkImages FAQ

Once the application has been successfully installed you will be redirected to the main monitor listing page from which you will be able to view the progress and completion status of each image import process on the products. As a first step, in order to take advantage of the import service, you will need to have successfully performed and completed the configuration of the OkImages settings, which can be visited by clicking on the menu item named 'Settings' present on the top right of the main page.

Settings Configuration

Within the settings page there will be 4 types of forms:

1. Services configuration (Choice of the service from where OkImages will take the images)
2. Source folders for images: (Setup of folder names from where OkImages will fetch images or load images that failed during the import process)
3. Setup rules for images: (Setup of rules for image files)
4. OmniChannel settings: Configuration of the app related to the channel in which OkImages was installed (Master / Child).





FTP Settings form fields:

Host (text) : Host name
Port (number): default value: 21
User (text): User name corresponding to the user enabled for access in FTP.
Password (text): FTP server access password

Once you have filled in the previous 4 fields, you will activate a main action (found at the top right of the 'FTP connection' Card) called "Test FTP connection". Performing this action will allow you to perform a connection test before finally saving your settings, in order to make sure that you have correctly entered the data for the connection between the OkImages application and your FTP.

At the end of the action you will have feedback if the test was successful or if it failed.




Next, two fields must necessarily be filled in in order to save the settings.

Images folder (text): Corresponds to the name of the folder (starting from the user root) from which OkImages should take the images to be imported. Note: If not configured correctly, OkImages will not be able to know where the images you want to import are located.

Folder for images on error (text): Corresponds to the name of the folder(starting from the user root) where OkImages will send the images that suffered errors during the import process. In case an image is not imported due to errors of different nature, it will be sent to this folder.

Note: If you choose FTP Server as your service you will be able to use nested paths to refer to the folder where the images will be.

Setup rules for images

Image max. weight (number 1-2048) Number defined in kb (1024Kb = 1mb) that identifies the maximum weight the image will need to have in order to be imported.
Note: If the image weight is greater than or equal to the defined number, the image will be rejected and sent to the folder of the defined in the "Source folders for images" section (Folder for images on error field).

Max number of product images (number, 1-20). Corresponds to the maximum number of images each individual product can have.
Note: If more images than the maximum number defined in this field are provided, those in excess will be rejected and sent to the dedicated folder configured in the "Folder for images on error" field.

Available extensions List of supported extensions. The total extensions supported by the application are jpeg,jpg,webp,png,gif,heic,JPEG/JPEG,JPEG,JPG,WEBP,PNG,GIF,HEIC, respectively.
If files with a different extension are found, they will not be recognized and will be rejected.

Image name rule pattern (text) Text string that defines the pattern that will be adopted for the image name. Thanks to the pattern it will be possible for the application to recognize which product to search for in order to import the corresponding images. It will be possible to define a pattern by following a specific and strict procedure.

- each rule in the pattern should be delimited by a set of square brackets.

Wrong:
[sku](DIV:_)(position) only what is inside the angle brackets will be recognized, the rest will be ignored.

Correct:
[sku][DIV:_][position] -> PROD-123_2.png

- each rule in the pattern must correspond to a specific field supported by the application in order to search which product the image belongs to.

- The following are the supported fields to search for a product starting from the pattern and image name: sku, handle, gtin, barcode and position to identify the location of the image within the product, written strictly in lower case, otherwise they will not be considered as acceptable key rules.

Wrong example:

[HANDLE][DIV:_][position]

Correct example:
[handle][DIV:_][position]

 

Between each attribute rule produced must be a special directive called:

[DIV:your_character]

will be used to figure out when the previous attribute rule within the image name ends.

[sku][gtin][position] or
[DIV:_][sku][handle] or
[sku][DIV:-][position][DIV:_]
[sku][DIV:_][position]

will be considered as the value relative to the defined attribute/rule, the set of characters preceding the character defined as DIV (divider). If in our product SKU for example we need the character ' - ' to separate the characters of the SKU, we will not use this character as a divider, otherwise OkImages will interpret as an attribute value of the SKU the series of characters until it finds the first ' - ' as a character.

Wrong Example:
pattern:
[sku][DIV:-][position]
image name: G3T5-125-4_2.png will be considered "G3T5" as the product sku and "125-4_2" as the position.

Correct example:
pattern: [sku][DIV:_][position]
image name: G3T5-125-4_2.png where "G3T5-125-4" is the product sku, " _ " is the divisor, and "2" is the position of the image.

Omnichannel settings

A very interesting and optional feature of OkImages resides in the possibility of being able to import images produced on multiple channels from a single source (folder present on the configured service) through a simple association involving a main channel and all the rest of the channels in which you will want to take advantage of OkImages' services.

Channel id (text): The first time, when the settings have not yet been saved, the field will be blank and disabled. Once the settings are successfully saved the field will always be disabled and not editable because an ID will be generated that will uniquely and securely identify the store/channel.

Once the settings have been created try refreshing the page and you will notice that this field will now be valued. Now this assigned code will uniquely identify the channel where the OkImages application is installed.

If set to the 'Is a Master channel' flag the Channel id assigned will be used to recognize this channel as Master.

Otherwise if set to the 'Is a Child channel' flag a second field will appear to connect the channel to a previously configured Master channel.



Form Fields:

Channel Parent id (text): Usually those who manage their own e-commerce have the need to manage multiple sales channels, from this profound need comes the need to manage the process of importing images in a centralized manner, so for example having the ability to be able to import a series of images to one remote folder and then upload them to multiple sales channels. Without where to create a folder for each individual channel. In order to do this you will need to follow a simple and intuitive procedure for enhancing the Channel Parent id field.

Any channel other than the main (Master) channel that will have the OkImages app installed will have to be considered Child of the OkImages app configured in the Master channel.

In order to identify and differentiate who is the Master instance (main channel) and the multiple child instances (the other sales channels) you will need to leave the flag set to the value 'Is a Master Channel' in the main channel settings.

We will also need to note the Channel id assigned to the Master channel because we will need it on all other channels.

For children channels in create/edit settings we will need to value this field (Channel Parent id) with the Channel id of the master channel that we pinned previously, so now OkImages will be able to uniquely identify the Master app that all children channels refer to.

Start Import

Within the monitors page of the image import there is an action called "start import".

Normally two crons run every 15 and 30 minutes respectively as automatic processes in the background, the first one will check the folder present remotely and see if any images are present, if yes it will download the images and store them and then ensure the second cron has the images and imports them, and in case of errors it will upload the images that have suffered errors at the dedicated user folder for the images gone wrong.

If you do not wish to wait for the automatic process and force the loading of your images you can take advantage of the "start import" action.
Once clicked you will be redirected to a viewing page where images present remotely will be checked, if there are no images you will receive feedback and the user will be invited to retry the search for images in their folder remotely.






If the verification is successful you will receive feedback with a list of valid and invalid images found within the folder and the main action will be triggered so that OkImages can start the import.






Proceeding with the import you will have to wait for OkImages to download the images and once this first process is successfully completed you will be automatically redirected to the monitors page, showing at the interface the pending processes and displaying an information banner indicating the presence of an image import currently in progress.
Once all images have finished loading, the banner will update, returning to its default state.





Have you encountered any problems? Feel free to contact us.
[email protected]

OkImages Privacy Policy
Privacy Policy