In my former post I described, how we can manage Project Server event handlers via the managed client object model. In the current post I show you how to do that in case of lookup tables.
As I wrote in the previous post, we can deploy Project Server entities declaratively, via SharePoint solution packages (WSP), see that post for the details. An example for lookup tables is included below:
- <?xml version="1.0" encoding="utf-8" ?>
- <ProjectServerEntities xmlns="http://schemas.microsoft.com/sharepoint/">
- <LookupTables>
- <LookupTable Id="E7397277-1AB0-4096-B2DD-57029A055BA4" Name="YourLookupTable">
- <SortOrder>UserDefined</SortOrder>
- <Mask>
- <MaskLength>0</MaskLength>
- <MaskType>CHARACTERS</MaskType>
- <MaskSeparator>.</MaskSeparator>
- </Mask>
- <LookupEntry>
- <Id>8D3CFDD8-566B-4FA4-8C01-E315BCF13E74</Id>
- <ParentId />
- <SortIndex>86</SortIndex>
- <Value>
- <TextValue>Value1</TextValue>
- </Value>
- </LookupEntry>
- <LookupEntry>
- <Id>8A913280-C8D5-4E85-AE73-526EF5ABC686</Id>
- <ParentId />
- <SortIndex>100</SortIndex>
- <Value>
- <TextValue>Value2</TextValue>
- </Value>
- </LookupEntry>
- <LookupEntry>
- <Id>C89A98F0-795A-49EC-9031-BA892CE0D610</Id>
- <ParentId />
- <SortIndex>114</SortIndex>
- <Value>
- <TextValue>Value3</TextValue>
- </Value>
- </LookupEntry>
- </LookupTable>
- </LookupTables>
- </ProjectServerEntities>
Alternatively, we can deploy our entities (including the lookup table) via the managed client object model. I prefer this approach to the declarative option, as I feel more control on the process of what / when deployed / retracted.
First, we can list the lookup tables (including value sets) using the code below:
- using (var projectContext = new ProjectContext(pwaUrl))
- {
- projectContext.Load(projectContext.LookupTables,
- lts => lts.Include(
- lt => lt.Name,
- lt => lt.Id,
- lt => lt.FieldType,
- lt => lt.Entries.Include(
- lte => lte.FullValue,
- lte => lte.Id)));
- projectContext.ExecuteQuery();
- projectContext.LookupTables.ToList().ForEach(lt =>
- {
- Console.WriteLine("LT: Name [{0}], Id [{1}], FieldType [{2}]", lt.Name, lt.Id, lt.FieldType);
- lt.Entries.ToList().ForEach(lte => Console.WriteLine("LTE: Name [{0}], Id [{1}]", lte.FullValue, lte.Id));
- });
- }
The next code creates a new lookup table including three entries:
- var lookupTableName = "YourLookupTable";
- var values = new List<string> {
- "Value1",
- "Value2",
- "Value3"
- };
- using (var projectContext = new ProjectContext(pwaUrl))
- {
- var si = 0;
- var entries = values.ConvertAll(v => new LookupEntryCreationInformation
- {
- Id = Guid.NewGuid(),
- Value = new LookupEntryValue { TextValue = v },
- SortIndex = 100 + (si++) * 10
- });
- LookupTableCreationInformation ltci = new LookupTableCreationInformation
- {
- Id = Guid.NewGuid(),
- Name = lookupTableName,
- SortOrder = LookupTableSortOrder.UserDefined,
- Masks = new List<LookupMask> { new LookupMask { Length = 0, MaskType = LookupTableMaskSequence.CHARACTERS, Separator = "." } },
- Entries = entries
- };
- projectContext.LookupTables.Add(ltci);
- projectContext.LookupTables.Update();
- projectContext.ExecuteQuery();
- }
The code below removes an existing entry from a lookup table and inserts a new one into the entries:
- using (var projectContext = new ProjectContext(pwaUrl))
- {
- projectContext.Load(projectContext.LookupTables, lts => lts.Include(lt => lt.Name, lt => lt.Entries));
- projectContext.ExecuteQuery();
- var lookupTable = projectContext.LookupTables.First(lt => lt.Name == "YourLookupTable");
- // this value should be removed
- lookupTable.Entries.Remove(lookupTable.Entries.First(pe => pe.FullValue == "ValueToRemove"));
- // and a new value has to be created
- lookupTable.Entries.Add(new LookupEntryCreationInformation
- {
- Id = Guid.NewGuid(),
- Value = new LookupEntryValue { TextValue = "ValueToCreate" },
- SortIndex = 165
- });
- projectContext.LookupTables.Update();
- projectContext.ExecuteQuery();
- }
The last sample illustrates how we can remove a set of lookup tables based on their name:
- var tabledNames = new List<string> { "YourLookupTable", "AnotherLookupTable" };
- using (var projectContext = new ProjectContext(pwaUrl))
- {
- projectContext.Load(projectContext.LookupTables, lts => lts.Include(lt => lt.Name));
- projectContext.ExecuteQuery();
- // query made case insensitive
- tabledNames.ConvertAll(tn => projectContext.LookupTables
- .FirstOrDefault(lt => lt.Name.ToLower() == tn.ToLower()))
- .Where(lt => lt != null).ToList()
- .ForEach(lt => lt.DeleteObject());
- projectContext.ExecuteQuery();
- }
In my next post I describe how to work with enterprise custom fields using the managed client object model.
