Server Component Class Documentation

CRFramework.VISControls.VISServerControl

Constructors

New()

New(Server As System.String, UserName As System.String, Password As System.String)

New(Server As System.String, Port As System.String, UserName As System.String, Password As System.String)

Properties

Name	Type	Description
UserName	String	Valid BlueSky Integration Studio User name
Password	String	Password that coincides with the user name
ServerName	String	DNS or TCP/IP address to the BlueSky Integration Studio Server
Port	String	Port number the server is listening on (defaults to 7570)
IsConnected	Boolean	Boolean value indicating whether the connection is currently valid
ServerTimeout	Integer	Server time out in seconds

Methods

Name	Returns	Description
Connect	Boolean	Attempts to connect to the BlueSky Integration Studio Server
Close		Closes the active connection
RunJob	Boolean	Run the specified job
StopJob	Boolean	Stop the specified job
ResetJob	Boolean	Reset the specified job
ForceResetJob	Boolean	Force reset the specified job
GetJobStatus	JobStatus	Returns the status of the specified job
GetJobStatistics	JobStatisticsCollection	Returns a collection of Statistics for the specified job
GetJobLogEvents	LogEventCollection	Returns a collection of LogEvents for the specified job
GetJobs	JobStatusCollection	Returns a collection of JobStatus for all jobs in the specifed Application Domain.
GetAppDomains	ApplicationDomainCollection	Returns a collection of ApplicationDomain available on the server
GetParameters	ParameterCollection	Returns a collection of Parameter for the specified job
SetParameterValue	Boolean	Set the value of a parameter for the specified job
ClearParameters	Boolean	Clear all parameters for the specified job. Caution: Clears the parameter file of all parameters associated with the job.

Associated Classes

Name	Description
JobStatus	Status information relative to a specific job such as its current running status
JobStatusCollection	Collection to hold a list of JobStatus objects
JobStatistics	Statistics information relative to a specific job such as RecordCount and RecordsPerSecond
JobStatisticsCollection	Collection to hold a list of JobStatistics objects
LogEvent	Log information relative to a specific job. Each LogEvent object contains 1 log entry
LogEventCollection	Collection to hold a list of LogEvent objects
ApplicationDomain	The ApplicationDomain object gives information about each Application Domain
ApplicationDomainCollection	Collection to hold a list of ApplicationDomain objects
Parameter	Parameter information relative to each individual parameter for a specific job, such as the parameter name and its associated value
ParameterCollection	Collection to hold a list of all Parameters for a given job.