Command line interface in Adobe Campaign server provides an easy way to manage and configure a various aspect of Adobe Campaign. Either you can use these command directly in your command console, or you can use “nlserver module” activity available in Adobe Campaign workflow to execute these commands.

nlserver module activity(Command line) in Adobe Campaign

nlserver module activity in Adobe Campaign

There is two part for every nlserver module command in Adobe campaign, namely command and command options. Let’s see what various available commands in Adobe campaign and usage of these commands are.

List of nlserver commands

Usage in Console: 

Usage in nlserver module: 

Adobe Campaign CommandCommand Usage
aliasCleansingcleanse enumeration values
billingcreation of an activity report for the system
cleanupdatabase cleanup
configmodifying server configuration
copybasecopy a database
exportCommand line export
fileconvertfixed width file conversion
importCommand line import
inMailInbound mail processing
interactiondWrite server for inbound Interaction events
javascriptJavaScript execution
jobcommand line processing
mergemerge forms
midSourcingretrieve delivery information using mid-sourcing mode.
monitordisplay status of server processes and scheduled tasks, per instance.
mtamain Message Transfer Agent
packageimport/export file based entity package
pdumpdisplay status of server processes
pipelinedPipeline Services
preparedaprepare a delivery action
restartpartial restart of the system
runwfexecution of a workflow instance
shutdownfull stop of the system
smsprocessing of SMS notifications
sqlSQL script execution
startadditional starts
statMaintains MTA connection statistics
stoppartial stop of the system
submitdasubmit a delivery action
syslogdlog and trace writing server
trackingconsolidation and retrieval of tracking logs
trackinglogdtracking log writing and purge server
watchdogstart-up and monitoring module (watchdog)
webThe Web(HTTP and SOAP), application server
wfserverworkflow server

List of Arguments of command

Usage Example: 

Arguments of commandUsage of arguments
-verbose verbose mode
-? show this help message
-version Show version number
-noconsole do not display logs and traces on the console
-tracefile name of trace file to generate (without extension)
-tracefilter Filter to generate traces. E.g. wdbc,soap,!xtkquery.
-instance instance to use (‘default’ instance if none specified).
-low start with low priority
-high start with high priority (not recommended)
-queryplans Generates traces with execution plans of SQL queries.
-detach detaches the process from its parent (internal option)
-svc starts as a Windows service
-pidfile file in which the process ID is written

Import/Export packages using the command line or nlserver Module:

Create a Package Definition

  • Go to Administration >> Configuration >> Package Management >>Package Definition.
  • Create a new package definition using a proper naming convention and Meaningful Label.
  • Add the appropriate filters to add configuration/content/code to the package definition.
Package creation in Adobe Campaign

Package creation in Adobe Campaign

Once you have created the package and defined its contents, copy the Internal package name created in this step. You will need to use this name in the next step.

Export a Package in Adobe Campaign using command line

Using Adobe Campaign server command line console:

  • Start the command line console from Adobe campaign server or using SSH.
  • Use the following sample command to export the package created above

Description of parameters used above:

  • instance_name_ofyour_Adobe_Campaign_server: the name of the Adobe Campaign instance. You can find the same under con directory of your server, i.e.,  in the config-[local_au].xml.
  • target_file_namethe file/SFTP location+filename, Which will be used to write the content of the package. You need to ensure that campaign system user has required permissions to write in the directory. This option will create the file automatically. So you need not provide an existing name.
  • package_name_created_in_step_1: the name of the package defined in step 1, we have used mcb:testPackage in the example.
  • verbose argument is used to get more details about command execution in the console.

Sample execution of the above command and its console output:

Import a Package in Adobe Campaign using command line

Once the package is exported, it can be shared with other team members or It can modify or distribute as a vendor as needed. To import the package into the same or a different instance, execute the command:

Description of parameters used above:

  • instance_name_ofyour_Adobe_Campaign_server: the name of the Adobe Campaign instance. You can find the same under con directory of your server, i.e.,  in the config-[local_au].xml.
  • target_file_namethe file/SFTP location+filename, Which will be used to write the content of the package. You need to ensure that campaign system user has required permissions to write in the directory. This option will create the file automatically. So you need not provide an existing name.
  • package_name_created_in_step_1: the name of the package defined in step 1, we have used mcb:testPackage in the example.
  • verbose argument is used to get more details about command execution in the console.

Sample execution of the above command and its console output:

Using Adobe Campaign nlserver module to export/import package:

It is exactly similar to this process except you can use nlserver module activity to execute this commands in a workflow and you can even use the scheduler to run these command periodically, i.e., automated way.

Examples of commands:

What is the command to list the absent modules in Adobe Campaign?

What is the command to list all modules in Adobe Campaign?

How to update/change the database password in Adobe Campaign?

I am confident that this article will help my fellow Developers and Architects to leverage command line interface to improve their productivity. Feel free to ask any question in the comments section.

Note: Commands are best suited for the experienced developer as there is no roll back.


Amit Kumar

Results driven Adobe Certified Architect with extensive experience managing and implementing marketing Strategies to drive business growth. Enjoy optimizing the customer experience through the use of data, futuristic thinking + channel mixing – e.g., using creative combinations of traditional methods + shiny new toys like automation platforms.

Leave a Reply

Your email address will not be published. Required fields are marked *