Use the Import Controller from the Command Line
- Last UpdatedDec 12, 2025
- 3 minute read
The AIM Import Controller is used to configure the Import Server and to load data and documents into AIM. The Import Controller Console is a command-line version of the Import Controller. You can control the Import Server using scripts.
Import Controller Console Commands
The following sections provide descriptions for the Import Controller Console commands and the corresponding acceptable parameters.
To get help on the available parameters for a command, type [commandName] /Help. For example, encrypt password /Help.
Encrypt Password
This command encrypts the given password.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
encrypt password -Password:PasswordString |
Password |
Required |
Engine Commands
The following are the various engine commands.
Show Engine
This command displays Import Engine configurations.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
show engine -EngineHost:localhost -EnginePort:8228 |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
Set Engine
This command sets the Import Package properties for an engine.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
set engine -EngineHost:localhost -EnginePort:8228 |
AllowChangeParent |
Optional |
|
AllowCombiningObjects |
Optional |
|
|
AllowUnknown |
Optional |
|
|
CalloutPath |
Optional |
|
|
CheckClassification |
Optional |
|
|
CreateContentFolders |
Optional |
|
|
DiscardPrevious |
Optional |
|
|
EngineHost |
Required (default: localhost) |
|
|
EnginePort |
Required (default: 8228) |
|
|
ErrorLevel |
Optional |
|
|
ForceChangeParent |
Optional |
|
|
MaxErrors |
Optional |
|
|
TemporaryArea |
Optional |
Database Commands
The following are the various database commands.
List Database
This command lists all databases associated with the engine.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
list database -EngineHost:localhost -EnginePort:8228 |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
Add Database
This command adds a database to a given engine host.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
add database -Id:DatabaseId -Datasource:YourServerName -Integrated:False -Database:YourDatabaseName -Username:DatabaseUserName -Password:DatabasePassword -PasswordEncrypted:False -EnginePort:8228 -BootStrapFolder:"<ProviderConfig type=\"S3\"><Region value=\"Your-Region-Name\" desc=\"Region\" type=\"string\" /><Bucket value=\"Your-Bucket-Name\" desc=\"Bucket\" type=\"string\" /><Path value=\"Folder-Path\" desc=\"Path\" type=\"string\" /></ProviderConfig>" |
BootStrapFolder |
Optional |
|
Database |
Optional |
|
|
Datasource |
Required |
|
|
EngineHost |
Required (default: localhost) |
|
|
EnginePort |
Required (default: 8228) |
|
|
Force |
Required (default: False) |
|
|
Id |
Required |
|
|
Integrated |
Required (default: False) |
|
|
Name |
Optional |
|
|
Password |
Optional |
|
|
PaaswordEncrypted |
Optional (default: True) |
|
|
ReplicationEnabled |
Optional (default: False) |
|
|
ReplicationFolder |
Optional |
|
|
Schema |
Optional |
|
|
Username |
Optional |
Delete Database
This command deletes a database from the given engine host.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
delete database -Id:databaseName |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
|
|
Id |
Required |
Package Commands
The following are the various package commands.
Add Package
This command adds a package to a database.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
add package -Id:databaseName -Package:packageName -RootObjectId:rootPackageId -RootObjectClass:rootClassName -StagingArea:"<ProviderConfig type=\"S3\"><Region value=\"Your-Region-Name\" desc=\"Region\" type=\"string\" /><Bucket value=\"Your-Bucket-Name\" desc=\"Bucket\" type=\"string\" /><Path value=\"Folder-Path\" desc=\"Path\" type=\"string\" /></ProviderConfig>" |
AllowChangeParent |
Optional |
|
AllowCombiningObjects |
Optional |
|
|
AllowUnknown |
Optional |
|
|
CalloutPath |
Optional |
|
|
CheckClassification |
Optional |
|
|
CreateContentFolders |
Optional |
|
|
DiscardPrevious |
Optional |
|
|
EngineHost |
Required (default: localhost) |
|
|
EnginePort |
Required (default: 8228) |
|
|
ErrorLevel |
Optional |
|
|
Force |
Required (default: False) |
|
|
ForceChangeParent |
Optional |
|
|
Id |
Required |
|
|
MaxErrors |
Optional |
|
|
Package |
Required |
|
|
PopMeshDropFolder |
Optional |
|
|
RootObjectClass |
Required |
|
|
RootObjectID |
Required |
|
|
RootObjectName |
Optional |
|
|
StagingArea |
Optional |
|
|
TemporaryArea |
Optional |
List Package
This command lists all the packages for a database.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
list package -Id:databaseName |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
|
|
Id |
Required |
Show Package
This command displays the package configuration details.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
show package -Id:databaseName -Package:packageName |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
|
|
Id |
Required |
|
|
Package |
Required |
Delete Package
This command deletes a package from a database.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
delete package -Id: databaseName -Package:packageName |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
|
|
Id |
Required |
|
|
Package |
Required |
Set Package
This command sets or updates the properties of a package.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
set package -Id: databaseName -Package:packageName |
AllowChangeParent |
Optional |
|
AllowCombiningObjects |
Optional |
|
|
AllowUnknown |
Optional |
|
|
CalloutPath |
Optional |
|
|
CheckClassification |
Optional |
|
|
CreateContentFolders |
Optional |
|
|
DiscardPrevious |
Optional |
|
|
EngineHost |
Required (default: localhost) |
|
|
EnginePort |
Required (default: 8228) |
|
|
ErrorLevel |
Optional |
|
|
ForceChangeParent |
Optional |
|
|
Id |
Required |
|
|
MaxErrors |
Optional |
|
|
Package |
Required |
|
|
PopMeshDropFolder |
Optional |
|
|
StagingArea |
Optional |
|
|
TemporaryArea |
Optional |
Process Package
This command processes the packages for a given database.
|
Command |
Parameter |
Parameter Type |
|---|---|---|
|
process package -Id: databaseName -Package:packageName |
EngineHost |
Required (default: localhost) |
|
EnginePort |
Required (default: 8228) |
|
|
Force |
Required (default: False) |
|
|
Id |
Required |
|
|
Object |
Required (default: "") (that is, it takes empty string) |
|
|
Package |
Required |
|
|
ShowLog |
Required (default: False) |
|
|
Wait |
Required (default: False) |