spMFVaultConnectionTest

Returns
  • 1 = Success

  • -1 = Error

Parameters
@IsSilent smallint (optional)
  • Default = 0: display the result

  • Set to 1 for silent mode (useful when called from another procedure)

@MessageOut nvarchar(250) (output)
  • Result message for the test

Purpose

Perform a basic end-to-end test on the vault connection.

Additional Info

The procedure performs several checks:

  1. Validate login credentials

  2. Validate the M-Files version for the assemblies

  3. Validate license

Examples

DECLARE @MessageOut NVARCHAR(250);
EXEC dbo.spMFVaultConnectionTest
   @IsSilent   = 0,
   @MessageOut = @MessageOut OUTPUT;

EXEC dbo.spMFVaultConnectionTest;

Changelog

Date

Author

Description

2022-11-25

LC

Add logging and improve messaging

2021-12-20

LC

Add guid to result set

2020-03-29

LC

Add documentation

2020-02-08

LC

Fix bug for check license validation

2016-08-15

DEV1

Create procedure