public void ExtractLinkChangeActions(
Session session,
OAdEntity hostRecord,
List <LinkChangeGroup> linkChangeGroups)
{
string hostRecDispName = CQWrapper.GetEntityDisplayName(hostRecord);
string hostRecEntityDefName = CQWrapper.GetEntityDefName(hostRecord);
if (string.IsNullOrEmpty(hostRecEntityDefName) ||
!CQStringComparer.EntityName.Equals(hostRecEntityDefName, this.m_hostRecordType))
{
return;
}
string hostRecMigrItemId = UtilityMethods.CreateCQRecordMigrationItemId(hostRecEntityDefName, hostRecDispName);
var linkChangeGroup = new LinkChangeGroup(hostRecMigrItemId, LinkChangeGroup.LinkChangeGroupStatus.Created, false);
OAdFieldInfo fldInfo = CQWrapper.GetEntityFieldValue(hostRecord, m_referenceFieldName);
int cqFieldType = CQWrapper.GetFieldType(fldInfo);
if (cqFieldType == CQConstants.FIELD_REFERENCE_LIST)
{
// get the current entity def handle
OAdEntityDef curEntityDef = CQWrapper.GetEntityDef(session, hostRecEntityDefName);
OAdEntityDef refEntityDef = CQWrapper.GetFieldReferenceEntityDef(curEntityDef, m_referenceFieldName);
string childRecEntityDefName = CQWrapper.GetEntityDefName(refEntityDef);
int valueStatus = CQWrapper.GetFieldValueStatus(fldInfo);
if (valueStatus == (int)CQConstants.FieldStatus.HAS_VALUE)
{
// list value required
object[] refFldValObjs = CQWrapper.GetFieldValueAsList(fldInfo);
foreach (object refFldValObj in refFldValObjs)
{
string refFldVal = refFldValObj as string;
if (!CQStringComparer.RecordName.Equals(refFldVal, hostRecDispName))
{
// NOT a reference to self.. Note TFS cannot have a reference to self
OAdEntity childRecord = CQWrapper.GetEntity(session, childRecEntityDefName, refFldVal);
if (null != childRecord)
{
string childRecDispName = CQWrapper.GetEntityDisplayName(childRecord);
string childRecMigrItemId = UtilityMethods.CreateCQRecordMigrationItemId(
childRecEntityDefName, childRecDispName);
ILink refFieldLink = new ArtifactLink(
hostRecDispName,
new Artifact(hostRecMigrItemId, new ClearQuestRecordArtifactType()),
new Artifact(childRecMigrItemId, new ClearQuestRecordArtifactType()),
string.Empty,
this);
LinkChangeAction action = new LinkChangeAction(
WellKnownChangeActionId.Add,
refFieldLink,
LinkChangeAction.LinkChangeActionStatus.Created,
false);
linkChangeGroup.AddChangeAction(action);
}
else
{
// [teyang] TODO replace debug assertion with a conflict?
Debug.Assert(false, "null == childRecord");
}
}
} // foreach obj refFldValObj
}
}
linkChangeGroups.Add(linkChangeGroup);
}
public XmlDocument CreateRecordDesc(
OAdEntity record,
string versionStr,
ClearQuestMigrationContext migrationContext,
bool isLastRevOfThisSyncCycle)
{
string lastAuthor;
DateTime lastChangeDate;
FindLastRevDtls(record, out lastAuthor, out lastChangeDate);
ClearQuestRecordDescription recordDesc = new ClearQuestRecordDescription();
recordDesc.CreateHeader(lastAuthor, lastChangeDate, MigrationRecordId, EntityDefName, versionStr, isLastRevOfThisSyncCycle);
object[] fieldNames = (object[])CQWrapper.GetEntityFieldNames(record);
foreach (object fldName in fieldNames)
{
string fieldName = (string)fldName;
if (s_skipAlgorithm.SkipField(fieldName))
{
TraceManager.TraceInformation("Skipping Field '{0}' while migrating data for Entity '{1}'",
fieldName, EntityDefName);
continue;
}
OAdFieldInfo fldInfo = CQWrapper.GetEntityFieldValue(record, fieldName);
int cqFieldType = CQWrapper.GetFieldType(fldInfo);
switch (cqFieldType)
{
case CQConstants.FIELD_INT:
case CQConstants.FIELD_ID:
case CQConstants.FIELD_SHORT_STRING:
case CQConstants.FIELD_STATE:
case CQConstants.FIELD_DBID:
case CQConstants.FIELD_STATETYPE:
case CQConstants.FIELD_RECORDTYPE:
{
string fldValue = CQWrapper.GetFieldValue(fldInfo);
recordDesc.AddField(fieldName, string.Empty, fldValue ?? String.Empty);
}
break;
case CQConstants.FIELD_MULTILINE_STRING:
{
string fldValue = CQWrapper.GetFieldValue(fldInfo);
if (migrationContext == null ||
!CQStringComparer.FieldName.Equals(migrationContext.NotesLogFieldName, fieldName))
{
// non-log field
try
{
var aTestEntity = CreateTestEntity(record, migrationContext);
object[] choices = (object[])CQWrapper.GetFieldChoiceList(aTestEntity, fieldName);
if (choices != null && choices.Length > 0)
{
// Multi Line String with List of Allowed/Suggested Values.. replace all '\n' with comma
// fix for bug# 429098
if (fldValue != null)
{
fldValue = fldValue.Replace("\n", ",");
}
}
}
catch (Exception ex)
{
// NOTE:
// This feature of testing the multiline string choices create a dummy CQ record
// The API call CreateTestEntity requires WRITE permission to CQ
// If the migration account doesn't have the permission, we will simply use
// the field's current value
TraceManager.TraceInformation(
"Skipping retrieval of Allowed Values for field '{0}' - Write permission is needed. Error: {1}",
fieldName, ex.Message);
}
recordDesc.AddField(fieldName, string.Empty, fldValue);
}
else if (fldValue != null)
{
// log field
StringBuilder sb = new StringBuilder();
List <CQNotesLog> notes = CQNotesLog.Parse(fldValue);
foreach (CQNotesLog note in notes)
{
if (string.IsNullOrEmpty(note.Content) ||
note.Content.Contains(Constants.PlatformCommentSuffixMarker))
{
// skip empty logs or those generated by this adapter
continue;
}
if (note.Header.ChangeDate.CompareTo(migrationContext.CurrentHWMBaseLine) <= 0)
{
// skip the logs before the hwm
continue;
}
sb.AppendFormat("{0} {1} {2}\n",
CQNotesLogHeader.NotesLogHeaderIdentifier,
note.HeaderString,
CQNotesLogHeader.NotesLogHeaderIdentifier);
sb.AppendLine(note.Content);
}
string extractedLog = sb.ToString();
if (!string.IsNullOrEmpty(extractedLog))
{
recordDesc.AddField(fieldName, string.Empty, extractedLog);
}
}
}
break;
case CQConstants.FIELD_DATE_TIME:
{
string fldValue = CQWrapper.GetFieldValue(fldInfo);
if (fldValue != null)
{
// the time returned from CQ API is the local time..
DateTime fldVal = DateTime.Parse(fldValue, CultureInfo.CurrentCulture);
//convert it in UTC
DateTime utcTime = UtilityMethods.ConvertLocalToUTC(fldVal);
TraceManager.TraceInformation("Field [{0}], CQ Time [{1}], UTC Time [{2}]",
fieldName, fldVal.ToString(), utcTime.ToString());
recordDesc.AddField(fieldName, string.Empty, utcTime.ToString());
}
else
{
recordDesc.AddField(fieldName, string.Empty, string.Empty);
}
}
break;
case CQConstants.FIELD_REFERENCE:
{
// get the current entity def handle
OAdEntityDef curEntityDef = CQWrapper.GetEntityDef(CQSession, EntityDefName);
OAdEntityDef refEntityDef = CQWrapper.GetFieldReferenceEntityDef(curEntityDef, fieldName);
string refEntityName = CQWrapper.GetEntityDefName(refEntityDef);
if (CQWrapper.GetFieldValueStatus(fldInfo) == (int)CQConstants.FieldStatus.HAS_VALUE)
{
// single value required
string refFldVal = CQWrapper.GetFieldValue(fldInfo);
recordDesc.AddField(fieldName, string.Empty, refFldVal ?? string.Empty);
}
else
{
recordDesc.AddField(fieldName, string.Empty, string.Empty);
}
}
break;
case CQConstants.FIELD_REFERENCE_LIST:
{
// get the current entity def handle
OAdEntityDef curEntityDef = CQWrapper.GetEntityDef(CQSession, EntityDefName);
OAdEntityDef refEntityDef = CQWrapper.GetFieldReferenceEntityDef(curEntityDef, fieldName);
string refEntityName = CQWrapper.GetEntityDefName(refEntityDef);
object[] refFldValues = CQWrapper.GetFieldValueAsList(fldInfo);
if (refFldValues != null)
{
StringBuilder userList = new StringBuilder();
for (int valueIndex = 0; valueIndex < refFldValues.Length; valueIndex++)
{
object refFldObj = refFldValues[valueIndex];
if (valueIndex > 0)
{
userList.Append(",");
}
userList.Append((string)refFldObj);
}
recordDesc.AddField(fieldName, string.Empty, userList.ToString());
}
else
{
recordDesc.AddField(fieldName, string.Empty, string.Empty);
}
}
break;
case CQConstants.FIELD_ATTACHMENT_LIST:
case CQConstants.FIELD_JOURNAL:
TraceManager.TraceInformation("Skipping the Field migration for Internal Field Type '{0}'",
cqFieldType);
// not migrating these fields as they are CQ internal fields
continue;
default:
TraceManager.TraceInformation("Skipping the Field migration for Unkknown Field Type '{0}'",
cqFieldType);
break;
} // end of switch cqFieldType
} // end of foreach fieldNames
return(recordDesc.DescriptionDocument);
}
public bool Update(
ClearQuestMigrationContext migrationContext,
Session session,
OAdEntity hostRecord,
LinkChangeAction linkChangeAction)
{
if (null == linkChangeAction)
{
throw new ArgumentNullException("linkChangeAction");
}
if (!linkChangeAction.Link.LinkType.ReferenceName.StartsWith(ReferenceNameQualifier))
{
throw new ArgumentException("Link type mismatch.");
}
string childRecEntityDefName;
if (!ClearQuestRecordArtifactHandler.TryExtractRecordDefName(linkChangeAction.Link.TargetArtifact,
out childRecEntityDefName))
{
return(false);
}
string childRecDispName;
if (!ClearQuestRecordArtifactHandler.TryExtractRecordDispName(linkChangeAction.Link.TargetArtifact,
out childRecDispName))
{
return(false);
}
string refFieldName = linkChangeAction.Link.LinkType.ReferenceName.Substring(ReferenceNameQualifier.Length);
if (string.IsNullOrEmpty(refFieldName))
{
return(false);
}
string hostRecEntityDefName = CQWrapper.GetEntityDefName(hostRecord);
if (string.IsNullOrEmpty(hostRecEntityDefName) ||
!CQStringComparer.EntityName.Equals(hostRecEntityDefName, this.m_hostRecordType))
{
return(false);
}
// retrieve reference field information
OAdFieldInfo refFieldInfo = CQWrapper.GetEntityFieldValue(hostRecord, refFieldName);
int cqFieldType = CQWrapper.GetFieldType(refFieldInfo);
if (cqFieldType != CQConstants.FIELD_REFERENCE_LIST)
{
// the field is not of the FIELD_REFERENCE_LIST type
// [teyang] TODO conflict?
return(false);
}
// get the current entity def
OAdEntityDef hostRecordEntityDef = CQWrapper.GetEntityDef(session, CQWrapper.GetEntityDefName(hostRecord));
OAdEntityDef childRecordEntityDef = CQWrapper.GetFieldReferenceEntityDef(hostRecordEntityDef, refFieldName);
string childRecordEntityDefName = CQWrapper.GetEntityDefName(childRecordEntityDef);
if (!CQStringComparer.EntityName.Equals(childRecordEntityDefName, childRecEntityDefName))
{
// the field is not designated to hold reference to the EntityType of the target artifact
// [teyang] TODO conflict?
return(false);
}
int valueStatus = CQWrapper.GetFieldValueStatus(refFieldInfo);
if (valueStatus == (int)CQConstants.FieldStatus.HAS_VALUE)
{
// the field already has a list of reference values set
bool targetArtifactIsSet = false;
// value list expected
object[] refFldValues = CQWrapper.GetFieldValueAsList(refFieldInfo);
foreach (object refFldObj in refFldValues)
{
string refFldVal = (string)refFldObj;
if (CQStringComparer.RecordName.Equals(refFldVal, childRecDispName))
{
targetArtifactIsSet = true;
break;
}
}
if (targetArtifactIsSet)
{
// the target artifact is already referenced in the field
// [teyang] TODO conflict?
return(false);
}
}
string[] modifyActionNames = CQUtilityMethods.FindAllChangeActionNamesByType(
session, hostRecord, CQConstants.ACTION_MODIFY);
if (modifyActionNames.Length == 0)
{
// [teyang] TODO conflict?
return(false);
}
else if (modifyActionNames.Length > 1)
{
// [teyang] TODO conflict?
return(false);
}
else
{
string modAction = modifyActionNames[0];
CQWrapper.EditEntity(session, hostRecord, modAction);
string retVal = CQWrapper.AddFieldValue(hostRecord, refFieldName, childRecDispName);
retVal = CQWrapper.Validate(hostRecord);
if (string.IsNullOrEmpty(retVal))
{
// [teyang] TODO conflict
return(false);
}
retVal = CQWrapper.Commmit(hostRecord);
if (string.IsNullOrEmpty(retVal))
{
// [teyang] TODO conflict
return(false);
}
return(true);
}
}