This is a quick post to demonstrate how you would create or update the Information Rights audit policy for a specific content type in SharePoint.<\/p>\n
First things first, lets have a look at the method that implements this for us:<\/p>\n
\r\npublic void EnsureAuditPolicy(SPContentType ct)\r\n{\r\n const string AUDIT_POLICY_NAME = \"Custom Audit Policy\";\r\n \/\/ Policy XML for enabling all out of the box auditing\r\n const string AUDIT_POLICY = \"<\/p>\n
For the code to compile you’ll need to add a reference to the Microsoft.Office.Policy<\/em> assembly which is located in the ISAPI folder of the hive.<\/p>\n%ProgramFiles%\\Common Files\\Microsoft Shared\\Web Server Extensions\\14\\ISAPI\\Microsoft.Office.Policy.dll<\/p>\n
The two namespaces that should be added to your code are:<\/p>\n
\r\nusing Microsoft.Office.RecordsManagement.InformationPolicy;\r\nusing Microsoft.Office.RecordsManagement.PolicyFeatures;\r\n<\/pre>\nFrom looking at the code you can see it’s pretty straight forward. You call the static method GetPolicy<\/em> of Microsoft.Office.RecordsManagement.InformationPolicy.Policy to try and retrieve the policy object for the content type that was passed into the method.<\/p>\nFrom here we check if there is already a policy for the content type. Where there is no policy we create a new one via the CreatePolicy<\/em> static method. We then assign a name, statement and description – the text for this has no bearing on the type of audit that will be implemented.<\/p>\nThe last step is to check if the policy object has an existing policy item for auditing. We check this by attempting to retrieve the PolicyItem that has the feature id of the audit class. The feature id is provided for us by the policy object that we are creating – Microsoft.Office.RecordsManagement.PolicyFeatures.PolicyAudit.PolicyId<\/p>\n
The policy configuration in this example is provided by the AUDIT_POLICY constant. This enables all out of the box auditing for the content type.<\/p>\n
An easy way to retrieve the custom data for a policy is to create the policy through the UI and then write a simple console application to return the policy object for your content type, something like:<\/p>\n
\r\npublic string GetAuditPolicyCustomData(SPContentType ct)\r\n{\r\n string customData = string.Empty;\r\n Policy policy = Policy.GetPolicy(ct);\r\n\r\n if (policy != null)\r\n {\r\n PolicyItem auditItem = policy.Items[PolicyAudit.PolicyId];\r\n if (auditItem != null)\r\n {\r\n customData = auditItem.CustomData;\r\n Console.WriteLine(customData);\r\n }\r\n }\r\n\r\n return customData;\r\n}\r\n<\/pre>\nHere we are retrieving the audit policy configuration data for the manually configured content type, which for a fully enabled audit policy is: <\/p>\n
\r\nExamples of other audit objects that can be used are:<\/p>\n
\r\nMicrosoft.Office.RecordsManagement.PolicyFeatures.Barcode\r\nMicrosoft.Office.RecordsManagement.PolicyFeatures.Expiration\r\nMicrosoft.Office.RecordsManagement.PolicyFeatures.PolicyLabel\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"This is a quick post to demonstrate how you would create or update the Information Rights audit policy for a specific content type in SharePoint. First things first, lets have a look at the method that implements this for us: … Continue reading