Running from CLC Server Command Line Tools

The CLC Server Command Line Tools (CLT) allows algos, workflows and external applications to be invoked on a CLC Server from a command line and scripts. See the CLC Server Command Line Tools User Manual for more information.

When using the CLT to run external applications, the server exectution context is chosen unless the -G is used to select a specific grid preset. As always, running the CLT with missing or invalid parameters, will provide a help text describing how to correct the situation. Trying to invoke the copy external application with no arguments yields the following output:

clcserver -S <HOSTNAME> -U <USER> -W <PASSWORD> -A copy
Message: Trying to log on to server
Message: Login successful
The following options are available through the command line and the types are as follows:
Type                                     Valid input                           
----                                     -----------                           
<Integer>                                A decimal number in the range         
                                           [-2147483648;2147483647]            
                                         Example: 42                           
<Boolean>                                The string true or false              
                                         Example: true                         
<String>                                 Any valid string. It is recommended   
                                           to enclose all strings in '' to     
                                           avoid issues with the shell         
                                           misinterpreting spaces or double    
                                           quotes                              
                                         Example: 'text="My text"'             
<ClcFileUrl>                             A valid path to a file on the server  
                                           or in the local file system         
                                         Example: clc://serverfile/tmp/export  
<ClcObjectUrl>                           A valid path to a Clc object on the   
                                           server or locally                   
                                         Example: clc://server/pstore1/Variant1
Option                                   Description                           
------                                   -----------                           
-A <Command>                             Command currently set to 'copy'       
-C <Integer>                             Specify column width of help output.  
-D <Boolean>                             Enable debug mode (default: false)    
-G <Grid preset names>                   Specify to execute on grid.           
-H                                       Display general help.                 
-O <File>                                Output file.                          
-P <Integer>                             Server port number. (default: 7777)   
-Q <Boolean>                             Quiet mode. No progress output.       
                                           (default: false)                    
-S <String>                              Server hostname or IP-address of the  
                                           CLC Server.                         
-U <String>                              Valid username for logging on to the  
                                           CLC Server                          
-V                                       Display version.                      
-W <String>                              Clear text password or domain         
                                           specific password token.            
-d, --destination <ClcServerObjectUrl>   Destination for import from External  
                                           Application                         
--in <ClcServerObjectUrl>                Model object(s) to be exported to     
                                           FASTA (.fa/.fsa/.fasta)             
Error: Missing required options: d, in

Here we need to give both the -d and -in parameters in order for the external application being able to run.