Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

DynamicsNav

Contains helper function which allow to interact with Microsoft Dynamics NAV.

Nested types and modules

TypeDescription
DynamicsNavParams

A parameter type to interact with Dynamics NAV

NavisionServerType

A Dynamics NAV server type

RTCParams

The parameter type allows to interact with Dynamics NAV RTC.

SynchronizeSchemaChangesOption
ModuleDescription
Replacements

Functions and values

Function or valueDescription
analyzeTestResults(fileName)
Signature: fileName:string -> TestResults option

Analyzes the Dynamics NAV test results

analyzeXmlTestResults fileName testSuite
Signature: fileName:string -> testSuite:string -> TestResults option

Analyzes the XML-based Dynamics NAV test results from XMLPort 130021

CloseAllNavProcesses(...)
Signature: raiseExceptionIfNotFound:bool -> unit

Closes all running Dynamics NAV instances

CompileAll(connectionInfo)
Signature: connectionInfo:DynamicsNavParams -> unit

Compiles all uncompiled objects in the Dynamics NAV client.

CompileWithFilter filter connectionInfo
Signature: filter:string -> connectionInfo:DynamicsNavParams -> unit

Compiles all filtered uncompiled objects in the Dynamics NAV client.

createConnectionInfo(...)
Signature: navClientVersion:string -> serverMode:NavisionServerType -> serverName:string -> targetDatabase:string -> DynamicsNavParams

Creates the connection information to a Dynamics NAV instance.

CreateImportFile importFileName files
Signature: importFileName:string -> files:seq<string> -> unit

Creates an import file from the given .txt files.

createRTCConnectionInfo(...)
Signature: navClientVersion:string -> serverName:string -> serviceTierName:string -> port:int -> company:string -> RTCParams

Creates the connection information to a Dynamics NAV RTC instance

ensureAllNAVProcessesHaveStopped(...)
Signature: timeout:TimeSpan -> unit

Waits until all NAV processes have stopped or fails after given timeout.

Parameters

  • name - The name of the processes in question.
  • timeout - The timespan to time out after.
ExportAllObjects connectionInfo fileName
Signature: connectionInfo:DynamicsNavParams -> fileName:string -> unit

Exports all objects from the Dynamics NAV client to the given .txt or .fob file

ExportObjects(...)
Signature: connectionInfo:DynamicsNavParams -> filter:string -> fileName:string -> unit

Exports objects from the Dynamics NAV client based on the given filter to the given .txt or .fob file

FullCompile(connectionInfo)
Signature: connectionInfo:DynamicsNavParams -> unit

Compiles all objects in the Dynamics NAV client including already compiled ones.

getNAVClassicPath(navClientVersion)
Signature: navClientVersion:string -> string

Retrieves the the file name of the Dynamics NAV ClassicClient for the given version from the registry.

getNAVPath(navClientVersion)
Signature: navClientVersion:string -> string

Gets the directory of the Dynamics NAV ClassicClient for the given version from the registry.

getNAVProcesses()
Signature: unit -> seq<Process>

Returns all running NAV processes.

getNAVServicePath(navClientVersion)
Signature: navClientVersion:string -> string
ImportFile connectionInfo fileName
Signature: connectionInfo:DynamicsNavParams -> fileName:string -> unit

Imports the given .txt or .fob file into the Dynamics NAV client

ImportFiles(...)
Signature: connectionInfo:DynamicsNavParams -> importFileName:string -> files:seq<string> -> unit

Creates an import file from the given .txt files and imports it into the Dynamics NAV client. If the import fails, then every file will be tried alone.

OpenPage connectionInfo pageNo
Signature: connectionInfo:RTCParams -> pageNo:int -> bool

Opens a page with the given ID on the RTC client

RunCodeunit connectionInfo codeunitID
Signature: connectionInfo:RTCParams -> codeunitID:int -> unit

Runs a codeunit with the given ID on the RTC client

RunCodeunitWithSettings(...)
Signature: connectionInfo:RTCParams -> settingsFile:string -> codeunitID:int -> unit

Runs a codeunit with the given ID on the RTC client and the settings file (full path required)

StartNavServiceTier(...)
Signature: serverMode:NavisionServerType -> navClientVersion:string -> unit
StopNavServiceTier(...)
Signature: serverMode:NavisionServerType -> navClientVersion:'?11257 -> unit
Type parameters: '?11257