DGNum/Stirling-PDF
15
0
Fork 0
Code Issues 4 Pull requests 1 Projects Releases Packages Wiki Activity

format

Browse source
This commit is contained in:
Anthony Stirling 2023-12-31 13:28:18 +00:00
parent d91c600925
commit 143b770882
1 changed files with 203 additions and 157 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
src/main/resources/templates/pipeline.html
View file

@ -22,8 +22,10 @@
text-align: center; text-align: center;
margin: auto; margin: auto;
} }
.element-margin { .element-margin {
margin: 10px 0; /* Adjust this value to increase/decrease the margin as needed */ margin: 10px 0;
/* Adjust this value to increase/decrease the margin as needed */
} }
</style> </style>
@ -41,14 +43,16 @@
<div class="text-end text-top"> <div class="text-end text-top">
<button id="uploadPipelineBtn" class="btn btn-primary">Upload <button id="uploadPipelineBtn" class="btn btn-primary">Upload
Custom</button> Custom</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" <button type="button" class="btn btn-primary"
data-bs-target="#pipelineSettingsModal">Configure</button> data-bs-toggle="modal" data-bs-target="#pipelineSettingsModal">Configure</button>
</div> </div>
<div class="center-element"> <div class="center-element">
<div class="element-margin"> <div class="element-margin">
<select id="pipelineSelect" class="custom-select"> <select id="pipelineSelect" class="custom-select">
<option value="{&quot;name&quot;:&quot;Custom&quot;,&quot;pipeline&quot;:[],&quot;_examples&quot;:{&quot;outputDir&quot;:&quot;{outputFolder}/{folderName}&quot;,&quot;outputFileName&quot;:&quot;{filename}-{pipelineName}-{date}-{time}&quot;},&quot;outputDir&quot;:&quot;{outputFolder}&quot;,&quot;outputFileName&quot;:&quot;{filename}&quot;}" th:text="Custom"></option> <option
value="{&quot;name&quot;:&quot;Custom&quot;,&quot;pipeline&quot;:[],&quot;_examples&quot;:{&quot;outputDir&quot;:&quot;{outputFolder}/{folderName}&quot;,&quot;outputFileName&quot;:&quot;{filename}-{pipelineName}-{date}-{time}&quot;},&quot;outputDir&quot;:&quot;{outputFolder}&quot;,&quot;outputFileName&quot;:&quot;{filename}&quot;}"
th:text="Custom"></option>
<th:block th:each="config : ${pipelineConfigsWithNames}"> <th:block th:each="config : ${pipelineConfigsWithNames}">
<option th:value="${config.json}" th:text="${config.name}"></option> <option th:value="${config.json}" th:text="${config.name}"></option>
@ -56,7 +60,8 @@
</select> </select>
</div> </div>
<div class="element-margin"> <div class="element-margin">
<div th:replace="~{fragments/common :: fileSelector(name='fileInput', multiple=true)}"></div> <div
th:replace="~{fragments/common :: fileSelector(name='fileInput', multiple=true)}"></div>
</div> </div>
<div class="element-margin"> <div class="element-margin">
<button class="btn btn-primary" id="submitConfigBtn">Submit</button> <button class="btn btn-primary" id="submitConfigBtn">Submit</button>
@ -74,58 +79,98 @@
<h3>How it Works Notes</h3> <h3>How it Works Notes</h3>
<ul> <ul>
<li>Configure the pipeline config file and input files to run files against it</li> <li>Configure the pipeline config file and input files to run
<li>For reuse, download the config file and re-upload it when needed, or place it in /pipeline/defaultWebUIConfigs/ to auto-load in the web UI for all users</li> files against it</li>
<li>For reuse, download the config file and re-upload it when
needed, or place it in /pipeline/defaultWebUIConfigs/ to
auto-load in the web UI for all users</li>
</ul> </ul>
<h3>How to use pre-load configs in web UI</h3> <h3>How to use pre-load configs in web UI</h3>
<ul> <ul>
<li>Download config files</li> <li>Download config files</li>
<li>For reuse, download the config file and re-upload it when needed, or place it in /pipeline/defaultWebUIConfigs/ to auto-load in the web UI for all users</li> <li>For reuse, download the config file and re-upload it when
needed, or place it in /pipeline/defaultWebUIConfigs/ to
auto-load in the web UI for all users</li>
</ul> </ul>
<h3>Todo</h3> <h3>Todo</h3>
<ul> <ul>
<li>Fix operation adding requering settings to be openned and saved instead of saving defaults</li> <li>Fix operation adding requering settings to be openned and
saved instead of saving defaults</li>
<li>Translation support</li> <li>Translation support</li>
<li>offline mode checks and testing</li> <li>offline mode checks and testing</li>
<li>Improve operation config settings UI</li> <li>Improve operation config settings UI</li>
</ul> </ul>
<h2>User Guide for Local Directory Scanning and File Processing</h2> <h2>User Guide for Local Directory Scanning and File
Processing</h2>
<h3>Setting Up Watched Folders:</h3> <h3>Setting Up Watched Folders:</h3>
<p>Create a folder where you want your files to be monitored. This is your 'watched folder'.</p> <p>Create a folder where you want your files to be monitored.
<p>The default directory for this is <code>./pipeline/watchedFolders/</code></p> This is your 'watched folder'.</p>
<p>Place any directories you want to be scanned into this folder, this folder should contain multiple folders each for their own tasks and pipelines.</p> <p>
The default directory for this is
<code>./pipeline/watchedFolders/</code>
</p>
<p>Place any directories you want to be scanned into this
folder, this folder should contain multiple folders each for their
own tasks and pipelines.</p>
<h3>Configuring Processing with JSON Files:</h3> <h3>Configuring Processing with JSON Files:</h3>
<p>In each directory you want processed (e.g <code>./pipeline/watchedFolders/officePrinter</code>), include a JSON configuration file.</p> <p>
<p>This JSON file should specify how you want the files in the directory to be handled (e.g., what operations to perform on them) which can be made, configured and downloaded from Stirling-PDF Pipeline interface.</p> In each directory you want processed (e.g
<code>./pipeline/watchedFolders/officePrinter</code>
), include a JSON configuration file.
</p>
<p>This JSON file should specify how you want the files in the
directory to be handled (e.g., what operations to perform on them)
which can be made, configured and downloaded from Stirling-PDF
Pipeline interface.</p>
<h3>Automatic Scanning and Processing:</h3> <h3>Automatic Scanning and Processing:</h3>
<p>The system automatically checks the watched folder every minute for new directories and files to process.</p> <p>The system automatically checks the watched folder every
<p>When a directory with a valid JSON configuration file is found, it begins processing the files inside as per the configuration.</p> minute for new directories and files to process.</p>
<p>When a directory with a valid JSON configuration file is
found, it begins processing the files inside as per the
configuration.</p>
<h3>Processing Steps:</h3> <h3>Processing Steps:</h3>
<p>Files in each directory are processed according to the instructions in the JSON file.</p> <p>Files in each directory are processed according to the
<p>This might involve file conversions, data filtering, renaming files, etc. If the output of a step is a zip, this zip will be automatically unzipped as it passes to next process.</p> instructions in the JSON file.</p>
<p>This might involve file conversions, data filtering,
renaming files, etc. If the output of a step is a zip, this zip
will be automatically unzipped as it passes to next process.</p>
<h3>Results and Output:</h3> <h3>Results and Output:</h3>
<p>After processing, the results are saved in a specified output location. This could be a different folder or location as defined in the JSON file or the default location <code>./pipeline/finishedFolders/</code>.</p> <p>
<p>Each processed file is named and organized according to the rules set in the JSON configuration.</p> After processing, the results are saved in a specified output
location. This could be a different folder or location as defined
in the JSON file or the default location
<code>./pipeline/finishedFolders/</code>
.
</p>
<p>Each processed file is named and organized according to the
rules set in the JSON configuration.</p>
<h3>Completion and Cleanup:</h3> <h3>Completion and Cleanup:</h3>
<p>Once processing is complete, the original files in the watched folder's directory are removed.</p> <p>Once processing is complete, the original files in the
<p>You can find the processed files in the designated output location.</p> watched folder's directory are removed.</p>
<p>You can find the processed files in the designated output
location.</p>
<h3>Error Handling:</h3> <h3>Error Handling:</h3>
<p>If there's an error during processing, the system will not delete the original files, allowing you to check and retry if necessary.</p> <p>If there's an error during processing, the system will not
delete the original files, allowing you to check and retry if
necessary.</p>
<h3>User Interaction:</h3> <h3>User Interaction:</h3>
<p>As a user, your main tasks are to set up the watched folders, place directories with files for processing, and create the corresponding JSON configuration files.</p> <p>As a user, your main tasks are to set up the watched
<p>The system handles the rest, including scanning, processing, and outputting results.</p> folders, place directories with files for processing, and create
the corresponding JSON configuration files.</p>
<p>The system handles the rest, including scanning, processing,
and outputting results.</p>
<!-- The Modal --> <!-- The Modal -->
@ -136,7 +181,8 @@
<!-- Modal Header --> <!-- Modal Header -->
<div class="modal-header"> <div class="modal-header">
<h2 class="modal-title">Pipeline Configuration</h2> <h2 class="modal-title">Pipeline Configuration</h2>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button> <button type="button" class="btn-close" data-bs-dismiss="modal"
aria-label="Close"></button>
</div> </div>