Folio Crawl Component Readme

Ed Bryant - December 2008

Introduction

This component add a service that crawls a folio structure and returns the folio elements in a result set.

Service Description

Service Name: FOLIO_CRAWL

Service Parameters:

Service Result Sets:

FolioResults Result Set

The FolioResults set returns the content and structure of the folio, with one row for each node, link (slot pointing to an external link), and slot (which may or may not contain a content item), as outlined below:

Result Set Column Name Column Values by Folio Element Type
Folio Nodes (including root node) Slots with External Links Slots without a content item Slots with a content item
id the node GUID the slot GUID the slot GUID the slot GUID
type "node" "link" "slot" "slot"
level level in the hierarchy (root is 0 level) level in the hierarchy (root is 0 level) level in the hierarchy (root is 0 level) level in the hierarchy (root is 0 level)
title the node name the link name the name of the slot the title (dDocTitle) of the content item -
may be changed by editing the folio.
description the node description the link description the slot description the slot description
dDocTitle       dDocTitle metadata
dDocName       dDocName metadata
dRevLabel       dRevLabel metadata
dID       dID metadata
dDocType       dDocType metadata
dDocAuthor       dDocAuthor metadata
docURL   the link URL   web viewable URL
thumbNailURL       thumbnail URL
dFormat       dFormat metadata