Tasks

Know what tasks are available and what their inputs are.

The PowerOn Pipelines Azure DevOps extension comes with two primary tasks which can be configured to best serve your credit union. This page gives a comprehensive overview of what's available within each one.

SynchronizeDirectory

Available • Synchronizes a Symitar directory (DATAFILES, LETTERSPECS, HELPFILES, or REPWRITERSPECS) with your Azure repository using a release artifact created as your default branch receives changes. In the case of PowerOn files (e.g. the REPWRITERSPECS directory), the task will Install & Uninstall based on your checked-in PowerOn Pipelines configuration.

Inputs

The following inputs are available using the SynchronizeDirectory task in any Azure DevOps pipeline.

Directory Type

directoryType • This determine which directory is going to be targeted by the sync operation. The is interpreted and then translated into the known Symitar directory.

  • dataFiles - targets the DATAFILES directory on your target Sym

  • helpFiles - targets the HELPFILES directory on your target Sym

  • letterFiles - targets the LETTERSPECS directory on your target Sym

  • powerOns - targets the REPWRITERSPECS directory on your target Sym

Required
Available Values
Default Value

Yes

dataFiles, helpfiles, letterFiles, powerOns

--

Local Directory Path

localDirectoryPath • This is the local directory path in your repository containing the files to synchronize. It can be any path relative to the project root and the defaults listed below are dependent on your value for directoryType.

Required
Available Values
Default Value

No

--

  • DATAFILES/ with dataFiles

  • HELPFILES/ with helpFiles

  • LETTERSPECS/ with letterFiles

  • REPWRITERSPECS/ with powerOns

Connection Type

connectionType • This determines which connection adapter to use.

  • ssh - uses the legacy Symitar CLI over SSH as well as some native SSH commands

  • https - uses the available SymAppServer endpoints to perform a limited number of operations on the Sym (this is coupled with native SSH commands for full functionality)

circle-check
Required
Available Values
Default Value

Yes

ssh or https

--

Sync Mode

syncMode • This determines how to synchronize your Sym directory relative to your local path.

  • push - strictly uploads files which are present in your local directory

  • pull - strictly downloads files which are present on your Symitar host directory

  • mirror - synchronizes your Symitar host to match your local directory

Required
Available Values
Default Value

Yes

push, pull or mirror

--

Dry Run

isDryRun • This determines whether or not to make physical changes in the Sym. With this enabled no files are changed, only output which will communicate what would have changed.

Required
Available Values
Default Value

No

true or false

true

Sync Method

syncMethod • The transport method for file synchronization. SFTP is the default and supports concurrent transfers. rsync is faster for large directories but requires rsync + sshpass to be installed on the ADO agent.

Required
Available Values
Default Value

No

rsync or sftp

sftp

SFTP Concurrency

sftpConcurrency • Number of concurrent SFTP transfers (1-50). Only applies when syncMethod is set to sftp.

Required
Available Values
Default Value

No

1 through 50

20

Artifact Path

artifactPath • Simply the destination folder of your artifact after it has been extracted.

circle-info

Take a look at our examples We published the complete Examples of our YAML-based pipelines for merges, PRs, and releases. Take a look & don't be shy to reach out to [email protected]envelope if you get stuck!

Required
Available Values
Example Value

Yes

--

repo

Symitar Hostname

symitarHostname • The endpoint by which you connect to the Symitar host.

Required
Available Values
Example Value

Yes

--

93.455.43.232

Symitar App Port

symitarAppPort • The port which your Symitar Application Server communicates over. This is typically 42 + symNumber unless you're running at the SYSTEM level.

Required
Available Values
Example Value

Yes (for connectionType = http)

--

42627

SSH Username

sshUsername • The AIX user name for the Symitar host.

Required
Available Values
Example Value

Yes

--

libum

SSH Password

sshPassword • The AIX password for the Symitar host.

Required
Available Values
Example Value

Yes

--

hunter2

SSH Port

symitarHostname • The port to connect to the Symitar (AIX) host over SSH.

Required
Available Values
Default Value

No

--

22

Symitar User Number

symitarUserNumber • Your Symitar Quest user number (fka. Teller Number). It is recommended you provide more of a "system user" instead of your personal for Production instances.

Required
Available Values
Example Value

Yes

--

1995

Symitar User Password

symitarUserPassword • Your Symitar Quest user password.

Required
Available Values
Example Value

Yes

--

2dfKQYR!TeXJwe

API Key

apiKey • Your PowerOn Pipelines API Key from Libum Portalarrow-up-right.

circle-exclamation
Required
Available Values
Default Value

Yes

See API Keysarrow-up-right in Libum Portal

--

Sym Number

symNumber • The directory (aka Sym) number to deploy to. If nothing is defined here, the task will attempt to pull from the branchSymNumbers you have defined in your Configuration.

Required
Available Values
Example Value

No

--

627

Debug

debug • Enable debug logging for the Symitar client.

Required
Available Values
Default Value

No

true or false

false

ValidatePowerOn

Available • Validates the updated PowerOn files in the configured powerOnsDirectory. In the PR context this will only validate changes between target and source branches. In the build context, this will validate differences between the current state and what exists in the provided symNumber.

Inputs

The following inputs are available using the ValidatePowerOn task in any Azure DevOps pipeline.

Connection Type

connectionType • This determines which connection adapter to use.

  • ssh - uses the legacy Symitar CLI over SSH as well as some native SSH commands

  • https - uses the available SymAppServer endpoints to perform a limited number of operations on the Sym (this is coupled with native SSH commands for full functionality)

circle-check
Required
Available Values
Default Value

Yes

ssh or https

--

Symitar Hostname

symitarHostname • The endpoint by which you connect to the Symitar host.

Required
Available Values
Example Value

Yes

--

93.455.43.232

Symitar App Port

symitarAppPort • The port which your Symitar Application Server communicates over. This is typically 42 + symNumber unless you're running at the SYSTEM level.

Required
Available Values
Example Value

Yes (for connectionType = http)

--

42627

SSH Username

sshUsername • The AIX user name for the Symitar host.

Required
Available Values
Example Value

Yes

--

libum

SSH Password

sshPassword • The AIX password for the Symitar host.

Required
Available Values
Example Value

Yes

--

hunter2

SSH Port

symitarHostname • The port to connect to the Symitar (AIX) host over SSH.

Required
Available Values
Default Value

No

--

22

Symitar User Number

symitarUserNumber • Your Symitar Quest user number (fka. Teller Number). It is recommended you provide more of a "system user" instead of your personal for Production instances.

Required
Available Values
Example Value

Yes

--

1995

Symitar User Password

symitarUserPassword • Your Symitar Quest user password.

Required
Available Values
Example Value

Yes

--

2dfKQYR!TeXJwe

API Key

apiKey • Your PowerOn Pipelines API Key from Libum Portalarrow-up-right.

circle-exclamation
Required
Available Values
Default Value

Yes

See API Keysarrow-up-right in Libum Portal

--

Sym Number

symNumber • The directory (aka Sym) number to deploy to. If nothing is defined here, the task will attempt to pull from the branchSymNumbers you have defined in your Configuration.

Required
Available Values
Example Value

No

--

627

PowerOns Directory

powerOnsDirectory • The directory in the repository to monitor PowerOn changes in.

Required
Available Values
Default Value

No

--

REPWRITERSPECS/

Sync Method

syncMethod • The transport method for file synchronization. SFTP is the default and supports concurrent transfers. rsync is faster for large directories but requires rsync + sshpass to be installed on the ADO agent.

Required
Available Values
Default Value

No

rsync or sftp

sftp

Debug

debug • Enable debug logging for the Symitar client.

Required
Available Values
Default Value

No

true or false

false

Last updated