Managed Data Server Administration
Managed Data Server Administration
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:
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 manage the managed data servers by assigning one of the following predefined roles:
Add, update, and delete access to managed data servers.
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
- In API Creator, on the APIs page, click theManaged Data Serverstab.A list of managed data servers displays.
- Above the list of managed data servers, clickAdd.The Create Managed Data Server window opens.
- Complete the following fields, and then clickAdd:Create managed data server usingSpecifies the category of data source for the managed data server. AcceptJDBC data sourceas the category.Database typeSpecifies the type of database that you want to use for your managed data server.Values:MySQL, Oracle, (Microsoft) SQLServer, PostgreSQL, and (Apache) DerbyDefault:DerbyNameDefine the name for the authentication provider.
- Modify the following fields as required, and then save your changes:All the fields exceptCatalogare required.URLThe URL for your managed data server and the port that the database uses. 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:YesFor more information about the fields thatCA Live API Creatoruses to connect to a data source, see Database Connectivity.ActiveSpecifies 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:
- 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
For more information about how to add a data source for a managed database to the managed data server from an existing API, see Database Connectivity.
Add a Data Source for a Managed Database While Creating Your API
App-firstapproach to creating APIs, you create an empty API, connect to a managed data server, and then add a data source for a managed database. With this approach, you create your tables, fields, and data using Data Explorer. API Creator creates your application, your schema, and your default API.
Follow these steps:
- On the APIs page, clickCreate New API.The connection wizard opens.
- ClickApp Firstas the approach that you want to use to create your API.
- Select the managed data server that you want to use and create your database, and then clickCreate.The connection window for the empty managed database opens. The connection parameters for this database display in the wizard.
- ClickProceed 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:
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.