MasterPlan Admin

Access Control

MasterPlan Admin
Determining access available to users in MasterPlan WORK jobs

Individual users can have their individual access set in their user settings.

By default all users have access to all jobs for their client but you may wish to invite specific users only to see and work on some of your current MasterPlan WORK jobs.

Choose to allow access to None, All or Only a Range of spreads on a per user and per job level.

Alternatively, choose the Assign Custom Access Level to quickly specify an Access Scheme.

Read full article
MasterPlan Admin

Adding a Cover File

MasterPlan Admin
Adding a cover image for visual identification of a client page and job page

A cover image is used for quick visual identification of a job via the client page and job page.

Admin Users can add any web as a cover image in the Job Details Cover Image URL field after clicking the Edit Details button in the Job Admin page.

MasterPlan is aimed at supporting the creation and production of pages of illustrated publications and is not recommended for managing the production of complex cover files.

Read full article
MasterPlan Admin

Client setup

MasterPlan Admin
Choosing a Client Name and allocation of your Client Number when setting up in MasterPlan

When first subscribing to use MasterPlan you choose a Client Name and you will be allocated a Client Number.

A client can be an individual but typically a client will have multiple users working together on one or more jobs.

Only users that are assigned to this client can then modify the spreads that are included in the job page for that client.

The Client Name is displayed in the MasterPlan Info Panel which is displayed on launch and can be found using MasterPlan menu > MasterPlan Info Panel.

The Client Number is used to identify the client when switching between clients and adding MasterPlan stamps.

Read full article
MasterPlan Admin

Creating Embed Codes

MasterPlan Admin
Using embed codes to give clients and external users access to MasterPlan job pages or client pages.

You may wish to offer clients and others to have access to certain MasterPlan job pages or even entire client pages.

Admin Users can embed a customised view of MasterPlan inside other webpages.

You can choose this to be behind a button or link and whether presented in a 'lightbox' style overlay or within an iframe.

To create an embed code, after logging in as an Admin User and selecting Client Admin, click the Embed tab and customise the content and appearance of the MasterPlan embed.

Read full article
MasterPlan Admin

Creating an Applying Access Groups

MasterPlan Admin
Using Access Groups to quickly give the same level of access to multiple users

An Admin User can set up Access Schemes to quickly apply the same level of access to multiple users.

Click Add New Custom Access to set up new Access Schemes, click the name of existing Access Schemes to edit them.

For example you may allow internal production staff complete access to all MasterPlan WORK jobs but restrict sales staff to only viewing completed jobs.

Access Schemes are applied when managing users.

Read full article
MasterPlan Admin

Edit Job Details

MasterPlan Admin

Click Edit button to view and edit Job Details

  • Main Job Details
    • Publication Type
      • Visual
      • Textual
      • Audiobook
      • Data Only
    • Job Title
    • External Cover Image URL
    • Spread View Type
      • Double
      • Single
    • Spread Width
    • Spread Height
    • Slack Hook URL
  • Upload Publication
    • General Extraction Options
      • Extract Thumbnails
      • Extract Spread Texts
      • Extract Cover
    • Reader Page One
    • PDF Extraction Options
      • Page Per Page
      • Spread Per Page
Read full article
MasterPlan Admin

Managing Jobs

MasterPlan Admin
MasterPlan online offers a variety of ways for Admin Users to control access to jobs

After creating a new MasterPlan WORK job using the MasterPlan desktop app an Admin User can alter existing jobs in a number of ways using MasterPlan online.

Amending job options as an Admin User

To amend job options, visit a Job page after logging in as an Admin User and select Job Admin from the top right corner

The Job Page is now shown with extra admin preferences.

Admin Only restricts access to an entire Job to Admin users only.

At a spread level, individual spreads can be restricted to Members Only with a check box. Along with Access Schemes this is another way to restrict access to certain sections of a work in progress from general access.

The Toggle All/None for Members Only provides a quick way to switch all spread access in this way in one click.

The Hide Members Only Spreads to Non-Members choice allows spreads which are marked as members only to be either blurred and watermarked (to show a representation of their amount and place within the page order of the book) or to be completely hidden from non-members.

The Show Overlays and Enable Annotator check boxes control whether to show overlaid info on when who last worked on a spread and whether to allow comments to be added using the Viewing and Commenting panel.

If allowing commenting then uncheck the Allow non-users to annotate to restrict comments to only being added by logged in users.

Read full article
MasterPlan Admin

Managing MasterPlan Users

MasterPlan Admin
Admin users can create, manage and remove other users, grant admin rights and control which jobs users can access.

After logging in as an Admin User, move to the Client Admin section of MasterPlan Online by clicking your name at the top right corner of any MasterPlan Online and selecting 'Client Admin' or going directly to circularsoftware.com/MasterPlan/admin/Client0001 (replacing the client number with your own)

Users are identified using a ten digit Circular Software ID that is unique to the Mac they are using. Ask your users to install MasterPlan and give your their ID number which can be copied with menu command  Set-up > Copy Your User ID Number.

To add a new user in the Client Admin section of MasterPlan Online click the 'Add New User' button.

Enter the User ID number in the DesktopID field then continue to add name and email address. On creation the user will be emailed and invited to choose and confirm a password when they first login.

When logged in, the user's name is added to MasterPlan WORK comments and can be used to control which jobs and spreads a user can see and comment on.

Only users that are entered here are able to work on the MasterPlan jobs for your client.

To amend details of a user, click on  their name in the displayed list. Names and ID numbers can be altered here as frequently as required and changes here will automatically allow / disallow users to work on jobs for the client.

Read full article
MasterPlan Admin

Managing Statuses

MasterPlan Admin
Changing the wording and colours of statuses used by MasterPlan WORK

Admin Users can alter the wording and colours for statuses used by MasterPlan WORK at a client level.

These statuses are applied to spreads in the Viewing and Commenting panel and can be used to filter the Job Page.

To amend statuses for your client, after logging in as an Admin User and selecting Client Admin click the Statuses tab and alter the labels and colours.

Read full article
MasterPlan Admin

Managing Users

MasterPlan Admin
Managing and adding users of MasterPlan Online

Admin users can manage existing and add new users through Client Admin:

After logging in as an Admin User, move to the Client Admin section of MasterPlan Online by:

  • clicking your name at the top right corner of any MasterPlan Online and selecting Client Admin, or
  • going directly to circularsoftware.com/MasterPlan/ admin/Client0001 (replacing the client number with your own)

A number of concurrent users is included in your subscription to MasterPlan WORK.

Users are identified using a ten digit Circular Software ID that is unique to the Mac they are using.

Ask your users to install MasterPlan and give you their ID number, which can be copied by choosing the command MasterPlan Set-up nenu > Copy Your User ID Number.

Adding a new user

To add a new user in the Client Admin section of MasterPlan Online click the Add New User button.

Enter the User ID number in the DesktopID field, then continue to add name, email and choose and confirm a password.

This password is used to identify the user within MasterPlan Online. When logged in, the user name is added to comments and can be used to control which jobs and spreads a user can see and comment on.

Only users that are entered here are able to work on the MasterPlan jobs for your client.

Amending user details

To amend details of a user, click on their name in the displayed list.

Names and ID numbers can be altered here as frequently as required and changes here will automatically allow / disallow users to work on jobs for the client.

Read full article
MasterPlan Admin

MasterPlan API

MasterPlan Admin
Controlling MasterPlan Online using the MasterPlan API

As well as the regular visual user interface MasterPlan Online can be rapidly and automatically controlled using an application program interface (API).

Everything can be controlled by the Admin User, automatically, at a large scale and at speed.

For example, the MasterPlan desktop app makes use of the MasterPlan API to feed MasterPlan Online with content and to retrieve comments.

As this is a User Guide the full API is not described in detail here. Please visit circularsoftware.com/MasterPlan/api/ documentation and contact us to work with our API.

Read full article
MasterPlan Admin

MasterPlan Online Client Admin

MasterPlan Admin
Client Admin Users can manage Jobs and Users centrally in the admin area of MasterPlan Online

Users of MasterPlan Online who have the Client Admin status can make client-wide changes:

To access MasterPlan Online Client Admin settings

  1. Log in to MasterPlan Online
  2. Click on your name and choose Client Admin at the top right of MasterPlan Online
The Client Admin login at the top right of MasterPlan Online

Once in Client Admin view, a list of client settings are shown on the left with the Job Maintenance setting chosen

The standard list of Client Admin settings

You can access client settings in the following ways:

Open Client Page

A quick link back to the Client Page showing Search across all publications and clickable covers of every available MasterPlan job along with statuses of WORK jobs.

Custom Access Groups

A list of active Access Groups (controlling access to MasterPlan content for designated groups).

Click Add New Custom Access to specify a new Access Group with restrictions added for certain jobs, statuses, spread ranges.

The Access Visualiser shows a quick preview of how jobs will be viewed by Access Groups and individual users.

See Creating an Applying Access Groups for more info.

Users

Click the Add New User button to add a registered Circular Software User to this MasterPlan Client by entering their DesktopID (User ID Number), full name and email address, assigning an Access Group and allocating Client Admin and Job Admin rights as appropriate.

Note: MasterPlan Online only users (without the need for the Mac Desktop Application) can be allocated any unique ten digit number as their DesktopID.

Active Users are listed with their unique ID, name and email address.

Click a user name to edit the user, to update their DesktopID (User ID Number), assign an existing Access Group and grant Client Admin and Job Admin rights.

Click the Save User button to save changes.

Users can be removed from a client with the Remove User button.

Job Maintenance

The Job Maintenance page shows an overview of all MasterPlan jobs.

Enter any text in the Filter Jobs field to instantly filter jobs by matching Name, Job Number or ISBN.

Use sliders to filter jobs by their WORK / LIVE mode along with their publication type: Visual PDF / Textual EPUB / Visual JPEG / Audiobook / Visual EPUB / Data Only.

Each job displayed shows a cover thumbnail, a label indicating LIVE or WORK mode and the job title. Hover over the title to see the Job Number. Click the title to open the Job page in a new browser window.

BookSite clients can click an additional link icon to open the job page on their BookSite.

Click buttons on the cover thumbnail to either Delete a Job or Edit Job Details. More info available at Editing Job Details.

Statuses

The six statuses that can be applied to WORK mode spreads are listed here.

Choose the name and the colour of each status to suit your workflow and click Save Statuses to apply to all WORK mode jobs. More info available at Spread Statuses.

Custom Job Detail Fields

Along with artwork and content, MasterPlan can store and present additional information about the MasterPlan jobs e.g. Author info, RRP, page extent and much more.

Manually specified fields can be added by clicking + Add Field, choosing a field type and entering a Label, optional help text and more options as required.

Alternatively, a specific data structure e.g. ONIX can be imported from a JSON file or a feed from a linked BookSite.

MasterPlan Embed

Create a secure embed code to place a customised view of MasterPlan content into any allowed website.

Specify Publication Options to choose which content, access groups, embed type, default appearance.

For MasterPlan WORK jobs choose from additional options including the ability to add annotations and display statuses.

Add Header Options to set the content, functionality and position of the embedded MasterPlan header bar.

Choose from a list of Sharing Options to send a preview link to social media platforms and a URL link for email and direct messaging.

Custom CSS Options allow full customisation of fonts, sizes, colour schemes for the appearance of the embedded MasterPlan to best match the host site.

More info available at Creating Embed Codes.

Third Party Integration

MasterPlan integrates with a number of additional plugins and connects with some third party applications to provide enhanced functionality.

Analytics – Enable and filter analytics of your MasterPlans to monitor usage, count job and spread views, discover reading habits and track interactions.

More info available at Adding Analytics to MasterPlan.

SIDD – SIDD connects people, documents and images to a lightweight but powerful and centralised source for contextual image descriptions.

More info available at SIDD (Simple Image Descriptions Database).

Webflow – Webflow empowers designers to build professional, custom websites in a completely visual canvas with no code.

Enable MasterPlan to connect to the Webflow CMS for the supply of content and custom job details.

Settings

The Client Settings control the set-up and default settings covering how users can access and view MasterPlans.

For technical users the API Settings determine how systems or services can interact with MasterPlan API.

Also for technical users, the AWS Settings specifc how MasterPlan links to their Amazon Web Services (AWS).

The Watermarks, and Share Images tab is used to control the watermarks applied by MasterPlan at spread, job or client level along with the backgroud images appleid to sharing and ShowCase embeds (coming soon…)

More info MasterPlan Client Settings

Read full article
MasterPlan Admin

MasterPlan Online Job Admin

MasterPlan Admin
Job Admin Users can specify Publication and Viewer Type, control access and sharing options for the publication, enable watermarking and more

To access MasterPlan Online Job Admin settings:

  1. In MasterPlan Online‘s Client Page click on the Job to be administered
  2. Choose Job Admin from your User Settings [top right of the window]
  • Publication Options
    • Publication Type
      • Visual – A visual publication has spreads, ideal for fixed-layout EPUB and PDF documents and InDesign publications
      • Textual – A text-led publication split into chapters or sections, ideal for reflowable EPUB
      • Audiobook – Audio only format, ideal for W3C LPF audiobooks
      • Data Only – a publication with a cover and metadata, but no content yet
    • Set Viewer Type
      • View JPEG as slides – Any visual publication can be quickly shown with retina-quality JPEG slides
      • View EPUB in Readium Cloud Reader – This is not currently offered. Contact us for more info
      • View EPUB in Colibrio Reader – A visual or textual EPUB can be read online in the most interactive and accessible way with this modern reader
      • View PDF in Colibrio Reader – A PDF can be read online in the most interactive and accessible way with this modern reader
      • Direct to Custom URL – MasterPlan can be used to direct users to another service if required
    • Reader Page One – the absolute page number of page one of the publication (by default this is page one). This should always be an odd number
    • Link to Publication – For an uploaded PDF, EPUB or Audiobook this is the direct URL of the publication
    • XML data source URL – The link to the Biblio data feed for clients using this service
  • Access Options
    • Publication only accessible to Admins – Restrict viewing of the job to Admin Users only
    • Publication only accessible to Members – Restrict viewing of the job to logged in members of this MasterPlan client
    • Spreads marked “Members Only” hidden to Non-Members – Remove spreads from public MasterPlans rather than blurring and watermarking
    • Enable Watermarking – Add watermarks to every spread. Watermarks are set up at Client Admin level
    • Toggle All/None for Members Only – Quickly switch all spreads to be marked as Members Only and their view restricted
  • Viewing & Sharing Options
    • Show Cover as Thumbnail – Add a cover to the spread thumbnails in the MasterPlan for visual publications
    • Spread View Type
      • Double – Thumbnails of visual publications consist of two facing pages
      • Single – Thumbnails of visual publications consist of single pages
    • Force Reader Renderer
      • Do Not Force – The default is to have no preference
      • Responsive – The MasterPlan will resize depending on the viewer’s screen and present double-page spreads for visual publications where space allows
      • Flip – The MasterPlan will always present as double-page spreads for visual publications
      • Stack – The MasterPlan will always present as single pages for visual publications
      • Scroll – The MasterPlan will always present each section of a Textual document as one long scrolling view
    • Enable Interactive Twitter Share Card? – Tick to add the live MasterPlan to a Twitter (X) post
    • Share Description – The line of text that is posted along with the MasterPlan preview when social media sharing

In WORK mode you can also choose from these additional options:

  • WORK options
    • Show Overlays – Add more information on hovering about who last updated each spread and when and its status
    • Enable Annotator – Switch on the View & Comment button to allow commenting
    • Enable Annotator for Non-Users – Switch on to invite people outside of MasterPlan to join in the commenting

The following three options are available below:

  • Save and Publish Job Commit to saving the changes made in Job Admin mode. This will also push to BookSite if using
  • Edit Job Details – More options for BookSite users to add and edit custom job details
  • Delete Job – Remove the entire MasterPlan job

For each spread displayed from your publication you can choose to specify whether their text is to be Searchable, to restrict viewing to Members Only and to select for Deletion

Read full article
MasterPlan Admin

Security and Hosting

MasterPlan Admin
Please see below for some answers to commonly-asked questions on MasterPlan’s security, hosting and working methods

Some companies may have security questions or requirements which we aim to answer here:

  • Firstly it is important to state that MasterPlan NEVER moves or uploads your InDesign files, image links or fonts.
  • There is NO requirement to put your files anywhere or name files in a particular way.
  • There is nothing added to your InDesign files that can damage them or stop them being used offline or without our software.
  • We have designed MasterPlan to work as unobtrusively as possible and to fit around the workflow of our customers with an ease of set-up and use.
  • We only use the web transfer protocol of FTP-SSL to transfer files to our web server at https://www.circularsoftware.com.
  • Only users that are assigned to your client by your Admin User are allowed to alter the spreads shown or retrieve comments.
  • MasterPlan WORK jobs can also be hidden or shared with only certain logged-in users.
  • We store user information of name, email address and their unique Circular Software ID number. We never share your information; our privacy policy is available online at circularsoftware.com/privacypolicy/
  • The MasterPlan site and database is secured with a 256 bitSSL certificate.
  • With customisation you can choose to host MasterPlan Online client and job web pages on your own web server and we can build a customised MasterPlan desktop app to redirect to your own web server using the file transfer protocol of your choice.
  • With customisation all images can be watermarked.
  • With customisation all MasterPlan Online web pages can be password protected encrypted using an MD5 hash or SHA hash with a salt.

Please contact us with any other security or hosting questions.

Read full article
MasterPlan Admin

Setting up a new job

MasterPlan Admin
Creating jobs to manage and present your publications in MasterPlan

For MasterPlan the term job refers to one complete publication. A job can consist of one or multiple InDesign documents, and can be worked on by one or multiple users.

To start using MasterPlan there needs to be at least one job.
For Free Trial users, new jobs can be created by anyone.
For Pro users, only licensed users can create new jobs.

To make a new job using the MasterPlan app choose
the MasterPlan menu command Set-Up > Create a new MasterPlan then fill out short form to name your MasterPlan and to specify the number of pages.
For Free Trial Users, your user details are also required. We ask for your User ID (see page 14) and up to two other ID numbers of InDesign co-workers who you wish to share this newly created MasterPlan with.

Co-worker ID numbers can be added later by contacting us.
We also ask for your name and email address so we can contact and support your use of our software. We never share your information, our privacy policy is available online at circularsoftware.com/privacy-policy

Read full article
MasterPlan Admin

Slack Notifications

MasterPlan Admin
Keeping people informed on MasterPlan WORK activity using Slack notifications to mobile, web and desktop apps.

Instant information on MasterPlan WORK activity including uploads, commenting and thumbnail previews can be pushed out as Slack notifications at a job level so just the right people can stay in touch with changes via notifications on mobile, web and desktop apps.

MasterPlan uses Slack notifications rather than email which means you get live updates when you wish to have them but also these notifications can be easily silenced when you don't.

Admin Users can add a Slack WebHook URL in Job Details pane after clicking the Edit Details button in the Job Admin page.

Read full article
MasterPlan Admin

Support

MasterPlan Admin
A range of support and training options are available when subscribing to MasterPlan

All MasterPlan desktop app subscribers receive free email support by emailing help@circularsoftware.com

Monthly webinars which run through the MasterPlan Online and MasterPlan desktop app processes are free to attend.

Contact us for more details.

Admin Users for medium and large teams receive live one-to- one set-up training via screen-share.

Live presentations and training can be arranged on request.

Read full article
MasterPlan Admin

The Admin User

MasterPlan Admin
Each Pro client has one or more Admin Users who can manage jobs and users centrally in the admin area of MasterPlan Online

Clients can easily invite new users, including freelancers, to join them in MasterPlan without the end user needing to arrange their own subscription.

Admin Users also have extra power to create and add cover files, choose who can view and comment and alter the status labels displayed for a client.

The initial Admin User is set up when first subscribing – additional users can then be created and promoted to the same status by an existing Admin User.

Read full article
MasterPlan Admin

Topics

No items found.