SPH Report Cleanup is a Batch script designed to search for and clean up Synxis Property Hub (SPH) reports from the workstation's "Downloads" folder. This script features several enhancements for user convenience. It keeps itself and its dependencies up-to-date, ensuring a seamless experience.
The script employs a PowerShell script to find and delete SPH PDF files based on the predetermined search format: "sph.pdf"*. This specific format is chosen to safeguard against unintended deletion of non-SPH files. The script's sole purpose is to clean up residual report files in the "Downloads" folder, enhancing system hygiene.
Examples of SPH Reports Looked For
- Cashier Closing
- Credit Card Transaction Total
- Hotel Ledger
- Standard Guest List
- Statistics Report
- Transaction Total Detail
- Transaction Total Summary
- Getting Started
- What To Expect When Running The Script
- FAQ
- Repository Information
- Changelog
- Contributing
- License
- Contact
To begin using SPH Report Cleanup, download the latest release. The script is a standalone Batch file; no additional downloads are required. The script will handle the installation of necessary dependencies automatically upon execution.
There is no installation process. The script will reside in the user's "Downloads" folder. While the script can be run from any location on the user's machine, it is recommended to move it to the desktop for easy access. The script creates a desktop shortcut with every run, ensuring an always up-to-date link.
Upon running the script, it will perform the following tasks:
- Attempt to run as an administrator
- If not granted administrative privileges, it will prompt for elevation, ensuring a one-time administrative session for necessary operations.
- Verify and install dependencies
- Ensure proper functioning of the script.
- Check for updates
- Download and install the latest version of the script and its dependencies, if available.
- Display a progress bar
- Visualize the search for files matching the "sph.pdf"* format.
- List files to be deleted
- Provide a preview of files targeted for deletion.
- Confirm file deletion
- Prompt the user for confirmation to prevent accidental deletions.
- Display informational message
- Showcase script details and offer options via buttons.
- Create a desktop shortcut
- Facilitate easy script execution.
- Terminate the script
- Exit after prompting the user to press any key.
-
Why does the script need to be run manually?
- The script is designed for user-initiated execution and is not intended for automatic runs.
-
Why does the script require Windows 10?
- It relies on PowerShell 5.1 or higher, exclusive to Windows 10.
-
Why administrative privileges?
- Necessary for file deletion in the user's Downloads folder and for self-updating.
-
Why run on a company machine?
- Tailored for Synxis Property Hub files, serving no purpose on other machines.
-
Why run after downloading Synxis PDF files?
- Targets cleanup of downloaded SPH files; irrelevant otherwise.
-
Automated script run?
- Possible via Windows Task Scheduler but not recommended due to unnecessary resource usage.
-
Why check for updates?
- Ensures script and dependencies are current for optimal functionality.
-
Different window during script run?
- CMD Prompt window used for progress display; background downloads may spawn a second window.
-
Uninstall prompt during script run?
- Git uninstalling previous versions as part of the update process.
-
"Cloning" or "pulling" message?
- Git fetching the latest script version during the update.
-
Desktop run recommendation?
- Convenience feature; script can run from any location, but desktop placement is advised.
Commits
Pull Requests
Downloads by Version
V1.0 Downloads [*Ongoing*]
V0.1 Downloads [*Discontinued*]
Currently there are no recent issues. If you have an issue, please open one and let us know so we can fix it.
For a detailed changelog, please refer to the CHANGELOG.md file. It contains information about every release, including notable changes, bug fixes, and new features. The format is based on Keep a Changelog. This project adheres to Semantic Versioning. The latest release is v0.1.0.
Contributions are what make the open-source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated. Please refer to the CONTRIBUTING.md file for more information on how to contribute. The process for submitting pull requests is described in GitHub Help. Please refer to the CODE_OF_CONDUCT.md file for our code of conduct. We welcome all contributions, including but not limited to the following: reporting issues, contributing code, submitting pull requests, identifying bugs, proposing new features, and creating suggestions. When contributing to this repository, please follow the Ethereal Style Codex and the Ethereal Documentation Codex.
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details. The license is also available online. The license is based on the GNU General Public License v3.0. It is a copyleft license that requires anyone who distributes our code or a derivative work to make the source available under the same terms, and also provides an express grant of patent rights from contributors to users. It is compatible with the GNU GPL, but not with the GNU LGPL. The license is designed specifically to ensure that, if you make changes to this code and distribute the resulting executable, you must release your changes under the same license. It ensures that the user of a program that includes this code can download the source freely and modify it freely. It also ensures that the user can know what license the code is released under, and can use that code in other projects.
- Please use the Issues tab to report any issues, bugs, or enhancements (feature requests)
- You may email us at Ghost Hackers for any other inquiries