Defining document providers

Besides printing to the Document Output Management device, documents can be added to Document Output Management through a document provider.

To define a new document provider:

  1. Create a new library, for example tssocdomflpr, with this content: 
    #include <bic_dom>

function extern domain ttxmlnode get.metadata()
{
	FunctionUsage
	Expl:	Provides the document provider meta data in datafields and optionally contexts.
		Example implementation which assumes the bic_dom be included:
		
		domain	ttxmlnode	meta.node
		
		meta.node = dom.provider.metadata.init()
		
		dom.provider.metadata.add.field("filename", "Filename", "ttaud.path", meta.node)
		dom.provider.metadata.add.field("docname", "Document name", "ttaud.path", meta.node)
		dom.provider.metadata.add.field("extension", "Extension", "ttst10", meta.node)
		
		
		dom.provider.metadata.add.context("new", "New file", meta.node)
		dom.provider.metadata.add.context("update", "Updated file", meta.node)
	
		return (meta.node)
	Pre:	-
	Post:	-
	Input:		-
	Output:	
	Return:	domain ttxmlnode an XML node containing the meta data describing the 
		document provider
	EndFunctionUsage
		
	domain	ttxmlnode	meta.node
	domain	ttxmlnode	duml.node
	
	meta.node = dom.provider.metadata.init()
	
	duml.node = dom.provider.metadata.add.field("filename", "Filename", "ttaud.path", meta.node)
	duml.node = dom.provider.metadata.add.field("docname", "Document name", "ttaud.path", 
		meta.node)
	duml.node = dom.provider.metadata.add.field("extension", "Extension", "ttst10", meta.node)
	
	
	duml.node = dom.provider.metadata.add.context("new", "New file", meta.node)
	duml.node = dom.provider.metadata.add.context("update", "Updated file", meta.node)

	return (meta.node)
}
  2. Start the Document Providers (ttrpi2556m000) session.
  3. Create a new Document Provider. Specify this information:
    Document Provider
    Files.
    Description
    File Provider.
    Library
    tssocdomflpr
  4. Save the record.
    The get.metadata method of the document provider library is called. The fields and contexts are shown in the Document Provider details.

    When the document provider library is updated you must refresh the Document Provider data with the refresh option in the Document Provider details.