Skip navigation
Toggle Sidebar

2.3 - Creating and Editing Components

Components are reusable configuration objects including certificates, connections, Connector operations, cross reference tables, document caches, maps, map functions, Processes, profiles and trading partners. They are listed in the Component Explorer. Components can be created once and referenced by Process steps across multiple Processes. This modular design simplifies maintenance because configuration changes can be made once and then instantly applied everywhere the component is referenced.


Creating Components

You can create components by using the Create Component window or the Component Explorer on the Build menu, or from the Welcome tab or the Process canvas.

To Create a Component from the Create Component Window

  1. On the Build menu, click the green Create Component button above the Component Explorer.
    The Create Component window opens.
  2. Select a component type from the first select box.
  3. Type a name for the component.
  4. Click the Browse button and select the desired Component Explorer folder.
  5. (Optional) Depending on the type of component that you selected, you may have to select more options. For example, if you create a connection you must select a Connector type.
  6. Click Create.
    The component appears on a tab with the name you entered.
  7. After the tab appears click Save or Save and Close, otherwise the component that you created will not be saved.

To Create a Component from the Component Explorer

  1. On the Build menu in the Component Explorer, navigate to the folder in which you want to create the component.
  2. Click the blue arrow ( ) next to the folder.
  3. Click the New Component link.
    The Create Component window opens with the folder selected.
  4. Select a component type from the first select box.
  5. Type a name for the component.
  6. (Optional) Depending on the type of component that you selected, you may have to select more options. For example, if you create a connection you must select a Connector type.
  7. Click Create.
    The component appears on a tab with the name you entered.
  8. After the tab appears click Save or Save and Close, otherwise the component that you created will not be saved.

To Create a Component from the Welcome Tab

  1. On the Build menu, click the Welcome tab.
  2. In the Create New column, click the type of component that you want to create.
  3. (Optional) Depending on the type of component that you selected, you may have to select more options. For example, if you create a connection you must select a Connector type. Then click Create.
  4. The component appears on a tab.
  5. Type a name for the component.
  6. After the tab appears click Save or Save and Close, otherwise the component that you created will not be saved.

To Create a Component from the Process Canvas

  1. On the Build menu open a Process.
  2. Do one of the following:
    Drag a step from the Logic or Execution palette onto the canvas.
    Double-click an existing step in the Process to display its configuration window.
  3. At various points you will see an icon for creating a new component ( ). Click Create a new component.
    The component opens on a new tab.
    Not all steps reference components.
  4. Add information about the new component on the tab.
  5. Click Save or Save and Close, otherwise the component that you created will not be saved.


Editing Components

You can edit some basic information about all components.

To Edit a Component

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Double-click the component.
    The component opens on a tab on the Process canvas.
  3. To edit the component's name, click in the text box next to the component type and type a new name.
  4. To edit the component's description, click Edit Description Here and type a new description.
  5. Click Save or Save and Close, otherwise the component that you created will not be saved.
    For information on how to configure different types of components, see the specific topic under the Build section.

To Move a Component to Another Folder

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Click the component and drag it to another folder.
    If the destination folder is valid, the folder's name is highlighted in green.
  3. Drop the component in the folder.


Deleting Components

You can delete components from your account through the Component Explorer. Before deleting a component, remember that a component can be used in multiple Processes and/or by other components.

Note: Removing a component from a Process does not delete it from your account. It still exists in the Component Explorer and it can be used within other components or Processes.

To Delete a Component from Your Account

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Click the blue arrow ( ) next to the component's name.
  3. Select Delete.
    A confirmation window appears.
  4. Click OK.
    This operation cannot be undone.


Revision History for Components

When you select a component and click the Revision History link, standard information about the component and its history are displayed. You can view or edit previous revisions of components and view their XML.


Field
Description
Component ID
Unique identifier of the component.
Created By
User name and e-mail address of the user who created the component.
Created Date
Date and time at which the component was created.
Revision
Revision numbers, with the most recent revision at the top.
View/Edit Revision icon
Allows you to view or edit the selected revision of the component.
View Component XML
Allows you to view the component's XML.
Modified By
For each revision, the user name and e-mail address of the user who modified it.
Modified Date
For each revision, the date and time at which the component was modified.


To View a Previous Revision of a Component

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Double-click the component.
    The component opens on a tab.
  3. Click the Revision History icon.
    The Revision History window opens.
  4. Click the View/Edit Revision ( ) icon next to a revision number.
    The older revision of the component opens on a new tab with a banner indicating the revision number.
  5. Click Close.
    The older revision of the component closes and no changes are made.

To Edit a Previous Revision of a Component

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Double-click the component.
    The component opens on a tab.
  3. Click the Revision History icon.
    The Revision History window opens.
  4. Click the View/Edit Revision ( ) icon next to a revision number.
    The older revision of the component opens on a new tab with a banner indicating the revision number.
  5. Make changes to the component as needed.
  6. Click Save or Save and Close.
    Saving older revisions of a component will overwrite the latest revision. Any component references, child components, or sub-components will be to the latest revision of those individual components. This is important when you are configuring older revisions of a Process or map that contains one or more child components.

To View the XML for the Previous Revision of a Component

  1. In the Component Explorer, navigate to the folder containing the component.
  2. Double-click the component.
    The component opens on a tab.
  3. Click the Revision History icon.
    The Revision History window opens.
  4. Click the View Component XML icon next to a revision number.
    The Component XML dialog opens, containing the XML. The XML cannot be edited.
  5. Click Close.


See Also:
Build Overview

Adaptavist Theme Builder Powered by Atlassian Confluence