database publishing in adobe framemaker 11 publishing is an automated multichannel and multi-device...

Adobe® FrameMaker® 11 White Paper

Database Publishing in Adobe FrameMaker 11

IntroductionDatabase publishing is important for businesses of all sizes in all industries. Every enterprise needs to distribute information internally and externally. From company phone directories to online product catalogs to 3D media content, database publishing enables timely, effective communication. A well-implemented database publishing system can help companies reduce the time and expenses associated with publishing and improve information quality.

What is database publishing? Database publishing is a form of automated media production in which source data resides in traditional databases (in the form of text, pictures, and metadata related to formatting and special rules regarding document generation). The data is then aggregated and converted into multiple formats for publication and distribution. Such formats include Adobe Portable Document Format (PDF) and Hypertext Markup Language (HTML), including HTML5, for the Internet, ePub, and Kindle formats, help outputs for online help systems, Extensible Markup Language (XML), which can be delivered to VoiceXML browsers and mobile devices, and formats for native apps that can be viewed on mobile devices without an Internet connection. The goal for many organizations is to create content once and publish it across multiple formats. Through Adobe Technical Communication Suite 4, FrameMaker can also publish to multiscreen HTML5 for delivery on mobile devices such as tablet computers and smartphones.

Database publishing occurs in two broad categories: automated, tagged publishing or data-driven, dynamic publishing. Automated publishing is the process in which a flat file (e.g., a large text file with special markups or tags) is parsed and published. Data-driven publishing is the process in which data is retrieved dynamically (in real time) from a database and published (in real time) without the need for an intermediate markup language or text file.

All forms of database publishing share common characteristics. First, data must be presented so users can easily find what they need. Data also must be formatted for effective presentation, and presentation must be customized according to the needs of a specific audience or user. Finally, automated database publishing should meet the demand for timely, consistent information delivery.

Contents 1 Introduction 2 Applications of server-

based publishing 5 Document types 8 Data sources 9 The FrameMaker

database publishing solution

11 Implementing a FrameMaker solution

16 Next steps 18 Conclusion

2 Adobe FrameMaker 11 White Paper

The goals of this documentThis white paper explains the basics of database publishing and how implementations can vary by industry and document type. It also discusses the unique capabilities within Adobe FrameMaker, and describes how to successfully implement FrameMaker, including integration with third-party database publishing tools such as PatternStream software from Finite Matters Ltd. (FML), Miramo software from Datazone, and R4i Illustrated Parts Data (IPD) Manager from Absolute Data Group (ADG).

Applications of server-based publishing Server-based publishing is an automated multichannel and multi-device database publishing solution. It enables publication departments to centralize and automatically schedule publication tasks using database documents. Server-based publishing is ideal for organizations that need to deliver large volumes of high-quality technical content via multiple channels in many formats to different types of devices. Server-based publishing can reduce the production cycle for frequently updated documents and can also create opportunities for new types of documents. Database content typically comes from web servers, content management systems (CMS), parts and Product Lifecycle Management (PLM) servers, application servers, and database servers. Distribution can occur within a closed network to a finite audience or through a cloud-computing environment with the potential to reach a global audience. Server-based publishing solutions are typically tailored to meet publishing needs according to:

• Industry

• Documenttype

• Datasource

Industry overview While database publishing is important to most industries, the types of source data, required output formats, and desired levels of personalization and customization typically depend on industry-specific needs and standards. To some companies, the most important documents are internally circulated; to others, publishing information for external audiences is either an important part of doing business or the main focus of their business. Database publishing solutions, including server-based publishing applications, are commonly found in the following industries and organization types:

• Engineering •Insurance

• Financialservices •Manufacturing

• Government •Pharmaceuticals

• Healthcare •Publishing

Engineering Engineering projects typically require extensive documentation. Engineering documents can be visually complex, including flow charts, schematics, and computer aided design (CAD) diagrams. Publishing tools used by engineering companies must effectively integrate complex graphics and text.

Engineering is also a collaborative effort, and engineering organizations usually house shared information in databases and file management systems. Database publishing lets users share the information with no worries about changes occurring in one place and not in another.

The design and production of an asset starts with engineering information in the form of drawings, bills of materials, and supporting technical information. When a concept is approved, technical writers, illustrators, and engineers collaborate to produce intelligent parts information supported by in-depth operating and servicing information. Typically, spreadsheets and/or databases contain parts information while illustrations are stored in repositories or on network drives. The collation, editing, and publishing of the required publishing data can be complex and time-consuming.


For example, Absolute Data Group’s R4i Illustrated Parts Data Manager automates the process of assembling, validating, and creating parts data, speeding time to market and eliminating human error from the parts data production cycle. Designed to connect to disparate information systems, including Microsoft SQL Databases, Excel spreadsheets and the R4i S1000D CSDB Server Suite, IPD Manager simply maps the data fields to the required export data sets. Non-proprietary IPD data is then generated as XML and S1000D data modules with linked illustrations. This interactive content can then be produced as a PDF, HTML, or checked into XML repositories such as R4i CSDB Server for inclusion in an intelligent, interactive R4i Viewer Package.

Financial services Financial services companies have stringent publishing standards because of consumer demand and legal and regulatory requirements. They are obligated by law to provide published information about performance and operations to government and regulatory agencies, shareholders, and the general public. Many of these required documents must include data in tables accompanied by graphs and/or charts.

Financial services have the strongest demand for personalized content: customers want access to the latest information about their portfolios, including account activity and current value. To meet these consumer demands, publishing applications must be able to access multiple systems in real time and deliver digital or print versions of documents on demand.

Government Federal, state, and local governments typically manage and publish vast amounts of information. In fact, the United States federal government is the world’s largest publisher. Government entities publish to communicate with their various audiences, including citizens, vendors, and other governments. Data-generated documents published by governments include recently passed legislation, forms, catalogs, directories, transit schedules, statistical reports, budgets, and many other types of documents. Governments face constant pressure to become more efficient and make information readily accessible. Server-based publishing solutions can help meet these demands.

Periodic financial reporting is a common requirement for federal, state, and local governments—or new one from any of the other verticals.


Healthcare Healthcare is an information-intensive industry, both for effective patient care and efficient operation. Patients need information about providers and payers, disease management, and compliance with treatments. Physicians need information about their patients, specialists in referral networks, and current research regarding therapy and medication.

Provider directories typically integrate information such as plan or provider policies with the directory listings. Thus, publishing tools for directory production must be able to integrate word processing files with data-generated content. Provider directories are often formatted in a multi-column layout and may have multiple indices.

Insurance Insurance companies maintain a variety of critical documents that contain information representing legal obligations. Accuracy is essential for insurance premium and policy information distributed to vendors, brokers, and the general public.

Insurance policies and related documents are often managed with systems that merge data from back-end databases (for example, actuarial tables) into appropriate sections of the document, or component content management systems that facilitate reuse of document components (for example, language common to many documents or document versions). Such documents typically must go through an extensive review and approval process. Database publishing systems for the insurance industry must have dynamically assembled data and document sources, and proper tools for formatting tabular information and composing graphically rich documents that are easy to exchange, read, and understand.

Manufacturing Product catalogs let prospective purchasers and distributors know what products are available, how much they cost, and other product details relevant to purchase and use of manufacturers’ inventory. Customers and distributors expect catalog information to be available 24 hours a day, seven days a week, online and offline, in print or PDF. Product catalogs often contain many pages of complex tabular information, accompanied by extensive photographs or illustrations such as exploded parts diagrams.

Product catalogs frequently contain complex illustrations and tabular information.

Information relevant to catalog production and technical documentation is generally housed in one or more databases. Related assets, such as graphics and word processing files, can be housed in the same or a different database, on file servers or in content management systems. Data and document sources may also be part of, or may interface with, an Enterprise Resource Planning (ERP) system. Because product catalogs are time sensitive, they typically require an automated database publishing process.

Depending on the number, complexity (e.g., multiple configurations/variations), and volume of the products they manufacture, manufacturing companies can place great demands on a database publishing system, particularly if they are exporting to multiple markets in multiple languages.


Pharmaceuticals One branch of healthcare with special database publishing needs is the pharmaceutical industry. It is heavily regulated and must inform physicians and other healthcare providers of current product availability, indications, dosages, known side effects, and potential drug interactions.

Accurate documentation is essential during the process of new drug review and approval by regulatory agencies, because delays due to incorrect information can delay patient access to treatment and cost the pharmaceutical company potential revenue.

Publishing Data-driven, dynamic database publishing is an important dimension of the publishing industry. With increased demand for electronic delivery and an increasing number of required media and output formats, such as HTML, eBooks, and mobile apps, it has become essential in many publishing contexts to maintain a distinction between the content and structure of source documents. Structured authoring with XML, or conversion of documents from an unstructured format into XML, can maximize the flexibility required for publishing content in multiple formats for multiple devices to meet the demands of various audiences.

On-demand publishing can be as simple as printing single editions or small quantities of a static publication in response to an order; it can also be a far more customized and data-intensive process. Users can now log on to a website, select sections from multiple publications (for example, chapters from different books), and integrate these sections into their own custom publication, which they can then receive in PDF, eBook, or printed form.

Document types Just as different industries have different database publishing needs, various document types present unique publishing challenges. Documents can be either text-centric (mostly containing text) or data-centric (mostly containing numerical or non-text data), which determines the optimal XML structure for retrieval. They can also be technical, personalized, or both. Document size can range from single-page forms, to hundreds or even thousands of pages in the case of directories and catalogs.

In the case of long, data-generated documents, sorting and grouping can be very important. For instance, an automobile parts catalog may be sorted by make, model, year, and subsequent part information such as part name or part number. Directories often have very similar sorting and grouping. In such cases, visual navigation can be aided by means of bleed tabs (that is, reverse-type vertical or horizontal bars that bleed to the side of the printed page, enabling easy section identification while thumbing through the catalog or directory), and running or “continued” headers indicating the context of particular pages within the overall grouping or sort. The indices of such long, data-generated documents may also be grouped and sorted, each with a particular sort order.

Document types that can be generated by server-based publishing applications include:

• Directories •Productcatalogs

• Financialreports •Real-timepersonalizeddocuments

• Illustratedpartsbooks •Technicaldocumentation

Directories Directories are essential documents for people, companies, and industries, and many directories have moved online or are now available in digital formats. From phone books to internal staff directories and published association listings, directories provide a means for people to quickly and efficiently find the resources they need. Healthcare provider directories, for example, may include a physician’s specialty, provider type, hospital affiliations, foreign languages spoken, and accepted health plans. Directories may also include illustrations or photographs.


Directories are often formatted in multiple columns to efficiently use the printed page.

For large directories, source information is usually housed in a database. To efficiently use the printed page, directories may be formatted in multiple columns. Directories typically include front matter (text information related to directory content), such as advertising in commercial directories. Front matter may come from word processing or page layout files.

Financial reports Financial reports include documents such as prospectuses, financial statements, annual reports, and proxy statements. Financial reporting often has to include both high-level summary information as well as detailed historical data. With financial reports, a picture often paints a thousand words: charts, graphs, and other visual displays of quantitative information let end users see the characteristics of data faster and with far less effort than reading through unformatted data.

Financial information is data-centric and most financial reports come directly from a database. As the presentation of such information is often important to the corporate image of the financial institution or business presenting the report, design quality is also critical. The scalability challenges for financial reporting are most often challenges of high throughput rather than high page count or large document size.

Illustrated parts booksIllustrated parts books (IPBs) are one of several technical publications essential to the Engineering and Maintenance Environments.

Parts and Engineering information is normally housed in a Product Lifecycle Management (PLM) database, with engineering drawings being held in a separate CAD drawing database or on network drives. In some instances spreadsheets and other documents such as XML may be supplied by Engineering.

Database Publishing Systems suitable for parts data must have the ability to access the content from the PLM and CAD databases and generate a robust print version of the IPBs spanning several hundred pages. An online version of the data that is easily navigable, including multi-directional hotspots from parts table to the exploded parts diagram, must also be generated from the same data source.

In addition to accessing parts data online, it is a common expectation by maintainers that they have the ability to make purchase transactions directly from their online parts manual while performing maintenance tasks.


Product catalogs Product catalogs are essential to companies that need to promote their products to consumers and distributors. Product catalogs typically include tabular information and often contain images (either photographs or illustrations) representing some or all products. Automated tables of contents (TOCs), indices, and cross-references are frequently a functional requirement for product catalogs because products can be referenced in multiple ways (e.g., part number, name, or function). Products may have relationships that are important for the user (for example, one part may contain component parts or be compatible with other parts). All of these functions are needed to help the user effectively navigate the catalog.

Product catalogs often integrate graphic assets including photographs.

Product information is typically housed in a database, but the production of catalogs can also include graphic and text assets from other sources. Database publishing systems suitable for product catalog generation must have the capacity to handle long documents with lengthy, complex tables and a large number of graphic objects. The ability to import from word processing documents, spreadsheets, and other document formats (such as XML) is also common.

Real-time personalized documents Users expect instant information tailored to their unique needs. For example, a user may wish to see their current stock portfolio, a listing of stores in a radius around their home address, or the results of a query based on criteria entered on a website. With automated database publishing processes, such information can be immediately displayed electronically or formatted for high-quality presentation as a PDF for use later.


Technical documentation Technical documentation is frequently mission-critical. Documentation of procedures (for example, airplane repair) demands the highest standards of clarity and accuracy. In addition to the integrity of data, text, and graphic objects used in technical documentation, effectiveness of formatting and page layout can be crucial in maximizing the clarity and usability of such vital information.

While technical documentation is essential to engineering processes and product documentation, the documents and data associated with technical documentation quite often find their way into many aspects of organizational activity. The same CAD illustration, for example, may be used in the initial design of a product as well as in subsequent sales and marketing efforts such as brochures, catalogs, and advertisements. Data, documents, and graphics created or accessed in the course of technical documentation, including operator and maintenance manuals, are often shared across departments, where they can be re-used for training manuals and online eLearning.

Data sources In the same way that the number of output media and formats has increased, the number of potential data sources available for use in database publishing applications has increased. Accordingly, a single database publishing system can aggregate data from several systems—often in multiple formats—to produce output that appears to the user as if it came from a single source. Server-based applications can publish from sources including:

• Relationaldatabases •Mainframeandlegacysystems

• Contentmanagementsystems •Internetapplications

• XMLrepositories •SpreadsheetsandCSVfiles

Relational databases The most common form of database is a relational database, which has been the traditional backbone of database publishing systems. Relational databases store information in multiple tables, typically on database servers. The capacity of databases to store information continues to increase. Even personal databases are now able to handle millions of records.

Publishing applications typically access relational databases via queries in Structured Query Language (SQL). SQL queries return database records that meet specific criteria (e.g., banking transactions for a particular customer for a particular time period). Records can be filtered to include specific fields and can be sorted based on any number of key fields. Database publishing applications typically process data received from such queries into formatted output.

Content management systemsA content management system (CMS) allows users to publish, edit and modify content, and perform system maintenance from a central interface. Such systems are typically used to manage workflow in a collaborative environment. CMS platforms allow users to centralize data editing, publishing, and modification on a single back-end interface.

CMS features vary widely. Simple systems showcase a small handful of features, while enterprise systems offer complex and powerful functions. Most CMSs include web-based publishing, format management, revision control (version control), indexing, search, and retrieval. A CMS may serve as a central repository containing documents, movies, pictures, phone numbers, and scientific data. CMSs can be used for storing, controlling, revising, semantically enriching, and publishing documentation.

XML repositories With a modest number of frequently reused files, XML content can be effectively stored as simple text files on a personal computer or file server. As the number of files or the number of participants collaborating on a single file increases, it usually becomes desirable to house XML content in a system that can provide features such as version control, check-in/check-out, and component reuse.


While it is possible to map XML data to the structure of a relational database, such mapping can often be quite inefficient. For this reason, XML repositories often use other methods of data storage. Entire XML files or XML fragments can be retrieved by database publishing systems for formatting. The advent of DITA and other forms of XML publishing have led to the proliferation of component content management systems (CCMS.)

Internet applications Not all of the content flowing into database publishing applications comes from persistent data storage such as a relational database, CMS, XML repository, or mainframe system. Data often comes from Internet applications such as web servers, application servers, web browsers, or mobile applications. For example, a user requesting an online financial report will typically enter information into an HTML form. Upon submission of the form, the user will receive a formatted report. The report may include information submitted in the form as well as information accessed by querying a database.

With web services now a standard form of content delivery, an increasing number of systems exchange information by means of XML messages. There are, for example, standards for XML purchase orders and ordering processes that facilitate business-to-business (B2B) transactions. Such XML messages can also serve as data sources for Internet-based publishing systems.

The FrameMaker database publishing solution Adobe FrameMaker 11 is best-in-class database publishing software that simplifies authoring, increases enterprise productivity, helps enrich user experiences with rich multimedia, and enables publishing to multiple channels, formats, and screens.

Core features of FrameMaker FrameMaker helps technical authors and editors work more effectively. Today’s technical communicator needs tools to take advantage of established and emerging trends and technologies, such as XML, S1000D, DITA, PDF, HTML5, and rich media. Previous releases of Adobe FrameMaker software made dramatic strides in what users could create with rich content. FrameMaker 11 dramatically improves content creation and substantially reduces the amount of time required to perform common and complex authoring, editing, and publishing tasks.

Besides its layout and formatting capabilities, FrameMaker integrates easily with Adobe FrameMaker Publishing Server 11. FrameMaker Publishing Server 11 is an enterprise scheduling and publishing engine that helps large publishing operations configure, customize, and automate high-volume, professional-quality documents.

The streamlined user interface in FrameMaker, with the ability to save custom workspaces, dramatically improves efficiency. FrameMaker lets authors and editors use floating toolbars and control bars, dock the most frequently used dialog boxes for quick access, and create customized workspaces. In addition, the fully integrated authoring environment allows users to create, edit, and publish technical content with powerful features for automatic numbering, cross-referencing, creating tables of contents, indices, books, and more. It also simplifies formatting via templates, and the integration of tables, graphs, and images.

Scripting is a powerful tool that can be used to control and automate many features of Adobe FrameMaker. It saves time and effort by eliminating some of the repetitive manual tasks. FrameMaker scripts provide the necessary depth to handle sophisticated jobs. There are two ways of running scripts: from within FrameMaker and by using the ExtendScript Toolkit (ESTK).

Easily authoring XML/DITA content

Adobe FrameMaker 11 gives content authors and editors multiple options for managing content. By using the native XML Code View, authors can manipulate XML documents with a variety of editing features, including customized toolbars, the inline attribute editor, automated error tracking, Intelliprompt of attributes and elements, searching with XPath, and advanced XSLT features. Similarly, XSLT 2.0 support in FrameMaker lets users create a variety of transformation scenarios by applying pre-defined or customized XSLT to XML files. These transformations can be executed using a range of JAXP-compliant processors, such as Xalan and Saxon. And users can define the scope of the transformation—a file, all files of a folder, DITA map, or all “children” of a book element.


Automation, simplification, customization

XPath 2.0 support helps eliminate the need to browse through numerous lines of XML code. The XPath Pod helps users find elements and automatically apply functions to them. This pod also lets users customize their query builders, get suggestions, define the scope of queries, use the history dropdown feature, and save search results for greater productivity. Comprehensive DITA support helps users meet consistency and authoring needs and specific output requirements through customized information models with automatic generation of DITA 1.2 elements (such as titles, tables of content, and indexes), page rounding, and numbering.

Helpful views

In the Author View, authors and editors can focus on writing content without worrying about page breaks and text formatting. The Author View speeds up content creation prior to customizing appearance and output. Meanwhile, the WYSIWYG View helps prepare documentation for publishing and sharing with the user community. Authors and editors can use the WYSIWYG View to apply and modify styles, themes, and formats. It allows creators to view content as users will see it, and also to view how much (e.g. page count) content they have created. Finally, customizable banner text suggestions for various content elements eliminate the need to constantly refer to the document structure, which further speeds production.

Powerful, scalable single sourcing

In FrameMaker 11, users can effortlessly single-source variations of the same document for different channels and purposes. Multi-level Boolean expressions can be built to define output filters in topic-based, structured, and unstructured modes. Content can also be managed and reused by taking advantage of support for multi-value attributes in structured content and the ability to import expressions from one document to another.

Increase enterprise productivityAdobe FrameMaker 11 helps users create high-impact enterprise content faster with productivity features for individual contributors and collaborating teams. For instance, API-based connectivity with CMS and CCMS, automatic content suggestions, Smart Paste, Quick Catalogs, error-tracking, and scripting help speed up authoring. A range of productivity features such as Intelliprompt of elements and attributes, template based structure suggestions, automatic end tag insertion, dynamic validation, and pretty printing substantially accelerate workflow. FrameMaker 11 also smoothly integrates with best-of-breed CMSs such as EMC Documentum and Microsoft SharePoint via built-in connectors or third-party plug-ins.

Automation, usability, and scripting

Users can easily automate time-consuming, repetitive tasks through advanced scripting support with Adobe ExtendScript. Running scripts for simple tasks from within Adobe FrameMaker or through the ExtendScript Toolkit can eliminate manual effort and help increase productivity. Adobe FrameMaker also offers workflow efficiencies through popular, pre-built, standards-compliant tools and templates. Utilities like Auto Spell Check, Highlight Support, scrolling for lengthy dialogue, and enhanced Find and Replace help get the job done faster and smarter. In addition, users can compare any two documents through the Compare Documents user interface, which automatically marks changes through Track Text Edits in the composite document.

Do more with rich multimediaAdobe FrameMaker 11 makes it easy to enhance the user experience by adding interactive media, such as MP4, FLV, and SWF videos, Object Styles, and images. Publishers can also enhance videos by selecting posters and creating links with adjacent text to play, pause, or jump to selected scenes. Furthermore, improved readability and usability is easy with Hotspot insertion over images, vector illustrations, and objects (or parts of them). Users can also convert shapes to Hotspots. When working with 3D graphics, authors and editors can link them with relevant parts of a document, enabling users to switch between parts of 3D graphics and the associated descriptions by inserting bi-directional links. An automatically hyperlinked table of parts, views or animations may also be instantly generated from a selected 3D graphic. The ability to create, save, and apply Object Styles gives content a consistent look and feel.

An example of gray, customizable banner text in a new DITA topic created in FrameMaker.


Publish to multiple channels, formats, and screensIt’s never been easier to publish HTML5 content virtually anywhere with Adobe FrameMaker Publishing Server 11 or Adobe Technical Communication Suite 4. The suite is a powerful toolkit that integrates authoring, multimedia, multichannel, and multiscreen capabilities. Adobe Technical Communication Suite 4 includes XML/DITA content creation with Adobe FrameMaker 11, virtual publishing with Adobe RoboHelp® 10, and interactive content development using Adobe Illustrator® CS6, Adobe Captivate® 6, and Adobe Presenter 8. Publishers can output to almost any device by simply specifying the screen size and layout because of the HTML5 integration built into Adobe FrameMaker Publishing Server 11 or Adobe Technical Communication Suite 4. Now content can be published to iPads and other tablets, smartphones, and desktops in a wide range of popular formats. Print-ready CMYK PDF files are also an option.

DITA content can be easily published to create professional-looking output. Nested books and books with flat components are easily generated. Attractive book content can be created from DITA maps by automatically generating titles, tables of content, indices, applying number properties, and page rounding.

Implementing a FrameMaker solutionThere are several ways to implement an Adobe FrameMaker 11 solution. The following examples illustrate some of the ways the software improves productivity and document integrity:

•BuildingasolutionwithFrameMakerPublishingServer

•UsingsolutionsfromAbsoluteDataGroup

•UsingMiramo

•UsingFMLPatternStream

Building a solution with FrameMaker Publishing ServerAdobe FrameMaker Publishing Server 11 is a separate product and may be purchased from Adobe. It lets users create multiple output formats with unique FrameMaker Publishing Server settings for device-independent content delivery. These output formats include Adobe PDF, WebHelp, Adobe AIR®-based Help, Native Mobile App, and ePub. By centralizing and automating publication, it is easy to integrate and synchronize publication of documents with other critical business schedules. FrameMaker Publishing Server integrates easily with server-based content management systems such as EMC Documentum and Microsoft SharePoint, enabling users to efficiently manage publication tasks and enforce version control.

Building a solution without third-party tools typically requires customization by means of the FrameMaker Developer Kit (FDK). There are three principal methods of leveraging the power of FrameMaker Publishing Server in custom-built solutions:

•UsingtheXMLcapabilitiesofFrameMaker

•UsingMIF

•UsingtheFDKtodirectlycontroltheFrameMakerformattingengine

The best method for a particular publishing need depends on factors such as the nature of the data sources, the type of desired output, and the role of the publishing application in overall workflow and system architecture.

Using the XML capabilities of FrameMaker

The FrameMaker desktop product provides a robust, structured authoring environment for XML and a means of formatting XML for high-quality print and PDF output. Its structured authoring capabilities allow you to define context-determined styles to XML via templates developed in a WYSIWYG environment. All of the XML formatting capability of this desktop product can be used with FrameMaker Publishing Server in server-side publishing applications.

With structured applications defined in the desktop product, you can specify an association between XML document type definitions (DTDs), FrameMaker templates, and other files required to format XML. Central to the formatting process are structured templates, which are FrameMaker documents that store document properties such as layout, formatting, and structure.


With this method of server-side publishing, XML that conforms to the same XML DTD of the FrameMaker structured application is streamed into FrameMaker under control of a lightweight FDK client. The source XML is formatted for print or PDF output according to the rules of the structured application. Such a template-driven workflow can provide a powerful means of presenting XML content.

Using MIF

The capability of FrameMaker to save and load files in maker interchange format (MIF), a text-based, easily parsed format, provides another way of using FrameMaker Publishing Server in database publishing applications. The MIF language and syntax are documented in the Adobe MIF Reference. MIF provides an excellent intermediate format for manipulating non-XML FrameMaker documents programmatically in server-based applications.

In application architectures centered on MIF, a database publishing application typically extracts database content and wraps it with appropriate MIF code for automatic publishing. It is also possible to translate application-generated data to MIF, or to transform source XML files to MIF via XSLT.

It is not a requirement to dynamically generate every component of MIF input. MIF provides an include facility, so static components such as format catalogs can reside on the server and be referenced in the MIF that streams in rather than redundantly passed for each document.

As with FrameMaker Publishing Server applications built around the XML capabilities of FrameMaker, applications that stream MIF into FrameMaker Publishing Server can be automated by means of a lightweight FDK client. In this case, however, formatting for published output is already explicitly defined by the MIF itself, requiring less processing on the server.

Using the FDK

Another method of database publishing built around FrameMaker Publishing Server involves using the FDK client in a more central capacity than it is used with XML- and MIF-based applications. The FDK client can completely control the FrameMaker Publishing Server application, including management of the interface with external data sources and content destinations, creation and manipulation of FrameMaker document objects, and publishing either paginated pages and documents or export data such as XML or Standard Generalized Markup Language (SGML).

In such an architecture, the FDK establishes a connection to and queries data sources (which can include databases, XML sources or application-generated data), then programmatically composes and publishes documents based on the source content.

Using solutions from Absolute Data GroupR4i Illustrated Parts Data Manager is a third-party solution from Absolute Data Group that leverages the industry XML Schemas provided in FrameMaker 11, such as DITA and S1000D, to deliver Engineering and Manufacturing parts data to print and online formats including R4i Viewer, HTML, HTML5, and iPad.

The R4i IPD Manager easy Setup Wizard allows you to point to your SQL Data Source or Spreadsheet, select which data fields or range you are collecting the data from, select the Schema/XML (DITA, S1000D) that you would like to output to, save and generate your IPD.xml files.

Immediate preview of the XML content that is generated, is available via the R4i Viewer Preview window with the use of the XSLT stylesheet that is shipped with the R4i Software.

The R4i IPD Manager is bundled with powerful features including automatic generation of hotspot links, and referencing of the hotspotted images, and automatic completion of data fields. Using the easy XML authoring environment in FrameMaker 11, allows the interaction to be extended further by adding references to other content including PDFs and other XML files.

Although R4i IPD Manager is typically used by connecting directly with a SQL Database, R4i IPD Manager input can come from a variety of sources, including Excel Spreadsheets, .csv files, or XML.


Using MiramoMiramo is a third-party solution available from Datazone that leverages the power of the FrameMaker Publishing Server composition engine to provide several specialized features:

• MiramoSimpleMarkup(MSM)isbasicbutexpressiveXMLdocumentdescriptionlanguagethatcancutsolutiondevelopmenttimebyupto80%andenableapplicationmaintenancewithfivetimesgreaterefficiencythanextensiblestylesheetlanguageformattingobjects(XSL-FO)-basedproducts.

• High-speedproductionwithmission-criticalreliabilityandenterprisescalability,supportingmorethansevenmillion PDF output pages per day.

• TheMiramommServerWindowsservicemanagesmultiplejobqueues(e.g.,accounts,marketing,catalogs),eachofwhichmayhavemultipleconcurrentuser-configurablejob-processingchannels.

• JobprocessingAPIsfor.NET,Java™,andC++thatprovideintegrationwithallapplicationenvironments,plusfull command line interface (CLI) support.

• ThemmVisorGUIsystemconfigurator,jobviewer,andjobcontrollerenablesjobqueueconfiguration,viewingcurrent jobs, cancelling jobs, checking data regarding completed jobs, and more than 20 other parameters per job (e.g., start time, processing time, number of output pages).

• OutputinArabic,Hebrew,Thai,andIndiclanguagesandscripts.Morethan80languagesandwritingsystemsaresupported—essentialtofulfilltheneedsofglobalcorporationstargetingworldwidemarkets.

• Built-inXSLTprocessorwithspecialimage-processingenhancements.

• AnyFrameMakerdocumentsmaybeusedasdocument-designtemplatesusingtheMiramodocumentformatdefinitionsexportplugin.AllfeaturesofFrameMakeraresupported,includingalldocumentandimageimporttypes and all layout features.

• TheMiramochartingmoduleprovidessupportfordynamic,data-drivenbusinesscharts.

• AdditionalspecializedenhancementstotheFrameMakerPublishingServerincludemultipleimagelayerswith alpha-channel transparency, color gradients in table cells, and auto-sized text frames.

Miramo uses FrameMaker both as a GUI template design tool and as a hidden pagination engine to produce documents at a rate of tens of thousands of pages per hour, or over a million pages overnight. Document types range from 1- to 20-page customer statements, produced in high volume and at high speed, to enormous, multipage documents such as encyclopedias, directories, and industrial catalogs. Miramo harnesses the power of the FrameMaker Publishing Server for a high-end Dynamic Enterprise Publishing environment that meets the requirements of both global enterprises and medium-sized businesses with regard to accuracy, efficiency, regulatory compliance, and cost savings.

Miramo-created documents can be highly dynamic in layout and content. Under programmatic control, data-driven content formatting can produce multiple results from a single homogeneous input stream, with variations ranging from the minutely granular (e.g., minor formatting nuances in response to subtle variations in the source data) to global (e.g., applying an entirely different document template based on flags in the source data).

A single Miramo host application can be accessed in multiple ways, ranging from use as an on-demand process triggered from user action in a web browser to unattended batch generation of documents and completely automated integration with other systems.

Designing FrameMaker templates for use with Miramo

The FrameMaker GUI simplifies complex page layout and design for use with Miramo. Dynamic, data-driven formatting variations to the template can be programmatically controlled by Miramo. This includes all aspects of a FrameMaker template (e.g., paragraph, font, table, and variable catalogs). Miramo can dynamically define and apply master page layouts. An existing template’s definitions can be used as is, or Miramo can apply data-driven formatting overrides on the fly. Miramo can also define and add new formats to the catalogs of newly created documents.


Miramo and FrameMaker Publishing Server provide a powerful, server-based publishing application.

Data and content sources

Although Miramo is typically used with input generated by a database query, Miramo input can come from a variety of sources, including static text files, .csv files, legacy system data or typesetting files, XML, HTML, PDF, or component FrameMaker files. Any of these data sources can be intermingled with database-generated data or any of the valid FrameMaker input formats (for example, word processing files).

Miramo can dynamically create and send formatted data to an external application for processing, then incorporate the result into the Miramo document. Examples include formatting complex equations, scientific charts or graphs, or third-party graphics applications.

Working with XML

With mmxslt (the built-in Miramo XSLT processor), Miramo can transform XML-encoded data streams into fully formatted output (for example, .fm or PDF files, or any of the FrameMaker formats). In addition, Miramo can divert input data through any external validation or parsing process desired prior to resuming processing. The input may include a reference to the Miramo DTD or to any external DTD.

The XML-handling capability in Miramo, in combination with the powerful formatting engine of FrameMaker, lets users add sophisticated layout and document formatting to any XML-based application.

Working with mmpp

The Miramo macro preprocessor, or mmpp, can be used as an input filter to transform incoming data streams for subsequent Miramo processing. mmpp supports macro arguments, file inclusion, reading and processing external files line by line, system commands, expression evaluation, conditional output, ”for” loops, variable definitions, ”regular expression” matching and substitution, as well as a number of powerful string and arithmetic functions.

Automating the publishing process

Just as the term “publishing” has been redefined to include content delivery in multiple media (for example, paper, eBooks, wireless data, and HTML), the concept of “publishing automation” has also been expanded to include a wide range of automation requirements.

With a publishing framework built around FrameMaker and Miramo, implementations can range from multi-focus, web-based, on-demand systems for catalogs or personalized account summary generation to highly sophisticated, single-focus background processing for banking and financial systems. With Miramo, flexibility in content creation and delivery media does not come at the price of complexity or rigidity in implementation. Interfaces to a Miramo-based process can be developed with virtually any tool (for example, VB, Java, WSH, ASP, and PHP) to accommodate any degree of ad hoc input or control required.


Using FML PatternStreamPatternStream is a third-party publishing solution available from Finite Matters Ltd. (FML) that offers a complete, interactive environment for building data-driven publications. Using the PatternStream GUI, the user can manipulate objects that define how data will be accessed and formatted. PatternStream also provides a database and business intelligence system access layer that acts as a direct connection between data sources and the page layout and composition engine in FrameMaker.

PatternStream architecture

PatternStream is implemented as an extension of FrameMaker and uses FrameMaker templates to provide a library of style resources. The PatternStream system is designed to enable rapid setup of data-driven publishing projects by means of a visual programming ecosystem that allows users to manipulate re-locatable objects. No external scripts or programs are needed to extract the data and no intermediate markup files are required for processing.

PatternStream uses the FDK to acquire information and present FrameMaker attributes, such as paragraph, character, and table styles, master page, and other information, for its GUI for publishing project setup and modification. PatternStream also uses the FDK to seamlessly publish transformed information sources directly into FrameMaker. PatternStream builds publications from the data and file information in empty FrameMaker templates. Once a publishing project is set up, it is saved and can be used to publish on demand and modified as needs change.

PatternStream feeds information from a series of nested queries and files directly into the FrameMaker formatting engine, enabling users to quickly see the results of changes they make to the document’s design and layout logic in the course of iterative development.

PatternStream supports multiple interactions from multiple sources to create a versatile publication solution. The PSET Hierarchy

In documents used to present structured data, the layout logic often reflects the underlying data structure. For data-driven documents, this layout logic will be reflected as a repeating sequence of nested patterns of structural elements and text. The structure of these nested patterns can be represented as a data hierarchy. Documents can often be viewed as a logical hierarchy of structural elements. An example of a document being viewed in this manner would be the DTD of an XML document type.


However, the levels in the data hierarchy may not match exactly with the levels in the document hierarchy. PatternStream is built around a paradigm that uses both of these natural ways of viewing the output, and provides a means of merging these two different views together. The method for doing this is a construct called the PSET Hierarchy.

This PSET Hierarchy is composed of an interleaved, nested structure of pattern objects and target objects. Each pattern object has an associated query. These patterns define the data hierarchy. The target objects contained in each pattern are used to generate structural elements such as paragraphs and tables. The number of times a pattern uses the attached target objects to generate structural content is determined by the immediate results of its associated query.

Connecting to data sources

FML PatternStream is a data-centric application. It allows direct connection to any Open Database Connectivity (ODBC)-compliant database and Online Analytical Processing (OLAP)-compliant business intelligence system, as well as flat files and custom data sources. You can connect to multiple data sources simultaneously. The queries from these different data sources can be nested together with no preprocessing or intermediate markup files, providing flexibility of data access and layout strategy.

PatternStream can also treat markup files (e.g. XML, HTML, etc.) that are structured as data sources to drive publishing—or serve as content input. Hierarchical files can be navigated to present specific publishing information.

Object classes in the PatternStream application

FML PatternStream offers a rich collection of objects that can be used to build complex, data-driven documents:

• Patterns: used to represent a collection of structural elements (for example, paragraphs and table rows) that repeat.Patternsareassociatedwithqueriesandcontaintargets.

• Targets:usedtocreatethestructuralelementsassociatedwithpatterns.Targetsdonotdirectlycreatetextualcontent;however,sometargetscanuseattachedstringtemplatesforthispurpose.

• Queries:usedtoextractdatafromanoutsidedatasource.Patternsmustbeassociatedwithaqueryobjecttobe invoked. A query can be executed as many times as the logic of the document layout requires.

• Variables: used to hold the data extracted by queries. They can also be assigned values programmatically.

• Connectionobjects: used to provide connections for data sources.

• StringTemplates:used to create an instance of text. String Templates contain multiple segments, which can represent variable data, constant strings, or a wide range of document objects.

• Transforms:used to change the values of variables (for example, computation or string manipulation).

• Conditions: used to make the generation of structural elements in the output document conditional on whether various data criteria are met.

• ParameterLists:usedforspecificpurposes(forexample,passingvaluestoaFrameScript).

• Extensions:miscellaneousobjectsorextensionstothebasicPatternStreamapplication,includingcustomizedpluginswritteninCorinFrameScript,associativearrays,andreusablesubtrees.

Next steps If this white paper has demonstrated how to improve database publishing at your organization, you will definitely benefit from a critical assessment of your needs and an evaluation of database publishing tools.

Database publishing needs assessmentDepending on industry, company size, and specific demands for published output, different companies face very different publishing needs. When assessing these varied needs, it is useful to consider both the inputs to the system and the desired qualities of published output.


Issues to consider regarding inputs to a database publishing system include:

• Therangeofdatasources(forexample,multipledatabases,XMLdatasources,andflatfiles)

• Theformatsofintegratedgraphics(forexample,SVG,TaggedImageFileFormat[TIFF],andEPS)

• Theformatsofthosedocumentsourcesthatarenotdata-generated(forexample,staticfrontmatter)

• Thelikelihoodofdatasourceconsistencyovertime

Issues to consider regarding published output include:

• Therangeofdesiredoutputmediaandformats(forexample,AdobePDF,HTML,andXML)

• Therequiredthroughputofthesystem(forexample,documentsperhourforeachoutputformat)

• Thescopeofrequiredpersonalizationofthesystem

• Thecomplexityofdocumentformatting

• Thedegreeofadvancedcompositionrequirementssuchasauto-generatedindexesandTOCs

Database publishing solutions based on FrameMaker can accommodate a wide range of needs. FrameMaker tends to be most valuable when there are multiple input and/or publishing formats, demand for high throughput or complex composition, and/or personalization demands. FrameMaker is a very potent solution for organizations that maintain their documents as XML.

FrameMaker evaluation

For more details about FrameMaker, including information on the availability of evaluation versions of the application, please go to the FrameMaker product Web page at www.adobe.com/products/framemaker.

Checklist for a database publishing solution

When evaluating whether it’s time to upgrade your publishing solution, consider prospective applications using the questions in the following table:

Question FrameMakerYour Application

Can you easily publish from a single source to high-quality print, PDF, HTML, ePubs and XML formats? •Can you easily publish long documents with complex formatting and automatically generated indices and tables of contents? •Can you effectively style XML for delivery to print, ePubs, and PDF? •Are hyperlinks and bookmarks automatically generated when publishing to PDF as well as to web formats? •Can you produce mission-critical high document throughput with confidence in your application’s reliability and stability? •Can you leverage a proven, fully featured document object model for formatting your documents? •Can your publishing system save out and read in a complete representation of documents in an easily parsed, text-based format with no loss of information? •Can you precisely control the location of graphic objects in relation to text, with proper relocation of such objects when documents are reflowed or repaginated? •Can you leverage a template-driven workflow in which content is maintained independently from formatting? •Can you save and reuse formatting styles for a complete range of document objects, including paragraph, character, anchored frame, graphic and table styles? •Can you reliably format tables with complex structure and detailed formatting spanning many pages? •

18

Adobe Systems Incorporated 345 Park Avenue San Jose, CA 95110-2704 USA www.adobe.com

Adobe, the Adobe logo, Adobe AIR, AIR, Captivate, FrameMaker, FrameMaker Publishing Server, Illustrator, and RoboHelp are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Java is a trademark of Oracle and/or its affiliates. All other trademarks are the property of their respective owners.

© 2013 Adobe Systems Incorporated. All rights reserved. Printed in the USA.

91086430 11/13

Question FrameMakerYour Application

Is your document production tightly integrated as a fully automated process within your business’ other mission-critical applications? •Can you use rich, interactive multimedia to improve the user experience? •Can you create interlinked documents with Hotspots and automatically hyper-linked 3D images and parts tables for better browsing and readability? •Can you publish to multiple channels, formats, and screens? •

ConclusionDatabase publishing is more important than ever to a number of industries because business, legal, and regulatory demands require the timely and accurate dissemination of information. Advances in database technology, increased demands for real-time information access, and an expanding number of formats and channels for content delivery are forcing organizations to seek more effective database publishing solutions. With enhanced XML support, new accessibility features, tight integration with the latest version of Adobe PDF, and support for new graphic formats such as SVG, FrameMaker continues to evolve in meeting these demands.

Whether your enterprise publishes single-page specification sheets or large, complex documents spanning thousands of pages; whether your data sources are primarily XML, database, or other formats; and whether you deliver more to web, mobile, or print output, FrameMaker warrants a thorough evaluation as the central component of a database publishing solution.

Appendix: Resources

FrameMaker Publishing Server product page www.adobe.com/products/framemakerpublishingserver

FrameMaker product page www.adobe.com/products/framemaker

Information about Adobe products http://access.adobe.com/accessibility

Miramo home page (worldwide) www.miramo.com

PatternStream home page www.patternstream.com/FML

Data Group home page www.absolutedata.com

Contributor:

Tammy Halter is the founder and CEO of Absolute Data Group. Tammy has been a senior technical trainer, support engineer, and project manager for numerous XML software distributors and has held the role of FrameMaker Product Engineer, (Asia Pacific & Latin America) for Adobe Systems. With over 17 years of experience in information technology, Tammy has extensive experience in technical publishing, S1000D technical data management,

and information delivery systems for defense and aerospace. Tammy has previously served in the Royal Australian Navy Fleet Air Arm and worked for leading document management companies prior to founding Absolute Data Group.