Creating a New Service for SOTI Snap Data Access Controller

Create a RESTful API service by connecting to an existing database. SOTI Snap applications can then perform create, read, update and delete (CRUD) operations on database table data using the API.

Procedure

  1. From the SOTI Snap Data Access Controller web console, select the Services tab.
  2. From the Services tab, select New Service.
  3. Select the Database Server Type.
    Create New Service 1/6: Database Type
    Select a database server type from the drop-down menu:
    • PostgreSQL
    • MySQL
    • Oracle
    • Microsoft SQL Server
    • IBM Db2
    Note: If you wish to connect to a remote Oracle database and encounter errors, you may need to install Oracle Instant Client. Instructions are available at http://127.0.0.1:<console_port>/oracleSetupDocs.
  4. Set up the Connection to the database server.
    Create New Service 2/6: Connection
    1. Database Hostname / IP: The hostname/network address that has the database server.
    2. Port: The port number for accessing the database server on the hostname/network address.
    3. Username: The username for accessing the database server.
    4. Password: The database username respective password.
    5. Select Test Connection to verify that you can successfully connect to the database server.
  5. If you can successfully connect to the database server, continue to set up the Connection by selecting a database and / or schema.
    Create New Service 2/6: Successful Connection
    1. Database: Choose a database from the database server.
    2. Database Schema: Choose a schema from the database you have chosen.
  6. Select the Tables in the database server to receive API endpoints.
    Create New Service 3/6: Tables
    1. Optional: Enable Allow for custom SELECT queries to display tables with composite keys and / or no primary key.
    2. For the Table Name, choose the tables you would like to Create API Endpoint and / or Allow for Custom SELECT Queries.
    See the Custom SELECT Queries section in the API Docs tab for more details about allowing custom SELECT queries.
    Note: Tables with composite keys and / or no primary key are only accessible using custom SELECT queries.
  7. Under Routines, select the stored procedures and functions that should be accessible via the API endpoints.
    Create New Service 4/6: Routines
    1. For Procedure Name, choose the stored procedures that the API endpoint can access.
    2. For Function Name, choose the functions that custom SELECT queries can access.
    See the Stored Procedures section in the API Docs tab for more details about accessing stored procedures and functions.
    Restriction: You must choose at least one table or procedure to create an API endpoint for.
  8. Set up the Authentication details to access the API endpoints.
    Create New Service 5/6: Authentication
    1. Service Name: The name for the RESTful API service.
    2. Port Number To Host the Service: The port number where the RESTful API service binds to and listens for incoming requests. SOTI Snap applications use this port to connect to the service. By default this value is 5000.
      Restriction: You must enter a port number from 5000 to 5998, inclusive. No two DAC services can use the same port.
    3. Username: Enter an alphanumeric string as the API endpoint user.
    4. Password and Re-enter Password: Enter a password as specified by the API Password Complexity settings (see Managing SOTI Snap Data Access Controller Settings).
    5. Optional: Toggle Enable HTTPS to restrict access to HTTPS only for SOTI Snap applications that access this API. This offers a more secure connection.
  9. In the Summary step, preview the settings for the service. Select Back to make changes. You can also edit your selections and choices after you create the service as needed.
    Create New Service 6/6: Summary
  10. Select Create Service to create the service.

Results

SOTI Snap Data Access Controller adds a new created service row to the Services panel.