Whats new in 1.0.8

• Add command Generate Session to replace Authenticate
• You can now call a post authentication hook which will get passed the connection id and session id.
• Update readme
• improvements and bug fixes

About

This Visual Studio Code extension allows you to quickly generate a Symitar session which returns a session ID and connection ID.

Requirements

• Visual Studio Code 1.70.0 or greater
• Connection to Jack Henry VPN
• Login credentials to a Jack Henry Symitar host

Getting Started

To get started you need to set these required settings either in your workspace settings JSON file or through the preferences GUI.

{
  "symitar-session-generator.host": "some-host.com",
  "symitar-session-generator.profile": "TEST",
  "symitar-session-generator.institutionId": "SYMITAR",
  "symitar-session-generator.symId": "000",
  "symitar-session-generator.port": "42000",
  "symitar-session-generator.username": "someuser"
}

How To Use

Entering your password

You have two options for entering your password for authenticating.

1. Storing in VSC secret storage
2. Manual entry

1. Storing password in secret storage

You can store your password in Visual Studio Codes's secret storage by running the command Set Password from the command pallete or from the VSC UI settings page. This prevents you from having to enter your password everytime.

NOTE If you need to change your password simply run Set Password again.

2. Manual Password Entry

If you do not want to store your password you can enter it everytime you request a new session. You will be prompted for it after running the Generate Session command if a password has not been set using the Set Password command.

Generating a session

To generate a new session run the Generate Session command.

NOTE If you have already set your password using the Set Password command you will not be requested to enter your password.

Open Command Palete:

ctrl + shft + p

Enter:

Authenticate

NOTE Ensure that you are connected to VPN first or you will not be able to authenticate.

Once you are authenticated with the server a new file will open with your connection ID and session ID in JSON format.

Example

{
  "CONNECTION_ID": "CONN7ca730b2-abc-4a88-bf51-123456abcdefg",
  "SESSION_ID": "SYMITAR.TEST.000.SESSce6a07fb-c51d-abc-123a-123456abc"
}

Calling a post authentication script

After authenticating you can automatically call a node script to do things like updating files in the project or settings environment variables utilizing the new session credentials. You can set the symitar-session-generator:postHookLocation setting to the relative location of the post hook.

For example creating a node script and placing it in the root of the project at symitar/postHook.js

// Access command-line arguments
const args = process.argv.slice(2);

const connectionId = args[0];
const sessionId = args[1];

if (!connectionId || !sessionId) {
  process.exit(1);
} else {
  // Do something with the connectionId and sessionId such as updating environment variables
}

and then setting the symitar-session-generator:postHookLocation to symitar/postHook.js.

This script will get called with the conenction ID and session ID passed as CLI arguments.

Resetting or removing your stored password

To remove your password run the command Set Password and set a blank password. Once you do this you will be asked to enter your password each time you request a new session.

To change your password run the command Set Password and enter your new password.