Introduction
  • 2 Minutes to read
  • Dark
    Light
  • PDF

Introduction

  • Dark
    Light
  • PDF

Article summary

Important: Advanced Technical Topics Ahead

Please note that the scripting feature in Agility Blue is an advanced tool that utilizes Microsoft's PowerShell execution engine. To effectively use this feature, a foundational understanding of basic programming concepts and familiarity with PowerShell scripting are essential. While we are excited to offer this powerful functionality, please be aware that our support team's scope does not extend to providing training in PowerShell or conducting code analysis of your custom scripts. We encourage users with the requisite skills to explore this feature, and recommend those new to PowerShell to seek external resources for learning and development. 

Introduction

Scripting is an enterprise-tier feature that empowers your users to extend and customize the functionality of Agility Blue in ways that best suit your unique business needs and helps facilitate automated workflows through event-driven triggers.

What is Scripting?

Agility Blue scripting allows you to write and execute custom PowerShell scripts directly within the application environment. This feature leverages a specialized set of tailor-made PowerShell commands (cmdlets) that enable you to seamlessly query, create, update, and delete the various objects, entities, and resources found throughout your Agility Blue environment. These commands act as a direct interface to Agility Blue's REST API, giving you a powerful set of tools to automate and streamline your processes without having to externally invoke the REST API.

Key Features and Capabilities

  • Custom Cmdlets: Access a unique set of over 170 PowerShell commands designed specifically for interacting with Agility Blue. These cmdlets allow you to perform a wide range of actions, from simple queries to complex object manipulations.

  • Event-Driven: Elevate your automation game by attaching scripts to specific events within the application. Whether it's creating a new task or updating an existing matter, you can trigger scripts to execute before or after the event, providing a high level of control and customization.

  • Object Manipulation: When a script is tied to an event, the relevant object instance is injected into the script. This allows your script to directly manipulate the object, offering a seamless integration between your custom scripts and the application's core functionalities.

  • Scheduled Jobs: Automate repetitive tasks by running your scripts on a defined schedule, enabling efficient execution of routine operations without manual intervention.

  • Return to Pipeline: After processing, scripts can return the manipulated object back to the application, ensuring that your custom logic is perfectly integrated into the standard operation flow.

Why Use Scripting?

The Scripting feature in Agility Blue is more than just a tool; it's a gateway to optimizing your workflow, facilitating automation, and personalizing your experience within the application. Whether you're looking to automate repetitive tasks, implement custom business logic, or simply explore the vast potential of Agility Blue, Scripting offers the flexibility and power to make it happen.

Dive deeper into subsequent sections on how to harness the full potential of Scripting which include detailed guides on writing your first script, attaching scripts to events, and exploring the custom cmdlets.

Getting Help

Stuck on a particular problem or not quite sure how to do something? Visit our community GitHub discussions page and see if your question has already been answered or post a new one. Be sure not to post anything sensitive! Our staff will try to respond within our support hours SLA and other community members may offer their guidance.

If you don’t have the internal resources to create your own scripts and you are looking to have scripts created for you, contact your account representative to arrange a discovery & requirements meeting. If we have the resources available to meet your needs, we will put a quote together for you or provide you with a 3rd party developer partner that we trust.





What's Next