Difference between revisions of "Document Automation"

From Icms
Jump to navigationJump to search
(Created page with "==Overview== Document Automation allows the user to insert ICMS metadata, such as Content ID, in a Microsoft Word or Excel document. This feature leverages the "Document Propert...")
 
 
(3 intermediate revisions by one other user not shown)
Line 12: Line 12:


# '''Access the document's custom properties.'''
# '''Access the document's custom properties.'''
## Office 2010 (Windows): Click File > Info (in left bar). On "Properties" in right half of screen, click drop-down menu and select "Advanced Properties." Click the "Custom" tab.
#* Office 365 and Office 2010 (Windows): Click File > Info (in left bar). On "Properties" in right half of screen, click drop-down menu and select "Advanced Properties." Click the "Custom" tab.
## Office 2007 (Windows): Click the Office button, then select Prepare > Properties. The Properties pane will appear. In that pane, select Document Properties > Advanced Properties > Custom tab.
## Office 2008 (Mac) and Office 2003 (Windows): Go to File > Properties > Custom.
# '''Enter the name of the ICMS field you want to add to your document.'''  
# '''Enter the name of the ICMS field you want to add to your document.'''  
## See Word and Excel instructions below for supported fields.
## See Word and Excel instructions below for supported fields.
Line 22: Line 20:
##Place your cursor at the point in the document you want the ICMS field code to appear.
##Place your cursor at the point in the document you want the ICMS field code to appear.
##Browse the Document Properties list:
##Browse the Document Properties list:
###Word 2010 (Windows): Click on Insert > Quick Parts > Field. Under "Categories", select "Document Information." Under "Field Names", select "DocProperty."
###Word 365 and Word 2010 (Windows): Click on Insert > Quick Parts > Field. Under "Categories", select "Document Information." Under "Field Names", select "DocProperty."
###Word 2007 (Windows): Click on Insert > Quick Parts > Field. Select DocProperty.
###Word 2008 (Mac) and Word 2003 (Windows): Click on Insert > Field. The Field Panel is displayed. Click on the Document Properties.
##Select the field property to be placed in your document. A placeholder value is inserted in your document. This value will be replaced with the actual value at check in time.
##Select the field property to be placed in your document. A placeholder value is inserted in your document. This value will be replaced with the actual value at check in time.
# '''Save the document and check it into ICMS.'''
# '''Save the document and check it into ICMS.'''
Line 30: Line 26:
==Word==
==Word==


You may use any of the following document properties to insert the relevant ICMS value into a Word document.
You may use any of the following document properties to insert the relevant ICMS value into a Word document. You should fill in the ''Name'' and ''Value'' fields, as shown below for each property you wish to include.
 
{| border="1"
! Name
! Value
|-
|ICMSContentID
|APS_XXXXXXX
|-
|ICMSRevision
|Rev
|-
|ICMSRevisionStatus
|Status
|-
|ICMSContributor
|Contributor
|-
|ICMSComments
|Comments
|-
|ICMSDocumentDate
|Doc Date
|}
 


* ICMSContentID
* ICMSRevision
* ICMSRevisionStatus
* ICMSContributor
* ICMSComments
* ICMSDocumentDate


==Excel==
==Excel==
Line 48: Line 62:
these can be set to a specific cell value (i.e. A2) or ''footer''. If you enter ''footer'', the value(s) will be placed in the printer margins at the bottom of the page.
these can be set to a specific cell value (i.e. A2) or ''footer''. If you enter ''footer'', the value(s) will be placed in the printer margins at the bottom of the page.


Optionally, you can control which sheets in your workbook will contain these values. To do so, add the following document property:
You must also indicate which sheet in your workbook will contain these values. To do so, add the following document property:


* ICMSSheetLoc
* ICMSSheetLoc


this must be an integer that equates to a specific sheet (i.e. 1). If you want it to print the values on all sheets, set it to -1. If the property is not specified, it will print on the first sheet only.
this must be an integer that equates to a specific sheet (i.e. 1). If you want it to print the values on all sheets, set it to -1. If the property is not specified, it will print on the first sheet only.

Latest revision as of 02:35, 16 April 2021

Overview

Document Automation allows the user to insert ICMS metadata, such as Content ID, in a Microsoft Word or Excel document. This feature leverages the "Document Properties" feature in Microsoft Office. When the document is checked in, the specified properties are replaced with the actual ICMS values.

Examples

  • Including the Content ID as part of a report lets everyone know that the document is in ICMS, how to find it, and how to reference it in other documents.
  • Including the ICMS revision number and revision status of a procedure helps a technician know if her printed copy is current.

Adding ICMS metadata to an Office document

  1. Access the document's custom properties.
    • Office 365 and Office 2010 (Windows): Click File > Info (in left bar). On "Properties" in right half of screen, click drop-down menu and select "Advanced Properties." Click the "Custom" tab.
  2. Enter the name of the ICMS field you want to add to your document.
    1. See Word and Excel instructions below for supported fields.
    2. You must use the exact field names as indicated.
  3. Click OK to close the Document Properties window.
  4. (Word Only) Add the ICMS field code to the document.
    1. Place your cursor at the point in the document you want the ICMS field code to appear.
    2. Browse the Document Properties list:
      1. Word 365 and Word 2010 (Windows): Click on Insert > Quick Parts > Field. Under "Categories", select "Document Information." Under "Field Names", select "DocProperty."
    3. Select the field property to be placed in your document. A placeholder value is inserted in your document. This value will be replaced with the actual value at check in time.
  5. Save the document and check it into ICMS.

Word

You may use any of the following document properties to insert the relevant ICMS value into a Word document. You should fill in the Name and Value fields, as shown below for each property you wish to include.

Name Value
ICMSContentID APS_XXXXXXX
ICMSRevision Rev
ICMSRevisionStatus Status
ICMSContributor Contributor
ICMSComments Comments
ICMSDocumentDate Doc Date


Excel

Content ID and Revision number are the supported properties that can be added to Excel documents:

  • ICMSContentIDLoc
  • ICMSRevisionLoc

these can be set to a specific cell value (i.e. A2) or footer. If you enter footer, the value(s) will be placed in the printer margins at the bottom of the page.

You must also indicate which sheet in your workbook will contain these values. To do so, add the following document property:

  • ICMSSheetLoc

this must be an integer that equates to a specific sheet (i.e. 1). If you want it to print the values on all sheets, set it to -1. If the property is not specified, it will print on the first sheet only.

Retrieved from "https://wiki-ext.aps.anl.gov/icms/index.php?title=Document_Automation&oldid=112"