Configuration

Before building and deploying your application for the first time you need to configure Builder with the details of what to build and where to deploy it. You do this by placing the model elements you want to deploy in a deployable element. You then specify configuration properties for the folder and the segment elements.

Note: For a Windows platform you need to first set up the Runtime database.

To configure a Runtime database server for Windows

Before you attempt to build your application, you need to set up the database server that it uses.

Runtime for the Windows operating system includes an Administration Tool, which provides an integrated interface to help you manage and control all the components that your application uses. You can use the Administration Tool to create a new database. This creates a basic database on the server. Other Runtime platforms which are available in Agile Business Suite use the proprietary tools for each platform. Refer to the Agile Business Suite Installation and Configuration Guide for each particular platform.

It is recommended, however, that you create your own database using the tools that come with your database software. This enables you to fully control the preparation, deployment, and configuration of the database. You must then use the Administration Tool to prepare the database you have created. Refer to the Agile Business Suite Runtime for Windows® Operating System Administration Guide for more information on how to do this.

To fully configure a system for deployment, the target host name, database name and the database server registration alias names must be known.

Creating a set of configuration properties

You can create more than one set of configuration properties for your model.

To create a new set of configuration properties, perform the following:

  1. On the model’s Property Pages dialog, click the Configuration Manager... button.

  2. From the Active Solution Configuration drop­down list, select <New...>.

  3. Enter a Solution Configuration Name. Ensure that the Create new project configurations check box is selected.

  4. From the Platform drop-down list select a platform for the deployment, or add a new platform to use. You can also remove an existing platform by selecting <Edit…>.

Note: Having too many multiple configurations impacts the performance of Visual Studio especially in a multi user environment. You should delete unwanted configurations from the project at regular intervals. In a multi user environment, only one user should delete all the unwanted configurations across all the projects. After that, other users should delete their Visual Studio project folders only. After deleting the unwanted configurations, all users should copy the project folder to their respective locations.

To delete multiple configurations, perform the following:

  1. Select Configuration Manager from the Solution Configurations drop-down list on the standard toolbar.

    The Configuration Manager window opens.

  2. Select Edit from the Active solutions configuration drop-down list.

    The Edit Solutions Configuration window opens.

  3. Select the unwanted configurations from the Name list, and click Remove.

    You can delete only one configuration at a time.

  4. Click Close to close the Edit Solutions Configuration window.

  5. Select Edit from the Configuration drop-down list in the Project contexts list.

    The Edit Project Configurations window opens.

  6. Select the unwanted configurations from the Name list and click Remove.

    You can delete only one configuration at a time.

  7. Click Close to close the Edit Project Configurations window.

  8. Click Close to close the Configuration Manager window.

  9. Save the project file and distribute the project folder to other users.

    Creating and Configuring a Deployment Folder

To create and configure a deployment folder for an AB Suite model, perform the following:

  1. Add a folder to the model that contains the segment you want to deploy.

  2. Drag the segment you want to deploy into this folder.

  3. Right-click the folder and select Properties from the context menu.

    The Property Pages dialog box appears.

  4. Set the Deployable property to True. This enables all the relevant properties for editing.

  5. Specify the deployment properties for the folder.

You can either create nested deployable elements so that parts of your application can be deployed separately for an AB Suite application. For example, you might need to deploy some reports separately from the main application. In Windows runtime each deployable folder is built as a separate installation package. It is important that each deployable element has a unique package name within a project, particularly if you have multiple segments within a project.

To create and configure a deployment folder for an AB Suite Client Framework model, perform the following:

  1. Add a folder to the model that contains the segment you want to deploy.

  2. Drag the segment you want to deploy into this folder.

  3. Right-click the folder and select Properties from the context menu.

    The Property Pages dialog box appears.

  4. Set the Deployable property to True.

  5. Set the Deploy Application Components property to True.

  6. Set the Deploy Database property to True.

  7. Set the Deploy SQL Views property to True.

  8. Enter the Package Name of the MSI file in which you want to package the deployable elements.

    By default, the value is the name of the folder.

  9. Enter the Deployment Host name.

  10. Browse to and select the Package Installation Directory where the deployable unit should be installed on the Runtime server.

  11. Browse to and select the Package Intermediate Directory where the installer files should be transferred before the installation process starts.

Configuring the Segment

There are additional configuration properties that need to be set on the segment.

To configure a segment for an AB Suite application, perform the following:

  1. Right-click the segment you want to deploy. It should already be in the configured deployable element.

  2. Select Properties from the context menu.

    The <Segment Name> Property Pages dialog box appears.

  3. For Windows platform, configure Target Database and Database Server Registration with the names used when the runtime database was created.

To configure a segment for an AB Suite Client Framework application, perform the following:

  1. Right-click the segment that you want to deploy. It should already be in the configured deployable Element.

  2. Select Properties from the context menu.

    The <Segment Name> Property Pages dialog box appears.

  3. Configure the Database Schema Name, Database Server Registration, and Database Name with the names used when the runtime database was created.

There are additional segment properties that can be changed at this point. Review the settings to ensure they are correct.