Server Command Line Utility¶
Command Line Utility¶
Name¶
Centerprisecl.exe
Purpose¶
Gives ability to submit , terminate, and monitor jobs from a command line
Usage¶
Syntax¶
Centerprisecl [/H <ServerUri>] [/R <filePath> [[/A] [/V <check|trace>] [/P <paramn1=value1>] [/U <interval>]]] | [/S <JobId>] | [/T <JobId>] | [/I <JobId>]
Switches¶
| Switch | Name | Format | Purpose |
|---|---|---|---|
| ? | Help | N/A | Outputs help. Will display in a brief format giving syntax usage and switch meanings |
| H | Host | Hostname:PortNumber | The hostname should be the machine or IP address of the machine that has the Astera Integration Server up and running. This is where you are submitting the job to. |
| R | Run | Pathttodataflow.df or pathtoworkflow.wf | Use this switch to submit a flow to the server to be run. The parameter after the switch should be the full filepath of the flow. Example: “c:\path\filename.df” . Quotes are not necessary. |
| I | Info | JobId | Displays more detailed information about the job including any source files or destination files used, duration, and anything else outputted during the job run. |
| S | Status | JobId | Displays the current status of the job. Also displays the current time of the request for status in UTC format.. |
| T | Terminate | JobId | Terminates a running job |
| A | Asynchronous | N/A | Applies to run only. This will run the job asynchronously from the centerprisecl point of view. If this is used, it will only return the jobid and exit. |
| V | Verbosity | Check or Trace | Applies to run only. If check is used, it will only show the time a status request was made and the status of the job at that time. If Trace is used, it will display the entire job trace up to that point. |
| U | Update Interval | Intervalnumber | Applies to run only. Time, in milliseconds, that the centerprisecl will query for the status or trace. The default is 2000 (or 2 seconds). |
| P | General Parameter | DataflowObject.Property1=Value1 | Applies to run only. This is for setting individual item data values in a dataflow. For example, you can set the filepath of delimited file source using this switch. |
Example¶
Centerprisecl /r “c:\test data\dataflow1.df” /h myservername:9258
/p “DelimitedSource1.SourceFile=c:\test data\testforparam.csv;DelimitedDest1.DestinationFile=c:\temp\outwithparam.csv” /v trace /u 3000
In the above example, we are submitting a dataflow (c:\test data\dataflow1) to be run on the server myservername that is listening on port 9258. We are also changing the filepath found inside of an action called DelimtiedSource1 as well as DelimitedDestination1. These are two different swaps separated by a ‘;’ character. Finally, we are setting the verbosity of the monitoring by using the /v switch with the “trace” option and adding to the trace every 3 seconds.
Running a Job¶
Running a job requires use of the /R switch. When this is done, the path of the file is read, parsed, and the contents sent to the server. Keep in mind that the server may be on a completely separate machine and file paths need to be accessible from that server. If the /A switch is used, only the ID of the job that was created is returned and displayed on screen. If the /A is not used, centeprisecl will not return until the job has finished. If the check verbosity flag is used, a status will periodically display along with a timestamp. This timestamp is not when the job started. It is the time of the status request. If the “trace” verbosity switch is used, centerprisecl will periodically poll the server and get the latest trace infoformation.
Monitoring a Job¶
Monitoring a job is usually done when the /A switch is used to submit it. So, for example, you can submit a job, get the job ID back and later use the /I or /S flags to check on it.
General Flow Parameters¶
Centerprisecl has the ability to change any parameter available in a flow using the /P switch. The /P is given once followed by a semicolon separated list of name value pairs. The format is:
ObjectName.parameter=value
Where ObjectName is the name of the action you wish to modify. For example, if you have a dataflow that has an delimited file reader named ExtractCustomerABCFile, ObjectName would be “ExtracCustomerABCFile”. The parameter name is a special name that each action exposes. If I wish to change the filepath, that name would be “SourceFile”. The list of parameters changes with each action. To see the list of parameters, you can click on the “replace parameters” button while your dataflow is open in the designer. This will show a list of objects in your flow. When you click on that object, the screen will display a list of parameters on the right. These are the parameters you can set from the centerprisecl.
Deploying Centerprisecl¶
The only thing needed to run centerprisecl.exe is the executable itself and the dependent astera.core.dll assembly. All other assemblies found in the server’s bin directory (read program files) are irrelevant. This means that centerprisecl.exe is a lightweight program that can be anywhere .NET is installed.