Configuring Activation Network Cartridge Projects

To configure an Activation Network cartridge project:

1. Create and set up the Activation Network cartridge project.

   Double-click the cartridge project entity to display the project in the Activation Project editor.

2. Define and edit the data elements.

   1. Create service actions, atomic actions, action processors, and activation run-time parameters as data elements for the model. See "Creating Service Actions, Atomic Actions, and Action Processors" and "Creating Activation Run-Time Type Parameters in the Data Dictionary" for more information.

      You can create elements with a wizard or with the Cartridge Generation feature, which creates and links the elements. See "Generating Framework Models" for more information.

   2. Do any one of the following:

      For elements that you created with a wizard, define their relationships by manually linking service actions, atomic actions, and action processors, and define the element parameters.

      For elements that you created with the Cartridge Generation feature, the linking process is automated, and elements are automatically created and linked.

      See "About Service Action, Atomic Action, and Action Processor Relationships" for more information.

   3. Add information that will be used for auto-generation of documentation for the model.

      See "Documenting Cartridges" for more information.

3. Implement the action processor.

   1. Define a Java action processor implementation.

      Use the Java with code generation implementation to write the logic in the execute method of the processor class (the proxy automatically performs several steps of code generation). See ASAP Cartridge Development Guide for more information.

      Configure Java libraries. See ASAP Cartridge Development Guide for more information.

   2. Use the Unit Test procedure to generate a test case, which enables you to test the processor outside of the ASAP environment.

      Configure a Unit test for the processor. See "Testing ASAP Cartridges in Design Studio".

4. Configure the user-defined exit types (UDET). See "Configuring User-Defined Exit Types" for more information.

   1. Create UDETs as elements for the model.

   2. Configure the UDETs in the editor to define the content.

5. Implement the connection handler.

   Write a Java Connection Handler. See ASAP Cartridge Development Guide for more information.

6. Define the network elements.

   You must create and configure at least one of the following elements (all three elements are related as they involve connection to equipment):

   • NE templates

     A template that can be copied to create one or many specific network elements.

   • Network elements

     A network element represents one specific piece of equipment (a single instance) in the network. A connection pool contains one or more connections that can be used to connect to the network element (possibly simultaneously). Each network element has a single connection pool associated with it.

   • Dynamic NE templates

     Use dynamic NE templates to enable network element attributes to be dynamically sent to ASAP 5.x on work orders. Dynamic NE templates are used when upstream systems (such as Inventory) contain the necessary information to connect to the network element instance. Passing this information to ASAP 5.x dynamically avoids having to configure it in multiple locations (for example, in ASAP 5.x as well as in an inventory system).

   See "Working with Network Elements" for more information.

7. Package the cartridge project.

   1. Use the Project editor to specify which elements to include in the cartridge project SAR file.

   2. Create the JAR with ANT.

   3. Include JARs in the SAR.

   4. Put external JARs in the NEP classpath on the ASAP server.

   See "Packaging Projects" for more information.

8. Deploy the cartridge project.

   1. Create a Studio Environment project and a Studio environment in the Studio Projects view (use corresponding wizards for both the tasks).

   2. On the Connection Information tab of the Studio Environment editor, specify how to connect to the activation environment. See "Studio Environment Editor Activation Connection Details Area" for more information.

      The NEP Map editor and Activation Test case utility use the information specified in the Activation Connection Details area to deploy network element configuration and to submit test work orders to a run-time ASAP environment respectively.

   3. In the Cartridge Management view, deploy cartridge projects to the run-time environment, and undeploy them from the run-time environment.

   4. Use the NEP Map editor to deploy and manage network elements.

   See "Deploying Cartridge Projects" for more information.