Class DPMServiceClient

Top Previous Topic Next Topic  Print this topic

The DPMServiceClient class represents an instance of a DPM Service.

 

Constructors

 

 

       public DPMServiceClient ()

       public DPMServiceClient (string endpointConfigurationName)

       public DPMServiceClient (string endpointConfigurationName, string remoteAddress)

       public DPMServiceClient (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)

       public DPMServiceClient (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)

 

 

 

Methods

 

Name

Description

RunJob

The method starts running an Ecrion Omni System job.

GetJobStatus

Returns the status of a specified Ecrion Omni System job.

GetJobEvents

Returns an array of log events generated for a specified Ecrion Omni System job.

 

 

 

RunJob

 

The method starts running an Ecrion Omni System job.

 

 

       public JobInfo RunJob(LogIn logIn, String projectName, String fileName, Dictionary<String, String> parameters)

 

 

Parameters

 

logIn

       - the login details of the user which is trying to access the Ecrion Omni System repository. The structure is described in details here

projectName

       - string whish specifies the name of the project to be run.

fileName

       - string which specifies the name of the file which contains the workflow information (example "myworkflow.wkf")

parameters

       - object of type Dictionary which contains the parameters to be sent to the Ecrion Omni System job.

 

 

 

GetJobStatus

 

Returns the status of a specified Ecrion Omni System job. The method returns an object of type JobStatus .

 

 

       public JobStatus GetJobStatus(LogIn logIn, String jobId)

 

 

Parameters

 

logIn

       - the login details of the user which is trying to log into Ecrion Omni System. The structure is described in detail here

jobId

       - string which specifies the ID of the Ecrion Omni System job

 

 

 

GetJobEvents

 

The method returns an array of log events generated for a specified Ecrion Omni System job.

More details about the LogEvent class can be found here.

 

 

       public LogEvent[] GetJobEvents(LogIn logIn, String jobId)

 

 

Parameters

 

logIn

       - the login details of the user which is trying to log into Ecrion Omni System. The structure is described in detail here

jobId

       - string which specifies the ID of the Ecrion Omni System job