How to create an application to run on a schedule

Summary

This topic shows how to create a console application, using ArcObjects, that runs on a regular schedule. For example, to use a console application on a nightly basis to run a CPU-intensive process. In this topic, a personal geodatabase is converted to a file geodatabase using the geoprocessor.

In this topic

• About console applications
• Creating the console application
• Binding to a specific ArcGIS product
• Adding the geodatabase conversion code
• Building the project
• Scheduling the task
  • Scheduling a task in Windows XP
  • Scheduling a task in Windows 7 and Windows Vista

About console applications

Creating the console application

1. Start Visual Studio, click File, select New, and click Project. The New Project dialog box appears.
2. Under Project Types, expand the ArcGIS node, and click Extending ArcObjects.
3. Under Templates, select Console Application (Desktop), specify GPFiletoGDB as the project name, and click OK. The ArcGIS Project Wizard opens.
4. Expand the Desktop (Core) node and add references to ESRI.ArcGIS.DataManagementTools and ESRI.ArcGIS.Geoprocessor.
5. Scroll down, expand the Desktop ArcMap node, and add references to ESRI.ArcGIS.Geoprocessing and ESRI.ArcGIS.Version.
6. Click Next.
7. Check the box next to Basic to specify the license that is required to run the application, and click Finish. 
8. If it is not already open, double-click Program.cs (or Program.vb) to view the code.
9. Add Using (or Imports) statements to the top of the code editor as follows:
   • using ESRI.ArcGIS.Geoprocessor;
   • using ESRI.ArcGIS.Geoprocessing;
   • using ESRI.ArcGIS.DataManagementTools;

Binding to a specific ArcGIS product

[C#]

//Add runtime binding prior to any ArcObjects code in the static void Main() method.
ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop);

[VB.NET]

'Add runtime binding prior to any ArcObjects code in Public Sub New().
ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop)

Adding the geodatabase conversion code

[C#]

[STAThread()] static void Main(string[] args)
{
    //Add runtime binding prior to any ArcObjects code in the static void Main() method.
    ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop);
    //ESRI License Initializer generated code.
    m_AOLicenseInitializer.InitializeApplication(new esriLicenseProductCode[]
    {
        esriLicenseProductCode.esriLicenseProductCodeBasic
    }
    , new esriLicenseExtensionCode[]{}
    );
    //ESRI License Initializer generated code.
    //********************************
    // Insert code here.
    //********************************
    //Do not make any call to ArcObjects after ShutDownApplication().
    m_AOLicenseInitializer.ShutdownApplication();
}

[VB.NET]

<STAThread()> _
           Sub Main()
    'Add runtime binding prior to any ArcObjects code in the static void Main() method.
    ESRI.ArcGIS.RuntimeManager.Bind(ESRI.ArcGIS.ProductCode.Desktop)
    'ESRI License Initializer generated code.
    m_AOLicenseInitializer.InitializeApplication(New esriLicenseProductCode() {esriLicenseProductCode.esriLicenseProductCodeBasic}, _
                                                 New esriLicenseExtensionCode() {})
    'ESRI License Initializer generated code.
    '***************************
    ' Insert code here.
    '***************************
    'Do not make any call to ArcObjects after ShutDownApplication().
    m_AOLicenseInitializer.ShutdownApplication()
End Sub

[C#]

// Initialize the geoprocessor.
Geoprocessor geoprocessor=new Geoprocessor();
// Allow for the overwriting of existing file geodatabases.
geoprocessor.OverwriteOutput=true;
// Set the workspace to a folder containing personal geodatabases.
geoprocessor.SetEnvironmentValue("workspace", @"C:\GP");
// Identify personal geodatabases.
IGpEnumList workspaces=geoprocessor.ListWorkspaces("*", "Access");
string workspace=workspaces.Next();
while (workspace != "")
{
    // Set the workspace to the current personal geodatabase.
    geoprocessor.SetEnvironmentValue("workspace", workspace);

    // Create a file geodatabase with the same name as the personal geodatabase.
    string gdbname=System.IO.Path.GetFileName(workspace).Replace(".mdb", "");
    string dirname=System.IO.Path.GetDirectoryName(workspace);

    // Execute the CreateFileGDB tool.
    CreateFileGDB createFileGDBTool=new CreateFileGDB(dirname, gdbname + ".gdb");
    geoprocessor.Execute(createFileGDBTool, null);
    // Initialize the Copy tool.
    Copy copyTool=new Copy();
    // Identify feature classes and copy to the file geodatabase.
    IGpEnumList fcs=geoprocessor.ListFeatureClasses("", "", "");
    string fc=fcs.Next();
    while (fc != "")
    {
        Console.WriteLine("Copying " + fc + " to " + gdbname + ".gdb");
        copyTool.in_data=fc;
        copyTool.out_data=dirname + "\\" + gdbname + ".gdb" + "\\" + fc;
        geoprocessor.Execute(copyTool, null);
        fc=fcs.Next();
    }
    // Identify feature datasets and copy to the file geodatabase.
    IGpEnumList fds=geoprocessor.ListDatasets("", "");
    string fd=fds.Next();
    while (fd != "")
    {
        Console.WriteLine("Copying " + fd + " to " + gdbname + ".gdb");
        copyTool.in_data=fd;
        copyTool.out_data=dirname + "\\" + gdbname + ".gdb" + "\\" + fd;
        geoprocessor.Execute(copyTool, null);
        fd=fds.Next();
    }
    // Identify tables and copy to the file geodatabase.
    IGpEnumList tbls=geoprocessor.ListTables("", "");
    string tbl=tbls.Next();
    while (tbl != "")
    {
        Console.WriteLine("Copying " + tbl + " to " + gdbname + ".gdb");
        copyTool.in_data=tbl;
        copyTool.out_data=dirname + "\\" + gdbname + ".gdb" + "\\" + tbl;
        geoprocessor.Execute(copyTool, null);
        tbl=tbls.Next();
    }
    workspace=workspaces.Next();
}

[VB.NET]

' Initialize the geoprocessor.
Dim geoprocessor As ESRI.ArcGIS.Geoprocessor.Geoprocessor=New ESRI.ArcGIS.Geoprocessor.Geoprocessor()
' Allow for the overwriting of existing file geodatabases.
geoprocessor.OverwriteOutput=True
' Set the workspace to a folder containing personal geodatabases.
geoprocessor.SetEnvironmentValue("workspace", "C:\GP")
' Identify personal geodatabases.
Dim workspaces As IGpEnumList=geoprocessor.ListWorkspaces("*", "Access")
Dim workspace As String=workspaces.Next()
Do While workspace <> ""
    ' Set the workspace to the current personal geodatabase.
    geoprocessor.SetEnvironmentValue("workspace", workspace)
    ' Create a file geodatabase with the same name as the personal geodatabase.
    Dim gdbname As String=System.IO.Path.GetFileName(workspace).Replace(".mdb", "")
    Dim dirname As String=System.IO.Path.GetDirectoryName(workspace)
    ' Execute the CreateFileGDB tool.
    Dim createFileGDBTool As CreateFileGDB=New CreateFileGDB(dirname, gdbname & ".gdb")
    geoprocessor.Execute(createFileGDBTool, Nothing)
    ' Initialize the Copy tool.
    Dim copyTool As Copy=New Copy()
    ' Identify feature classes and copy to the file geodatabase.
    Dim fcs As IGpEnumList=geoprocessor.ListFeatureClasses("", "", "")
    Dim fc As String=fcs.Next()
    Do While fc <> ""
        Console.WriteLine("Copying " & fc & " to " & gdbname & ".gdb")
        copyTool.in_data=fc
        copyTool.out_data=dirname & "\" & gdbname & ".gdb" & "\" & fc
        geoprocessor.Execute(copyTool, Nothing)
        fc=fcs.Next()
    Loop
    ' Identify feature datasets and copy to the file geodatabase.
    Dim fds As IGpEnumList=geoprocessor.ListDatasets("", "")
    Dim fd As String=fds.Next()
    Do While fd <> ""
        Console.WriteLine("Copying " & fd & " to " & gdbname & ".gdb")
        copyTool.in_data=fd
        copyTool.out_data=dirname & "\" & gdbname & ".gdb" & "\" & fd
        geoprocessor.Execute(copyTool, Nothing)
        fd=fds.Next()
    Loop
    ' Identify tables and copy to the file geodatabase.
    Dim tbls As IGpEnumList=geoprocessor.ListTables("", "")
    Dim tbl As String=tbls.Next()
    Do While tbl <> ""
        Console.WriteLine("Copying " & tbl & " to " & gdbname & ".gdb")
        copyTool.in_data=tbl
        copyTool.out_data=dirname & "\" & gdbname & ".gdb" & "\" & tbl
        geoprocessor.Execute(copyTool, Nothing)
        tbl=tbls.Next()
    Loop
    workspace=workspaces.Next()
Loop

Building the project

1. Save the project.
2. Click Build, then click Build Solution, or press F6.

Scheduling the task

1. Click Start, click Control Panel ,Click System and Security, Click Administrative Tools.
2. Double-click Task Scheduler. The Scheduled Task Wizard opens.
3. Click Action and select Create Task. The Create Task dialog box appears. See the following screen shot:
   
   
   
4. On the General tab, specify a name for the task and select the security options.
5. On the Triggers tab, click New and specify the settings for daily, weekly, or monthly and the time when you want the task to run.
6. On the Actions tab, click New. The New Action dialog box appears.
7. Click Browse and navigate to the location where you saved your project. For example, C:\TEMP\GPFiletoGDB\bin\Debug.
8. Click Open to select the executable and click OK.
9. On the Settings and Conditions tabs, specify any additional parameters, then click OK on the Create Task dialog box. Your task will now run on the specified day and time.

Scheduling a task in Windows 7

1. Click Start, click All Programs, point to Accessories, point to System Tools, and click Task Scheduler. The Task Scheduler dialog box appears.
2. Click Action and select Create Task. The Create Task dialog box appears. See the following screen shot:
   
   
3. On the General tab, specify a name for the task and select the security options.
4. On the Triggers tab, click New and specify the settings for daily, weekly, or monthly and the time when you want the task to run.
5. On the Actions tab, click New. The New Action dialog box appears.
6. Click Browse and navigate to the location where you saved your project. For example, C:\TEMP\GPFiletoGDB\bin\Debug.
7. Click Open to select the executable and click OK.
8. On the Settings and Conditions tabs, specify any additional parameters, then click OK on the Create Task dialog box. Your task will now run on the specified day and time.

---

To use the code in this topic, reference the following assemblies in your Visual Studio project. In the code files, you will need using (C#) or Imports (VB .NET) directives for the corresponding namespaces (given in parenthesis below if different from the assembly name):

• ESRI.ArcGIS.System (ESRI.ArcGIS.esriSystem)
• ESRI.ArcGIS.DataManagementTools
• ESRI.ArcGIS.Geoprocessing
• ESRI.ArcGIS.Geoprocessor
• ESRI.ArcGIS.Version (ESRI.ArcGIS)

Additional Requirements

• Installation of Microsoft Visual Studio
• A personal geodatabase

Development licensing	Deployment licensing
ArcGIS for Desktop Basic	ArcGIS for Desktop Basic
ArcGIS for Desktop Standard	ArcGIS for Desktop Standard
ArcGIS for Desktop Advanced	ArcGIS for Desktop Advanced