Publishing and Retracting Metadata for IS and TN Assets

Available IS and TN Assets

You can publish and retract metadata for Integration Server (IS) assets, IS administrative assets, and Trading Networks (TN) document types to and from the CentraSite shared registry. IS administrative assets include Adapter connections, Broker connections, and JMS connection aliases. By publishing metadata, you make these assets available to other CentraSite users for activities such as search, documentation, reuse, and impact analysis.

The following table lists the Integration Server and Trading Networks assets that you can publish and retract, and how they are mapped to CentraSite assets.

Integration Server Asset	CentraSite Asset
.NET service	IS service
Adapter connection	IS connection
Adapter notification	IS type definition
Adapter service	IS service
Blaze rule service	IS service
Broker connection	IS connection
C service	IS service
Document type (IS document type and XML document type)	IS type definition
Flat file dictionary	IS type definition
Flat file schema	IS type definition
Flow service	IS service
Integration Server	IS server
Java service	IS service
JMS connection alias	IS connection
JMS trigger	IS routing rule
Map service	IS service
Package	IS package
REST resource	IS service interface Note: You cannot publish REST V2 resources to CentraSite.
Schema	IS type definition
Specification	IS specification
TN document type	TN document type
Web service connector	IS service
Web service descriptor	IS service interface
webMethods messaging trigger	IS routing rule
XML field	IS type definition
XSLT service	IS service

Publishing and Retracting Metadata

You can publish and retract IS assets, IS administrative assets, and TN document types. Designer publishes and retracts metadata using the credentials defined for a CentraSite connection in Designer. The CentraSite URL and credentials required for a CentraSite connection are specified in Designer preferences (Window > Preferences).

For more information about publishing and retracting metadata, see the information in Considerations for Publishing and Retracting Metadata and Usage Notes for IS Assets.

Considerations for Publishing and Retracting Metadata

When you publish or retract metadata for IS assets, IS administrative assets, and TN document types, keep the following points in mind:

You must configure the CentraSite URL and credentials in the Window > Preferences page in Designer. Designer uses these credentials and URL to connect to CentraSite to publish or retract metadata.
Integration Server must be able to resolve and access the host name defined in the CentraSite connection configuration in Designer.
When you publish or retract metadata at the Integration Server level, Designer publishes or retracts packages as well as administrative assets. When you publish or retract metadata at the asset level, Designer publishes or retracts metadata for the selected asset only. The selected asset could be a single asset, such as a document type, or a container, such as a folder or a package.
When publishing metadata for TN document types, you publish metadata for all TN document types on the Integration Server. When retracting metadata for TN document types, you retract metadata for all published TN document types. That is, it is not possible to publish or retract metadata for specific TN document types.
After Designer starts a metadata operation, it executes to completion. You cannot cancel the operation.
Only one metadata operation can run at a time.
If you select an Integration Server for publishing or retracting metadata, Designer lists the packages and administrative assets, if any, rather than individual publishable assets. If you select a folder or package for publishing or retracting metadata, Designer lists all the publishable or retractable assets in that folder or package.
If a folder or package contains assets that cannot be published or retracted, Designer does not list those assets in the Publish Metadata and Retract Metadata dialog boxes.
If an asset cannot be published or retracted, the Publish and Retract commands appear but are disabled in the context menu.
If CentraSite plug-ins are not installed in Designer, the Publish and Retract commands will not appear in the context menu.

Publishing Metadata for IS Assets or TN Document Types at the Integration Server Level

About this task

When you publish metadata by selecting the Integration Server and then selecting Publish from the context menu, you publish metadata at the Integration Server level. You can publish packages, IS administrative assets, and TN document types when publishing at the Integration Server level.

Before you publish metadata for IS or TN assets, do the following:

Make sure the Reuse property for the asset is set to the appropriate value. The Reuse property controls whether or not a published IS asset can be reused in BPM processes or CAF projects. .
Note: The Reuse property applies only to the namespace elements in Integration Server.
Review the information related to publishing assets mentioned in Usage Notes for IS Assets.

To publish metadata for IS assets or TN document types at the Integration Server level

Procedure

In the Service Development perspective, in Package Navigator view, select the Integration Server that contains the assets that you want to publish.
Right-click the selected Integration Server and select Publish.

If a CentraSite connection is not yet configured, Designer displays the Preferences window and prompts you to configure a connection. For more information about configuring a connection, see the CentraSite Help.
In the Publish Metadata dialog box, under Select the packages to publish, do the following:
- To publish metadata for packages, select the packages that you want to publish.
  Note: Designer lists all the packages that can be published to CentraSite. You can select multiple packages by pressing the CTRL or SHIFT keys.
- To publish metadata for TN document types, select Trading Networks Document Types.
If you want Integration Server to automatically publish metadata for packages on which the selected packages depend, select the Auto-select package dependencies check box.
Click Next if you want to publish administrative assets. Otherwise, click Finish.

Note: The Next button will be disabled if there are no administrative assets to publish.
Under Select the administrative assets to publish, do one of the following:
- To publish all administrative assets, select the Administrative assets check box.
- To publish specific administrative assets, select the check boxes next to the administrative assets that you want to publish.
Click Finish.

Designer publishes the metadata and displays the progress of the operation in the Metadata Publish Status Job dialog box. To close the Metadata Publish Status Job dialog box, click Cancel. Clicking Cancel does not cancel the operation.

After publishing metadata, Designer displays a summary of the publish operation in the Published Metadata dialog box on completing the publish operation. Click OK to close the dialog box.

Retracting Metadata for IS Assets or TN Document Types at the Integration Server Level

About this task

When you retract metadata by selecting the Integration Server and then selecting Retract from the context menu, you retract metadata at the Integration Server level. You can retract metadata for packages, IS administrative assets, and TN document types when you retract metadata at the Integration Server level.

Before you retract metadata for published assets, review the information given in Considerations for Publishing and Retracting Metadata and Usage Notes for IS Assets.

To retract metadata for IS assets or TN document types at the Integration Server level

Procedure

In the Service Development perspective, in Package Navigator view, select the Integration Server that contains the assets that you want to retract.
Right-click the Integration Server and select Retract.

Note: If a configured CentraSite connection does not exist, Designer displays the Preferences window and prompts you to configure a connection. For more information about configuring a connection, see CentraSite Help.

If there are no metadata for packages, IS administrative assets, or TN document types to retract from CentraSite, Designer displays a message stating that there are no metadata to retract.
In the Retract Metadata dialog box, under Select the packages to retract, do the following:
- To retract metadata for packages from CentraSite, select the packages that you want to retract.
  Note: Designer displays all the published packages from the selected Integration Server. You can select multiple packages by pressing the CTRL or SHIFT keys.
- To retract published metadata for TN document types, select Trading Networks Document Types.
Click Next if you want to retract metadata for published administrative assets. Otherwise, click Finish.

Note: The Next button will be disabled if there are no published administrative assets to retract.
Under Select the administrative assets to retract, do one of the following:
- To retract metadata for all published administrative assets, select the Administrative assets check box.
- To retract metadata for specific administrative assets, select the check boxes next to the administrative assets that you want to retract.
Click Finish.

Designer retracts the metadata and displays the progress of the operation in the Metadata Retract Status Job dialog box. To close the Metadata Retract Status Job dialog box, click Cancel. Clicking Cancel does not cancel the operation.

Designer displays a summary of the retraction in the Retracted Metadata dialog box on completing the operation. Click OK to close the dialog box.

Publishing Metadata for IS Assets or TN Document Types at the Asset Level

About this task

When you publish metadata by selecting specific assets and then selecting Publish from the context menu, you publish metadata at the asset level. You can publish metadata for individual assets, such as a package, a folder, or an element to CentraSite. You can also publish metadata for TN document types collectively by selecting Trading Networks Document Types.

Note: You can only publish metadata for IS administrative assets by publishing at the Integration Server level.

To publish metadata for IS assets or TN document types at the asset level

Procedure

In the Service Development perspective, in Package Navigator view, do the following:
- To publish metadata for a specific asset such as a package, a folder, or an element, select the asset.
- To publish metadata for TN document types, select Trading Networks Document Types.
  Note: When publishing metadata for TN document types, you must publish all available TN document types. That is, it is not possible to publish metadata for specific TN document types.
Right-click and select Publish.

Note: If a CentraSite connection is not yet configured, Designer displays the Preferences window and prompts you to configure a connection. For more information about configuring a connection, see the CentraSite Help.
In the Asset Publish dialog box, select the assets that you want to publish.

By default, all the assets you selected in the Package Navigator view will be marked for publishing to CentraSite. If you selected a package or folder in the Package Navigator view, Designer lists all the publishable assets in the folder or package.
- To deselect any of the selected assets, clear the check box next to the asset.
- To deselect all the selected assets, click Deselect All.
- To select an asset, select the check box next to the asset.
- To select all the assets, click Select All.
Click OK.

Designer publishes the metadata and displays the progress of the operation in the Metadata Publish Status Job dialog box. To close the Metadata Publish Status Job dialog box, click Cancel. Clicking Cancel does not cancel the operation.

After publishing metadata, Designer displays a summary of the publish operation in the Published Metadata dialog box. Click OK to close the dialog box.

Retracting Metadata for IS Assets or TN Document Types at the Asset Level

About this task

When you retract metadata by selecting specific assets and then selecting Retract from the context menu, you retract metadata at the asset level. You can retract metadata for individual assets, such as a package, a folder, or an element from CentraSite. You can also retract metadata for TN document types collectively by selecting Trading Networks Document Types.

Note: You can only retract metadata for IS administrative assets by retracting at the Integration Server level.

To retract metadata for IS assets or TN document types at the asset level

Procedure

In the Service Development perspective, in Package Navigator view, do the following:
- To retract metadata for a specific asset such as a package, a folder, or an element, select the specific asset.
- To retract published metadata for TN document types, select Trading Networks Document Types.
  Note: When retracting metadata for TN document types, you must retract all published TN document types. That is, it is not possible to retract metadata for specific TN document types.
Right-click and select Retract.

Note: If a CentraSite connection is not yet configured, Designer displays the Preferences window and prompts you to configure a connection. For more information about configuring a connection, see the CentraSite Help.

If none of the assets that you selected was published to CentraSite, Designer displays a message stating that the assets do not exist in CentraSite and cannot be retracted. If you have selected multiple assets and at least one of the assets can be retracted from CentraSite, this message does not appear.
In the Asset Retract dialog box, select the assets that you want to retract.
By default, the assets you selected in the Package Navigator view will be marked for retraction from CentraSite. If you right-clicked a package or folder in the Package Navigator view, Designer lists all the published assets in the folder or package and selects them for retraction. You can deselect the assets that you do not want to retract.
- To deselect any of the selected assets, clear the check box next to the asset.
- To deselect all the selected assets, click Deselect All.
- To select an asset, select the check box next to the asset.
- To select all the assets, click Select All.
Click OK.

Designer retracts the metadata and displays the progress of the operation in the Metadata Retract Status Job dialog box. To close the Metadata Retract Status Job dialog box, click Cancel. Clicking Cancel does not cancel the operation.

Designer displays a summary of the retraction in the Retracted Metadata dialog box on completing the operation. Click OK to close the dialog box.

Usage Notes for IS Assets

Keep the following information in mind when publishing and retracting metadata for IS assets:

You cannot retract a published asset that is referenced by another published asset until the asset that established the reference is retracted. For example, suppose that you publish a process (processA), that uses an IS service (serviceA). Then, you publish the package (packageA) that contains serviceA. Because processA depends on an asset in packageA, you can only retract packageA (and any of its contents) after you retract processA. If you change processA so that it no longer references serviceA and republish processA, you can retract packageA.
Uninstalling Integration Server can cause any published Integration Server assets to become unreferenced, or orphaned. Retract any published Integration Server assets before uninstalling the Integration Server that contains those assets.
If a published IS asset is in pending state in CentraSite, retracting the package that contains the IS asset results in an orphaned asset in CentraSite. For example, suppose that you published a package containing an IS service to CentraSite. If you change the life cycle state of the IS service asset to “Deploy” and then retract the package while the state change is pending, the IS service asset is not deleted when the package is retracted. The IS service asset becomes an orphaned asset in CentraSite.
CentraSite only establishes the “Uses” relationship between the IS Service Interface asset created for a consumer Web service descriptor and the Service asset created for a web service if the Service asset exists in CentraSite before you publish the consumer Web service descriptor.
If you create the web service asset in CentraSite by importing its WSDL after publishing the consumer Web service descriptor, republish the consumer Web service descriptor to establish the “Uses” relationship between the IS Service Interface asset created for the Web service descriptor and the Service asset created for the web service.
You can use the scheduler capabilities within Integration Server to schedule the pub.metadata.assets:publishPackages service to publish information about Integration Server packages and administrative assets to CentraSite. The pub.metadata.assets:publishPackages service publishes metadata to CentraSite using Integration Server credentials. For more information about configuring CentraSite credentials on Integration Server, see webMethods Integration Server Administrator’s Guide. For more information about scheduling services, see webMethods Integration Server Built-In Services Reference.
To establish the correct relationships between Web service descriptors created from WSDL documents and the CentraSite Service asset, use the New wizard in Designer to create the Web service descriptor and select CentraSite as the source location. If you create a Web service descriptor from a WSDL in CentraSite through the UDDI registry or directly from a file or URL, the “Uses” and “Implements” relationships will not be established between the Web service descriptor and the CentraSite service asset.
If you intend to change the compatibility mode of a Web service descriptor for which you published metadata to CentraSite, first retract metadata for the Web service descriptor. Next, change the compatibility mode. Finally, republish metadata for the Web service descriptor to CentraSite.
Each asset in CentraSite has a “Deployed On” property that identifies each Integration Server from which an asset with that name has been published. However, the Integration Servers might have published different versions of the same asset or completely different assets that happen to have the same name. In CentraSite, it will appear as if both Integration Servers published the exact same asset. CentraSite will maintain the asset that was most recently published.
For example, suppose that Integration Server1 publishes a service named myService. CentraSite creates an IS service asset with the name myService and a “Deployed On” property value of Integration Server1. Later, Integration Server2 also publishes a service named myService but the service published by Integration Server2 is not identical to the service published by Integration Server1. CentraSite will update the IS service asset to represent the myService service published Integration Server2. CentraSite also updates the “Deployed On” property value to be: Integration Server1, Integration Server2. CentraSite indicates that both Integration Servers published an identical asset when, in fact, they did not.

When an Integration Server retracts an asset, CentraSite removes that Integration Server from the “Deployed On” property for the CentraSite asset. If the asset is not deployed on another Integration Server, CentraSite removes the asset. If the asset is deployed on another Integration Server, the asset remains in CentraSite. The content of the CentraSite asset will be the asset that was most recently published. This might result in a CentraSite asset whose content does not represent the IS asset that was published by the Integration Server listed in the “Deployed On” property.

To continue the above example in which Integration Server1 and then Integration Server2 published different versions of services named myService, if Integration Server2 retracts myService, CentraSite removes Integration Server2 from the “Deployed On” property value. However, the content of the myService asset in CentraSite represents the myService asset published by Integration Server2 because Integration Server2 published the asset most recently. This results in CentraSite indicating that the myService asset published by Integration Server2 is deployed on Integration Server1.

Status Information for Publish and Retract Requests

During and after execution of publish and retract requests, Designer displays status information for each package in the request and the overall request.

Status	Description
`complete`	Integration Server completed the publication or retraction request.
`error`	An error occurred while publishing or retracting the metadata. Refer to the Integration Server log for more information.
`retracting`	Integration Server is removing the assets from CentraSite. This status applies to retraction requests only.
`publishing`	Integration Server is sending the metadata to CentraSite. This status applies to publication requests only.
`starting`	Integration Server is starting the request. This is always the initial state when a request is submitted.
`counting`	Integration Server is counting the number of assets in the package or the number of TN document types.
`counted`	Integration Server has completed counting the number of assets in the package or the number of TN document types. The total number is displayed in the Assets column.
`extracting`	Integration Server is extracting the metadata for selected assets.

Summary Information for Publish and Retract Requests

Designer displays the following information about the metadata for IS assets, IS administrative assets, or TN document types in the Published Metadata and Retracted Metadata windows.

Column	Description
Asset	If a package was selected for metadata publication or retraction, this column displays the package name. If Trading Networks Document Types was selected for metadata publication or retraction, this field displays `Trading Networks Document Types`.
Status	The status of the metadata operation. For more information about status values for metadata operations, see Status Information for Publish and Retract Requests.

The Published Metadata and Retracted Metadata windows display the following summary information for the entire publication or retraction request:

Field	Description
Status	The overall status of the publication or retraction request.
Assets	The total number of assets processed in the publication request. This field only applies to publish requests.
Duration	The time (in hh:mm:ss) Integration Server spent executing the publication or retraction request.