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

DynamicsNavFile

Provides an abstraction over Dynamics NAV object files.

Nested types and modules

TypeDescription
NavObject

A type definition of a Dynamics NAV object.

Functions and values

Function or valueDescription
checkTagsInFile(...)
Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> fileName:string -> string * string

Checks a Dynamics NAV file for missing required and invalid tags and raises this as errors
checkTagsInObjectString(...)
Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> objectString:string -> name:string -> string * string

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors
DateRegex
Signature: Regex

A Regex which allows to retrieve modified date.
fileNameFromObject(...)
Signature: (navObject:NavObject * fileEnding:string) -> string

Returns a standardized filename based on the given NavObject.
getHighestTagVersionInFiles(...)
Signature: versionTag:string -> fileNames:seq<string> -> string

Gets the highest version number for a specified version tag in a number of Dynamics NAV objects in a set of object files
getHighestTagVersionInObjects(...)
Signature: versionTag:string -> sourceCode:string -> string

Gets the highest version number for a specified version tag in a number of Dynamics NAV objects
getInvalidTags invalidTags versionTags
Signature: invalidTags:seq<string> -> versionTags:seq<string> -> seq<string>

Get all invalid tags from a Dynamics NAV version tag list
getMissingRequiredTags(...)
Signature: requiredTags:seq<string> -> versionTags:seq<string> -> seq<string>

Get all missing required tags from a Dynamics NAV version tag list
getTagVersionInObject(...)
Signature: versionTag:string -> sourceCode:string -> string

Gets the version number for the specified version tag in a Dynamics NAV object
getTagVersionInVersionTagList(...)
Signature: versionTag:string -> tagList:string -> string

Gets the version number for the specified version tag in a Dynamics NAV version tag list
getVersionTagList(text)
Signature: text:string -> string

Returns the version tag list from Dynamics NAV object.
ModifiedRegex
Signature: Regex

A Regex which allows to retrieve the modified flag.
modifyNavisionFiles(...)
Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> versionTag:string -> newVersion:string -> removeModified:bool -> newDateTime:DateTime -> fileNames:seq<string> -> unit

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. It also changes the given tag, resets the modified flag and time stamp.
NavObjectDateFormat
Signature: string

A NAV culture-specific date format.
ObjectRegex
Signature: Regex

A Regex which allows to parse objects in a Dynamics NAV file.
objectsInObjectString(text)
Signature: text:string -> NavObject list

Splits an object string into multiple Dynamics NAV objects of type NavObject.
ObjectSplitRegex
Signature: Regex

A Regex which allows to find objects in a Dynamics NAV file.
removeModifiedFlag(text)
Signature: text:string -> string

Removes the modified flag from a Dynamics NAV object.
replaceDateTimeInString dateTime text
Signature: dateTime:DateTime -> text:string -> string

Replaces the timestamp in a Dynamics NAV object.
replaceDateTimeInStringWithFormat(...)
Signature: dateTime:DateTime -> dateFormat:string -> text:string -> string
replaceInVersionTag(...)
Signature: versionTag:string -> newVersion:string -> tagList:string -> string

Replaces a version tag in a version tag list from Dynamics NAV object
replaceVersionTag(...)
Signature: versionTag:string -> newVersion:string -> sourceCode:string -> string

Replaces a version tag in a Dynamics NAV
replaceVersionTagList text newTags
Signature: text:string -> newTags:string -> string

Replaces a version tag list from a complete Dynamics NAV object with a new version tag list
setVersionTags(...)
Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> versionTag:string -> newVersion:string -> removeModifiedFlag:bool -> newDateTime:DateTime -> fileNames:seq<string> -> unit

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. It also changes the given tag, resets the modified flag and time stamp.
splitNavisionFiles fileNames destDir
Signature: fileNames:seq<string> -> destDir:string -> unit

Splits the given files into individual object files in the specified destination directory.
splitVersionTags(tagList)
Signature: tagList:string -> string []

Splits a version tag list from Dynamics NAV object into single tags
TimeRegex
Signature: Regex

A Regex which allows to retrieve the modified time.
VersionRegex
Signature: Regex

A Regex which allows to retrieve the version list.