BOARD Procedure Launcher

Document created by mik1893 Employee on Jul 13, 2017Last modified by ggallo on Jul 13, 2017
Version 3Show Document
  • View in full screen mode

The BOARD Procedure Launcher allows a BOARD procedure to be executed from a Windows command line (CMD).

The tool comes with the server installation of BOARD on all versions starting from BOARD 8 and is located in: C:\Program Files\Board\Board Server\Tools

 

This utility is not only useful for launching a procedure without opening the BOARD client but also to monitor the execution in a better way. The procedure is executed in synchronous way and you can have information about the status just looking at the job status (running or terminated).

Only database procedure can be called with this utility and must contain only "server-side" actions.

 

Command:  

BoardProcedureLauncher.exe

 

Options: 

/host "serverName:9700"

         You can specify an host/port match.
/ssl "on" | "off"
         Uses an encrypted SSL connection. Default: off
 
/winEncryption "on" | "off"
         Uses Windows Encryption. Default: on
 
/sso "on" | "off"
         Uses Single Sign-On to connect, i.e. the current Windows user. Default: off
 
/username "myUsername"
         Uses this username to connect, in this case you must also specify a password
 
/password "myPassword"
         Uses this password to connect
 
/Procedure "myProcedure"
         Name of the procedure to run (only DataBase procedures are supported!)
 
/DataBase "myDataBase"
         Name of the DataBase where the procedure is saved
 

 

Sample: 

BoardProcedureLauncher.exe  /host "serverName:9700"  /username "myUsername"  /password "myPassword"  /Procedure "myProcedure"   /DataBase "myDataBase"

Sample with SSL :

BoardProcedureLauncher.exe  /host "serverName:9700" /ssl "on" /LastDnsName "<YourRegisteredDomain>"  /username "myUsername"  /password "myPassword"  /Procedure "myProcedure"   /DataBase "myDataBase"
 
Return codes:
 

Job completed successfully = 0

Job failed =  see below codes...

 

        // Security:

        EmptyUsername = 1001,

        UnknownUsername = 1002,

        WrongPassword = 1003,

        UnknownWinUser = 1004,

        UsersFileNotReadable = 1005,

        NoProfile = 1006,

        UnknownIdentity = 1007,

        UserIsNull = 1008,

        WrongUserType = 1009,

        BlankPassword = 1010,

        GroupNotFound = 1011,

        UserLocked = 1012,

        CannotAuthenticate = 1013,

        UndefinedError = 1014,

        ProcedureOwnerNotFound = 1015,

        ProfilesFileNotReadable = 1016,

        OldPasswordIncorrect = 1017,

        NewPasswordInvalid = 1018,

        MustBeAdmin = 1019,

        PasswordTooShort = 1020,

        UsersAlreadyConfigured = 1021,

        NotAPasswordUser = 1022,

        UserNotRegistered = 1023,

        PermissionDenied = 1024,

        CubeChangesNotAllowed = 1025,

        CannotSaveUsers = 1026,

        CannotSaveProfiles = 1027,

        CannotWriteDbProfilesBinFile = 1028,

        CannotConvertDbProfilesBinToXml = 1029,

        CannotReadDbProfilesBinFile = 1030,

        ClientNotCompatible = 1031,

 

        // License:

        LicenseNotAvailable = 2001,

        LicenseIsStandalone = 2002,

        LicenseCurrentlyNotAvailable = 2003,

        LicenseTypeUnknown = 2004,

        KeyFileNotFound = 2005,

        UserAlreadyLogged = 2006,

        OfficeLicenseNotFound = 2007,

        LicenseIsMaster = 2008,

        UserRegisteredAsVisitor = 2009,

        WebServicesNotAllowed = 2010,

 

        // Layout/Data Entry:

        TrafficLightRed = 3001,

        ExceedsRowsLimitation = 3002,

        SplitSplatOnZeroNotAllowed = 3003,

        ValuesChangedInMeanwhile = 3004,

        NoEntitiesByRow = 3005,

        EntityByRowEmpty = 3006,

        NoRowsOrColumns = 3007,

        PivotNoEntitiesByRow = 3008,

        ConnectionIsMissing = 3009,

        MoreThan32Dimensions = 3010,

        UnableToRunAnalysis = 3011,

        CannotApplyFunctionToTarget = 3012,

 

        // Database:

        DatabaseAccessDenied = 4001,

        UnableToOpenDatabase = 4002,

        DatabaseDoesNotExist = 4003,

        UnableToBrowseTable = 4004,

        ConnectionToRdbFailed = 4005,

        CodeAlreadyExists = 4006,

        DatabaseCurrentlyLocked = 4007,

        DatabaseCurrentlyUnderModification = 4008,

        DatabaseSecurityCorrupted = 4009,

        CannotUpdateRelationships = 4010,

        CannotWriteConnections = 4011,

        QueryDataError = 4012,

        QueryDataDownError = 4013,

        NoMoreQueriesAllowed = 4014,

 

        // Capsules/Procedures:

        ProfileIsNull = 5001,

        CannotAccessMainFolder = 5002,

        CannotAccessResource = 5003,

        ProcedureNotFound = 5004,

        NoRightsToSaveSecureCritical = 5005,

        NoValidLicense = 5006,

        PathIsNull = 5007,

        InvalidPath = 5008,

        GenericError = 5009,

        ResourceIsLocked = 5010,

        InvalidCapsuleExtension = 5011,

        CapsuleAlreadyExists = 5012,

        CapsuleDoesNotExist = 5013,

        DirectoryDoesNotExist = 5014,

        DirectoryAlreadyExist = 5015,

        InvalidCapsuleFile = 5016,

        ConnectionStringIsEmpty = 5017,

        DatabaseIsReadOnly = 5018,

        UnknownProtocolType = 5019,

        UnableToReadDatareadBinFile = 5020,

 

        // KeyFileController:

        CPU64BitNotAllowed = 6001,

        InvalidOrAbsentKey = 6002,

        WrongValidationFile = 6003,

        ContractCodeExpired = 6004,

        BoardUninstalled = 6005,

        TemporaryLicenseExpired = 6006,

 

        // Misc:

        FullMethodNameIsEmpty = 9001,

        DrillThroghNotYetImplemented = 9002,

        UnableToConvertXMLToBin = 9003,

        UnableToReadConnectionsBinFile = 9004,

        PathNotFound = 9005,

        AutomatedBypassingError = 9006,

        OutOfMemory = 9007,

        DbCorrupted = 9008,

        DataReaderUndefinedError = 9009,

        CannotReadFile = 9010,

        CannotSetMainSettings = 9011,

        CannotInitDbList = 9012,

        CrawlerCurrentlyScanning = 9013,

        CrawlerScanRequired = 9014,

        DatabaseNotSelected = 9015,

        CrawlerScanFailed = 9016

5 people found this helpful

Attachments

    Outcomes