Control Architect Help Documentation
×
Menu
Index

Mongo Server Options

 
Mongo Server Options
 
 
 
1

Mongo Server Database location

1. Mongo Server Database location
Displays the folder path where the MongoDB Server database resides.
 
Users can choose to relocate this folder and its data contents by stopping the MongoDB Service, moving the folder and its contents, updating the Mongo Server Configuration file to point to the new folder path and restart the MongoDB Service.
 
2

Edit MongoDB Server Configuration file

2. Edit MongoDB Server Configuration file
Click this button to open the configuration file in Notepad for editing.  Note that any changes to this file will not be used by the MongoDB Server until its Service is restarted.
3

Mongo Server Configuration file location

3. Mongo Server Configuration file location
Displays the current file path where the MongoDB Server configuration file resides.  Users should only have to edit this file when moving the installed location of the MongoDB Server database.  Click the button next to this text box to open the configuration file in Notepad for editing.  Note that any changes to this file will not be used by the MongoDB Server until its Service is restarted.
4

Launch Compass Administration

4. Launch Compass Administration
Click this button to launch the MongoDB Compass administration tool.  This tool provides all the tools necessary to maintain your MongoDB Server and its contained data.  Users should not use this tool to delete any Collections maintained by Control Architect as this could result in ghost references.  Control Architect provides its own functions to delete both Collections and Databases while assuring that referential integrity is maintained.  This tool is installed for those users that have advanced knowledge and training working with MongoDB database deployments.
 
5

Username edit

5. Username edit
Specify a User name for the Mongo Server account.
6

Password edit

6. Password edit
Specify a Password for the Mongo Server account.  This Password is saved to your local settings using Microsoft System Security Cryptography API, which significantly reduces the chances of your account credentials being hacked.  This Password is only valid for the user that is logged into the Windows account.  Other users with valid login accounts will also have to establish their own Mongo Server authentication account.
7

Show Password option

7. Show Password option
Choose this option to show the masked Password characters.
8

Create User button

8. Create User button
Click this button to create a new user account with administration rights for the currently connected physical MongoDB database.  Clicking this button will start and stop the Mongo Server multiple times during the account creation process.  The status of the Mongo Server will be displayed along with a progress indication while the new user account is being created.  Wait until the progress indicator is no longer visible and the Mongo Server status LED is showing a "good" green status indication, which indicates successful completion.
 
 
If you manage multiple physical MongoDB databases in your file system, you are required to create authentication accounts for each database.  Click the Create User button when connecting to a new physical MongoDB database to create the new user account.
 
When using the Mongo Compass application you will also be required to create a new connection that uses the same authentication credentials you specified here.
9

Most Recently Used Database Paths list

9. Most Recently Used Database Paths list
Click this drop-down list to view a list of recently used physical MongoDB database paths that can be selected for attachment to your Local MongoDB Server.  Select a physical database path from this list and then click the Change Database button to change the attached MongoDB server database.
10

Change Database

10. Change Database
Click the drop-down button to view a list of options to execute against your Local MongoDB Server.  Clicking the button itself will execute the default option to change the Local physical database path to the selection in the drop-down list.
 
Select a menu item from the drop-down list to execute.
 
These actions only apply to your local MongoDB Server installation and has no effect on a Remote Intranet or Enterprise Atlas Server installation.
11

Use MongoServer Authentication option

11. Use MongoServer Authentication option
Choose this option to enable authentication for your local Mongo Server logon.  Enterprise Atlas Mongo Cloud connections use these specified credentials to update the embedded "<admin> and <password>" text with secure string values during authentication.  Remote Intranet Mongo Servers will also use the specified User Name and Password to authenticate logins.
12

Package MongoDB Database

12. Package MongoDB Database
Click this button to create a deployable Package file of your local or remote MongoDB physical database.  You can choose what logical Databases are packaged.  Typically you will use this function to copy/move a local Host Mongo database to another physical location or to create a periodic backup.
 
This is the recommended way to both upgrade and/or deploy a copy of a local database to another local or remote installation.
 
Users can optionally copy a physical MongoDB database by:
  • Stopping the Mongo Service
  • Copying the physical MongoDB database path to media
  • Copying the media copy to another physical database location and configuring the Server configuration file to reference this new database path
  • Delete the files located in the MongoDB database path "journal" folder to remove any transaction history
  • Restart the Mongo Service on the new server installation
 
Example MongoDump.exe and MongoRestore.exe Command Prompt usage:
 
D:\Program Files\MongoDB\Server\bin>mongodump /d EDV_GRIEG /c "EDV_GRIEG_20170519-<Graphics>" /archive:"E:\TestDump\EDV_GRIEG.EDV_GRIEG_20170519-%Graphics%.gz" /gzip
2018-05-20T13:05:36.830-0600    writing EDV_GRIEG.EDV_GRIEG_20170519-<Graphics> to archive 'E:\TestDump\EDV_GRIEG.EDV_GRIEG_20170519-%Graphics%.gz'
2018-05-20T13:05:39.822-0600    [######..................]  EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  176/647  (27.2%)
2018-05-20T13:05:42.823-0600    [#############...........]  EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  353/647  (54.6%)
2018-05-20T13:05:45.823-0600    [##################......]  EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  507/647  (78.4%)
2018-05-20T13:05:48.463-0600    [########################]  EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  647/647  (100.0%)
2018-05-20T13:05:48.544-0600    done dumping EDV_GRIEG.EDV_GRIEG_20170519-<Graphics> (647 documents)     *
    
D:\Program Files\MongoDB\Server\bin>mongorestore /archive:"E:\TestDump\EDV_GRIEG.EDV_GRIEG_20170519-%Graphics%.gz" /gzip
2018-05-20T14:43:54.040-0600    preparing collections to restore from
2018-05-20T14:43:54.064-0600    reading metadata for EDV_GRIEG.EDV_GRIEG_20170519-<Graphics> from archive 'E:\TestDump\EDV_GRIEG.EDV_GRIEG_20170519-%Graphics%.gz'
2018-05-20T14:43:54.075-0600    restoring EDV_GRIEG.EDV_GRIEG_20170519-<Graphics> from archive 'E:\TestDump\EDV_GRIEG.EDV_GRIEG_20170519-%Graphics%.gz'
2018-05-20T14:43:57.006-0600    EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  358MB
2018-05-20T14:43:59.001-0600    EDV_GRIEG.EDV_GRIEG_20170519-<Graphics>  592MB
2018-05-20T14:43:59.001-0600    no indexes to restore
2018-05-20T14:43:59.002-0600    finished restoring EDV_GRIEG.EDV_GRIEG_20170519-<Graphics> (647 documents)
2018-05-20T14:43:59.002-0600    done
    
Special characters used in Database Collection naming such as '<' and '>' must be renamed as above using the '%' character to form valid archive file names when dumping the contents of a Database:Collection.  This would typically apply to Collections that contain Process Graphic documents where the collection name is formed as DatabaseName:CollectionName_TimeStamp-<Graphics>.
13

UnPack Local MongoDB Database

13. UnPack Local MongoDB Database
Click this button to unpack a previously packaged MongoDB database to your local Host or Remote Mongo Server.  Users have the option to create a new physical Mongo database path while unpacking to a local Host Server only.
14

Use Remote Server option

14. Use Remote Server option
Choose this option to connect to a Remote intranet Mongo Server or Enterprise Atlas Cloud installation.
 
Provide the IP Address for your remote intranet Mongo Server installation or a Connection string for your Enterprise Atlas Cloud installation in the Address field.
Provide a Port address for your remote intranet Mongo Server installation only.
 
If authentication is required, then provide your UserName and Password credentials and choose the Use MongoServer Authentication option.
15

Remote Server Address drop-down

15. Remote Server Address drop-down
Provide the IP Address for your remote intranet Mongo Server installation or a Connection string for your Enterprise Atlas Cloud installation.
 
IT administrators will either provide you an IP address to connect to your Intranet server installation or provide a DNS host name that resolves to the IP address as specified in your system HOSTS file.
Connecting to an Enterprise Atlas Cloud installation will require a connection string that will be provided by your IT administrator that must be entered in this Address field. 
 
This is a typical connection string to use when connecting to a Mongo Atlas Cloud server:
mongodb+srv://<username>:<password>@testcluster0.p3yfc.mongodb.net/?retryWrites=true&w=majority
 
The connection string above begins with the format "mongodb+srv://UserName:Password" where UserName is automatically replaced by the Username text value and "<password>" is automatically replaced by the decrypted Password text value while connecting.  Do not replace the text phrases <username> and <password> or an error will occur.
 
When connecting to a MongoDB Atlas cluster the required connection string is provided to you by accessing the "Connect" button on your Atlas home page and choosing to connect from an application using the driver: "C#/.NET" version: "2.13 or later".
 
16

Port edit

16. Port edit
Provide a Port address for your remote intranet Mongo Server installation only.  The default port of 27017 can be used in most cases.
17

Test Connection

17. Test Connection
Click this button to validate your remote MongoDB Server connection.  This will test your authentication credentials, connection string for Mongo Atlas deployments, and port usage for remote intranet deployments.
18

Watchdog Period for Remote Server

18. Watchdog Period for Remote Server
Specify the Watchdog period in seconds as to how often to periodically poll the remote server to verify MongoDB Server connectivity.
19

View Log button

19. View Log button
Click this button to view the current MongoDb Server Log content.  The Log content is retrieved from the Mongo Server memory cache. 
 
If the Mongo Server is local and the Server has stopped, then the log content is retrieved by reading the physical Mongo database log file.  If an attempt to retrieve the log for a remote server fails because the remote server is not reachable, then the physical log file must be retrieved from the Mongo Server's file system.
20

Print Log button

20. Print Log button
Click this button to print the content of the Mongo Server Log view.
21

Mongo Server Log view

21. Mongo Server Log view
Click the View Log button to view the connected Mongo Server log that is cached in memory.  If the Server is not reachable due to a bad connection or a failed MongoDB Service, then this function will attempt to retrieve the physical log file from the local Mongo Server connected database.  The physical log file of a remote Mongo Server cannot be retrieved using this function.
22

Exit Options button

22. Exit Options button
Click this button to return back to the main application view.