GeoJet Command Line Control Guide

This guide is for third party application developers to control GeoJet from their own application through command line commands. GeoJet is run as a stand-alone application.

1. Introduction.

GeoJet is developed on the Basemap/Attachment architecture. Basemap objects are common to many applications. They are maintained by GeoJet. Attachment objects are user-specific data. They are normally stored in a relational database, or a spread sheet. Attachment objects are maintained by users or third party applications. When users want to view and analyze attachment objects in a spatial context, those objects need to be mapped into GeoJet.

Let's discuss this further with an example. On one hand, we, as end users, have GeoJet that manages a street map. On the other hand, we have MLS software that manages a list of active listings. We want to know where these listings are on the map. To make this a reality, GeoJet provides command line commands interface that can be invoked by MLS software to attach and display the listing on the map.

When a collection of user data objects, which are normally stored in one relational database table, is attached to GeoJet, it is called an attachment. Each individual object, which is one record in a table or one row in a spread sheet, is called an attachment object. Attachments are further grouped into attachment categories in GeoJet.

2. Command Line Commands Supported.

GeoJet supports six command line commands: Attach, Show, Delete,GetPicture,CopyToClipboard, and Close.

• Attach. Use this command to attach user data to GeoJet.
  
  GeoJet Attach "file to attach" "file format" "attach to"
  
  "file to attach" is the user data file to be attached. The following table lists the format of this parameter.
  

• File Type	Command LineFormat	Example
  dBase	full path name	"c:\my documents\schools.dbf"
  Access	full path name\table name	"c:\my documents\listings.mdb\schools
  Excel	full path name\sheet name	"c:\my documents\listings.xlc\~schools

• 
  "file format" specifies which fields contain the information that can be used to map the objects. It is given in the format of
  "mapType:field1,field2,...,city\IDCOL:field"
  mapType could be ADDRESS, XY, or LL. Choose ADDRESS if your data contains addresses. Choose XY if your data contains (x,y) coordinates. Choose LL if your data contains (latitude,longitude).
  

• Map Type	Command Format	Example	Description
  Address	Address:field1,field2,...,city	ADDRESS:address,city	field address contains a full address.field city contains the city
  		address:house_num,st_name,st_type,st_dir,city	address is decomposed and stored in fields house_num,st_name,st_type, and st_dir.
  XY	XY:x field,y field,city	XY:x_coord,y_coord	(x,y) are stored in x_coord and y_coord. No city field
  LL	LL:lat field,long field	XY:lat,long	(latitude,longitude) are stored in lat, long respectively

• 
  IDCOL defines whether your data has an integer field that uniquely identifies an object. You should give the field name if your data has such a field. Otherwise, leave it blank (IDCOL:).
  
  "attach to" defines how the attachment is represented in GeoJet. It is in the format of "attachment category\attachment name". Attachment category specifies which category this attachment should be assigned to. Attachment name is the name of this attachment. It should be unique within the attachment category. If attachment category is not given, the attachment will be assigned to a category named "My Attachments"
  
• Show. Use this command to highlight an attachment object in GeoJet.
  
  GeoJet Show "attachment category\attachment name\attachment object id"
  Attachment category is the attachment category where the attachment to be shown is assigned to. It defaults to "My Attachments" if not given. Attachment name is the name of the attachment to be shown. Attachment object ID is the identifier of the attachment object to be highlighted in GeoJet. It is the value of the IDCOL field if IDCOL is specified when the attachment is attached, or the sequence number of the object if IDCOL is not defined.

• Delete. Use this command to delete attachments in GeoJet.
  
  GeoJet Delete "attachment category\attachment name"
  Attachment category is the attachment category where the attachment to be deleted is assigned to. It defaults to "My Attachments" if not given. Attachment name is the name of the attachment to be deleted. If attachment name is specified as "*", all attachments within the attachment category will be deleted.

• GetPicture. Use this command to save GeoJet map window as a JPEG file.
  
  GeoJet GetPicture "Jpeg full path name"
  
• CopyToClipboard. Use this command to copy GeoJet map window as Windows bitmap to Windows platform.
  
  GeoJet CopyToClipboard

• Close. Use this command to close GeoJet application.
  
  GeoJet Close

3. Rules and Recommendations.

Rule. When you attach attachments to GeoJet, always use one and only one category name. This will make sure all your attachments will be listed under your category in GeoJet Category Window.

Recommendations.

Always delete the attachment after use.

Call "GeoJet Close" when your application is closed.

Your application should have a button, such as "Map". When user clicks the button, your application calls GeoJet to attach the data that your end-user is accessing. When your end user changes to another dataset, call GeoJet to delete the attachment.

Tips. GeoJet command line parameters are case insensitive. You should use RMAP_RE to replace GeoJet in the command line if your end-user licenses GeoJet standard. You should use RMAP_Pro to replace GeoJet in the command line if your end-user licenses GeoJet Professional.