About setting up a Flex development environment

Oracle recommends setting up a Flex development environment for creating your custom editors.

You can use a standalone installation of Flash Builder, or set up your development environment in Eclipse. Setting up an Experience Manager SDK project in Eclipse requires the Flash Builder 4 plugin.

If you choose to develop using Flash Builder, you must use Flash Builder 4.0. In addition, the version of the Flex SDK that Flash Builder uses to compile must be 4.5.0 or higher. You should compile your editors using the Halo theme for visual consistency.

To configure a Flash Builder development environment:

  1. Confirm that you are running version 4.0 with the Flex 4.5 SDK:

    1. Start Flash Builder 4.0.

    2. Navigate to Window → Preferences.

    3. In the tree control on the left, navigate to Flash Builder → Installed Flex SDKs.

    4. Verify that the Flex 4.5 entry appears and is selected in the list of Installed SDKs.

  2. Update your project to use the Halo visual theme:

    1. In Flash Builder, navigate to Project → Properties → Flex Theme.

    2. Select Halo.

    3. Click OK to save your changes.

Experience Manager includes Flex Framework dependencies as Runtime Shared Libraries. Configure your editors to use these same dependencies in order to avoid version conflicts.

The following dependencies ship with Tools and Frameworks and are included within the Endeca Configuration Repository at ifcr/tools/xmgr. You should configure the resources below as Runtime Shared Libraries if they are dependencies of your editor module:

To configure a dependency as a Runtime Shared Library:

  1. Update your project to use the ExperienceManagerAPI-4.0.0.swc and the Halo theme:

    1. In Flash Builder, navigate to Project → Properties → Flex Build Path.

    2. Add the dependency..

      For example, ToolsAndFrameworks\4.0.0\editor_sdk\libs\ExperienceManagerAPI-4.0.0.swc.

    3. Beneath the new SWC in the tree view, select Link Type: and click Edit....

    4. Select Runtime shared library (RSL).

    5. For the Deployment Path/URL:, enter the location of the dependency in the Endeca Configuration Repository.

      For example, /ifcr/tools/xmgr/com.endeca.ExperienceManagerAPI-4.0.0.swf.

    6. Click OK.

    7. Click OK to save your changes.

The Experience Manager Editor SDK includes a Maven script for installing the included API package into a Maven repository.

These steps assume you have Maven 3.0.4 installed as part of your development environment.

To install the Experience Manager API package:

  1. Navigate to the %ENDECA_TOOLS_ROOT%\editor_sdk\reference\build\maven directory.

  2. Open a command prompt.

  3. Run the install-api profile in the Maven POM file using the following command: 

    mvn -Pinstall-api

    This installs ExperienceManagerAPI-4.0.0.swc to your Maven repository.

Copyright © Legal Notices