What is the Ytria automation API?
Go even bigger with your Ytria tools—through large-scale repeatable processes.
Ytria tools can be automated? Yes!
Ytria automation API lets you perform large, repetitive tasks quickly and efficiently. Ytria's tools sees the focus of the command language and the scope of possibilities greatly expanded.
Here’s how you can start putting automation to work for you
Following through this page will help your understanding of what you can do with automation and how you can get started doing it. We’ll also introduce you to some key automation resources you’ll want to keep handy for the future.
First, let’s look at a quick-and-easy script. Try out the script below in a server already loaded. You’ll get a concise readout of all entries, and their corresponding access levels for all databases on a loaded server.
Simply copy/paste the script shown here into any text editor and save it as an XML file.
Open and load a server into the selection tree. Then, select the option ‘Load Automation File…’ from the Server (or use CTRL+X).
Find the file you just saved and click ‘Open.’
That’s all there is to it! You’ll have a complete listing of all databases on the loaded server, as well as all applicable entries grouped by access level and name.
<ytriaAutomation> <RemoveAllColumns></RemoveAllColumns> <Add ColumnID="DB1" Position="1"></Add> <Add ColumnID="ACL5" Position="1"></Add> <Add ColumnID="ACL1" Position="1"></Add> <GroupBy ColumnID="DB1"></GroupBy> <GroupBy ColumnID="ACL5"></GroupBy> <GroupBy ColumnID="ACL1"></GroupBy> <Collapse/> </ytriaAutomation>
How to automate Ytria products?
Ytria applications allow you to automate most actions using XML scripts (eXtensible Markup Language).
XML files are plain text files that can be created with any text editor (e.g. Notepad).
Either UTF-8 or UTF-16 encoding will be accepted.
If you are currently unfamiliar with XML, http://w3schools.com has some excellent tutorials to help kickstart your understanding.
To learn more about automation itself, visit our “XML Basics” page by clicking the link below. You’ll find simple examples of the types of components found in a good automation script—including their structure and purpose.
If you want to understand more about how Ytria's automation for consolidation, be it for an imminent migration or for routine maintenance, see our "How to section".
Tip: Once you start to get the general idea of what automation is all about, check out some commands that you’ll want to know. Some of the concepts involved require a bit of familiarization, but once you have the knowledge under your belt, large scale operations are a cinch to handle:
To learn more about automation itself, visit our “XML Basics” page by clicking the link below. You’ll find simple examples of the types of components found in a good automation script - including their structure and purpose.
This section contains high-level commands used universally across all tools. For example, loading a server or database.
Check out the full scope of functionality
Check out the ever-expanding catalog of functions that you can automate. Some of these command tags will sound familiar, some will seem brand new. A vast amount of possibilities exist.
Each tag has it’s own page that contains an explanation of exactly what it will do, an example that puts it in context, and the technical information surrounding its use in a script.
Check out the ever-expanding catalog of functions that you can automate. Some of these command tags will sound familiar, some will seem brand new.
Drill down into the specifics
Every product has its own exclusive functions. Click the links below for a direct access to the pages describing the specific action tags that are used to automate the individual products’ functionality.