Difference between revisions of "Folios"

From Icms
Jump to navigationJump to search
(Created page with "=General= *are a document in ICMS of type Folio *are edited via the ICMS Web interface. Javascript is required. *if you look at the actual native file for a folio it's XML. *I...")
 
Line 9: Line 9:
*Can be Locked
*Can be Locked
*Can be Rendered as PDF, Xml or a zip file
*Can be Rendered as PDF, Xml or a zip file
=What is saved in the folio when a document is added?=
*title
*last modified date
*content id
*name
*create date
*author
*doc type
*native file format (text, excel, word etc.)
*a couple of urls and ids referring to the content for that item
=Simple Folios=
- Only holds documents
- How to Create
=Advanced Folios=
- Rules and Limitations
- How to Create
=Folio Templates=
- ICMS admins need to get involved to make a Folio Template
- available for Advanced Folios only
=Generating PDFs from Folios=
- To print a folio, open up the folio in edit or view mode.  In the upper right select Renderers > Download PDF rendition.  There are also options to create a Zip File of the component documents or an XML rendition of the contents of the folio. 
- The XML rendition will be of limited use to most Users - it just has information on the metadata of the component documents for the folio.
=Editing Folios=
- Folios have an edit view and a display view. 
- Some areas of the ICMS give you the web viewable link of the folio available on the search results page and the the folios content info page) will bring you to the folio in view mode.  Others like the Folio Icon on the search results page for a folio bring you into edit mode for the folio. 
- You are able to toggle between these two states by means of the Actions dropdown on the Edit or View page for the folio
- After you are in edit mode for a folio and changes are made to the folio, you must save your changes before going to view mode.  Actually, your changes are lost if you go anywhere else but the edit folio page or the popup search dialog it provides you with for adding new documents.
=Folio Subscriptions=
- You can subscribe to a folio.  This will cause the ICMS to send you emails whenever documents within the folio change. 
- If you have created a folio and wish for it to change as new revisions of its constituent documents are checked in, we recommend that you create a Folio Subscription for that Folio, then update it as you are alerted to changes in its documents.
- A folio is subscribed to by going to the Content Info page for that folio and selecting Content Actions > Subscribe.  You are presented with four non-exclusive options for the subscription and must press the 'subscribe' link before the action is complete. 
- The folios you have subscribed to are accessed from My Content Server > My Subscriptions.
=Workflow and Folios=
- Folios may not behave the way you expect or desire them to with respect to workflow.
- Workflow approval applies to the folio document only, not to any of the component documents.
=Security and Folios=
- A folio has its own metadata.  That includes the Security Group and Secure To fields. 
- Users who have permission to browse a folio are allowed to see a couple of metadata items related to all documents in that folio.
  - If a User does not have permissions to access a component document of the folio he will get an error as he tries to access the content of that document. 
=Deciding when to use a Folio=
==Folios vs Related Content==
  - RC is a parent-child relationship that can be nested arbitrarily deep
  - RC is just a little bit of metadata attached to each document.  There is no 'Related Content' document that is stored in ICMS for a relation
  - always uses the most current revision of any document in the folder
==Folios vs Contribution Folders==
  - you can make a Contribution Folder yourself
  - documents in a Contribution Folder inherit a lot of metadata of the folder itself 
  - always uses the most current revision of any document in the folder
==Folios vs Library Folders==
  - ICMS admins need to get involved to make a Library Folder
  - always uses the most current revision of any document in the folder
=Known issues with Folios=
*Multiselect Problems
-  one can click on a single item, shift-click to select a series of contiguous items but CANNOT option/command click to select discontiguous items.
*Insert Selected Source does not preserve HTML in the title
*Search window layout is not optimal
-  Checkbox is at the bottom, next button is at the top.
*Document Search Truncates Titles
-  When searching for Scheduling & Planning Meetings documents and adding to a folio, Barb noticed that the titles were truncated (they have dates at the end which were excluded.) Going to the folio first and searching within that interface worked fine.
*new revision causes Folio to get stuck in ArgonneEntry
-  Not sure of the cause, but some folio edits are getting stuck in the ArgonneEntry parent workflow, requiring an admin to approve them through.
*Browser quirks
-  As Folios are largely written in Javascript, a language which runs in the Users computer browser, we have encountered situations where the layout or behavior may be affected by the operating system and browser.  It's not an optimal solution but when you encounter a problem with a folio, try to do the same thing from another browser.  It's often the shortest past to a solution and frequently the best we can recommend as tech support for this product.

Revision as of 17:39, 25 May 2011

General

  • are a document in ICMS of type Folio
  • are edited via the ICMS Web interface. Javascript is required.
  • if you look at the actual native file for a folio it's XML.
  • It helps to think of a Folio as a real book.
    • It's a grouping of documents, like chapters in a book.
    • documents are frozen at the revision they are at when they are added to a folio. Books are also a printed snapshot of the data, or chapters, as they looked at the time of publishing
    • It is easy to look at all the contents in a folio. You can export a folio to PDF, this combines all the member documents just as a book is a seamless combination of all the chapters
  • Can be Locked
  • Can be Rendered as PDF, Xml or a zip file


What is saved in the folio when a document is added?

  • title
  • last modified date
  • content id
  • name
  • create date
  • author
  • doc type
  • native file format (text, excel, word etc.)
  • a couple of urls and ids referring to the content for that item


Simple Folios

- Only holds documents - How to Create

Advanced Folios

- Rules and Limitations - How to Create

Folio Templates

- ICMS admins need to get involved to make a Folio Template - available for Advanced Folios only

Generating PDFs from Folios

- To print a folio, open up the folio in edit or view mode. In the upper right select Renderers > Download PDF rendition. There are also options to create a Zip File of the component documents or an XML rendition of the contents of the folio. - The XML rendition will be of limited use to most Users - it just has information on the metadata of the component documents for the folio.

Editing Folios

- Folios have an edit view and a display view. - Some areas of the ICMS give you the web viewable link of the folio available on the search results page and the the folios content info page) will bring you to the folio in view mode. Others like the Folio Icon on the search results page for a folio bring you into edit mode for the folio. - You are able to toggle between these two states by means of the Actions dropdown on the Edit or View page for the folio - After you are in edit mode for a folio and changes are made to the folio, you must save your changes before going to view mode. Actually, your changes are lost if you go anywhere else but the edit folio page or the popup search dialog it provides you with for adding new documents.

Folio Subscriptions

- You can subscribe to a folio. This will cause the ICMS to send you emails whenever documents within the folio change. - If you have created a folio and wish for it to change as new revisions of its constituent documents are checked in, we recommend that you create a Folio Subscription for that Folio, then update it as you are alerted to changes in its documents. - A folio is subscribed to by going to the Content Info page for that folio and selecting Content Actions > Subscribe. You are presented with four non-exclusive options for the subscription and must press the 'subscribe' link before the action is complete. - The folios you have subscribed to are accessed from My Content Server > My Subscriptions.


Workflow and Folios

- Folios may not behave the way you expect or desire them to with respect to workflow. - Workflow approval applies to the folio document only, not to any of the component documents.

Security and Folios

- A folio has its own metadata. That includes the Security Group and Secure To fields. - Users who have permission to browse a folio are allowed to see a couple of metadata items related to all documents in that folio.

 - If a User does not have permissions to access a component document of the folio he will get an error as he tries to access the content of that document.  

Deciding when to use a Folio

Folios vs Related Content

 - RC is a parent-child relationship that can be nested arbitrarily deep
 - RC is just a little bit of metadata attached to each document.  There is no 'Related Content' document that is stored in ICMS for a relation
 - always uses the most current revision of any document in the folder

Folios vs Contribution Folders

 - you can make a Contribution Folder yourself
 - documents in a Contribution Folder inherit a lot of metadata of the folder itself  
 - always uses the most current revision of any document in the folder

Folios vs Library Folders

 - ICMS admins need to get involved to make a Library Folder
 - always uses the most current revision of any document in the folder

Known issues with Folios

  • Multiselect Problems

- one can click on a single item, shift-click to select a series of contiguous items but CANNOT option/command click to select discontiguous items.

  • Insert Selected Source does not preserve HTML in the title
  • Search window layout is not optimal

- Checkbox is at the bottom, next button is at the top.

  • Document Search Truncates Titles

- When searching for Scheduling & Planning Meetings documents and adding to a folio, Barb noticed that the titles were truncated (they have dates at the end which were excluded.) Going to the folio first and searching within that interface worked fine.

  • new revision causes Folio to get stuck in ArgonneEntry

- Not sure of the cause, but some folio edits are getting stuck in the ArgonneEntry parent workflow, requiring an admin to approve them through.

  • Browser quirks

- As Folios are largely written in Javascript, a language which runs in the Users computer browser, we have encountered situations where the layout or behavior may be affected by the operating system and browser. It's not an optimal solution but when you encounter a problem with a folio, try to do the same thing from another browser. It's often the shortest past to a solution and frequently the best we can recommend as tech support for this product.