Macromedia FrameMaker Publishing Server - 2017 Instruction Manual
Using FrameMaker
Publishing Server (2017
release)
January 31, 2017
Contents
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Activation and registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
License activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Help and support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Community Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Other resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
What’s new in FrameMaker Publishing Server (2017 release) . . . . . . . . . . . . . . . . . . . 4
Other features in FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Accessing the FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
FrameMaker Publishing Server dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Autorefresh of the FMPS interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installation and setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Install FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Configure FrameMaker instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Enable HTTP or HTTPS with Windows authentication . . . . . . . . . . . . . . . . . . . . . . 12
Enable HTTP or HTTPS without Windows authentication . . . . . . . . . . . . . . . . . . . . 13
Install a command line tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Manually install FMPS website in IIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Enable HTTP ports for FMPS access from other network machines . . . . . . . . . . . . . . . 14
Enable email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
ADOBE FRAMEMAKER PUBLISHING SERVER (2017 RELEASE)
Enable browse functionality through Java™ applet . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Creating and managing publication tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Create a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Run tasks from the list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Duplicate a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Edit a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Delete a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Create a schedule for run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
View the schedules for tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Reusing tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Create a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Run a template from Template tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Duplicate a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Create a task from a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Add a preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Edit a preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Delete presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Specify default log settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
View logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Working with FMPS using the APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
API methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
CRUD framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Web API URLs and task types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Help URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Enable the Help URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Using command line to manage tasks with FrameMaker Publishing Server . . . . . . . . . . 29
Create a task for the FMPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Retrieve all your tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Retrieve a particular task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Modify a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Delete a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
See all the Web APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
FMPS troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
ADOBE FRAMEMAKER PUBLISHING SERVER (2017 RELEASE)ii
Legal notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
ADOBE FRAMEMAKER PUBLISHING SERVER (2017 RELEASE)
Getting Started
Getting Started
Adobe FrameMaker Publishing Server (FMPS) is an enterprise software that allows you to automate
your multichannel publishing process. FMPS can run as a service on a remote system, and you can
generate output in multiple formats: Responsive HTML5, EPUB, Kindle, PDF, Microsoft HTML,
Basic HTML, Adobe Experience Manager Mobile, and as mobile apps. Leverage out-of-the-box
support for leading Content Management Systems (CMS), or use the web APIs to smoothly integrate
with other CMSs.
Resources
Before you begin working with Adobe FrameMaker Publishing Server, take a few moments to read
an overview of activation and the many resources available to you. You have access to instructional
videos, plug-ins, templates, user communities, seminars, tutorials, RSS feeds, and much more.
Activation and registration
To review complete system requirements and recommendations for your Adobe FrameMaker
Publishing Server software, see the FrameMaker Publishing Server product page at
www.adobe.com/products/fmserver.
System requirements
FrameMaker Publishing Server is available in English only. Before you install FrameMaker
Publishing Server ensure that your computer meets the following minimum system requirements:
Hardware
Intel Pentium 4 processor or above.
Operating System
Windows Server 2012 R2
RAM
1 GB or more (2 GB recommended)
Hard Disk Space
6 GB of available hard-disk space; additional free space required during installation (cannot
install on a volume that uses a case-sensitive file system or on removable flash storage devices).
1
Getting Started 1
If you copy your source documents to the server that hosts FrameMaker Publishing Server,
allocate additional disk space.
Screen Resolution
Maximum supported screen resolution – 4K (3480 x 2160, 8.3 megapixel, aspect ratio 16:9).
Activation
FrameMaker Publishing Server does not work without activation. Broadband Internet connection is required for registration, software activation, validation of subscriptions, and access to
Online Services. Phone activation is not available.
Browsers
• Google Chrome
• Firefox Mozilla
• Apple Safari
• Microsoft Internet Explorer 11 or 10
• Microsoft Edge
Installation
You can install FMPS on a machine that meets the System requirements and then access it over the
network using other machines. For more information on installation, see Installationandsetup.
License activation
During the installation process, your Adobe software contacts an Adobe server to complete the
license activation process. No personal data is transmitted. For more information on product activation, visit the Adobe website at www.adobe.com/go/activation.
Register
Register your product to receive complimentary installation support, notifications of updates, and
other services.
• To register, follow the on-screen instructions in the Registration dialog box, which appears
when you first start the software.
2
Getting Started
Help and support
Understand the various Help resources for you to get started with FMPS and other related products
like FrameMaker.
Community Help
Community Help is an integrated environment on Adobe.com that gives you access to community-generated content moderated by Adobe and industry experts. Comments from users help guide
you to an answer. Search the FrameMakerCommunity Help to find the best content on the web
about Adobe products and technologies, including these resources:
• Videos, tutorials, tips and techniques, blogs, articles, and examples for designers and developers. Check the publishing workflow videos on the FrameMaker video hub page.
• Complete online Help, which is updated regularly and may contain more information than the
Help delivered with FrameMaker Publishing Server.
• All other content on Adobe.com, including knowledge-base articles, downloads and updates,
Adobe Developer Connection, and more.
Other resources
Online Help also include links to the complete, updated PDF and HTML versions of Help for FMPS
and other related products.
Visit the Adobe Support website at www.adobe.com/support to learn about free and paid technical
support options.
3
Introduction 2
Introduction
FrameMaker Publishing Server
With centralized and automated publications, it is easy to integrate and synchronize publication of
technical documents with product build schedules. FMPS leverages out-of-the-box integration with
leading Content Management Systems (CMS) like EMC Documentum, Microsoft SharePoint, DITA
Exchange and Adobe Experience Manager. Using the FMPS APIs, you can smoothly integrate with
other CMSs as well to enable you to manage publication tasks and enforce version control.
With ExtendScript Toolkit integrated with FMPS, you can create custom publication tasks that work
with source files in XML and FrameMaker formats. By creating reusable publication task settings,
you can quickly set up custom publication environments and schedule the build processes to run
daily, weekly, or at any defined intervals.
What’s new in FrameMaker Publishing Server (2017 release)
New Frameless HTML5 layouts
Create modern frameless Responsive HTML5 layout to deliver a superior navigation experience. Also, the responsive HTML5 output comes with first-of-its kind search experience. The
newly redesigned responsive HTML5 output now displays predictive search results based on a
few characters that you type in the search box. This reduces the search time and improves the
usability of your Help system.
New Basic HTML output
You can now publish in Basic HTML format from FMPS. The Basic HTML output format
takes each topic file within your book or DITA map and generates a corresponding HTML file
with the similar look-and-feel controlled through a CSS file. The generated output does not
contain any JavaScript or custom layouts that can be re-purposed or customized for the
intended audience.
Enhanced native integration with AEM
XML Documentation Add-on for Adobe Experience Manager is an end-to-end enterprise-class component content management solution (CCMS). The XML Documentation
Add-on integrates with FMPS that allows you to publish DITA content to formats like Responsive HTML5, PDF, EPUB, Kindle and more.
Enhanced template-based publishing solution
Quickly automate document assembly and formatting by defining multiple output template
presets for generating output. The latest version of FMPS comes with HTML5 template that
4
Introduction
helps you generate HTML5 output without investing time and effort in creating a new
template.
Other features in FrameMaker Publishing Server
• Bidirectional language publishing: Publish documents with bidirectional content, including
XML/DITA content, from within FrameMaker in multiple formats: PDF, Responsive HTML5,
EPUB, Kindle, Microsoft HTML, Basic HTML, Adobe Experience Manager Mobile and as
native mobile apps. Optionally, flip the HTML5 layout so that the navigation pane appears on
the right for RTL content, and render smoothly on any device - desktop, tablet, or a mobile.
• Mobile app output: Deliver Help content for the audiences that are on the go. Ensure wider
distribution and consumption of content with a simplified mobile app generation workflow
and native integration with Adobe PhoneGap Build. With the licensed version of Adobe
PhoneGap Build, easily publish and then distribute your content as an installable app on major
mobile platforms including, iOS and Android with just one click.
Once the app is generated, you can share the QR code or the app URL with your users to download the app from the PhoneGap server. Alternatively, you can also publish the app from
PhoneGap on to Google Play store or Apple’s App Store.
Manage the branding and design standards of the mobile layout with easy-to-use responsive
layout editor. Leverage the power of the Responsive HTML5 layout that comes with the
dynamic content filtering feature that lets your users self-select the content most relevant to
them.
• Personalized dynamic content: Empower users to find relevant content faster in the document, TOC, and index in the final Responsive HTML5 or mobile app output. Leverage existing
conditional tags and expressions to enable end users to dynamically filter content in the final
HTML5 output, thereby delivering personalized help experiences.
Simply assign names for existing conditional tags or expressions, categorize them under any
Group you want (such as region, audience, market segment etc.), enable single or multiple
selections within a Group, and then display this two-level hierarchy as content filter criteria in
the final output.
• Customizable HTML5 Layout: Use the customizable Responsive HTML5 layouts to deliver
an amazing content consumption experience. With more powerful search options, configure
search to appear on the content or topic panes, and show informative context and breadcrumbs in the results. This helps your readers identify the best choice among results. You can
also customize the search context message for each topic. The search results can also be configured to appear on the left pane.
Easily show or hide widgets such as glossary, TOC, index, and filters. Convert the layout to
right-to-left languages (Arabic and Hebrew) to meet the needs of a global audience, just by
5
Introduction 2
changing one property. Also add Facebook and Twitter widgets to your pages to allow users to
share the content that they are reading – with a single click!
Provide your users with a different experience for the device (desktop, tablet, and mobile) that
they use by customizing the function bar, side bar, and TOC in the output.
Along with all these customizations, now you can also create frameless output, which does not
contain any widgets, function bar, or side bar.
Use the powerful, yet easy-to-use Layout Customization tool to customize not only your
content, but also the appearance of buttons, labels, fonts, background color, search boxes, and
most components of your online content.
• Embed custom fonts in EPUB output: Embed custom fonts in your EPUB output and ensure
that your users see high-quality typography exactly as you intended, whether or not they have
the font installed on their device.
This feature is especially useful if you are using fonts that may not be readily available to your
end users. Use embedded fonts to enhance the branding standard set by your design style
guides.
NOTE: You must have distribution rights for the embedded font.
• Reference page image publishing: Publish reference pages content such as images, headers
and footers, and logos, in all output formats supported by FrameMaker Publishing Server.
• SVG support in HTML5 output: Let your end users see top quality images regardless of the
screen size and resolution of the device on which they are being viewed. This is because
FrameMaker Publishing Server embeds the entire SVG code in the final responsive HTML5
output.
• Reusable publishing elements: Reuse elements easily with the enhanced multidevice
publishing settings file. Create elements, such as responsive HTML5 layouts, CSS, and HTML
page templates, just once. Then import or export the setting files for use across different books
and documents.
• HTML page template support: Improve the usability of your output by adding mini-TOCs,
breadcrumbs, and headers and footers. Configure the output settings just once and then easily
reuse these across all outputs to give your users a uniform experience.
• Integration with leading CMSs: Leverage the out-of-the-box integration with leading Content
Management Systems (CMS) like EMC Documentum, Microsoft Sharepoint, DITA Exchange
and Adobe Experience Manager. You can also use the FMPS APIs to smoothly integrate with
other CMSs to enable you to manage publication tasks and enforce version control. Use the
Repository view to check-out files, manage dependencies, version management and perform
search. Use the advanced metadata-based filter to quickly browse and find relevant topics,
DITA maps, or graphics in a large volume of content.
6
Introduction
Accessing the FrameMaker Publishing Server
You access FMPS by logging in to the server that hosts it. Using the Web user interface of FMPS, you
can access it remotely from any machine by entering the following URL in your browser:
http://<FMPS_server>:6234/index.html
NOTE: Where <FMPS_Server> is the DNS or IP address of the system hosting FMPS.
After installing FMPS on a server, various users can access its web user interface or using the APIs and command
line over the network
FMPS is configured to automatically start when you log in to the host.
FrameMaker Publishing Server dashboard
FMPS provides a simple, web-based user interface using which you can:
• Create, manage, and schedule publication tasks
• Create and use templates for quickly executing reusable publication tasks
7
Introduction 2
• Create and use presets to quickly apply and populate settings to the repetitive tasks with similar
settings
• Manage and view task logs
Once you have installed FMPS on a machine, you can access it on the network from any machine to
use it.
Adobe FrameMaker Publishing Server dashboard
A.
Add New drop-down - Depending on which tab you are in, this drop-down allows you to
create and duplicate Tasks, Templates and Presets.
B.
The Run button: To run tasks, select one or more tasks and click Run
C.
Incremental search: Search for a Task, Template, or Preset name (depending on the tab you are
on) - as you type text, FMPS finds matches the text and displays them in the list
D.
Autorefresh settings: You can enable autorefresh for FMPS and specify the number of seconds
after which FMPS automatically refreshes
By clicking on the column names, you can sort the list of tasks by that column. The tasks are color
coded: green are successful, red are failed, and orange are queued.
For more information on:
• Installing FMPS, see Installationandsetup.
• Using FMPS through a browser on a client machine, see Creatingandmanagingpublication
tasks
• Using FMPS through the APIs on a client machine, see WorkingwithFMPSusing the APIs
Related topics
• Creatingandmanagingpublication tasks
8
Introduction
•Tasks
Autorefresh of the FMPS interface
The FMPS web interface’s autorefresh is disabled by default. You can set it to autorefresh every
10-500 seconds.
1) Click Settings ( )
The Settings dialog appears.
2) In the Settings dialog, select Duration and enter the number of seconds after which you want
FMPS web interface to autorefresh. You can enter a number from 10 to 500.
3) Click Save.
NOTE: You can also manually refresh FMPS by clicking the refresh button on the FMPS dashboard.
9
Loading...