Active Workspace hosting APIs

The Active Workspace hosting APIs provide a set of tools to integrate the Active Workspace client with various modeling tools. These APIs support hosting environments such as SWT, JCEF, and Swing.

To use these APIs, ensure that you complete your configuration using one of the following options:

• Update the following entries in the CommonClient.properties file:

  ACTIVE_HOST_URI_KEY=activehost
  AWC_WEBLOGIC_HOST_URI=Active-Workspace-URL
  

  Example: AWC_WEBLOGIC_HOST_URI=http://vc6s015:3000/?ah=true

• Update the preference ActiveWorkspaceHosting.URL with the value of the Active Workspace hosting URL. Example: ActiveWorkspaceHosting.URL=http://vc6s015:3000/?ah=true

The APIs

tcmeActiveWorkspaceHostLogin() — Establishes a Teamcenter session for the integration of the model management tool with Teamcenter. After a successful login, you can perform the integration operations.

public TCMELoginOutput tcmeActiveWorkspaceHostLogin()

Returns: TCMEOperationOutput containing the operation status and error or warning message.

tcmeAddActiveWorkspaceHostControl() — Adds a hosted Active Workspace client to a parent composite, which is an SWT widget.

public void tcmeAddActiveWorkspaceHostControl(Composite parent, String strTOOLTYPE)

Input parameters: parent — the parent composite of the modeling tool. strTOOLTYPE — the tool type sent by the modeling tool.

tcmeAddActiveWorkspaceHostControlJCEF() — Adds or shows a hosted Active Workspace client to a parent composite using a JCEF-based browser.

public void tcmeAddActiveWorkspaceHostControlJCEF(Composite parent, String strTOOLTYPE)

Input parameters: parent, strTOOLTYPE (same as above).

tcmeAddActiveWorkspaceHostControlJCEFSwing() — Shows the Active Workspace client in a hosted environment with a JCEF-based browser.

public JCEFBrowserPanel tcmeAddActiveWorkspaceHostControlJCEFSwing(String strTOOLTYPE)

Input parameters: strTOOLTYPE — tool type sent by the modeling tool. Returns: JCEFBrowserPanel — the Swing JPanel in which the Active Workspace client is hosted.

tcmeAddActiveWorkspaceHostControlSwing() — Shows the Active Workspace client in a hosted environment using the Swing API.

public JCEFBrowserPanel tcmeAddActiveWorkspaceHostControlSwing(JPanel parentPanel, String strTOOLTYPE)

Input parameters: parentPanel — the parent JPanel of the modeling tool. strTOOLTYPE — the tool type sent by the modeling tool.

tcmeAddDragDropListener() — Adds a drag-and-drop listener to the hosted Active Workspace client.

public void tcmeAddDragDropListener(final IDragAndDropListener dragAndDropListener)

Input parameters: dragAndDropListener — instance of the browserinterop.IDragAndDropListener service to be added.

tcmeRemoveDragDropListener() — Removes the instance of the drag-and-drop listener from the hosted Active Workspace client.

public void tcmeRemoveDragDropListener(final IDragAndDropListener dragAndDropListener)

Input parameters: dragAndDropListener — the instance to be removed.

tcmeShowObjectInActiveWorkspaceHostControl() (Composite overload) — Shows a desired Teamcenter object in the hosted Active Workspace client from the modeling tool. Use with tcmeAddActiveWorkspaceHostControl and tcmeAddActiveWorkspaceHostControlJCEF.

public void tcmeShowObjectInActiveWorkspaceHostControl(Composite parent, String strTOOLTYPE, String showObjectTCUID)

Input parameters: parent, strTOOLTYPE, showObjectTCUID — the Teamcenter UID of the object to show.

tcmeShowObjectInActiveWorkspaceHostControl() (Swing overload) — Same purpose, for use with tcmeAddActiveWorkspaceHostControlJCEFSwing.

public JCEFBrowserPanel tcmeShowObjectInActiveWorkspaceHostControl(String showObjectTCUID)

Returns: JCEFBrowserPanel.

tcmeShowObjectInActiveWorkspaceHostControlSwing() — Same purpose, for use with tcmeAddActiveWorkspaceHostControlSwing.

public JCEFBrowserPanel tcmeShowObjectInActiveWorkspaceHostControlSwing(JPanel parentPanel, String showObjectTCUID, boolean isWindowOpen)

Input parameters: parentPanel, showObjectTCUID, isWindowOpen — true if the hosted client window/panel is already open, false if the panel is closed and the user is opening it. Returns: JCEFBrowserPanel.

tcmeShowObjectURIInActiveWorkspaceHostControl() (Composite overload) — Shows a desired Teamcenter object by URI. Use with tcmeAddActiveWorkspaceHostControl and tcmeAddActiveWorkspaceHostControlJCEF.

public void tcmeShowObjectURIInActiveWorkspaceHostControl(Composite parent, String strTOOLTYPE, String showObjectURI)

tcmeShowObjectURIInActiveWorkspaceHostControl() (Swing overload) — Use with tcmeAddActiveWorkspaceHostControlJCEFSwing.

public JCEFBrowserPanel tcmeShowObjectURIInActiveWorkspaceHostControl(String showObjectURI)

tcmeShowHomePageInActiveWorkspaceHostControl() — Shows the Active Workspace home page. Use with tcmeAddActiveWorkspaceHostControlJCEFSwing.

public JCEFBrowserPanel tcmeShowHomePageInActiveWorkspaceHostControl()

Returns: JCEFBrowserPanel.

tcmeShowHomePageInActiveWorkspaceHostControlSwing() — Same purpose, for use with tcmeAddActiveWorkspaceHostControlSwing.

public JCEFBrowserPanel tcmeShowHomePageInActiveWorkspaceHostControlSwing(JPanel parentPanel)

Returns: JCEFBrowserPanel.

tcmeSetShowHomePageOnCreation() (no-composite overload) — Sets a flag to show the home page in the hosted Active Workspace client when it is open.

public void tcmeSetShowHomePageOnCreation(boolean showHomePage)

tcmeSetShowHomePageOnCreation() (Composite overload) — Same purpose, scoped to a parent composite.

public void tcmeSetShowHomePageOnCreation(Composite parent, boolean showHomePage)

tcmeShowActiveWorkspaceComponent() — Opens any Active Workspace component URL in the hosted Active Workspace. Initialize the Active Workspace client hosting using one of tcmeAddActiveWorkspaceHostControl, tcmeAddActiveWorkspaceHostControlJCEF, tcmeAddActiveWorkspaceHostControlJCEFSwing, or tcmeAddActiveWorkspaceHostControlSwing before calling this API.

public void tcmeShowActiveWorkspaceComponent(String awcComponentUrlWithParameters) throws TCMEException

Input parameters: awcComponentUrlWithParameters — must not be null or empty, or a TCMEException occurs.

tcmeGetHostControlInstance() — Returns an instance of IHostControlInstance, used to register browser interoperability (browserinterop) services and handlers. Initialize the Active Workspace client hosting first, as above.

public IHostControlInstance tcmeGetHostControlInstance() throws TCMEException

Returns: IHostControlInstance — used for registering browserinterop services and handlers.

Support for hosting different Active Workspace components across multiple tabs

With the Active Workspace hosting APIs you can also host or embed multiple and distinct Active Workspace components across separate tabs within the modeling tool.

Example: You can embed different Active Workspace components such as variant configuration in one tab and Branching and versioning in another tab.

With the multiple hosting feature you can:

• Operate each component independently without interference.
• Maintain separate component states across different tabs.
• Achieve greater workflow flexibility through modular component usage.
• Get support for more complex and flexible modeling scenarios that require simultaneous access to multiple Active Workspace components.

For this, a single Teamcenter login is sufficient. Once authenticated, the resulting connection object should be reused to instantiate the Active Workspace Hosting APIs.

When using the multiple hosting feature make note of the following:

• A single Teamcenter login is sufficient. Once authenticated, the resulting connection object should be reused to instantiate the Active Workspace hosting APIs.
• Since each tab operates independently, integrators must create and manage a dedicated instance of the Active Workspace hosting APIs for each tab.
• Additionally, separate drag-and-drop and selection listeners must be implemented for every tab to ensure proper functioning.

Use the sample modeling tool to refer to the usage of hosting different Active Workspace components across multiple tabs.