VisualCron

VisualCron API

Summary

VisualCron offers an easy to use programming interface

VisualCron Client uses the API itself - this means that anything that can be done in the Client can be done by your program that uses the API

The API is optimized for any .NET language but can be used by any language with COM support

Our users has used the API, among other things, to create own web interfaces and to integrate their applications with VisualCron

Get started

Download the get started manual here

Download the get API reference help file here

Add a reference to VisualCronAPI.dll and VisualCron.dll

Open the test project in Visual Studio from the API folder of the VisualCron installation

For help/support - please post your questions in the APIforum

Requirements

.NET Framework 2.0

Reference to VisualCronAPI.dll and VisualCron.dll

Object model

To connect to the VisualCron Server you need to create a Client object first. The Connect method returns a Server object. The Server object has access to all main objects within VisualCron.

Methods

The objects share the same kind of methods:

Add - adds a Job or other object
Update - updates an object
Remove - Removes an object
Get - Retrieves an object based on Id
GetAll - Retrieves an array or list of all objects within the group (Jobs, Conditions etc.)

Events

These objects have events that you could add use to be notified when a Job or Task is added for example. This information is updated in real time during the connection.

COM support

The API is not only for .NET usage. You can use any other language that supports COM. Here are the steps you need to perform besides the normal Requirements. First, download REGASM tool here

VB6 example

1. Copy VisualCron.dll and VisualCronAPI.dll to folder where you have your vb.exe (if you are debugging use C:\Program Files\Microsoft Visual Studio\VB98 (where vb6.exe resides).

2. Run regasm.exe on VisualCron.dll and VisualCronAPI.dll like this: regasm VisualCron.dll /tlb:VisualCron.tlb

3. Add reference in Project‐>References to both *.tlb files

4. Write your code

5. Run or build output file

6. When moving your output file you need to include the two *.dll files

7. You can safely remove *.dll and *.tlb files from C:\Program Files\Microsoft Visual Studio\VB98 folder

8. In order to upgrade to a new version you need to perform step 1 and 2

VB6 code sample

Private Sub Form_Load()
    Dim c As New VisualCronAPI_Client
    Dim s As VisualCronAPI_Server
    Dim conn As New Connection
    conn.ConnectionType = ConnectionT_Local
    Set s = c.Connect(conn, True)
    MsgBox s.InSync
End Sub