Stirling-PDF/PipelineFeature.md

43 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2024-01-06 23:53:07 +01:00
# Pipeline Configuration and Usage Tutorial
2024-11-03 08:20:10 +01:00
- Configure the pipeline config file and input files to run files against it.
- 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.
2024-01-06 23:56:56 +01:00
2024-01-06 23:53:07 +01:00
## Steps to Configure and Use Your Pipeline
1. **Access Configuration**
- Upon entering the screen, click on the **Configure** button.
2. **Enter Pipeline Name**
- Provide a name for your pipeline in the designated field.
3. **Select Operations**
- Choose the operations for your pipeline (e.g., **Split Pages**), then click **Add Operation**.
4. **Configure Operation Settings**
- Input the necessary settings for each added operation. Settings are highlighted in yellow if customization is needed.
5. **Add More Operations**
- You can add and adjust the order of multiple operations. Ensure each operation's settings are customized.
6. **Save Settings**
- Click **Save Operation Settings** after customizing settings for each operation.
7. **Validate Pipeline**
- Use the **Validation** button to check your pipeline. A green indicator signifies correct setup; a pop-out error indicates issues.
8. **Download Pipeline Configuration**
2024-11-03 08:20:10 +01:00
- To use the configuration for folder scanning (or save it for future use and re-upload it), download a JSON file in this menu. You can also pre-load it for future use by placing it in `/pipeline/defaultWebUIConfigs/`. It will then appear in the dropdown menu for all users to use.
2024-01-06 23:53:07 +01:00
9. **Submit Files for Processing**
2024-11-03 08:20:10 +01:00
- If your pipeline is correctly set up, close the configure menu, input the files, and hit **Submit**.
2024-01-06 23:53:07 +01:00
10. **Note on Web UI Limitations**
- The current web UI version does not support operations that require multiple different types of inputs, such as adding a separate image to a PDF.
2024-03-17 10:33:05 +01:00
### Current Limitations
2024-11-03 08:20:10 +01:00
- Cannot have more than one of the same operation.
- Cannot input additional files via UI.
- All files and operations run in serial mode.