The out-of-the-box Project Cache is configured to report on the Project Statement and Projects Tracker list columns and metrics (included in the out-of-the-box templates). If you have added columns to a Project Statement, you can use the Automatic Mapping steps below to include them in Project Cache reporting.
For new columns in the Projects Tracker list, or metric items in the Metrics list, you should follow the Manual Mapping steps below to include these columns in Project Cache reporting.
To map a column from the Project Statement to the Project Cache:
Automatic mapping is a recent addition to BrightWork. It currently allows you to do the following:
Tip! As this functionality is a work in progress we welcome your input in the form of a one question survey asking what you would like to see next in Project Cache column mapping.
Tip! Best practice would be to add columns and do mapping from the site template. This will help reduce maintenance and the risk of duplicate effort.
If you have not already created the new Project Statement column you need then:
Note: Spaces in column names in SharePoint are returned as
_x0020_. This is why it is good practice not to use spaces in column names when creating them. We recommend you create the column name without spaces and save it. Then re-edit the column settings to add any spaces to the column's caption.
The following steps require Site Collection Administrator access.
When adding a column to the Project Cache list you need to open the Project Cache and create a column of the appropriate type.
If the source column is coming from a Project Statement or Projects Tracker list, you should follow these rules:
|Source Column Type||Project Cache Column Type|
|Single line of text||
|Multiple lines of text||
|Choice with 'allow multiple selections'||
|Date and Time||
|Lookup with 'Allow multiple values'||
|Person or Group||
|Person or Group with 'Allow multiple selections'||
|Hyperlink or Picture||
|Calculated Single line of text||
|Calculated Date and Time||
|Choice Indicator Icon||
|Number Indicator Icon||
If the source is in a Metric, select a column type that maps to the data type you want to output from the Metric.
We do not recommend adding Site Columns to the Project Cache list.
It is recommended that the same or a similar name is used in the source and Project Cache to make understanding and maintenance easier.
Note: Project Cache Mapping applies to the entire Site Collection. So even though the mapping is done in a template or project site, it impacts the entire Site Collection. So when making changes to Project Cache Mapping, it is important to consider the impact of any changes on other sites within the site collection.
You can then add new column Mappings or manage existing Mappings.
Tip! If you have not already added a column to the Project Cache List you can open the Project Cache in a new browser tab by clicking on the 'Project Cache List' link at the top of the page.
The Project Cache Mapping page contains the following:
When updating the Project Cache, if a mapping for both an active metric and a Project Statement value exist for the same Project Cache column, then the metric value is written to the Project Cache and not the Project Statement value. The Metric override column indicates that the mapping file is looking for both a metric value as well as a Project Statement value. A 'Yes' indicates that both mapping are possible. If the metric also exists in the site it will display the name of the Metric in brackets.
A good example to help understand this is % Complete. In the Project Lite template the % Complete is filled in manually by the project manager using the Project Statement. In a Project Standard template, the % Complete is a metric and gets updated automatically. Both of these values are mapped to the one % Complete column in the Project Cache.
If a Metric Override is possible, and the metric exists in the site, this columns displays whether the metric is active or not.
'Yes' means the metric exists in the site and is active. In this scenario, the metric's value will be written to the Project Cache and the Project Statement's value will not.
Clicking on Remove will delete the specific mapping from the mapping file. This can be useful if you make a mistake and need to remove an incorrect mapping.
Caution: consider the impact on other sites in the site collection before you Remove a mapping.
Note: If a Metric Override is possible, then the 'Remove' option is disabled.
To add a new column mapping:
When using the Project Cache Mapping page, only one person can make updates at a time. If more than one change is made at the same time then you may get an error saying: 'This version is not the latest version of the report'. Should this happen you need to refresh the Project Cache Mapping page and try your change again.
In order to map Projects Tracker items and Project Metrics to the Project Cache you still need to follow these more manual steps.
Note: This task requires SharePoint Designer 2013 and some experience with working in HTML or XML would be an advantage.
You also need to know how to add columns to lists and understand what a Metric Id is.
You need to be a Site Collection Administrator or a member of the BrightWork Cache Administrator's user group to perform this task.
Follow the steps for Adding a Column to the Project Cache List above.
Update the global ProjectCacheGlobalSettings.xml file that maps the column to the Project Cache list column.
Add a column in a Project Statement (710) or Projects Tracker (727) list
<Field target="bwPCIProjectId" source="Title" />
With Project Statement (710) or the Projects Tracker (727) lists, you supply the following data:
Add Metric Item
<IfMetric id="ActualStartDate" source="MetricValue" />
With Metric items, you supply the following:
Map both a Metric value and a Project Statement Column to the same Project Cache Column
In certain situations, a piece of project data may be captured by a Metric in one template and in the Project Statement in another template. As when adding Project Metric Joins in the Report Editor, the Project Cache allows you to map both of these values to a single column in a report. If both values exist, active Metrics will take precedence.
<Field target="bwPCIActualStartDate" source="StartDateActual">
<IfMetric id="ActualStartDate" source="MetricValue" />
To map Metric items to a Project Cache column, you can map the following as needed:
The ProjectCacheGlobalSettings.xml is for specifying global mappings in a BrightWork site collection. Every site also has its own ProjectCacheSettings.xml file.
The Project Cache list supports the addition of calculated columns. You do not need to add these columns to the ProjectCacheGlobalSettings.xml file.
If the column you want to map has a different internal name in a certain site (for example, one project template uses a column called Organization and the rest use a column called Department), update the local ProjectCacheSettings.xml with the appropriate mapping information and it will override the global setting specified in the top level ProjectCacheGlobalSettings.xml file.
Changes to the ProjectCacheSettings.xml file are automatically included in Design Sync. This means that changes to this file should be made in the Template and synced, especially if Design Sync is being used.