| Table of Contents |
|---|
About
MazeMap hosts a service that allows customers to push data from their Facility Management System (FMS) for updating the maps directly. This service offers two interfaces for the customer to choose from; either they upload data using SFTP or via REST API.
...
| Info |
|---|
For FMS updates via REST API documentation for this can be found here: |
SFTP Server Details
Host: | |
Port: | 8022 |
Generating Public SSH key
As mentioned above this push service uses SSH to make sure the connection is safe.
SSH requires a username and a generated key pair, one key is public and the other private, the following section covers the creation of these keys.
a) Create Username
Create a username, please remember that this will be unique for your user. The username (black arrow below) can be anything you like, but spaces, symbols and special characters should be avoided. Also keep in mind that this username should be unique. In the following example, the username is fmsintegration.
b) Create SSH Keys
The public part of the SSH key needs to be entered to connect to the MazeMap server (red arrow above). This key has to be created on the local computer.
1) Creating SSH Keys using Windows Command Line:
Step 1: Open the command prompt on your Windows machine.
...
Step 8: Create a support request with MazeMap Support support@mazemap.com including the copied public key in the request.
2) Creating SSH Keys using Linux:
Step 1: Open a terminal on your Linux machine.
...
Step 8: Create a support request with MazeMap Support support@mazemap.com including the the copied public key in the request.
3) Creating SSH Keys using PuTTY (Windows):
...
Download and install PuTTY from the official website (https://www.putty.org/ ).
...
Open PuTTYgen, which is part of the PuTTY installation package.
...
Select the desired key type as "Ed25519".
...
Enter "fmsintegration" in the "Key comment" field to specify the username.
...
Click on the "Generate" button to create the key pair.
...
Move your mouse cursor around the blank area of the PuTTYgen window to generate random data for key generation.
...
Once the key pair is generated, you can set a passphrase for the private key or leave it blank.
...
To retrieve the public key for sharing, select the entire content of the "Public key for pasting into OpenSSH authorized_keys file" section.
...
Copy the entire content of the public key file.
...
Create a support request with MazeMap Support support@mazemap.com including the copied public key in the request.
Create a support request with MazeMap Support support@mazemap.com including the copied public key in the request.
Connecting to the MazeMap SFTP server using SFTP Client
| Info |
|---|
Here's the technical user documentation for connecting to an SFTP server using four different options: FileZilla, WinSCP, Linux command line and automated script. Please note: Connection to the SFTP server will only work once you have provided the public key generated in the above steps to MazeMap. |
1) Connecting to the SFTP Server using FileZilla:
Step 1: Download and install FileZilla from the official website (https://filezilla-project.org/ ) if you haven't already.
...
Step 12: You should now be connected to the SFTP server and can navigate, upload, and download files as needed.
...
2) Connecting to an SFTP Server using WinSCP (Windows):
Step 1: Download and install WinSCP from the official website (https://winscp.net/ ) if you haven't already.
...
Step 9: You should now be connected to the SFTP server and can navigate, upload, and download files as needed using the WinSCP interface.
3) Connecting to an SFTP Server using Linux Command Line:
Step 1: Open a terminal on your Linux machine.
...
Step 5: To exit the SFTP session, type exit and press Enter.
4) Automating SFTP Connection and File Transfer:
By following these steps, you can automate the process of updating drawings and point of interest (POI) data for MazeMap on a nightly basis, ensuring efficient and regular updates without manual intervention.
...
| Info |
|---|
Please note that the automatic implementation details may vary based on your specific environment, programming language, and scheduling tool. Adapt the steps to fit your requirements and consult the MazeMap documentation or support for any specific integration details. |
Uploading/Syncing Files
File and Folder Specifications
Building and Point of Interest files must follow a predefined format:
...
| Info |
|---|
For structure and setup of Building and Point of Interest files please check this documentation FMS - Data Specifications |
Folder Hierarchy
The files uploaded to the SFTP server must adhere to the following setup:
...
drawings and have unique names.
File Formats
The building manifest and points of interest lists are both comma separated values files (the delimiter must be comma; use double quotes to surround a column value if it contains commas). The files should be encoded with Unicode (UTF-8). Examples of both file formats can be found in the appendix.
...