Blogs
Dynamics AX
About Me
Contact Me
CodeCrib.AX.TFS

Activities for the AOS (Application Server Object)

SetAOSDatabase
Changes the AOS server configuration to a different database.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the AOS server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
Database Required argument containing the database name to set in the AOS server configuration.

StartAOSService
Starts the AOS service.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the AOS server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
TimeOutMinutes Optional argument specifying a maximum number of minutes the startup is allowed to take. If not specified or set to 0, the startup will be allowed to run indefinitely.

StopAOSService
Stops the AOS service.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the AOS server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
TimeOutMinutes Optional argument specifying a maximum number of minutes the startup is allowed to take. If not specified or set to 0, the startup will be allowed to run indefinitely.

Activities for the AOT (Application Object Tree)

AXBuildCompile
Runs the AXBuild process for server-side compilation, as provided with R2 CU7.
[+] Arguments
[-] Arguments
AlternateBinaryFolder Optional argument for the AXBuild executable. By default this will be set to the binary folder where the client configuration is pointing to.
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified, the configuration file will be used to find the path to the server (AOS) executable, and the client binary folder.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
TimeOutMinutes Optional argument that specifies a time limit for the AXBuild process to finish. If not specified or set to 0, the AXBuild process will be allowed to run indefinitely.
Workers Optional argument specifying the number of worker threads to use. If not specified, AXBuild will determine the number of workers to use based on the available number of cores.

Clean
Cleans client and server-side artifacts.
[+] Details
[-] Details
  • Server label files \Application\Appl\Standard\ax*.al?
  • Server XppIL files \XppIL\*
  • Server VSAssemblies \VSAssemblies\*
  • Client cache
    • \%localappdata%\ax_*.auc
    • \%localappdata%\ax*.kti
  • Client VSAssemblies \%localappdata%\Microsoft\Dynamics Ax\VSAssemblies*\* (This will delete all files in all VSAssemblies* folders)
To avoid issues with files being locked, the server must be stopped to successfully delete the files. For the same reason, the user running the activity cannot have a Dynamics AX client session running, regardless of configuration the session may be using.

[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the server binary folder. If this argument is not specified, the current default client configuration for the user running the activities will be used.

CombineXPOs
Combines individual XPO files into a single XPO file that can be easily imported.
[+] Details
[-] Details
Note that Dynamics AX comes with a combine XPO command line tool which is more optimized, but with less options and no source code.

[+] Arguments
[-] Arguments
CombinedXPOFile Required argument specifying the name (and optional path) of the new XPO file.
Folder Required argument specifying the path of where the XPOs to-be-combined are located.
IncludeNonSystemObjects Optional argument specifying if XPOs for non-system objects should be included in the combined XPO. Default value is FALSE.
IncludeSystemObjects Optional argument specifying if XPOs for system objects should be included in the combined XPO. Default value is FALSE. Objects considered system objects are the following classes: syssetupformrun.xpo, info.xpo, classfactory.xpo, application.xpo, session.xpo
Recursive Optional argument to indicate if the specified Folder should be recursively traversed to find XPOs to combine.

Compile
Runs the X++ compiler using the traditional client-side startup command "CompileAll".
[+] Arguments
[-] Arguments
ClientExecutablePath Optional argument specifying the path of the Dynamics AX client. This should include the executable itself (Ax32.exe).
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to start the client, as well as find the path of the log file that will be created during compile. If a list of layer codes and a model manifest file are specified, the configuration file is also used to find the database and server containing the model store to verify existence of the model.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
LayerCodes Optional argument containing a list of layers and layer access codes. If specified and a model manifest file is specified as well, the compile will be run in the layer and model identified by the model manifest.
ModelManifestFile Optional argument specifying the path and filename of a model manifest file. If specified and a layer code list is specified, the compile will be run in the layer and model identified by the model manifest.
TimeOutMinutes Optional argument specifying a maximum number of minutes the compile is allowed to run. If not specified or set to 0, the compile will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.
UpdateCrossReference Optional argument specifying if the compile should also update the cross reference. Note that this significantly increases the time needed to finish the compile. Default is false.

DeployReferences
This activity will copy "references" to client and server paths that are used as .NET reference folders.
[+] Details
[-] Details
Third-party libraries may be referenced in the AOT and needed to successfully compile the application. This avoids any prerequisites to be setup in advance and allows using the same AOS to build multiple different applications or different versions of the same applications.
  • Server side, references are copied into \bin\VSAssemblies
  • Client side, references are copied into any and ALL VSAssemblies* folders found in the user's \%localappdata%\Microsoft\Dynamics Ax\ folder.
Files are copied in all VSAssemblies in case of R2CU7+. To find the actual VSAssemblies folder the activity would need to read the environment's GUID from the data-database. Copying to all VSAssemblies is less overhead and one dependency less.

[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the server binary folder.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ReferencesFolder Required argument specifying a folder containing any and all files that need to be copied.

GenerateCIL
Starts the full CIL generation process using the Dynamics AX client startup command.
[+] Arguments
[-] Arguments
ClientExecutablePath Optional argument specifying the path and filename of the client executable to be used.
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the Dynamics AX client path.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
TimeOutMinutes Optional argument specifying a maximum number of minutes the CIL generation is allowed to run. If not specified or set to 0, the generation will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.

ImportLabels
Imports label files into the application using the Dynamics AX client autorun startup command.
[+] Details
[-] Details
Note that it will check the first 50 lines of the label file to find an actual label text. If no text is found, the activity considers the label file empty and won't import it.
To avoid possible issues with the AOS comparing existing label files with the label file being imported (ignoring the absence of the labels in the actual model store), make sure to run the "Clean" activity first. Additionally, the activity will call Label::flush after import to force the AOS to update the model store. This avoids the final model having no labels.

[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the Dynamics AX client path.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
LabelFilesFolder Required argument specifying a folder containing the label files to be imported.
LayerCodes Required argument containing a list of layers and layer access codes. If specified and a model manifest file is specified as well, the compile will be run in the layer and model identified by the model manifest.
ModelManifestFile Required argument specifying the path and filename of a model manifest file. The model manifest will be used to find the model, publisher and layer to import the labels into. The correct access code for the layer will be read from the LayerCodes argument.
TimeOutMinutes Optional argument specifying a maximum number of minutes the import is allowed to run. If not specified or set to 0, the import will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.

ImportVSProject
Imports VS projects into the AOT using the Dynamics AX client by calling SysTreeNodeVSProject::importProject from an autorun file.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the Dynamics AX client path.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
LayerCodes Required argument containing a list of layers and layer access codes. If specified and a model manifest file is specified as well, the compile will be run in the layer and model identified by the model manifest.
ModelManifestFile Required argument specifying the path and filename of a model manifest file. The model manifest will be used to find the model, publisher and layer to import the labels into. The correct access code for the layer will be read from the LayerCodes argument.
TimeOutMinutes Optional argument specifying a maximum number of minutes the import is allowed to run. If not specified or set to 0, the import will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.
VSProjectsFolder Required argument specifying a folder that will be recursively searched for .csproj, .dynamicsproj and .vbproj files to be imported.

ImportXPO
Imports an XPO file into the AOT by using the Dynamics AX client with an autorun file.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the Dynamics AX client path.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
LayerCodes Required argument containing a list of layers and layer access codes. If specified and a model manifest file is specified as well, the compile will be run in the layer and model identified by the model manifest.
ModelManifestFile Required argument specifying the path and filename of a model manifest file. The model manifest will be used to find the model, publisher and layer to import the labels into. The correct access code for the layer will be read from the LayerCodes argument.
TimeOutMinutes Optional argument specifying a maximum number of minutes the import is allowed to run. If not specified or set to 0, the import will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.
XPOFile Required argument specifying the XPO file to be imported.

Synchronize
Synchronizes using the Dynamics AX client with an autorun file.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to start the client.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
TimeOutMinutes Optional argument specifying a maximum number of minutes the synchronize is allowed to run. If not specified or set to 0, the synchronize will be allowed to run indefinitely. Note that the client may throw an error or a dialog upon opening, causing the client to never exit.

Activities for the Model Store

CreateModel
Creates a model in the model store using the settings provided by the model manifest file.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store to create the model in.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
DescriptionOverride Optional argument that allows the model description specified in the model manifest to be overridden by the value specified.
ModelManifestFile Required argument specifying a model manifest file containing all the properties for the model to be created.
SetNoInstallMode Optional argument putting the model store into "no install mode" after performing the model store operation. This will suppress the "Model Store Changed" dialog at client startup.
VersionOverride Optional argument that allows the model version specified in the model manifest to be overridden by the value specified.

ExportModel
Exports a model from the model store.
[+] Arguments
[-] Arguments
AxUtilBinaryFolder Optional argument specifying a folder containing the AXUtil binaries. This can be used to extract a model using an older axutil kernel version, allowing a more recent kernel version to be used for building older application versions. Note that this is an undocumented and unsupported workaround. It will not work across major (R) releases but will typically work across minor (CU) versions within a major version. Please test your specific scenarios.
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database and server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ModelFile Required argument specifying the path and filename of the new model file.
ModelManifestFile Required argument specifying the model manifest containing the model name and publisher of the model to be extracted.
StrongNameKeyFile Optional argument specifying a key file to sign (strong name) the extracted model.

ExportModelStore
Exports a full model store.
[+] Arguments
[-] Arguments
AxUtilBinaryFolder Optional argument specifying a folder containing the AXUtil binaries. This can be used to extract a model using an older axutil kernel version, allowing a more recent kernel version to be used for building older application versions. Note that this is an undocumented and unsupported workaround. It will not work across major (R) releases but will typically work across minor (CU) versions within a major version. Please test your specific scenarios.
CompressModelStore Optional argument specifying if the extracted model store should be compressed using Gzip after extraction.
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database and server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ModelStoreFile Required argument specifying the path and filename of the new model store file.

InstallModel
Installs a model into the model store.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database and server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ModelFile Required argument specifying the name and path of the model file to be imported.
SetNoInstallMode Optional argument putting the model store into "no install mode" after performing the model store operation. This will suppress the "Model Store Changed" dialog at client startup.

UninstallAllModelsFromLayer
Uninstalls all models in a specific layer.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
Layer Required argument specifying the layer to uninstall models from.
SetNoInstallMode Optional argument putting the model store into "no install mode" after performing the model store operation. This will suppress the "Model Store Changed" dialog at client startup.

UninstallAllModelsFromModelLayer
Uninstalls all models in the layer specified in a model manifest.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ModelManifestFile Required argument specifying the model manifest to extract the layer information from.
SetNoInstallMode Optional argument putting the model store into "no install mode" after performing the model store operation. This will suppress the "Model Store Changed" dialog at client startup.

UninstallModel
Uninstalls a model from the model store.
[+] Arguments
[-] Arguments
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the model store database.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
ModelManifestFile Required argument specifying the model manifest of the model to be uninstalled.
SetNoInstallMode Optional argument putting the model store into "no install mode" after performing the model store operation. This will suppress the "Model Store Changed" dialog at client startup.

Activities for the SQL Database

RestoreDb
Restores a SQL database.
[+] Arguments
[-] Arguments
BackupFilePath File and path of the backup file to be restored.
ConfigurationFile Optional argument with full path and filename to a Dynamics AX client configuration file (.axc). If specified the configuration file will be used to find the SQL server to be used.
If this argument is not specified, the current default client configuration for the user running the activities will be used.
DatabaseName Required argument specifying the name of the database to restore the backup to. Note that if this database already exists, it will be overwritten.
ServerName Optional argument specifying the SQL server the database should be restored to. If this argument is not specified, the server specified in the configuration will be used.

Blog: Dynamics AX Musings
Dynamics AX
About Me
Contact Me
LinkedIn Twitter

Valid XHTML 1.0 Strict
Terms of Use   Disclaimer   Trademarks   Contact Me     © 2016 Joris de Gruyter, CodeCrib.com