Deploying to a DOME Server

Deploying a model

When working in build mode,  DOME models reside in one's local file space—not on a DOME server—and thus they are not available for use by others. The model needs to be deployed to a server to be used by others.

The tutorial is written assuming that you will be logging into a server running locally on the same machine as your client application. Here you will move the model and interface files that you saved to a server where they can be executed by remote users.

 You will learn how to:

  • Check model files into a server using a deploy mode wizard;
  • Select which interfaces will be available to users;
  • Assign permissions.

Before starting this process make sure that the DOME Server is running.

Start a local DOME Server

If you do not have a remote DOME server available to log in to, you can set up a local server for testing purposes.

Open a new terminal window (if using a command line interface) or explorer window, and navigate to the dome/bin directory where DomeClient.sh and DomeClient.bat were located. Alternatively, create a directory under the dome folder (e.g. myTest) and navigate to that folder, but it must have the same relative paths to client and server.

Copy DOMEdB.script and DOMEdB.properties from the server folder to your current directory. Important: copy the files from the server folder, NOT the bin folder!

Copy the AuxFiles folder from the server folder. This folder has the "deployed" models. The distribution includes some demonstration models.

If you tried to start the server before copying DOMEdB files and creating AuxFiles, the Dome server may have created incomplete files. Remove and copy them from the server folder.

 

Windows: launch DomeServer.bat. Important: You must be in the directory that has the correct DOMEdB.script and DOMEdb.properties files to launch the server. For example, if you haven't copied the files and they are still in the server folder, the command prompt must say: "C:\Dome\server>". To launch the Server, if this isn't the directory that also contains DOMEServer.bat, you can launch it by including the whole path in the command line, e.g., “ ..\bin\DomeServer.bat “.

Mac/Linux: Start server with "$ sudo sh DomeServer.sh" (or if you are not in bin, then $ sudo sh ../bin/DomeServer.sh).

You will see various output appear; one of the last lines will be "DomeServer started on port [number] at [timestamp]". Note the port number to log in with later. If you have difficulties logging in, refer to the terminal output for error messages. You can also open the DomeServer.bat or DomeServer.sh file to see which port was used.

Check model files into a server

In the DOME window select Deploy in the mode menu at right (Figure 55).

 

 

Figure 55. DOME Window

Choose Deploy > Model (Figure 56).

 

 

Figure 56

 

A Deploy Model window will open (Figure 57).

 

 

Figure 57. Deploy Model Window

Click on login (Figure 58).

 

 

 

Figure 58

 

A login to DOME Server window will open (Figure 59).

 

 

 

Figure 59

 

In the Login to DOME Server window, enter your username, password and server name and then click login (Figure 60). If you started a local server earlier, your credentials will be:

user name: ceed

password: ceed

server: localhost/number of the server :[port number]

After you connect for the first time, your credentials will be stored.

 

Figure 60

After logging in, the Login to DOME Server window disappears and information about the server is shown in the Deploy model window (Figure 61). Click next on the bottom right.

 

Figure 61

The window will change to Figure 62. Leave the default option, “deploy as new model,” selected. Click on browse on the right.

 

Figure 62

 

Now a window will open and you will navigate to find the model you want to deploy (Figure 63).

 

 

Figure 63

Once you find the model you want to deploy, select it and click Open (Figure 64).

 

 

Figure 64

 

 

Now the name and location of the model appears in the Deploy model window (Figure 65). Click next.

 

 

 

Figure 65

 

At this point you will choose where on the server to store your model (Figure 66).

 

 

Figure 66

 

To create a new folder, click on the name of the parent folder and then click on the “+” sign in the bottom right corner (Figure 67).

 

 

Figure 67

 

At this point the new folder windows appear and you chose the name of the folder. In this example the name of the folder is ForTutorial (figure 68). Click "add".

 

 

Figure 68

 

Navigate to that folder and click next. 

 

Figure 69

Select available interfaces and assign permissions

The next screen in the wizard allows you to set permissions (Figure 69). For more details about permissions, see the special topic section on permissions.

 

Figure 69

Choose the permissions you want for this model and click next (Figure 70).

 

 

 

Figure 70

In the “available” column, select which interface(s) you want to make available.This example selected the Velocity Model Interface (Figure 71). Click next.

 

Figure 72

 

 

 

The next screen allows you to set permissions specific to each interface (Figure 73). For more information on setting permissions, read the related special topic.

 

Figure 73

 

Now a summary window will appear (Figure 74). Click deploy.

 

Figure 74

DOME will confirm the deployment was successful (Figure 75).

 

 

Figure 75

 

Now that the model has been deployed to the server, its selected interface(s) are available to others.

 

Running the model

Now you will learn how to

  • Connect to a model;
  • Run a model.

 

From the DOME window choose Run mode in the right menu (Figure 76).

 

Figure 76

 

Click on Run > New Window, upper left, Figure 77.

 

 

Figure 77

 

A Browser window opens. Click login at the top right (Figure 78).

 

 

Figure 78

A Login to DOME Server window opens (Figure 79). Either select a stored set of credentials or enter new credentials and then click “login.”

 

 

 

Figure 79

The server folders appear in the Browser window (Figure 80). Browse to the model you want to run.

 

Figure 80

 

Click on the yellow rectangle to the left of the model name to expand it (Figure 81).

 

Figure 81

Double click on the book icon next to the interface you want to open (Figure 82).

 

 

Figure 82

 

A new interface window opens, showing the Input Dimensions and Output Dimensions context items. Expand these using the yellow triangles (Figure 83).

 

 

Figure 83

Parameters with a green background are consistent between the server and the model, but the model has not been run yet. Fields that will update when the model runs have a red background. Fields displayed with a yellow background have been updated locally, but not yet submitted to the server. The fields will become white when the model has run (Figure 84).

 

 

Figure 84

For example, enter v0=6, a=1, t=3 (Figure 85). Click submit.

 

 

Figure 85

When the model has finished running, the value of v changes to reflect the calculated value, v=9 (Figure 86). The values and background colors will update as the model runs, so in more complex models, changes may appear over time.

 

 

Figure 86