{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The Supersede utility is distributed as a single executable file (","type":"text"},{"text":"Supersede.exe","type":"text","marks":[{"type":"code"}]},{"text":"). No installation is required, however, it does require the ","type":"text"},{"text":".NET 6 runtime","type":"text","marks":[{"type":"link","attrs":{"href":"https://dotnet.microsoft.com/download/dotnet/6.0"}}]},{"text":" to be installed. See ","type":"text"},{"text":"deploying the Supersede utility","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2280062991"}}]},{"text":" for more information.","type":"text"}]},{"type":"paragraph","content":[{"text":"A default ","type":"text"},{"text":"configuration","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279866387"}}]},{"text":" file (","type":"text"},{"text":"Supersede.json","type":"text","marks":[{"type":"code"}]},{"text":") is also distributed along with the executable file. This file is optional, however, it must be placed in the same folder as the executable file.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also configure supersede behaviour for ","type":"text"},{"text":"specific folders","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279899171"}}]},{"text":" by placing a similar configuration file in the desired folder.","type":"text"}]},{"type":"paragraph","content":[{"text":"These configuration files use the ","type":"text"},{"text":"JSON","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279833616"}}]},{"text":" format.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Move superseded files","type":"text"}]},{"type":"paragraph","content":[{"text":"Consider the following files and folders:","type":"text"}]},{"type":"paragraph","content":[{"text":"📁P:\\Projects","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁P123","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Exports","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (1).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (1).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (2).pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"This folder contains PDF files exported from two sheets (","type":"text"},{"text":"A001 - Title Sheet","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"A002 - Site Plan","type":"text","marks":[{"type":"code"}]},{"text":") and there are two revisions of each sheet.","type":"text"}]},{"type":"paragraph","content":[{"text":"We can use the Supersede utility to move the earlier revisions to an ","type":"text"},{"text":"Archived","type":"text","marks":[{"type":"code"}]},{"text":" folder by configuring the following ","type":"text"},{"text":"rule","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279768093"}}]},{"text":" in a ","type":"text"},{"text":".supersede-config","type":"text","marks":[{"type":"code"}]},{"text":" file in the ","type":"text"},{"text":"📁P:\\Projects\\P123","type":"text","marks":[{"type":"code"}]},{"text":" folder:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Supersede\": {\n \"Enabled\": true,\n \"MatchFields\": [\"SheetNumber\"],\n \"Mode\": \"Move\",\n \"Path\": \"Archived\"\n }\n }\n ]\n}","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"This rule could also be configured in the ","type":"text"},{"text":"Supersede.json","type":"text","marks":[{"type":"code"}]},{"text":" configuration file located in the same folder as the ","type":"text"},{"text":"Supersede.exe","type":"text","marks":[{"type":"code"}]},{"text":" file, however, the ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"code"}]},{"text":" object would need to be placed inside a ","type":"text"},{"text":"Supersede","type":"text","marks":[{"type":"code"}]},{"text":" object.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"configuring the Supersede utility","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279866387"}}]},{"text":" and ","type":"text"},{"text":"folder specific configuration","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279899171"}}]},{"text":" for more information.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"This rule specifies a ","type":"text"},{"text":"regular expression","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279571495"}}]},{"text":" pattern to match ","type":"text"},{"text":".pdf","type":"text","marks":[{"type":"code"}]},{"text":" files. For each file that is matched to this pattern, the Supersede utility will then look for other related ","type":"text"},{"text":".pdf","type":"text","marks":[{"type":"code"}]},{"text":" files in the same folder that also match this pattern and share the same ","type":"text"},{"text":"SheetNumber","type":"text","marks":[{"type":"code"}]},{"text":". Older revisions of the related files will then be moved to the ","type":"text"},{"text":"📁Archived","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Running the command","type":"text"}]},{"type":"paragraph","content":[{"text":"For this example, we can run the Supersede utility using the ","type":"text"},{"text":"Command Prompt","type":"text","marks":[{"type":"link","attrs":{"href":"https://en.wikipedia.org/wiki/Cmd.exe"}}]},{"text":" in Windows to run the following ","type":"text"},{"text":"command line","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279637048"}}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"none"},"content":[{"text":"Supersede.exe Folder P:\\Projects\\P123\\Exports","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":688,"id":"21eeaeec-f644-4a66-bbd5-10f690e3368f","collection":"contentId-2279604229","type":"file","height":166}}]},{"type":"paragraph","content":[{"text":"The revision 1 files have now been moved into the new ","type":"text"},{"text":"📁Exports\\Archived","type":"text","marks":[{"type":"code"}]},{"text":" folder:","type":"text"}]},{"type":"paragraph","content":[{"text":"📁P:\\Projects","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁P123","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Exports","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Archived","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (1).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (1).pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Copy files to a ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"text":" folder","type":"text"}]},{"type":"paragraph","content":[{"text":"Another common approach is to export files directly to a location where they will remain even after they have been superseded, and use the Supersede utility to maintain a separate ","type":"text"},{"text":"current","type":"text","marks":[{"type":"em"}]},{"text":" folder that contains the current revision of each file.","type":"text"}]},{"type":"paragraph","content":[{"text":"In this scenario, we might have the following files and folders:","type":"text"}]},{"type":"paragraph","content":[{"text":"📁P:\\Projects","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁P123","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Exports","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁2022-02-03","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (1).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (1).pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"New files are exported to a date-specific folder within ","type":"text"},{"text":"📁Exports","type":"text","marks":[{"type":"code"}]},{"text":". Following an export, we want to run the Supersede utility to copy the new files into the ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"text":" folder and then remove older revisions of the same file from ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"We can modify the rule from the previous example to first copy matched files to ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"text":" and then delete superseded files:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Copy\": {\n \"Enabled\": true,\n \"Path\": \"..\\\\Current\"\n },\n \"Supersede\": {\n \"Enabled\": true,\n \"MatchFields\": [\"SheetNumber\"],\n \"Mode\": \"Delete\"\n }\n }\n ]\n}","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"As noted in the previous example, this rule could also be configured in the global ","type":"text"},{"text":"Supersede.json","type":"text","marks":[{"type":"code"}]},{"text":" configuration file by nesting the ","type":"text"},{"text":"Rules","type":"text","marks":[{"type":"code"}]},{"text":" object inside a ","type":"text"},{"text":"Supersede","type":"text","marks":[{"type":"code"}]},{"text":" object.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"configuring the Supersede utility","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279866387"}}]},{"text":" and ","type":"text"},{"text":"folder specific configuration","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279899171"}}]},{"text":" for more information.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"As before, we can run the Supersede utility using the ","type":"text"},{"text":"Command Prompt","type":"text","marks":[{"type":"link","attrs":{"href":"https://en.wikipedia.org/wiki/Cmd.exe"}}]},{"text":" with the following ","type":"text"},{"text":"command line","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/Transmit/pages/2279637048"}}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"none"},"content":[{"text":"Supersede.exe Folder P:\\Projects\\P123\\Exports\\2022-02-03","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":805,"id":"e7df7134-ff64-409e-8ad2-1c17be609b96","collection":"contentId-2279604229","type":"file","height":198}}]},{"type":"paragraph","content":[{"text":"The revision 2 files have now been copied into the ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"text":" folder and the revision 1 files have been deleted:","type":"text"}]},{"type":"paragraph","content":[{"text":"📁P:\\Projects","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁P123","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Exports","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁2022-02-03","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📁Current","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A001 - Title Sheet (2).pdf","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"text":"📄A002 - Site Plan (2).pdf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Instead of deleting the superseded files, you could configure the rule to move them to a ","type":"text"},{"text":"📁..\\Superseded","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Don’t forget to ","type":"text"},{"text":"escape backslash characters in paths","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279833616/JSON#Reserved-Characters-and-Escapes"}}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Working with multiple rules","type":"text"}]},{"type":"paragraph","content":[{"text":"You can specify multiple ","type":"text"},{"text":"Extensions","type":"text","marks":[{"type":"code"}]},{"text":" in the configuration to match different types of files with the same rule:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\", \".dwg\" ],\n ...\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also configure multiple rules to match different patterns with different copy or supersede configuration:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Copy\": {\n \"Enabled\": true,\n \"Path\": \"..\\\\Current\"\n },\n \"Supersede\": {\n \"Enabled\": true,\n \"MatchFields\": [\"SheetNumber\"],\n \"Mode\": \"Move\",\n \"Path\": \"..\\\\Superseded\"\n }\n },\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".dwg\" ],\n \"Copy\": {\n \"Enabled\": true,\n \"Path\": \"..\\\\Current\"\n },\n \"Supersede\": {\n \"Enabled\": true,\n \"MatchFields\": [\"SheetNumber\"],\n \"Mode\": \"Delete\"\n }\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"If your rules share the same behaviour then you can configure default (non-rule-specific) copy and supersede settings:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Copy\": {\n \"Enabled\": true,\n \"Path\": \"..\\\\Current\"\n },\n \"Supersede\": {\n \"Enabled\": true,\n \"Mode\": \"Move\",\n \"Path\": \"..\\\\Superseded\"\n },\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Supersede\": {\n \"MatchFields\": [\"SheetNumber\"]\n }\n },\n {\n \"Pattern\": \"(?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".dwg\" ],\n \"Supersede\": {\n \"MatchFields\": [\"SheetNumber\"]\n }\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overriding configuration for a specific folder","type":"text"}]},{"type":"paragraph","content":[{"text":"The Supersede utility supports ","type":"text"},{"text":"folder specific configuration","type":"text","marks":[{"type":"link","attrs":{"href":"https://xrev.atlassian.net/wiki/spaces/Transmit/pages/2279899171"}}]},{"text":" in ","type":"text"},{"text":".supersede-config","type":"text","marks":[{"type":"code"}]},{"text":" files. The utility will combine all of the relevant configuration files for each file it processes.","type":"text"}]},{"type":"paragraph","content":[{"text":"This allows you to specify some global default behaviour and rules in the global ","type":"text"},{"text":"Supersede.json","type":"text","marks":[{"type":"code"}]},{"text":" configuration file, and then in a folder specific ","type":"text"},{"text":".supersede-config","type":"text","marks":[{"type":"code"}]},{"text":" file you can simply add or override the specific parts that are different for that folder.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, consider the following global ","type":"text"},{"text":"Supersede.json","type":"text","marks":[{"type":"code"}]},{"text":" configuration:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Supersede\": {\n \"Copy\": {\n \"Enabled\": true,\n \"Path\": \"..\\\\Current\"\n },\n \"Supersede\": {\n \"Enabled\": true,\n \"Mode\": \"Move\",\n \"Path\": \"..\\\\Superseded\"\n },\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Supersede\": {\n \"MatchFields\": [ \"SheetNumber\" ]\n }\n },\n {\n \"Pattern\": \"(?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".dwg\" ],\n \"Supersede\": {\n \"MatchFields\": [ \"SheetNumber\" ]\n }\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"If we have a special project where we don’t want to keep superseded files (because they will remain in their initial location anyway), then we could use a folder specific ","type":"text"},{"text":".supersede-config","type":"text","marks":[{"type":"code"}]},{"text":" file with the following configuration:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Supersede\": {\n \"Mode\": \"Delete\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that in order to override configuration for a specific rule, you need to specify the same Pattern as defined in the global configuration file:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Rules\": [\n {\n \"Pattern\": \"(?.+) - (?.+) \\\\((?.+)\\\\)\",\n \"Extensions\": [ \".pdf\" ],\n \"Copy\": {\n \"Path\": \"..\\\\PDFs\\\\Current\"\n },\n \"Supersede\": {\n \"MatchFields\": [\"SheetNumber\"],\n \"Mode\": \"Delete\"\n }\n }\n ]\n}","type":"text"}]},{"type":"paragraph"}],"version":1}