Developer On-boarding

The Developer On-boarding chapter contains information on how to configure a basic API Builder app and explore the Dashboard.

Create and locate your API Builder app

  1. Using an IDE of your choosing or the CLI, create an API Builder app.
  2. Open Dashboard (https://platform.appcelerator.com) in your web browser.
  3. Use the API dropdown to find your API Builder application. 
    • Tip: you can type the name of the app to see a filter list of apps if your organization has several apps to choose from.
    • Note: You should disable Demo Data. Otherwise, you will get the following error message: "appName" contained an invalid value.
  4. Look for the API name that is followed by "(your- environment-name) data" to ensure your selecting the application that has been pushed to your Appcelerator Private environment.
    • Appcelerator Private customers should continue to use the legacy Dashboard interface instead of the 4.0 release of https://platform.appcelerator.com. This is due to additional enhancements that are required for the new UI to take advantage of the Appcelerator Private environment systems.

Create a user for the API Builder app

  1. With Dashboard still open, go to Apps in the left-hand menu. Wait 10 or so seconds (depending on your Internet speed) and you should see your app listed.
  2. Click on the link that has your app name.
  3. Click on Manage Data from the left hand navigation and select Users.
  4. Click the Create User button and create a new user. Make sure the user is marked as Admin = Yes.

    • There is a known issue with Appcelerator Private where you may have an undefined user that API Builder tried to create, this is being addressed in an upcoming release. For now, you can simply delete this user.

  5. Take note of the username and password of the new user.

  6. Click Save Changes to confirm your new user settings.

Configuration for API Builder app in Appcelerator Private environment

  1. Click on Configuration from the left hand navigation.
  2. Next to App Key, click on the Show link to reveal the app key. You'll need the app key for the next step.

Updating the configuration for ArrowDB in your API Builder app

  1. In an IDE of your choosing, expand the Arrow Application folders if you have a project explorer editor.
  2. Open the folder named conf. You will see several files that are called:

    • appc.arrowdb.development.js

    • appc.arrowdb.production.js
    • Note: These files are mapped to the development and production environments of the Appcelerator Public Cloud. For Appcelerator Private instances, you need only one of the configuration files.
  3. Delete the file called  appc.arrowdb.production.js .
  4. Rename the file called appc.arrowdb.development.js to appc.arrowdb.default.js .
  5. Open the file  appc.arrowdb.default.js in Appcelerator Studio.
  6. Update the configuration file to leverage the new user and app key from in the previous section.
  7. Save your changes to appc_arrowdb.default.js  file.

Run your Arrow app locally

At this point in the process, you will need to launch your API Builder app so that it can download any dependencies.

Configuring a newly installed cluster with Dashboard

  1. Create an Environment on Dashboard with the following configurations:
  2. https://platform.appcelerator.com/#/admin/reporting/envs/create
  3. https://platform.appcelerator.com/#/admin/envs
    1. Name: Provide a proper name that describes it's function or purpose.
    2. Is Production:
      1. Yes: Uses Dev APNS for iOS push.
      2. No: Uses Prod APNS for iOS push.
    3. ArrowDB Base URL: Provide the base URL for your cluster (e.g. https://api.single.cloud-services.appctest.com).
    4. ArrowDB Authentication Base URL: Should be the same as URL you provided for the ArrowDB Base URL field.
    5. ArrowDB Auth Token: Use the same token as found in the var file.
    6. Arrow Endpoint: Provide the URL for your endpoint (e.g. https://admin.single.cloud-services.appctest.com)
    7. Arrow Auth Token: Use the same value as listed in the ArrowDB Auth Token field.
  4. Create an Organization on Dashboard's Create Child Organization , and attach the newly created (cluster) Environment to it.

Publish your API Builder application using Appc CLI

  1. Append the admin endpoint IP's and URL's to your /etc/hosts file  (example shown below).
  2. Navigate to your app directory and run: appc cloud publish --host <admin server>
    1. Enter username and password (same as your Appcelerator platform login).
    2. Select the organization you wish to publish to.
    3. Select Yes to publish it now. After this request completes, the URL to your application will be displayed in the console. Note: Publishing API Builder apps should be the same for private clouds as it is for public clouds.
  3. Once published, append the application url along with the admin endpoint IP to your /etc/hosts file (example shown below).
  4. You should be able to access your app via the URL.

Import Appcelerator Titanium application sample application

Importing Titanium projects should be the same for private clouds as it is for public clouds.

Setup and basic example of test automation

Setting up and testing should be the same for private clouds as it is for public clouds.

Additional steps to perform

  1. Make sure that usage and other data shows up in the Dashboard analytics views.
  2. Create and publishing Node.ACS apps.
  3. Set a custom CNAME for the Node.ACS app.
  4. Upload a custom SSL certificate for the Node.ACS app.
  5. Update the container size of a Node.ACS app to something larger than the default.
  6. View the logs of the running Node.ACS app to look for errors.

Related Links