Macromedia FrameMaker Publishing Server - 2015 Instruction Manual
Using FrameMaker
Publishing Server
September 17, 2015
Contents
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Activation and registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
License activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Help and support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Community Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Other resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Services, downloads, and extras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Adobe downloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Adobe Labs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Adobe TV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
What’s new in FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Accessing the FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
FrameMaker Publishing Server dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Autorefresh of the FMPS interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installation and setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Install FrameMaker Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Configure FrameMaker instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Enable http with Windows® authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Install a command line tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Manually install FMPS13 website in IIS, if necessary . . . . . . . . . . . . . . . . . . . . . . . . 14
iADOBE FRAMEMAKER PUBLISHING SERVER (2015 RELEASE)
Enable http ports for FMPS access from other network machines . . . . . . . . . . . . . . . . 14
Enable email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Duplicate a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Edit a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Delete a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Create a schedule for run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
View the schedules for tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Reusing tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Create a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Run a template from the Template tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Run a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Duplicate a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Create a task from a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Add a preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Edit a preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Delete presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Specify default log settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
View logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Working with FMPS using the APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
API methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
CRUD framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Web API URLs and task types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Help URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Enable the Help URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Using command line to manage tasks with FrameMaker Publishing Server . . . . . . . . . . 30
Create a task for the FMPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Retrieve all your tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Retrieve a particular task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Modify a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Delete a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ADOBE FRAMEMAKER PUBLISHING SERVER (2015 RELEASE)ii
See all the Web APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
FMPS troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Legal notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
iii ADOBE FRAMEMAKER PUBLISHING SERVER (2015 RELEASE)
Getting Started
Getting Started
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, with 3 GB RAM and 6 GB free disk space. If you copy your
source documents to the server that hosts FrameMaker Publishing Server, allocate additional
disk space.
Operating System
Windows Server 2012 R2 or Windows Server 2008 R2
RAM
1 GB or more
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
Screen Resolution
1024x768 screen resolution (1280x800 recommended) with 16-bit video card.
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
Microsoft Internet Explorer 10 or 9 or the latest Google Chrome, Mozilla Firefox, Apple Safari
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 Installation and setup.
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 onscreen instructions in the Registration dialog box, which appears
when you first start the software.
TIP: If you postpone registration, you can register at any time by choosing Help > Registration.
Help and support
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
2
Getting Started
you to an answer. Search Community 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.
• Complete online Help, which is updated regularly and may contain more information than the
Help delivered with FrameMaker Publishing Server.
– When you are connected to the Internet and you select help in FrameMaker, your web
browser opens a Help page on the Adobe website.
– To view FrameMaker help when you are not connected to the Internet, download the
Help PDF of FrameMaker on your computer.
For more information on the offline Help, see Offline Help.
• All other content on Adobe.com, including knowledgebase articles, downloads and updates,
Adobe Developer Connection, and more.
Use the Help search field in your product’s user interface to access Community Help. You can search
for content within the Adobe.com site and also in websites that have useful information about your
product. Moderators continue to identify the most relevant web content for your product. You can
add comments to online Help and view comments added by other users. For a video of Community
Help, see www.adobe.com/go/learn_community_help_en.
Other resources
Online Help also includes a link to the complete, updated PDF version of Help.
Visit the Adobe Support website at www.adobe.com/support to learn about free and paid technical
support options.
Services, downloads, and extras
You can enhance your product by integrating various services, plug-ins, and extensions in your
product. You can also download samples and other assets to help you get your work done.
Adobe downloads
Visit www.adobe.com/go/downloads to find free updates, trials, and other useful software.
3
Getting Started 1
Adobe Labs
Adobe Labs at www.adobe.com/go/labs gives you the opportunity to experience and evaluate new
and emerging technologies and products from Adobe. At Adobe Labs, you have access to resources
such as these:
• Prerelease software and technologies
• Code samples and best practices to accelerate your learning
• Early versions of product and technical documentation
• Forums, wiki-based content, and other collaborative resources to help you interact with
like-minded users
Adobe Labs fosters a collaborative software development process. In this environment, customers
quickly become productive with new products and technologies. Adobe Labs is also a forum for early
feedback. The Adobe development teams use this feedback to create software that meets the needs
and expectations of the community.
Adobe TV
Visit Adobe TV at http://tv.adobe.com to view instructional and inspirational videos.
4
Introduction
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 integrates with EMC Documentum®,
Microsoft® SharePoint, and Adobe Experience Manager that 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
1) Bidirectional language publishing: Publish documents with bidirectional content, including
XML/DITA content, from within FrameMaker in multiple formats: PDF, Responsive HTML5,
Web-Help, CHM, EPUB, KF8, MOBI, and as mobile apps. Optionally, flip the HTML5 layout
or use the new responsive RTL WebHelp layout so that the navigation pane appears on the
right for RTL content, and render smoothly on any device - desktop, table, or a mobile.
2) Mobile app output: 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 new easy-to-use responsive layout editor. Leverage the power of the Responsive HTML5 layout that comes with the
new dynamic content filtering feature that lets your users self-select the content most relevant
to them.
Deliver Help content for the audiences that are on the go.
3) 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
5
Introduction 2
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.
4) New 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
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 frame-less output, which does not
contain any widgets, function bar, or side bar as shown below.
5) 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.
The search results can also be configured to appear on the left pane.
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.
6) Attractive customizable Responsive HTML5 layouts and WebHelp skins: Give your
WebHelp content a new look by choosing from a wide variety of skins from the Web-Help
gallery.
And a powerful, yet easy-to-use WebHelp skin editor lets you customize not only your content,
but also the appearance of buttons, labels, fonts, background color, search boxes, and most
components of your online content.
7) Reference page image publishing: Now, publish reference pages content such as images,
headers and footers, and logos, in all output formats supported by FrameMaker Publishing
Server.
6
Introduction
8) 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 because
FrameMaker Publishing Server now embeds the entire SVG code in the final responsive
HTML5 output.
9) Reuse of Adobe RoboHelp style mappings: Work more efficiently by reusing style mappings
that you have already configured in Robo-Help or Adobe Technical Communication Suite in
the native multidevice publishing workflow of Adobe FrameMaker Publishing Server.
10) Reusable publishing elements: Reuse elements easily with the enhanced multidevice
publishing settings file. Create elements, such as responsive HTML5 layouts, WebHelp skins,
CSS, and HTML page templates, just once. Then import or export the setting files for use
across different books and documents.
11) HTML page template support: Now 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.
12) Integration with DITA Exchange CMS: Leverage the new built-in connector to the DITA
Exchange CMS to manage your DITA content easily. 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.
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.
7
Introduction 2
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
• 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.
8
Introduction
Adobe FrameMaker Publishing Server dashboard
A.
Add New dropdown - 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.
Incrememtal search: Search for a Task, Template, or Preset name (depending on the tab you
are on) - as you type text, FMPS finds matches for 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 autorefreshes
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 Installation and setup.
• Using FMPS through a browser on a client machine Creating and managing publication tasks
• Using FMPS through the APIs on a client machine Working with FMPS using the APIs
Related topics
• Creating and managing publication tasks
• Create a task
• Tasks
9
Loading...