Difference between revisions of "Deprecated - Custom Field Type: Special - Spreadsheet"

From SmartWiki
Jump to: navigation, search
Line 1: Line 1:
 +
{{Template:Deprecated}}
 
<u>'''General Description'''</u>
 
<u>'''General Description'''</u>
  
−
This field type is used to present the user with a spreadsheet that is compatible with MS Excel. This spreadsheet is stored as part of the record and can be exported as a .xls file, or be opened directly by MS Excel.  
+
This field type is used to present the user with a spreadsheet that is compatible with MS Excel. This spreadsheet is stored as part of the record and can be exported as a .xls file, or be opened directly by MS Excel.
  
  
 
The '''Spreadsheet''' field will manifest on the record in both '''View''' and '''Edit''' mode as a button:
 
The '''Spreadsheet''' field will manifest on the record in both '''View''' and '''Edit''' mode as a button:
−
:[[Image:SpsView.png]]
 
  
 +
: [[Image:SpsView.png]]
 
When '''Open''' is clicked:
 
When '''Open''' is clicked:
  
 
'''View Mode:'''
 
'''View Mode:'''
−
:[[Image:Sps2View.png]]
 
  
 +
: [[Image:Sps2View.png]]
 
'''Edit Mode:'''
 
'''Edit Mode:'''
−
:[[Image:SpsEdit.png]]
+
 
−
+
: [[Image:SpsEdit.png]]
−
<u>'''Field Options''' </u>
+
<u>'''Field Options''' </u>
  
 
* '''Display Order''': The order (relative to other fields) in which this field is displayed
 
* '''Display Order''': The order (relative to other fields) in which this field is displayed
Line 24: Line 25:
  
 
<u>'''Special Options for Field'''</u>
 
<u>'''Special Options for Field'''</u>
 +
 
* '''Values''': Allows you to define a template including default values and formulas. See [[#Template|below]].
 
* '''Values''': Allows you to define a template including default values and formulas. See [[#Template|below]].
  
  
−
<u>'''Field Formatting Options'''</u>
+
<u>'''Field Formatting Options'''</u>
  
 
* '''[[Tool Tip]]''': Enter help text to be shown on mouse-over
 
* '''[[Tool Tip]]''': Enter help text to be shown on mouse-over
Line 34: Line 36:
  
  
−
<u>'''[[Role Field Permissions|Role - Field Permissions]]'''</u>
+
<u>'''[[Role Field Permissions|Role - Field Permissions]]'''</u>
  
 
These [[Role Field Permissions|fields]] allow you to control by [[Role]] who is allowed to view and/or modify the field.
 
These [[Role Field Permissions|fields]] allow you to control by [[Role]] who is allowed to view and/or modify the field.
  
−
<u>'''[[Status Field Permissions|Status - Field Permissions]]'''</u>
+
<u>'''[[Status Field Permissions|Status - Field Permissions]]'''</u>
 +
 
 
* ''Only present within the [[Universal Tracking Application]]''
 
* ''Only present within the [[Universal Tracking Application]]''
 
These [[Status Field Permissions|fields]] allow you to control by the [[Status]] of the record whether or not the field can be viewed and/or modified.
 
These [[Status Field Permissions|fields]] allow you to control by the [[Status]] of the record whether or not the field can be viewed and/or modified.
 +
  
  
Line 46: Line 50:
 
===Instructions===
 
===Instructions===
 
* If no Template is defined in the '''Values''' field, the first time the Open button is clicked a blank spreadsheet will need to be created by selection '''New''' from the '''File''' menu and entering the desired dimensions of the spreadsheet
 
* If no Template is defined in the '''Values''' field, the first time the Open button is clicked a blank spreadsheet will need to be created by selection '''New''' from the '''File''' menu and entering the desired dimensions of the spreadsheet
−
:[[Image:NewSps.png]]
 
  
−
* '''IMPORTANT:''' Each time the '''Spreadsheet''' is edited the changes must be saved by clicking File > Save.  
+
: [[Image:NewSps.png]]
 +
* '''IMPORTANT:''' Each time the '''Spreadsheet''' is edited the changes must be saved by clicking File > Save.
 +
 
 
  Modifications to the '''Spreadsheet''' will be lost if the window is closed without first saving.
 
  Modifications to the '''Spreadsheet''' will be lost if the window is closed without first saving.
  
Line 54: Line 59:
 
===Template===
 
===Template===
 
The '''Values''' field allows you define a template including formatting, formulae and initial default values.
 
The '''Values''' field allows you define a template including formatting, formulae and initial default values.
 +
 
* The default template can be created by creating a record that contains a '''Spreadsheet''' custom field. Create the spreadsheet as desired, including any formatting, formulas and initial values. Then from the Spreadsheet menu select '''View''' and then '''Source'''. The HTML shown can be copied and pasted into the '''Values''' field.
 
* The default template can be created by creating a record that contains a '''Spreadsheet''' custom field. Create the spreadsheet as desired, including any formatting, formulas and initial values. Then from the Spreadsheet menu select '''View''' and then '''Source'''. The HTML shown can be copied and pasted into the '''Values''' field.
  
 
'''Sample:'''
 
'''Sample:'''
−
<pre>
+
 
−
<TABLE border="1px" id="jSheet" class="jSheet ui-widget-content ui-corner-all" style="width: 708px;">
+
{| id="jSheet" class="jSheet ui-widget-content ui-corner-all" style="width: 708px;" border="1px"
−
<TR height="30" style="height: 30px;">
+
|- style="height: 30px;"
−
      <TD height="30" id="cell_c1_r1" class="styleBold styleUpper">Requested Budget</TD>
+
| id="cell_c1_r1" class="styleBold styleUpper" height="30"|Requested Budget
−
      <TD id="cell_c2_r1"/>
+
| id="cell_c2_r1"| 
−
      <TD id="cell_c3_r1"/>
+
| id="cell_c3_r1"| 
−
      <TD id="cell_c4_r1"/>
+
| id="cell_c4_r1"| 
−
      <TD id="cell_c5_r1"/></TR>
+
| id="cell_c5_r1"| 
−
<TR><TD id="cell_c1_r2">Cost Items</TD>
+
|-
−
      <TD id="cell_c2_r2">Year 1</TD>
+
| id="cell_c1_r2"|Cost Items
−
      <TD id="cell_c3_r2">Year 2</TD>
+
| id="cell_c2_r2"|Year 1
−
      <TD id="cell_c4_r2">Year 3</TD>
+
| id="cell_c3_r2"|Year 2
−
      <TD id="cell_c5_r2">Total</TD></TR>
+
| id="cell_c4_r2"|Year 3
−
<TR style="height: 16px;"><TD style="font-weight: bold;" id="cell_c1_r3">Staff</TD>
+
| id="cell_c5_r2"|Total
−
      <TD id="cell_c2_r3"/>
+
|- style="height: 16px;"
−
      <TD id="cell_c3_r3"/>
+
| id="cell_c1_r3" style="font-weight: bold;"|Staff
−
      <TD id="cell_c4_r3"/>
+
| id="cell_c2_r3"| 
−
      <TD id="cell_c5_r3" formula="=SUM(B3:D3)"/></TR>
+
| id="cell_c3_r3"| 
−
<TR style="height: 16px;">
+
| id="cell_c4_r3"| 
−
      <TD style="font-weight: bold;" id="cell_c1_r4">Equipment</TD>
+
| id="cell_c5_r3"| 
−
      <TD id="cell_c2_r4"/>
+
|- style="height: 16px;"
−
      <TD id="cell_c3_r4"/>
+
| id="cell_c1_r4" style="font-weight: bold;"|Equipment
−
      <TD id="cell_c4_r4"/>
+
| id="cell_c2_r4"| 
−
      <TD id="cell_c5_r4" formula="=SUM(B4:D4)"/></TR>
+
| id="cell_c3_r4"| 
−
<TR><TD id="cell_c1_r5">Materials</TD>
+
| id="cell_c4_r4"| 
−
      <TD id="cell_c2_r5"/>
+
| id="cell_c5_r4"| 
−
      <TD id="cell_c3_r5"/>
+
|-
−
      <TD id="cell_c4_r5"/>
+
| id="cell_c1_r5"|Materials
−
      <TD id="cell_c5_r5" formula="=SUM(B5:D5)"/></TR>
+
| id="cell_c2_r5"| 
−
<TR><TD style="font-weight: bold;" id="cell_c1_r6">Travel</TD>
+
| id="cell_c3_r5"| 
−
      <TD id="cell_c2_r6"/>
+
| id="cell_c4_r5"| 
−
      <TD id="cell_c3_r6"/>
+
| id="cell_c5_r5"| 
−
      <TD id="cell_c4_r6"/>
+
|-
−
      <TD id="cell_c5_r6"/>
+
| id="cell_c1_r6" style="font-weight: bold;"|Travel
−
      <TD id="cell_c6_r6" formula="=SUM(B6:D6)"/></TR>
+
| id="cell_c2_r6"| 
−
</TABLE>
+
| id="cell_c3_r6"| 
−
</pre>
+
| id="cell_c4_r6"| 
 +
| id="cell_c5_r6"| 
 +
| id="cell_c6_r6"| 
 +
|}
  
 
===Variables===
 
===Variables===
Line 99: Line 108:
  
 
'''Syntax:'''
 
'''Syntax:'''
−
*Single Cell:
 
−
:<font size=3>@sps.''fieldname''.B2@</font>
 
  
−
*Range of Cells:
+
* Single Cell:
−
:<font size=3>@sps.''fieldname''.A1:C1@</font>
+
 
−
:<font size=3>@sps.''fieldname''.A1:C3@</font>
+
: <span style="font-size: medium;">@sps.''fieldname''.B2@</span>
 +
* Range of Cells:
  
 +
: <span style="font-size: medium;">@sps.''fieldname''.A1:C1@</span>
 +
: <span style="font-size: medium;">@sps.''fieldname''.A1:C3@</span>
 
'''Where:''' ''fieldname'' is the name of the '''Spreadsheet''' custom field.
 
'''Where:''' ''fieldname'' is the name of the '''Spreadsheet''' custom field.
  
  
 
[[Category:Custom Fields]]
 
[[Category:Custom Fields]]

Revision as of 14:09, 22 August 2018


Ambox warning pn.png This feature is deprecated and should no longer be used, but may still be available for reasons of backwards compatibility.

General Description

This field type is used to present the user with a spreadsheet that is compatible with MS Excel. This spreadsheet is stored as part of the record and can be exported as a .xls file, or be opened directly by MS Excel.


The Spreadsheet field will manifest on the record in both View and Edit mode as a button:

SpsView.png

When Open is clicked:

View Mode:

Sps2View.png

Edit Mode:

SpsEdit.png

Field Options

  • Display Order: The order (relative to other fields) in which this field is displayed
  • Tab Name: Displays the field under a given tab
  • Field Name: The name of the field, used internally to reference the user's input
  • Caption: The leading question or prologue before the field


Special Options for Field

  • Values: Allows you to define a template including default values and formulas. See below.


Field Formatting Options

  • Tool Tip: Enter help text to be shown on mouse-over
  • HTML Tag: Additional attributes to the field HTML tag
  • Visibility Condition: Conditions upon which the field is visible


Role - Field Permissions

These fields allow you to control by Role who is allowed to view and/or modify the field.

Status - Field Permissions

These fields allow you to control by the Status of the record whether or not the field can be viewed and/or modified.


Notes

Instructions

  • If no Template is defined in the Values field, the first time the Open button is clicked a blank spreadsheet will need to be created by selection New from the File menu and entering the desired dimensions of the spreadsheet
NewSps.png
  • IMPORTANT: Each time the Spreadsheet is edited the changes must be saved by clicking File > Save.
Modifications to the Spreadsheet will be lost if the window is closed without first saving.


Template

The Values field allows you define a template including formatting, formulae and initial default values.

  • The default template can be created by creating a record that contains a Spreadsheet custom field. Create the spreadsheet as desired, including any formatting, formulas and initial values. Then from the Spreadsheet menu select View and then Source. The HTML shown can be copied and pasted into the Values field.

Sample:

Requested Budget        
Cost Items Year 1 Year 2 Year 3 Total
Staff        
Equipment        
Materials        
Travel          

Variables

The data stored within cells on the spreadsheet can be referenced as Variables in Read Only - System Variables fields, Web Page Views etc:

Syntax:

  • Single Cell:
@sps.fieldname.B2@
  • Range of Cells:
@sps.fieldname.A1:C1@
@sps.fieldname.A1:C3@

Where: fieldname is the name of the Spreadsheet custom field.

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Deprecated_-_Custom_Field_Type:_Special_-_Spreadsheet&oldid=32597’