Navigating Your Andi® Skills Kit in the IDE

Overview

You will write your skills using the Andi® Skills Kit extension in the Visual Studio Code IDE. This article will show you how to navigate your kit.

Shows the Andi Skills Kit in the IDE

 

In this Article

 

Your Andi® Skills Workspace

Shows the Andi Skills workspace section in the IDE

Your workspace to write your skills will be set up with the following structure:

  • Applications: This directory will house the skill files respective to each software system or application that is set up to engage with Andi®.

    • At this time, PrecisionLender is the only application.
  • Contexts: Within each application, the context refers to the area of the application that the skill will reference in response to an event to determine whether the skill should run.

    • At this time, Opportunity and Timer are the only contexts for the PrecisionLender application.
  • Each context contains two folders for skill writing:

    • Examples contains a set of example pre-written skills to help guide you with writing common skill types. The example skill itself is not meant to be published, but rather act as a guide when writing similar skills.

    • Skills is where you will use the skill templates to write your skills and deploy them to the Andi® Skills Manager.

  • Each skill you create will contain and must maintain the following file structure:

    • Skillmanifest.json is where the metadata of the skill resides - general information/descriptions (name, version, author, date published) and will also contain the description of the skill that appears in the Manager and all the configurable properties of the skill. For example, in the context of an email skill, the recipient email address is a property of the skill that may be configured manually in skillmanifest.json.

    • shouldIRun.ts is executed any time a change event is received by Andi®. The Andi® dispatcher is listening and monitoring the user's activity so when a change event occurs, the dispatcher will check if any skills should run based on the change event, which will output true or false. If true, run.ts will be executed. If false, the next skill in the queue will be checked.

    • Run.ts embodies the execution of the skill itself. This may involve sending an information message, a warning message, making calculations, or communicating with a third party application to generate insight. Once the skill has been executed, Andi® will deliver the output/insight through a delivery channel, for example, email, Field Tag, etc.

    • The test modules contain unit tests - one for shouldIRun.ts, and run.ts - that ensure each component behaves and works as expected. The Visual Studio Code IDE provides skill writers with Mocha tests to help easily and efficiently debug code within the IDE. Mocha unit tests, while a good practice, are not required and will typically be utilized by skill writers with more programming experience.

 

Andi® Skill Kit Section

Shows the Andi Skill Kit section in the IDE

The Andi® Skill Kit section of your IDE screen contains links to the following:

  • Sign in to Andi®: This will authenticate your credentials and connect your IDE to the Andi® platform so that you can deploy your skills and manage them in the Andi® Skills Manager. Although you can write your skills without being signed in to the platform, you must be signed in to deploy your skills. Once signed in, you will also be signed into the Andi® Skills Manager.

  • Andi® Support: This will open the Andi® Support site in a new page in your web browser. You can use the Support Center to find articles on how to write and manage your skills.

  • Andi® Skills Manager: This will open the in a new page in your browser. If you’re already signed into Andi®, you’ll automatically be directed to your dashboard. If you’re not signed into Andi®, then you’ll need to.

 

 

Was this article helpful?
0 out of 0 found this helpful