\n <orderListConfiguration automaticOrderSelectionAfterFilter=\"true\">\n <service id=\"PutAway\"/>\n <filter configurationKey=\"PutAwayOrderFilters\"/>\n <list listId=\"Orders\"/>\n <onOrderSelected navigateTo=\"PutAwayLines\"/>\n <unlockOrder title=\"@{ReleaseOrderMenuItemWithOrderId}\"/>\n </orderListConfiguration>\n </page>\n ...\n </pages>\n</application>","type":"text"}]},{"type":"paragraph","content":[{"text":"We want to use a different list configuration that is tailored to our needs. This can be achieved with a tweak file a la the one below, e.g. named ","type":"text"},{"text":"application-our-putaway-list-configuration.cfg","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<application xmlns=\"http://schemas.taskletfactory.com/MobileWMS/Application\">\n \n <resources>\n <lists tweak=\"append\">\n <listConfiguration id=\"OurPutAwayOrders\">\n <rows>\n ...\n </rows>\n </listConfiguration>\n </lists>\n </resources>\n <pages>\n ...\n <page id=\"PutAway\">\n <orderListConfiguration>\n <list listId=\"OurPutAwayOrders\" tweak=\"replace\"/>\n </orderListConfiguration>\n </page>\n ...\n </pages>\n</application>","type":"text"}]},{"type":"paragraph","content":[{"text":"This tweak uses the ","type":"text"},{"text":"tweak=\"append\"","type":"text","marks":[{"type":"strong"}]},{"text":" to add a new list configuration and then the ","type":"text"},{"text":"tweak=\"replace\"","type":"text","marks":[{"type":"strong"}]},{"text":" attribute in the page section to override the existing configuration.","type":"text"}]}],"version":1}</article></body></html>

{"type":"doc","content":[{"type":"heading","attrs":{"level":6},"content":[{"text":"Requires v. 1.2.6","type":"text"}]},{"type":"paragraph","content":[{"text":"The application is configured with two configuration files, which are start.cfg and application.cfg. Generally there will be one of each, which will be quite standard across companies. However, as all warehouses have their special ways of doing things there will most likely be small changes individually for each company. Up till now those changes have been made directly in either configuration file.","type":"text"}]},{"type":"paragraph","content":[{"text":"For simplicity, functionality has been added to the application where it is able to read multiple configuration files for the same type, e.g. application and start, and combine them into one. This will allow most companies to use the standard files, with the special functionality extracted into separate files, making it easy to update the standard functionality, and keeping custom behaviour.","type":"text"}]},{"type":"paragraph","content":[{"text":"This gives a brief explanation and examples of how to use the tweak functionality of configuration files. The same mechanism applies to both start and application configuration files.","type":"text"}]},{"type":"paragraph","content":[{"text":"*NOTE: When using the ","type":"text"},{"text":"schema validation in VS Code","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/TFSK/pages/78943035"}}]},{"text":" the tweak attributes are marked as being an error.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Filename conventions","type":"text"}]},{"type":"paragraph","content":[{"text":"To enable this functionality the file with the custom behaviour needs to adhere to the following format, and be located next to the standard files in the configuration folder.","type":"text"}]},{"type":"codeBlock","content":[{"text":"application-.cfg\nstart-.cfg","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples follow below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"How it works","type":"text"}]},{"type":"paragraph","content":[{"text":"Tweaks are applied to sections of the configuration by adding the ","type":"text"},{"text":"tweak","type":"text","marks":[{"type":"strong"}]},{"text":" attribute to a configuration element, e.g. a ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":" or ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":" element.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Replacing all pages","type":"text"}]},{"type":"paragraph","content":[{"text":"We have our ","type":"text"},{"text":"application.cfg","type":"text","marks":[{"type":"strong"}]},{"text":" file with the following content (stripped down for illustrative purposes):","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n \n \n \n ","type":"text"}]},{"type":"paragraph","content":[{"text":"We want to replace all pages in that configuration with a fresh batch. This ","type":"text"},{"text":"can","type":"text","marks":[{"type":"strong"}]},{"text":" be achieved by adding the ","type":"text"},{"text":"tweak=\"replace\"","type":"text","marks":[{"type":"strong"}]},{"text":" attribute on the ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":" element in a tweak file.","type":"text"}]},{"type":"paragraph","content":[{"text":"Content of ","type":"text"},{"text":"application-replace-pages.cfg","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Add an extra page","type":"text"}]},{"type":"paragraph","content":[{"text":"We use the same ","type":"text"},{"text":"application.cfg","type":"text","marks":[{"type":"strong"}]},{"text":" from the previous example, containing three pages. In this example we would like to add an extra page and create a tweak file ","type":"text"},{"text":"application-add-page.cfg","type":"text","marks":[{"type":"strong"}]},{"text":" with the following content:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"Notice how the ","type":"text"},{"text":"tweak=\"append\"","type":"text","marks":[{"type":"strong"}]},{"text":" attribute is added to the ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]},{"text":" element. ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Change list configuration for a specific page","type":"text"}]},{"type":"paragraph","content":[{"text":"In the configuration example below, the ","type":"text"},{"text":"PutAway","type":"text","marks":[{"type":"strong"}]},{"text":" page uses the standard list configuration ","type":"text"},{"text":"Orders","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n ...\n \n \n <orderListConfiguration automaticOrderSelectionAfterFilter=\"true\">\n <service id=\"PutAway\"/>\n <filter configurationKey=\"PutAwayOrderFilters\"/>\n <list listId=\"Orders\"/>\n <onOrderSelected navigateTo=\"PutAwayLines\"/>\n <unlockOrder title=\"@{ReleaseOrderMenuItemWithOrderId}\"/>\n </orderListConfiguration>\n </page>\n ...\n </pages>\n</application>","type":"text"}]},{"type":"paragraph","content":[{"text":"We want to use a different list configuration that is tailored to our needs. This can be achieved with a tweak file a la the one below, e.g. named ","type":"text"},{"text":"application-our-putaway-list-configuration.cfg","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<application xmlns=\"http://schemas.taskletfactory.com/MobileWMS/Application\">\n \n <resources>\n <lists tweak=\"append\">\n <listConfiguration id=\"OurPutAwayOrders\">\n <rows>\n ...\n </rows>\n </listConfiguration>\n </lists>\n </resources>\n <pages>\n ...\n <page id=\"PutAway\">\n <orderListConfiguration>\n <list listId=\"OurPutAwayOrders\" tweak=\"replace\"/>\n </orderListConfiguration>\n </page>\n ...\n </pages>\n</application>","type":"text"}]},{"type":"paragraph","content":[{"text":"This tweak uses the ","type":"text"},{"text":"tweak=\"append\"","type":"text","marks":[{"type":"strong"}]},{"text":" to add a new list configuration and then the ","type":"text"},{"text":"tweak=\"replace\"","type":"text","marks":[{"type":"strong"}]},{"text":" attribute in the page section to override the existing configuration.","type":"text"}]}],"version":1}</article></body></html>

Browser not supported