Welcome to ApexUtils
What is ApexUtils
PrUnTools started as a private set of tools that I wrote with another member of the community. I then noticed that I could seperate the Apex code in to it's own reusable library which resulted in ApexUtils. This would allow me to keep my tools and provide a framework for others to use to create their own.
ApexUtils is a set of utility functions designed to be used by TamperMonkey scripts (or similar products) to interact with the APEX interface in a safe way. The utility also loads CSS that mimics the style of APEX but with class names you can use in your own HTML.
What ApexUtils is NOT
ApexUtils is NOT a framework for creating Bots. It performs only one automatic click to create a new buffer window. I have personally showed this feature to the Devs and they are ok with it. You are responsible for what you create with the tool.
Is this against ToS
No. ApexUtils itself only reads and adds content to the Client. It does not send data to the server or automate client tasks. ApexUtils interfaces with the DOM elements of the page and does not attempt to interact with the Javascript in the page, all modifications are done using it's own Javascript utilizing jQuery.
How do I use ApexUtils
ApexUtils is just a helper script. It's meant to be used with some type of script injection system like TamperMonkey. TamperMonkey is a Chrome/Edge/Safari/Firefox browser plugin that will sideload Javascripts in to pages of your choosing.
Sideloading Javascript allows your scripts to interact with the elements on the page you are reading. You can read data off the page, add data to the page, add button, boxes, etc to the page.
This is where ApexUtil comes in, I've determined what I think is a good and safe way to interact with Apex is and then put that code in to a library for you to use.
Check out Setup Dev Environment
What can ApexUtils do?
Currently ApexUtils has the ability to
- Create a menu block in left menu and populate it with menu items you create
- Create new Buffer windows and replace the default content with content you provide
- Create alert Buffer windows to display success/error/warning messages
- Monitors the 'SCRN:' to detect when you change screens so you can perform actions when screen changes
This may not seem like much, but this is just a framework to make it easy for you to get your content in to the APEX interface. Once your content is in you could have an entire Javascript mini-application with the main APEX interface.
I want to try it!!!
- Go to your browser of choice Extension store
- Search for and install TamperMonkey (others may work, this is just the one I know)
- Navigate to your APEX console (TamperMonkey will record what URL you have loaded when you create the script and will only load it again on that page)
- Click on TamperMonkey icon in toolbar, click 'Create a New Script...'
- Copy contents of example/FlatMapMonkey.js to the editor, replace all text in editor
- Hit Ctrl+S or File --> Save to save script
- Click on Apex tab in browser and reload
- ApexUtils menu will appear in 5s (to let page complete load)
In this example I have included a zoomable/navigable flat map 'FMAP' of the universe made by Ausecko @ ausecko.com (used with permission) and the default 'HELP' button.
And a video of it in action!
Enjoy !!! :)
P.S.
I will warn you, I am NOT a JS developer. This is the first thing I have written in JS other than like drop down menus and such for bank websites. I used principles from my many other languages and I know JS just sometimes doesn't fit the same 'rules'.
So, this means if you are looking at my code and thing, wow, this guy is an idiot for doing it like this or this then please, reach out, do a patch, or pull request or offer up some knowledge on a better way. I am open to all feedback.