1. Services Reference for Oracle WebCenter Content
  2. Link Manager Services

14 Link Manager Services

This chapter describes the Oracle WebCenter Content services available when using and customizing the Link Manager component.

This chapter covers the following topics:

About Link Manager Services

The Link Manager component evaluates, filters, and parses the URL links of indexed content items before extracting them for storage in a database table (ManagedLinks). After the ManagedLinks table is populated with the extracted URL links, the component references this table to generate link search results, lists of link references for the Content Information page, and the resource information for the Link Info page.

Information about what is a WebCenter Content service and how services can be used is provided in Using Services. Information about basic services structure, attributes, actions, and a service example is provided in Customizing Services. You should be familiar with this information before customizing current services or creating new services

The locations for specific Link Manager services are listed within each individual service.

For more information about Link Manager, see Using the Link Manager Component in Managing Oracle WebCenter Content.

Link Manager Services

The following services are used in Link Manager functions:

ABORT_LINKS_ACTIVITY

This service is used to stop the current activity that Link Manager is performing.

You must be logged on to the Content Server instance with administrator credentials to execute this service. This service is also available from the Link Manager Admin page.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=ABORT_LINKS_ACTIVITY

ADD_MANAGED_DOCLINKS

This service is used to extract HTML links out of the given input file. It is executed automatically when content items are indexed

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=ADD_MANAGED_DOCLINKS

DELETE_MANAGED_DOCLINKS

This service is used to remove the managed links in the database for a given content item. It is executed automatically when content items are deleted.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=DELETE_MANAGED_DOCLINKS

GET_LINK_INFO

This service is used to display link information for a given content item.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Additional Required Service Parameters

  • dLkClassid: The unique class ID assigned to a link in the ManagedLinks table.

Results

  • ResultSets:

    • DOC_INFO (standard metadata fields)

    • LinkInfo:

      • dLkGUID: Unique ID assigned to a row in the ManagedLinks table.

      • dLkClassId: Unique ID assigned to the link in the ManagedLinks table.

      • dDocName: Doc name where the link was discovered.

      • dLkType: Type of link, which is one of the following: external, unknown, ss_link_rel, ss_link_page, ss_link_node, ss_link_page, ss_link_node, ss_link_internal, ss_link_page, ss_link_page, ss_link_node, ss_link_abs.

      • dLkOriginalUrl: Original URL of the link.

      • dLkContainerID: Site Studio siteId where the link was found.

      • dLkResource: Value of one of the following: dID, dDocName, ssDocName, nodeId (depending on dLkResourceType value, this is null for external links).

      • dLkResourceAlias: The docName or nodeLabel.

      • dLdResourceType: One of the following: id, doc, node.

      • dLkHasAlias: (Boolean) Indicates whether an alias exists.

      • dLkState: Y or N. Y means a link references a checked in content item and is valid. N means a link references a deleted content item and is invalid.

      • dLkCreateTs: Timestamp when the link was created.

      • dLkUpdateTs: Timestamp when the link was last updated.

      • dLkCycle: Flag used to tell LinkManager who is working on this link (A - Refresher, D - Decoder, null - none)

Example

IdcService=GET_LINK_INFO
dLkClassId=652

Sample return information. The beginning of the ResultSet shows how many fields exist (14 in this example) along with the names of the columns, the data types (string, date, integer, and so on), and the size of the fields in bytes. After these entries the values for these fields are listed in the next 14 rows. If there are multiple entries in a result set, another set of 14 rows is listed, and so on.

@ResultSet LinkInfo14
dLkGUID 6 30
dLkClassId 3 38
dDocName 6 30
dLkType 6 20
dLkOriginalUrl 6 1024
dLkContainerId 6 50
dLkResource 6 50
dLkResourceAlias 6 50
dLkResourceType 6 50
dLkHasAlias 6 1
dLkState 6 1
dLkCreateTs 5 20
dLkUpdateTs 5 20
dLkCycle 6 1

GET_LINKS_ADMIN_PAGE

This service is used to obtain the status of the current Link Manager activity. Used by the Link Manager admin page to display status.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=GET_LINKS_ADMIN_PAGE

LK_GET_SEARCH_RESULTS

This service is used to search for links to and from content items.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

This example opens a form that when submitted will execute the LK_GET_SEARCH_RESULTS service.

IdcService=LK_SEARCH_FORM

RECOMPUTE_MANAGED_LINKS

This service is used to extract URL links of indexed documents; evaluate, filter, and parse the URLs according to a pattern engine; and then store the results in a database table.

You must be logged on to the Content Server instance with administrator credentials to execute this service. This service is also available from the Link Manager Admin page.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=RECOMPUTE_MANAGED_LINKS

REFRESH_MANAGED_DOCLINKS

This service is used to refresh the links for a specific document. A refresh does not involve extracting the links again. It iterates through the links as they are listed in the database and determines their current status.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=REFRESH_MANAGED_DOCLINKS

REFRESH_MANAGED_LINKS

This service is used to refresh the managed links as they exist in the MANAGEDLINKS database table. The managed links are not re-extracted from the content items like in RECOMPUTE_MANAGED_LINKS.

You must be logged on to the Content Server instance with administrator credentials to execute this service. This service is also available from the Link Manager Admin page.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=REFRESH_MANAGED_LINKS

REFRESH_REFS_MANAGED_LINKS

This service is used to perform a recount on the content references as they exist in the MANAGEDLINKS table. Each content item is referenced in the table and will be tallied and stored in the reference table.

You must be logged on to the Content Server instance with administrator credentials to execute this service. This service is also available from the Link Manager Admin page.

Location: IdcHomeDir/components/LinkManager/resources/linkmanager_service.htm

Example

IdcService=REFRESH_REFS_MANAGED_LINKS