Docs‎ > ‎Logic Designer‎ > ‎

Project

Each Project represents the grouping of your database connections, schema, resource endpoints,  business rules and events as well as the security access-control settings.  

We also refer to Projects as an API.

This page describes how to use the Logic Designer to create and manage projects.


Multiple Projects per Account

An Espresso Logic account includes one or more projects.  These projects are all active and available (i.e. "running").  The logic Designer allows you manage the contents of the current project.  



Choosing a Project

Choose the current project using the combo box at the menu bar located on top-center of the Logic Designer.



Creating A New Project

There are two alternatives for creating a project.


Creating a Project from the Navigation Menu

The simplest way to create a project is via the Navigation Menu:




Creating a Project from the Project Combo Box


To create a Project 
  1. Click the Project combo box, and
  2. Select the 'New Project - Connect' menu option from the Project selection

The dialog box will prompt you for a connection to your database 
  1. First, check the box that enables you to specify your own database (not shown) and choose your database type, and then

  2. Complete the connection wizard for the specified database type (shown below)


Project Properties Checklist

For proper operation of your project, please ensure the following are properly defined:
  • Database Settings for your Active Database
  • Security settings (see especially Dev vs. App User) for the Authentication Provider
  • Project Libraries and other Project Attributes 

Active Database

Each project has a list of one or more registered Databases, only one of which is current.  This list may have only 1 entry (created as part of project creation, as described above), or many.  Multiple entries are enable you to use your service for test databases, integration databases, the production database, etc. 

Project Attributes

The sub-sections below described the key attributes of a project.  Use Short Menus; note some of these are included under the tab sheets.



Project Name

The identifies your project, set when you create your project.  This is your internal name.

URL

Defaulted from the Project Name,  you can specify the URL that is part of your REST API.  It must be unique within your project.

Authentication Provider

The Authentication Provider authenticates that login credentials (typically a user / password) are correct, and returns a set of roles.  You can supply your own provider to utilize corporate security services, or use the provided default.  Sample Authentication Providers are available from GitHub for Windows Azure AD, Stormpath, LDAP, and more.


Aggregate Default Override

This setting authorizes the system to ignore client attempts to update aggregate (sum, count, min, max) values.  False means exceptions are thrown on such update attempts.

Type Base URI

This will be used in a future release and should be ignored for now.

HTTPS Only

If this option is set to "true" (without the quotes), then only HTTPS API calls are allowed. This is the case by default. If security is not a major concern for your project, you can turn set this to false, which will allow calls using HTTP or HTTPS.

JavaScript allowed

Indicate whether JavaScript is enabled.  For security reasons, this is false unless you are using your own server instance.

Libraries

This is a list of Java and JavaScript libraries for your project. If you would like to use one or more of these in your JavaScript logic, you can select them here.

For example, many projects will use date arithmetic, so would select the Moment Library.

You should not select any libraries that you do not in fact use, since there is a (small) memory impact for every additional library selected.

New Libraries (JAR files) and JavaScript files may be uploaded using the 'Your Libraries' tab and the 'Create New Library' button.

Documentation


You can specify URLs for Documentation which will be shown in tabs on the Designer Home Page as shown here.  Specify the URLs in project settings.  The links must be https (e.g., Google Sites can be designated as such).


Project Import / Export

The Projects page has a button to Export the current selected project as a file download.  This export contains all the meta data for the current project including, database schema, business rules, resource endpoints, security definitions for users and roles. The export produces a .JSON file which can be saved into a source control system or used to import into another account.

The import is found on the Project menu drop down.  This import creates a project from an existing export (not a merge into your current project).  

IMPORTANT : The JSON export does not save certain information - after the Project Import is completed: 
  • re-specify you database password
  • specify user passwords (if you are using the default Authentication Provider)
  • re-specify your Authentication Provider on the Project dialog
  • optionally, you may also want to re-specify the Project URL (which will include the timestamp of the import)
See the Logic Sample Project for screen shots and details.


Project Verify

Espresso does not replicate your schema.  You are free to use your existing tools to manage your schema.

The Espresso rule repository does, of course, make reference to schema objects such as table and column names.  If these are dropped or renamed, you need to synchronize these with your repository. The project Verify button will re-validate the schema with the rules definitions and show problems on the 'Issues' tab in Logic Designer.

So, Espresso provides the following services to help you manage repository / schema.  Please see Database Administration.


Latest Changes

Use the tab below to view the latest changes to your project.



Subpages (2): Importing a project Topics