Skip to main content
OutSystems

Solution Pack Tool (OSPTool) Command Line Reference

The Solution Pack Tool (OSPTool) allows you to publish OutSystems solutions on an environment.

The default path of the Solution Pack Tool command line is the following:

.NET: C:\Program Files\Common Files\OutSystems\<version>\OSPTool.exe
Java: /opt/outsystems/platform/osptool.sh

The Solution Pack Tool command line returns non-zero values when an error occurs.

Note: The Windows executable OSPTool.exe is non-blocking, which means that it will return immediately after being invoked, without waiting for the requested operation to complete. For example, if you're automating its execution by using a batch file, you should prefix the command with START /WAIT, in order to wait for the process to terminate before continuing the batch file execution.

.NET

Syntax

OSPTool.exe { /Publish {osp_file|oap_file} hostname username password
            | /PublishFactory hostname username password }

Parameters

/Publish {osp_file|oap_filehostname username password
Publishes the specified OutSystems Solution Pack (.osp) or OutSystems Application Pack (.oap) file.
/PublishFactory hostname username password
Publishes all non-system components in the Environment specified by hostname. This helps to apply patch updates.

Example

Publish an OutSystems Solution Pack (.osp) file:

OSPTool.exe /Publish file.osp hostname username password

Publish an entire factory:

OSPTool.exe /PublishFactory hostname username password

Java

Syntax

osptool.sh { --publish {osp_file|oap_file} hostname username password
           | --publish-factory hostname username password }

Parameters

--publish {osp_file|oap_filehostname username password
Publishes the specified OutSystems Solution Pack (.osp) or OutSystems Application Pack (.oap) file.
--publish-factory hostname username password
Publishes all non-system components in the specified hostname. This helps to apply patch updates.

Example

Publish an OutSystems Solution Pack (.osp) file:

osptool.sh --publish file.osp hostname username password

Publish an entire factory:

osptool.sh --publish-factory hostname username password
  • Was this article helpful?