Org Chart Configuration Properties

This guide lists the properties that can be set by page designers on the organization chart web part to control the source of data, behavior and appearance.

Assistant Items

  • Assistant Field - Defines which field in the data source ( either a list or a database query ) indicates whether a particular person is drawn as an assistant. If the value of the field evaluates to true, yes or 1 then the person will be represented as an assistant.
  • Picture Column - Defines which field in the data source contains the URL to a picture that is shown in the chart boxes.
  • Columns to show - Defines a comma separated list of field names from the data source ( either a list, User Profile Service or database query ) that will be shown in the built in template. For exmample FullName, Title, Email.
  • Background Colour (Graphical) - The background colour of each chart box holding an assistant. This property takes effect when the chart is in graphical mode only. See this guide for more details.
  • Background Image Style - The graphical style of the background. SharePoint Org Chart has five built in styles.
  • HTML Template - This allows the page developer to define a custom HTML Template. This overrides the built in templates. The template takes HTML markup and field names enclosed in {}.  The template <b>{Title}<b/> would display the title field from the list in bold.  For more information on the HTML Template property refer to Creating Custom HTML Templates.
  • Image URL - The full path to an image to that is to be used as the background. This allows the page developer to overrides the built in background. If using a custom image the page developer must set the Custom Box Height and Custom Box Width properties.
  • Background Colour (CSS) - Sets tho colour of the boxes when the chart is operating in CSS Mode. See this guide for more details.
  • Custom Box Height - The height in pixels of each box displayed on the chart.
  • Custom Box Width - The width in pixels of each box displayed on the chart.
  • Line Style - This is the style of line used to join the assistant to the chart. It can be Solid, Dotted or Dashed.
  • Size - This sets the size of the assistant box to one of the built in sizes. These are Small, Medium, Large or Narrow. These sizes can be override by setting the Custom Box Height and Custom Box Width properties.

Chart Items

The Chart Items configuration section controls the display each item on the chart.

  • Picture Column -
    Sets the column name that holds the picture that will be displayed in each box in the org chart.
  • Columns to show - A comma separated list of field names that will be shown in each box in the org chart.
  • Background Colour (Graphical) -

    Sets the colour of the chart boxes when operating in Graphical Mode.
    See this guide for more details.

  • Background Image Style - Sets the style of the chart boxes.
  • Background Colour (CSS) -

    Sets tho colour of the boxes when the chart is operating in CSS Mode. See this guide for more details.

  • HTML Template -

    This allows the page developer to define a custom HTML Template. This overrides the built in templates. The template takes HTML markup and field names enclosed in {}.
    The template <b>{Title}<b/> would display the title field from the list in bold.
    For more information on the HTML Template property refer to Creating Custom HTML Templates.

  • Image URL -

    Sets a full path to an image that will be used as the background in the chart boxes.

  • Custom Box Height -

    Sets the height in pixels of a custom background image.

  • Custom Box Width -

    Sets the width in pixels of a custom background image.

  • Size -
    This sets the size of the assistant box to one of the built in sizes. These are Small, Medium, Large or Narrow. These sizes can be override by setting the Custom Box Height and Custom Box Width properties.

Conditional Format Rule 1 - 4

SharePoint Org Chart can support 4 different conditional format rules in addtion to the six "quick format rules" described here.

  • Field - The field name from the datasource that will be the rule will be applied to.
  • Operator - The operator that will be used in the rule. For example IsEqual or GreaterThan.
  • Value - Sets the value that will be used in the rule.
  • Background Color - Sets the colour of the boxes that will be used if the rule evaluates to true.
  • Box style - Sets the style of the boxes that will be used if the rule evaluates to true.
  • HTML Template - Sets the HTML Template that will be used if the rule evaluates to true.
  • Size Sets the size of the boxes that will be used if the rule evaluates to true.
  • Custom background URL - Defines a custom background that can be used if the rule is evaluated to true.
  • Custom background height - Defines the height of the custom background in pixels.
  • Custom background width - Defines the width of the custom background in pixels.

Data Rules

The SharePoint Org Chart Web Part allows page authors to set Data Rules that change the behaviour and appearance of the organisation chart based on the data for each individual item within the chart. See this guide for more details.

  • Exclusion Rules Items that match these rules are excluded from the chart.
  • Exclude Blank Fields A list of column names that will be used to exclude items if blank.
  • Inclusion Rules Only items that match these rules appear in the org chart.
  • Extend Line Rules Rules that allow the page author to extend the verticle lines of items.
  • Exclude From Smart Draw Rules Items that match these rules are excluded from the Smart Draw algorithm.
  • Html Format Rules Items that match these rules have additional HTML formatting applied to them.
  • Truncate Rules Fields that match these rules are shortend. For example job titles can be restricted to 30 characters. This is useful in preventing information overflowing from the chart.
  • Sort By Column Names A list of column names that are used to sort each tier of the organization chart.

Data Source

The data source configuration section controls from where and how data is accessed by the org chart web part. The supported data sources are Active Directory (AD), SharePoint List, CSV File,  Relational Database and UserProfile Service.

  • Property Description
  • Data Source Type Changes the source of the data for the organisation chart. The web part supports the User Profile Service, SharePoint List or Relational database. UserProfile service is available on SharePoint 2010 Server and Enterprise only.
  • Use Enhanced Fetch Mode (User Profile Service Only) Configures the SharePoint Org Chart to use the search service to retrieve data for the organisation chart as opposed to using the SharePoint object model. This feature only applies to the user profile service. For more details please refer to this guide.
  • Enhanced Fetch Mode - Service Name Allows the specification of the search service to be used.
  • Enhanced Fetch Mode - No Default Fields Removes the standard fields ( name, job title, email address ) from the enhanced search results.
  • Primary Key The name of a column or database field that uniquely identifies each row in the data source.
  • Manager The name of a column or field that identifies who the manager ( or parent ) is of each row.
  • SharePoint List Sets the name of the SharePoint List that will be used to draw the organisation chart. For example MyOrgChartList or http://MySharePointServer/Lists/People/ or even http://tisharepoint/Lists/People/MyView.aspx.
  • Starting Value This value that should match one of the primary keys. If set the org chart will be drawn from that point. If left blank the organisation will be drawn from the top.
  • SQL Server Connection String Sets the connection string that will be used if the database Data Source Type is selected.
  • SQL Query Defines the query that will be executed if the database Data Source Type is selected.
  • Initial LDAP Path Allows page author to set an initial path to a directory. This setting is only applicable when the Active Directory is used as the data source.
  • Row Provider Connection Field This sets the field name that will be used to retrieve the primary key from a SharePoint list that has been used to filter the org chart. If left blank the name of the primary key field is used.
  • Debug Mode Enabling this option turns on the debug mode which outputs diagnostic information. This includes a list of all the available fields and the current HTML Template being used to render the chart.
  • Enable Data Caching Turns on the data cache. Data caching increases performance by holding the org chart data in memory.
  • Cache Duration Defines the length of time in seconds after the last use of the org chart that the cached data in the will be stored.

Export to Excel

Enables the export to Excel functionality.

  • Property Description
  • Show Export To Excel If enabled the Export to Excel icon is displayed in the org charts menu.
  • Columns to export A comma separated list of column names that will be included in the export.

Look & Feel

The Look & Feel properties control the appearance of the organisation chart.

  • Property Description
  • Display as table Displays the data that would be turned into a chart as a data table. This option is for diagnostic purposes.
  • No Data Message The text that will be displayed if no data is returned from the data source.
  • Use Smart Draw Enables or disables the smart drawing algorithmn
  • Org Chart Background This is a URL to an image that will be used as the org chart background.
  • Render Top Down If enabled the chart is drawn top down. The "root" person is at the top.
  • Hide Top Item Hides the first item.
  • Hide Lines Does not display any connecting lines
  • Show Primary Key Shows the primary key in the template
  • Show SharePoint ID Adds the SharePoint ID to the template.
  • Show Navigation Buttons Shows the navigation buttons. This enables end users to navigate up or down the organisation chart.
  • Show Print Chart Button Shows the print org chart button.
  • Show People Picker Displays the standard people picker, allowing end users to pick the start position of the organisation chart.
  • Show Home Button Shows the "home" button. Pressing home will restore the chart back to the poition it was when the page first loaded. The home button is only displayed after the end user navigates away from the original starting point.
  • Show View Selector (SharePoint List only) Shows a drop down list of available views that can be used to draw the chart. This option is only applicable when a list is used as the data source of the chart.
  • Show Item Link (SharePoint List only) Displays a hyperlink to the actual item within the list used to display the chart. This allows the end user to quickly open up a specific item and either view the full list record or edit it.
  • Item Link Text(SharePoint List only) Text used in the Show Item hyperlink.
  • Show Frame Wraps a frame around the chart.
  • Link Field Sets the name of the field that will become a hyperlink and used to control the Information Panel.
  • Action when Link Field is Clicked Defines the behaviour of the Link Field. By default this is set to Update Panel.
    Valid values are :
    • Email - generates an email link
    • MySite - generates a link to the persons My Site
    • Update Panel - Updates the information panel
  • Query String Field This sets the name of the query string field ( http://mySP/Pages/MyPage.Aspx?QUERYSTRINGFIELD=xxxx ) that the org chart looks for to find a starting value.
    This allows the page developer to generate links directly to certain starting points in the org chart.
  • Update Progress Text Sets the text that will be displayed after a number of seconds waiting to update the chart.
  • Template Style Sets the style of the built in template. This can be None , Photo Left, Photo Right or No Photo.
  • Template Text Overflow If enabled then text that is too long for the org chart will be truncated.
  • Line Colour Sets the colour of the connecting lines.
  • Hyperlink Colour Sets the colour of the Link Field hyperlink.
  • Text Colour Sets the colour of the text used in the chart boxes.
  • Max Chart Depth Sets the maximum number of levels to show.
  • Stack Lower Level If enabled the lower level is displayed in a vertical stack rather than horizontally. This is useful to limit the amount of screen space occupied by larger organisation charts.
  • Background Type Sets the back ground type, either graphical, CSS or none.
  • CSS Background Outer HTML This contains the HTML for the encompassing DIV tag that is used if the Background Type is set to CSS.
  • No Style Sheet If enabled then the web part will not include any Javascript. This is used for diagnostics.

Presence Indicator

Shows the SharePoint presence indicator alongside the persons name

  • Property Description
  • Show Presence If enabled the SharePoint prescence indicator will be incorporated into the org chart boxes.
  • Email Field Sets the field name from the data source that holds the persons email address. This is required to ensure that the correct prescence can be displayed.

Quick Conditional Formatting

The page developer can set up some conditional formatting rules. These change the colour of the chart boxes depending on the evaluation of a rule.

  • Field The field name from the data source that will be evaluated.
  • Operator The operator applied to the field name. For example IsEqual.
  • Value The value being compared.
  • Color The colour that the chart box will be set to if the rule evaluates to true.

How can we help?

Our products

SharePointOrgChart

  • For Microsoft SharePoint
  • Download, install & configure
  • $750
 

TeamOrgChart

  • For Office 365 and Microsoft Azure
  • Online, interactive service based application
  • $100 +
 

OrgChartComponent

  • For ASP.NET websites and applications
  • Versatile & feature rich
  • $200 +
 

website design & build blooberrydesign.co.uk