Managed Data Server Administration

Managed Data Server Administration
lac42
Use the information in this article to add managed data servers, add data sources for managed databases to managed data servers, and authorize users to create managed databases within managed data servers.
In this article:
2
Verify the Prerequisites
Before you add the managed data server, ensure that you have completed the following prerequisites:
  • You have database administrator (DBA) permissions to the data source for a managed database that you are going to add.
  • You have system administrator (
    sa
    ) user privileges to the managed database to which you have access.
  • You are logged in to API Creator as a TeamSpace user assigned to the Data admin role.
    For more information about this role, including the other roles that are required for managing managed databases, see Database Creation.
Roles for Managing Data Servers and Managing Managed Databases
The system administrator (
sa
) user can authorize TeamSpace users to create the managed data servers by assigning one of the following predefined roles:
Role
Authorizes
Data admin
Add, update, and delete access to managed data servers.
Data designer
Create and delete access to managed databases and create, modify, and delete access to tables, fields, and relationships in those managed databases.
For more information about how to add a TeamSpace user and assign this user roles, see Manage TeamSpace Users.
Add a Managed Data Server
Follow these steps:
  1. In API Creator, on the APIs page, click the 
    Managed Data Servers
     tab.
    A list of managed data servers displays.
  2. Above the list of managed data servers, click
    Add
    .
  3. Complete the required fields, including the following fields, and then save your changes:
    All the fields except
    C
    atalog
     are required.
    Database type
    The database type for your managed data server. 
    Values: 
    MySQL, PostgreSQL, (Apache) Derby, (Microsoft) SQL Server, Oracle
    You cannot use Amazon Relational Database Service (Amazon RDS) for PostgreSQL databases as a managed database.
    For more information about the databases that you can use with
    CA Live API Creator
    in an Amazon Web Services (AWS) Elastic Beanstalk environment, see Install on Amazon Web Services Elastic Beanstalk.
    Default:
     MySQL
    Required:
     Yes
    URL
    The URL for your managed data server and the port that is used by the database. Do not include a forward slash (
    /
    ) at the end of the URL. When you create an API and you connect to an empty database, the database name is appended to this URL. For local servers, the URL is typically:
    jdbc:mysql://<server-name>[port-number (default 3306)]/[database-name]
    Required:
     Yes
    For more information about the fields that 
    CA Live API Creator
     uses to connect to a data source, see Database Connectivity.
    Active
    Specifies whether this managed data server is active and you can add data sources for managed databases to it. Select this checkbox.
    Required:
     Yes
Your managed data server is added.
Add a Data Source for a Managed Database to the Managed Data Server
Add a data source for a managed database to the managed data server that you added. There is no limit to the number of managed databases that you can add to a managed data server.
You can add the data source for a managed database to the managed data server in the following ways:
Prerequisites:
  • You have added a managed data server and it is active.
  • If your enterprise DBA has adopted practices that limit your ability to create schemas, you have allowed users to create schemas in the database. You do this by connecting to the database that your DBA has created using the SQL user account with the appropriate credentials to edit the schema.
Add a Data Source for a Managed Database From an Existing API
Follow these steps:
  1. With your API open, in the Create section, click
    Data Sources
    .
  2. Above the list of data source connections, click 
    Add
    .
    The Create data source window opens. 
  3. Create the data source by adding a connection to the database.
    For more information about how to add a connection, see Database Connectivity.
Your data source for the selected managed data server is added. The data source is added to the list of API data sources.
Add a Data Source for a Managed Database While Creating Your API
Add a data source for a managed database to the managed data server while creating your API and connecting to an empty database.
Follow these steps:
  1. On the APIs page, click
    Create New API
    .
    The connection wizard opens.
  2. Click the 
    App First
     as the approach you want to use to create your API.
  3. Select the managed data server that you want to use and create your database, and then click
    Create
    .
    The connection window for the empty managed database opens. The connection parameters for this database display in the wizard.
  4. Click 
    Proceed to Data Explorer
    .
    A default API for this database is created, your data source for a managed database is added to the managed data server, and the data source is added to the list of API data sources. Data Explorer starts in Author Mode in another browser window.
Authorize Users to Create a Managed Database Within the Managed Data Server
You can authorize users to create and use managed databases within the managed data server using the following methods:
  • Add the TeamSpace users in API Creator and assign one of the predefined roles for creating database.
    For more information:
  • Define the API users and their roles using a custom authentication provider.
    You authorize API users to create and use managed databases and managed data servers in your organization by creating a custom authentication provider.
    For more information about how to authenticate API users using a JavaScript authentication provider, see Authenticate API Users using a JavaScript Authentication Provider.
Next Steps
Now that you have set up the managed data server and added a data source for a managed database to the data server, you can open your API, start Data Explorer (in Author Mode), and then create tables, fields, and relationships in the data source. You can also manage data with your own schema.
For more information about how to create tables, fields, and relationships in your data source for a managed database using Data Explorer, see Manage Tables in Managed Databases.