Skip to content

Latest commit

 

History

History
190 lines (136 loc) · 5.94 KB

Operation-List.md

File metadata and controls

190 lines (136 loc) · 5.94 KB
Raw

Operation List

Simple Operations

lvEcho : Echo all the parameters to outputs

Parameters:
    1. All Parameters will be echoed to output.
Result:
    String concatenated with all parameters

lvBuild : Build the LabVIEW Projects specified

Parameters:
    Parameter1. (required) LabVIEW Project File Path
    Parameter2. (option) name of Build Specification, Empty to build all
       - "" as Default
    Parameter3. (option) Name of Target
       - "My Computer" as Default
Result:
    N/A

lvCopy : Copy Files using LabVIEW VIs

When agent/runner is registered as windows service. lvCopy could not access the network drivers.

Parameters:
    Parameter1. (required) Dest-Folder/Files of Copy operation
    Parameter2-10. (optional) Source Files of Copy operation
        - If no '*' contained in file name, the specified file path will be used.
        - If '*' in file name, the file name is the search pattern. Files in folder with the pattern will all be used as source-path.
Result:
    N/A

Test Related Operations

StartVITester : Start JKI VI Tester to run test cases

Parameters:
    Parameter1. (required) LabVIEW Project File Path which contains the VITester test cases
Result:
    N/A

VIPM related Operations

Requirements:

  • VIPM API is function of PRO Edition of VIPM. You need activate the license, or use a 30-days free-trial license.

vipm_OpenVIPM: Open VIPM

Parameters:
    N/A
Result:
    N/A

vipm_ExitVIPM: Exit VPM

Parameters:
    N/A
Result:
    N/A

vipm_SyncVIPMPackageLibrary: Sync VIPM package over network

Parameters:
    N/A
Result:
    N/A

vipm_InstallPackages : install vip by Package Name

Parameters:
    1. All Parameters accept a package name/package+version/vipFilePath. The latest version will be used if only package name applied.
Result:
    N/A

vipm_unInstallPackages : install vip by Package Name

Parameters:
    1. All Parameters accept a package name, the latest version will be used.
Result:
    N/A

vipm_BuildVIPackage : Build VIPM Library

Parameters:
    Parameter1. (required) vipb File Path
    Parameter2. (optional) Version: x.x.x.x, or empty to use date of year.month.day.time
    Parameter3. (optional) Install? : YES/NO, NO as default
Result:
    Generated VIP file path

vipm_BuildDailyVIP : Build Daily VIPM Library, library's version stands for the built date

Parameters:
    Parameter1. (required) vipb File Path
    Parameter2. (optional) Install? : YES/NO, NO as default
    Parameter3. (optional) CopyDestPath : Path
Result:
    Generated VIP file path

vipm_ApplyVIPCFile : Apply VIPC file

Parameters:
    Parameter1. (required) VIPC File Path
       1. For regular file path, the full file path will be used.
       2. If the path not end with '.vipc', recursively search will be executed the path with last part of path as pattern.
       3. If the last part of path contains '*', recursively search will be executed the path with last part of path as pattern.
Result:
    vipc file path used

Operations for VI Analyzer

VIAn_EasyAnalyze : Check the cfg file in your repo

Parameters:
    Parameter1. (required) vi-analyzer config File Path
    Parameter2. (optional) vi-analyzer config File Path's passwords
    Parameter3. (optional) Error if any test fails : YES/NO, yes as default

Result:
    result.txt path generated by VI Analyzer

VIAn_CheckBrokenVIs : Check broken VIs in your repo

Parameters:
    Parameter1. (required) folder or lvproj/vi path to be checked
    Parameter2. (optional) vi-analyzer config File Path's passwords
    Parameter3. (optional) Error if any test fails : YES/NO, yes as default
    Parameter3. (optional) Exclusive file pattern: String or String Array

Result:
    result.txt path generated by VI Analyzer

Operations for build facility

These operations are part of a build facility for large project with multiple repos. You need to pre-setup the folder contained all the repos organized as needed in the build machine.

Concepts

  • Build Spec Project: A LabVIEW project with build spec in it and named as "_build.[0-9]*.xxxxx.lvproj"
  • Build Index: The number part in name of Build Spec Project.

Batch_ListReposBranches : list all the repos' current branch

*Not available in LabVIEW 2014,2015*

Parameters:
    Parameter1. (required) Searching Folder
Result:
    N/A

Batch_SyncReposToLatest : Sync all repos to latest on the active branch in specified folder

*Not available in LabVIEW 2014,2015*

Parameters:
    Parameter1. (required) Searching Folder
Result:
    N/A

Batch_ListBuildSpecProjects : list all the build spec projects with build order

*Not available in LabVIEW 2014,2015*

Notes:
Smaller **Build Index** means higher priority.
If no **Build Index** defined in name of **Build Spec Project**, the priority is lowest.
The build order depends on the name characters. Usually no needs to care about the build orders.
If you care about the build orders, or dependent relationship exists, add **Build Index** in **Build Spec Project**.

Parameters:
    Parameter1. (required) Searching Folder
Result:
    N/A

Batch_TriggerBuild : Start build in specified folder

Notes:
Smaller **Build Index** means higher priority.
If no **Build Index** defined in name of **Build Spec Project**, the priority is lowest.
The build order depends on the name characters. Usually no needs to care about the build orders.
If you care about the build orders, or dependent relationship exists, add **Build Index** in **Build Spec Project**.

Parameters:
    Parameter1. (required) Searching Folder
Result:
    N/A