ArasDeveloperTool 4.0.1

dotnet tool install --global ArasDeveloperTool --version 4.0.1
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local ArasDeveloperTool --version 4.0.1
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=ArasDeveloperTool&version=4.0.1
nuke :add-package ArasDeveloperTool --version 4.0.1

ArasDeveloperTool

Command Line Application for handling developer tasks in Aras Innovator

####Features

  • Test Aras connection
  • Check latest changes in Aras
  • Check that everything is packaged, and package if needed.
  • Run Amls from files
  • Check Aras Database Info
  • Backup and Restore Databases

How To Use

Download ArasDevTool and extract it to a folder. Open Cmd/Powershell/Windows Terminal and navigate to the folder and .

ArasDevTool.exe
Availible commands for: ArasDevTool
  AmlRunner
  ArasInfo
  BackupDB
  CheckLatestUpdates
  Dummy
  PackageChecker
  RestoreDB
  Setup
  TestConnection

Options:
  --help    Displays help for a command

Setup an Aras connection (Setup)

ArasDevTool.exe Setup

Setup example

ArasDevTool.exe Setup -ext
#Extended setup: Configure Database for Backup/Restore

It is an option to explicity use a "Aras ConnectionString" in Aras Commands: E.g.

ArasDevTool.exe TestConnection --cs="http://localhost/Innovator;InnovatorSolutions;admin;innovator"
#Or
ArasDevTool.exe TestConnection --cs="http://localhost/Innovator;InnovatorSolutions;admin"
# To be promted for password

Aras Info

ArasDevTool.exe ArasInfo

Setup example

Check Latest Updates (CheckLatestUpdates)

ArasDevTool.exe CheckLatestUpdates 

CheckLatestUpdates example

ArasDevTool.exe CheckLatestUpdates --help
Help for: CheckLatestUpdates
  Specify connection string: E.g.
   -cs="http://localhost/innovator;InnovatorSoluions;admin;innovator"
   -cs="http://localhost/innovator;InnovatorSoluions;admin"
  Or environment: E.g.
  -env dev
  Non specified is equivalent with '-env dev'

Options: -c
  (Number of items to show: "-c 20"

Check if Items are in packages (PackageChecker)

ArasDevTool.exe PackageChecker -prefix HC_

Package Checker example

ArasDevTool.exe CheckLatestUpdates --help
Help for: PackageChecker
  Specify connection string: E.g.
   -cs="http://localhost/innovator;InnovatorSoluions;admin;innovator"
   -cs="http://localhost/innovator;InnovatorSoluions;admin"
  Or environment: E.g.
  -env dev
  Non specified is equivalent with '-env dev'

  Parameters:
    -prefix        Check Items with specific prefix. Example: "-prefix HC_"
  Options:
  --DryRun       Dont commit any changes.
  --Auto         Let it automatically select package for you.

Backup/Restore Database (Database)

If you have setup the extended setup database backup and restore is possible via

ArasDevTool.exe BackupDB 
ArasDevTool.exe RestoreDB

AMLRunner

Run AMLs from files

ArasDevTool.exe AMLRunner -mf \AMLRunner\AmlRunnerTest.mf

Example of manifest file running aml-files in the Pack1 and Pack2 directories. Where if the any aml fails in Pack2, execution will be stopped.

<?xml version="1.0" encoding="utf-8" ?>
<imports>
  <package  path="Pack1" />
  <package path="Pack2" stopOnError="TRUE" />
</imports>

Example Test1.xml in directory Pack1

<AMLS>
  <AML>
    <Item action="delete" type="Form" id="F596909BBC7746D99683DB1E759E582E">
    </Item>
  </AML>
   <AML>
    <Item action="delete" type="Field" id="53ADDFF20E5C43B7B51A5E4B818465E3">
    </Item>
  </AML>
</AMLS>

Or user the -file parameters to execute a single file of AML(s) like:

ArasDevTool.exe AMLRunner -file \AMLRunner\Pack1\Test1.xml

ApplyMethod

Run an ApplyMethod

ArasDevTool.exe ApplyMethod -name HC_Motd

Output

Executing ApplyMethod
SUCCESS:
    Message of the day
    Don't forget to unlock your items Finish your tasks Be good

RestoreMethod

'Restore' a specified Method to previous generation or a specified date" Prints out the method_code of the restored method. The restore locates a previous generation of the method and makes an edit with the content and 'comments'

ArasDevTool.exe RestoreMethod -name HC_Motd -toDate 2023-06-05T08:45
Executing RestoreMethod
SUCCESS:
    return this.getInnovator().newResult("Don't forget to unlock your items Finish your tasks Be good");

CreatedItemTypesCount

List number of instances created for each Item Type in Aras, ordered descending on highest number of instances.

Options: -month {yyyy-MM} #(default previous month) -count-display-threshold {int} #(default 5)

Example:

ArasDevTool.exe CreatedItemTypesCount

Output:

New Aras Connection: http://localhost/2023, 2023, root , 90
Executing CreatedItemTypesCount
790       Part
191       Express ECO
123       Document
85        Affected Item
85        Express ECO Affected Item
8         SavedSearch

Release Notes

See Release Notes

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
4.0.1 277 9/27/2023