Remote control via the command line
The remote control of EasyMap via command line reference offers the possibility to control elementary functions from other applications with simple programming, e.g. opening, updating and printing maps. The remote control can also be done via a batch script.
With appropriate programming, you can cause Windows to start EasyMap, open an EasyMap map folder and display it on the screen. If a map folder contains linked data, EasyMap automatically updates the maps. If the maps contain analyses with equidistant or evenly distributed value classes, the value classes are also updated automatically.
EasyMap is started via the command line with special parameters which are converted into actions by EasyMap. This procedure can be particularly interesting for regularly recurring, automated tasks.
The following things are possible with this approach:
- Open, save and close map folders
- Printing and graphic export of components of the map folder
- Modify the map folder within narrow limits, e.g. change visibility of objects.
If you need further access to the map folder, please use the COM-Object modell.
Below are some examples of command line referencing (please note that these remote control commands are intended for experienced programmers).
command line reference
With the help of command line parameters it is possible to process a large number of map folders. The control can be done e.g. by a batch script.
Structure of the commands
Each command always consists of the name of the command and a list of parameters. The parameter list is always enclosed in quotation marks and the parameters are separated by semicolons. Optional parameters (indicated by square brackets in the command reference) can be omitted. Any number of commands can be lined up.
Example:
Print a complete map folder:
Command line: EasyMap.exe open "filename.empx" print "" close ""
Help command
Command: /?
Output the command line help:
Command line: EasyMap.exe /?
Opening a map folder
Command: Open "File name;[Show];[Document name]"
Parameters:
| Filename | Path to map folder (filename.empx) |
| show |
(optional) 1=Program window is visible (default) 0=Program window is not visible |
| document name | (optional) The document name is used in the following commands to identify the map folder. If this parameter is empty, the last opened map folder is used. |
Example:
Open the map folder invisibly and set the document name to "Doc1":
Command line: EasyMap.exe open "Dateiname.empx;0;Doc1"
Print
Outputs the complete map folder, or parts of it, to the current default printer:
Command: Print "[Sheet|Print Range Name|Report Name];[Document Name]"
Parameters:
| Sheet/Print area name/Report name | (optional) Name of the sheet or print area (or report) to be printed. If this parameter is empty, all sheets are printed. |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
"Print "Print area 2" in the "Doc1" map folder:
Command line: EasyMap.exe print "Print area 2;Doc1"
export
Exports a sheet or a print area as a graphic. The graphic format is automatically determined by the file extension:
Command: Export "File name; Sheet|Print area name| Report name;[Image height];[Document name]"
Parameters:
| Filename | File name of the graphic. The following graphic formats are supported: PNG, JPG, BMP, TIF, EMF, PDF |
| Sheet/Print area name/ Report name | Name of the sheet, print area, or report to be exported. |
| image height | (optional) Height of the image in pixels. The width of the image is determined automatically. If this parameter is empty, the image height is determined automatically (72 DPI). |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
"Export "Sheet 1" with an image height of 2048 pixels as PNG:
Command line: EasyMap.exe export "Sheet 1;2048"
Export Office Formats
Exports a sheet, the entire map folder or a report as an Office document. The format is determined automatically by the file extension. The other export settings depend on the settings last used in this map folder.
Command: exportdocument "File name; [Sheet|Report name]; [Show]; [Document name]"
Parameters:
| Filename | File name of the Office document. The following formats are supported: DOC, PPT |
| Sheet/Report name | Name of the sheet or report that is to be exported. If this parameter is empty, the entire map folder is exported. |
| show | (optional) "Show" causes the subsequent opening of the export in the corresponding application. |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
"Export "Report 1" to a PowerPoint presentation and then show it:
Command line: EasyMap.exe export document "C:\Rep1.ppt;Report 1;Show"
Export the entire map folder to Word and then show it:
command line: EasyMap.exe exportdocument "C:\Karte.doc;;Show"
Replace freehand text
Replaces the text in the specified freehand text:
Command: SetText "Freehandtext;Text;[Document name]"
Parameters:
| freehand text | Name of the freehand text element. Please make sure that the name of the element is unique. |
| Text box | Any text. "\n" creates a line break. |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
Set text to freehand text "Heading 1":
Command line: EasyMap.exe settext "Headline 1;Example 1:"
Show/hide objects
Allows you to show or hide objects:
Command: SetVisible "Object name;[true|false];[Document name]"
Parameters:
| object name | Name of the object. Please make sure that the name of the object is unique. |
| [true|false] |
true=show object false=hide object |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
"Color legend 1" invisible:
Command line: EasyMap.exe setvisible "Color legend 1;false"
Classification from an XML file
Loads a classification from an XML file that was previously saved in the analysis settings dialog. Please make sure that the analysis properties are set to Custom so that the analysis is performed correctly.
Command: SetClassification "Analysis Name;Classification; Configuration File;[DocumentName] "
Parameters:
| Analysis Name | Name of the analysis (e.g. area coloring 1). Please make sure that the name of the element is unique. |
| Classification | Number of the classification. Corresponds to the order of the tabs in the settings dialog of the analysis. |
| configuration file | Path to a saved XML file. |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
Command line: EasyMap.exe setclassification "Area coloring 1; 0;classification.xml"
Saving a map folder
Saves a map folder under the specified file name:
Command: Save "File name;[Document name]"
Parameters:
| Filename | New file name of the map folder (file name.empx) |
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
Save the current map folder under a new file name:
Command line: EasyMap.exe save "file_new.empx"
Closing a map folder
... all changes are discarded - if no further map folders are opened, the program is closed.
Command: Close "[Document name]"
Parameters:
| document name | (optional) Name of the map folder. If this parameter is empty, the last opened map folder is used. |
You can only use the Document name parameter if you have opened the map folder using the Open command from the remote control via command line and have assigned a document name for the map folder there.
Example:
Close current map folder:
Command line: EasyMap.exe close ""
Releasing a map folder
Enables you to release a map folder for the EasyMap Xplorer.
Command: Publish "[ID of card folder]" /instance:update /publishserver:"<Server name>" /publishusername:"<Username>" /publishpassword:"<Password>"
Parameters:
| ID of the map folder | ID of the map folder that is to be replaced. This ID can be determined using the address when the map is viewed in the browser. |
| /instance:update | Specifies that an existing map folder is to be replaced. |
| /publish server:"<Server name>" | Specifies the server on which the map folder is to be uploaded. |
| /publishusername:"<Username>" | Defines the user name under whose authorization the release is to take place. |
| /publishpassword:"<Passwort>" | Specifies the password associated with the user. |
For automated sharing, you can combine this command with the Open and Close commands.
Example:
A map folder is available on the portal at the address
https://easymap-xplorer.de/Catalog/4acbf219-ae91-4f7e-a122-2e5136323af6
It is to be replaced, whereby this action is to be performed under the login of a user with the e-mail benutzer@email.de and the password 123.
Kommandozeile: Easymap.exe /batch /instance:update /publishserver: "https://easymap-xplorer.de" /publishusername: "benutzer@email.de" /publishpassword: "123" öffnen "c:\easymap\Interessenten.empx;0" veröffentlichen "4acbf219-ae91-4f7e-a122-2e5136323af6" schließen """.
Combination of several command lines
Open map folder, set freehand text, export, close map folder:
Command line: EasyMap.exe open "mapfile.empx;0" settext "heading 1;example 2:" export "mapfile.empx;sheet 1;1024" close ""
Structure of a batch file
Export sheet 1 from all map folders in the current directory (batch file):
FOR %%f IN (*.empx) DO start /Warte EasyMap.exe open "%%f;0" export "%%%f.png;Blatt 1" close ""
