NSProjectAgent - SuperOffice

Collection of all services that work with Project data.

Constructors

NSProjectAgent()

NSProjectAgent

Collection of all services that work with Project data.

Methods

AddProjectMembers(Integer,NSProjectMember[])

Adds multiple project members to a project

Void AddProjectMembers(Integer projectEntityId, NSProjectMember[] projectMembers)

Returns: CRMScript.Global.Void

CreateDefaultProjectEntity()

Sets default values into a new NSProjectEntity.

NSProjectEntity CreateDefaultProjectEntity()

Returns: CRMScript.NetServer.NSProjectEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSProjectAgent agent;
NSProjectEntity thing = agent.CreateDefaultProjectEntity();
thing = agent.SaveProjectEntity(thing);

CreateDefaultProjectEventEntity()

Sets default values into a new NSProjectEventEntity.

NSProjectEventEntity CreateDefaultProjectEventEntity()

Returns: CRMScript.NetServer.NSProjectEventEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSProjectAgent agent;
NSProjectEventEntity thing = agent.CreateDefaultProjectEventEntity();
thing = agent.SaveProjectEventEntity(thing);

CreateDefaultProjectMember()

Sets default values into a new NSProjectMember.

NSProjectMember CreateDefaultProjectMember()

Returns: CRMScript.NetServer.NSProjectMember

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSProjectAgent agent;
NSProjectMember thing = agent.CreateDefaultProjectMember();
thing = agent.SaveProjectMember(thing);

CreateNewEntry()

Creates a new project based on external duplicate

Integer CreateNewEntry(NSDuplicateEntry duplicate)

Returns: CRMScript.Global.Integer Example:

NSProjectAgent agent;
NSDuplicateEntry duplicate;
Integer res = agent.CreateNewEntry(duplicate);

DeleteProjectEntity(Integer)

Deletes the NSProjectEntity

DeleteProjectEntity(Integer projectEntity)

Returns: CRMScript.Global.Void Example:

NSProjectAgent agent;
agent.DeleteProjectEntity(123);

DeleteProjectEventEntity(Integer)

Deletes the NSProjectEventEntity

DeleteProjectEventEntity(Integer projectEventEntity)

Returns: CRMScript.Global.Void Example:

NSProjectAgent agent;
agent.DeleteProjectEventEntity(123);

DeleteProjectEventEntityFromProjectId(Integer)

Deletes a project event based on a project ID. Does not delete the project, but does delete the published and ExternalEvent and AudienceVisibility records.

Void DeleteProjectEventEntityFromProjectId(Integer projectId)

Returns: CRMScript.Global.Void Example:

NSProjectAgent agent;
Integer projectId;
agent.DeleteProjectEventEntityFromProjectId(projectId);

DeleteProjectMember(Integer)

Deletes the NSProjectMember

DeleteProjectMember(Integer projectMember)

Returns: CRMScript.Global.Void Example:

NSProjectAgent agent;
agent.DeleteProjectMember(123);

DeleteProjectMemberByIds(Integer[])

Deletes project-member rows.

Void DeleteProjectMemberByIds(Integer[] projectMemberIds)

Returns: CRMScript.Global.Void

DeleteProjectMembers(Integer,Integer[])

Deletes the given project members from a project

Void DeleteProjectMembers(Integer projectEntityId, Integer[] memberIds)

Returns: CRMScript.Global.Void

GetDuplicateRules()

Retrieve all available duplicate rules for project

NSDuplicateRule[] GetDuplicateRules()

Returns: CRMScript.NetServer.NSDuplicateRule[] Example:

NSProjectAgent agent;
NSDuplicateRule[] res = agent.GetDuplicateRules();

GetDuplicates(String)

Gets duplicates(exact or similar in the database) based on the name

NSDuplicateEntry[] GetDuplicates(String name)

Returns: CRMScript.NetServer.NSDuplicateEntry[] Example:

NSProjectAgent agent;
String name;
NSDuplicateEntry[] res = agent.GetDuplicates(name);

GetMyMemberProjects()

Returns projects where an user is project member.

NSProject[] GetMyMemberProjects()

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
NSProject[] res = agent.GetMyMemberProjects();

GetMyProjectEvents()

Gets all project events that belongs to the currently logged-on user.

NSProjectEvent[] GetMyProjectEvents()

Returns: CRMScript.NetServer.NSProjectEvent[] - The list of events is filtered by the Audience Visibility restrictions set when the project event is created. Example:

NSProjectAgent agent;
NSProjectEvent[] res = agent.GetMyProjectEvents();

GetMyProjects(Bool)

Returns projects belonging to an associate. If memberProjects is false only the projects where the associate is project responsible is returned, otherwise both the projects where the associate is project responsible and project member is returned.

NSProject[] GetMyProjects(Bool includeMemberProjects)

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
Bool includeMemberProjects;
NSProject[] res = agent.GetMyProjects(includeMemberProjects);

GetMyPublishedProjects()

Gets published projects from the logged in user.

NSProject[] GetMyPublishedProjects()

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
NSProject[] res = agent.GetMyPublishedProjects();

GetNextMilestone(Integer)

NSAppointment GetNextMilestone(Integer projectId)

Returns: CRMScript.NetServer.NSAppointment Example:

NSProjectAgent agent;
Integer projectId;
NSAppointment res = agent.GetNextMilestone(projectId);

GetNextProjectStatus(Integer)

Integer GetNextProjectStatus(Integer projectId)

Returns: CRMScript.Global.Integer

GetProject(Integer)

Gets an NSProject object.

NSProject GetProject(Integer projectId)

Returns: CRMScript.NetServer.NSProject Example:

NSProjectAgent agent;
NSProject thing = agent.GetProject(123);

GetProjectEntity(Integer)

Gets an NSProjectEntity object.

NSProjectEntity GetProjectEntity(Integer projectEntityId)

Returns: CRMScript.NetServer.NSProjectEntity Example:

NSProjectAgent agent;
NSProjectEntity thing = agent.GetProjectEntity(123);

GetProjectEntityWithoutMembers(Integer)

Get a project entity with no project members. Project members property is always an empty array.

NSProjectEntity GetProjectEntityWithoutMembers(Integer projectEntityId)

Returns: CRMScript.NetServer.NSProjectEntity Example:

NSProjectAgent agent;
NSProjectEntity thing = agent.GetProjectEntityWithoutMembers(123);

GetProjectEvent(Integer)

Gets an NSProjectEvent object.

NSProjectEvent GetProjectEvent(Integer projectEventId)

Returns: CRMScript.NetServer.NSProjectEvent Example:

NSProjectAgent agent;
NSProjectEvent thing = agent.GetProjectEvent(123);

GetProjectEventEntity(Integer)

Gets an NSProjectEventEntity object.

NSProjectEventEntity GetProjectEventEntity(Integer projectEventEntityId)

Returns: CRMScript.NetServer.NSProjectEventEntity Example:

NSProjectAgent agent;
NSProjectEventEntity thing = agent.GetProjectEventEntity(123);

GetProjectEventEntityFromProjectId(Integer)

Gets an NSProjectEventEntity based on a projectId.

NSProjectEventEntity GetProjectEventEntityFromProjectId(Integer projectId)

Returns: CRMScript.NetServer.NSProjectEventEntity Example:

NSProjectAgent agent;
Integer projectId;
NSProjectEventEntity res = agent.GetProjectEventEntityFromProjectId(projectId);

GetProjectEventList(Integer[])

Gets an array of NSProjectEvent objects.

NSProjectEvent[] GetProjectEventList(Integer[]  projectEventIds)

Returns: CRMScript.NetServer.NSProjectEvent[] Example:

Integer[] ids;
NSProjectAgent agent;
NSProjectEvent[] res = agent.GetProjectEventList(ids);

GetProjectEventOnPerson(Integer,Integer)

Gets an NSProjectEvent object from a project and a person.

NSProjectEvent GetProjectEventOnPerson(Integer projectId, Integer personId)

Returns: CRMScript.NetServer.NSProjectEvent

GetProjectEventsOnPerson(Integer)

Gets all project events that belongs to the person specified.

NSProjectEvent[] GetProjectEventsOnPerson(Integer personId)

Returns: CRMScript.NetServer.NSProjectEvent[] - The list of events are filtered by the Audience Visibility restrictions set when the project event is created. Example:

NSProjectAgent agent;
Integer personId;
NSProjectEvent[] res = agent.GetProjectEventsOnPerson(personId);

GetProjectImage(Integer)

Returns the project image that is displayed in the CRM application.

NSImage GetProjectImage(Integer projectId)

Returns: CRMScript.NetServer.NSImage Example:

NSProjectAgent agent;
Integer projectId;
NSImage res = agent.GetProjectImage(projectId);

GetProjectList(Integer[])

Gets an array of Project objects.

NSProject[] GetProjectList(Integer[] projectIds)

Returns: CRMScript.NetServer.NSProject[] Example:

Integer[] ids;
NSProjectAgent agent;
NSProject[] res = agent.GetProjectList(ids);

GetProjectMember(Integer)

Gets an NSProjectMember object.

NSProjectMember GetProjectMember(Integer projectMemberId)

Returns: CRMScript.NetServer.NSProjectMember Example:

NSProjectAgent agent;
NSProjectMember thing = agent.GetProjectMember(123);

GetProjectMembers(Integer)

Returns an array of project members

NSProjectMember[] GetProjectMembers(Integer projectId)

Returns: CRMScript.NetServer.NSProjectMember[] Example:

NSProjectAgent agent;
Integer projectId;
NSProjectMember[] res = agent.GetProjectMembers(projectId);

GetProjectMembersById(Integer[])

Returns an array of project members.

NSProjectMember[] GetProjectMembersById(Integer[] projectMemberIds)

Returns: CRMScript.NetServer.NSProjectMember[] Example:

NSProjectAgent agent;
Integer rojectMemberIds;
NSProjectMember[] res = agent.GetProjectMembersById(projectMemberIds);

GetProjectsFromContact(Integer)

Returns all projects where the given contact has project members.

NSProject[] GetProjectsFromContact(Integer contactId)

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
Integer contactId;
NSProject[] res = agent.GetProjectsFromContact(contactId);

GetProjectsFromPerson(Integer)

Returns all projects where the person is project member.

NSProject[] GetProjectsFromPerson(Integer personId)

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
Integer personId;
NSProject[] res = agent.GetProjectsFromPerson(personId);

GetPublishedProject(Integer)

Gets published project by project ID.

NSProject GetPublishedProject(Integer projectId)

Returns: CRMScript.NetServer.NSProject Example:

NSProjectAgent agent;
Integer projectId;
NSProject res = agent.GetPublishedProject(projectId);

GetPublishedProjects(Integer[])

Gets published projects by project IDs.

NSProject[] GetPublishedProjects(Integer[] projectIds)

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
Integer[] projectIds;
NSProject[] res = agent.GetPublishedProjects(projectIds);

GetPublishedProjectsOnPersonId(Integer)

Gets published projects where person is a member

NSProject[] GetPublishedProjectsOnPersonId(Integer personId)

Returns: CRMScript.NetServer.NSProject[] Example:

NSProjectAgent agent;
Integer personId;
NSProject[] res = agent.GetPublishedProjectsOnPersonId(personId);

HasGuide(Integer)

Bool HasGuide(Integer projectId)

Returns: CRMScript.Global.Bool - Does this project have a guide associated with its project type? Example:

NSProjectAgent agent;
Integer projectId;
Bool res = agent.HasGuide(projectId);

HasGuideActivities(Integer)

Bool HasGuideActivities(Integer projectId)

Returns: CRMScript.Global.Bool

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Bool IsNumberValid(Integer contactId, String number)

Returns: CRMScript.Global.Bool

The setting is configured from admin under system options.

Example:

NSProjectAgent agent;
Integer contactId;
String number;
Bool res = agent.IsNumberValid(contactId, number);

Merge(Integer,Integer,Bool)

Merges two projects into one, removing the source project in the process

Void Merge(Integer sourceProjectId, Integer destinationProjectId, Bool replaceEmptyFieldsOnDestination)

Returns: CRMScript.Global.Void

OfferAutoNextStatusOnAppointmentCompleted(Integer)

Bool OfferAutoNextStatusOnAppointmentCompleted(Integer appointmentId)

Returns: CRMScript.Global.Bool

SaveProjectEntity(NSProjectEntity)

Updates the existing NSProjectEntity or creates a new NSProjectEntity if the ID parameter is 0.

NSProjectEntity SaveProjectEntity(NSProjectEntity projectEntity)

Returns: CRMScript.NetServer.NSProjectEntity - New or updated NSProjectEntity. Example:

NSProject  agent;
NSProjectEntity thing = agent.CreateDefaultProjectEntity();
thing = agent.SaveProjectEntity(thing);

SaveProjectEntityWithoutMembers(NSProjectEntity)

Save or update a project entity, the project members are ignored.

NSProjectEntity SaveProjectEntityWithoutMembers(NSProjectEntity projectEntity)

Returns: CRMScript.NetServer.NSProjectEntity - New or updated NSProjectEntity. Example:

NSProject  agent;
NSProjectEntity thing = agent.CreateDefaultProjectEntity();
thing = agent.SaveProjectEntityWithoutMembers(thing);

SaveProjectEventEntity(NSProjectEventEntity)

Updates the existing NSProjectEventEntity or creates a new NSProjectEventEntity if the ID parameter is 0. Returns.

NSProjectEventEntity SaveProjectEventEntity(NSProjectEventEntity entity)

Returns: CRMScript.NetServer.NSProjectEventEntity - The new or updated NSProjectEventEntity. Example:

NSProject agent;
NSProjectEventEntity thing = agent.CreateDefaultProjectEventEntity();
thing = agent.SaveProjectEventEntity(thing);

SaveProjectMember(NSProjectMember)

Updates the existing NSProjectMember or creates a new NSProjectMember if the id parameter is 0

NSProjectMember SaveProjectMember(NSProjectMember projectMember)

Returns: CRMScript.NetServer.NSProjectMember Example:

NSProject  agent;
NSProjectMember thing = agent.CreateDefaultProjectMember();
thing = agent.SaveProjectMember(thing);

SaveProjectMembersFunctionAndComment(Integer[],Integer,String)

Saves role and comment on an array of project members represented by IDs.

Void SaveProjectMembersFunctionAndComment(Integer[] projectMemberIds, Integer roleId, String comment)

Returns: CRMScript.Global.Void

SetDuplicateRulesStatus(NSDuplicateRule[])

Sets which duplicate rules should be active or not

Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)

Returns: CRMScript.Global.Void

SetProjectImage(Integer,NSImage)

Stores the project image that is displayed in the CRM application.

Void SetProjectImage(Integer projectId, NSImage image)

Returns: CRMScript.Global.Void

UpdateProjectMember(NSProjectMember)

Updates an NSProjectMember row.

NSProjectMember UpdateProjectMember(NSProjectMember projectMember)

Returns: CRMScript.NetServer.NSProjectMember Example:

NSProjectAgent agent;
NSProjectMember projectMember;
NSProjectMember res = agent.UpdateProjectMember(projectMember);

ValidateProjectEntity(NSProjectEntity)

Checks that entity is ready for saving, return error messages by field.

Map ValidateProjectEntity(NSProjectEntity projectEntity)

Returns: CRMScript.Native.Map Example:

NSProjectAgent agent;
NSProjectEntity projectEntity;
Map res = agent.ValidateProjectEntity(NSProjectEntity);

​Constructors

​NSProjectAgent()

​Methods

​AddProjectMembers(Integer,NSProjectMember[])

​CreateDefaultProjectEntity()

​CreateDefaultProjectEventEntity()

​CreateDefaultProjectMember()

​CreateNewEntry()

​DeleteProjectEntity(Integer)

​DeleteProjectEventEntity(Integer)

​DeleteProjectEventEntityFromProjectId(Integer)

​DeleteProjectMember(Integer)

​DeleteProjectMemberByIds(Integer[])

​DeleteProjectMembers(Integer,Integer[])

​GetDuplicateRules()

​GetDuplicates(String)

​GetMyMemberProjects()

​GetMyProjectEvents()

​GetMyProjects(Bool)

​GetMyPublishedProjects()

​GetNextMilestone(Integer)

​GetNextProjectStatus(Integer)

​GetProject(Integer)

​GetProjectEntity(Integer)

​GetProjectEntityWithoutMembers(Integer)

​GetProjectEvent(Integer)

​GetProjectEventEntity(Integer)

​GetProjectEventEntityFromProjectId(Integer)

​GetProjectEventList(Integer[])

​GetProjectEventOnPerson(Integer,Integer)

​GetProjectEventsOnPerson(Integer)

​GetProjectImage(Integer)

​GetProjectList(Integer[])

​GetProjectMember(Integer)

​GetProjectMembers(Integer)

​GetProjectMembersById(Integer[])

​GetProjectsFromContact(Integer)

​GetProjectsFromPerson(Integer)

​GetPublishedProject(Integer)

​GetPublishedProjects(Integer[])

​GetPublishedProjectsOnPersonId(Integer)

​HasGuide(Integer)

​HasGuideActivities(Integer)

​IsNumberValid(Integer,String)

​Merge(Integer,Integer,Bool)

​OfferAutoNextStatusOnAppointmentCompleted(Integer)

​SaveProjectEntity(NSProjectEntity)

​SaveProjectEntityWithoutMembers(NSProjectEntity)

​SaveProjectEventEntity(NSProjectEventEntity)

​SaveProjectMember(NSProjectMember)

​SaveProjectMembersFunctionAndComment(Integer[],Integer,String)

​SetDuplicateRulesStatus(NSDuplicateRule[])

​SetProjectImage(Integer,NSImage)

​UpdateProjectMember(NSProjectMember)

​ValidateProjectEntity(NSProjectEntity)

Constructors

NSProjectAgent()

Methods

AddProjectMembers(Integer,NSProjectMember[])

CreateDefaultProjectEntity()

CreateDefaultProjectEventEntity()

CreateDefaultProjectMember()

CreateNewEntry()

DeleteProjectEntity(Integer)

DeleteProjectEventEntity(Integer)

DeleteProjectEventEntityFromProjectId(Integer)

DeleteProjectMember(Integer)

DeleteProjectMemberByIds(Integer[])

DeleteProjectMembers(Integer,Integer[])

GetDuplicateRules()

GetDuplicates(String)

GetMyMemberProjects()

GetMyProjectEvents()

GetMyProjects(Bool)

GetMyPublishedProjects()

GetNextMilestone(Integer)

GetNextProjectStatus(Integer)

GetProject(Integer)

GetProjectEntity(Integer)

GetProjectEntityWithoutMembers(Integer)

GetProjectEvent(Integer)

GetProjectEventEntity(Integer)

GetProjectEventEntityFromProjectId(Integer)

GetProjectEventList(Integer[])

GetProjectEventOnPerson(Integer,Integer)

GetProjectEventsOnPerson(Integer)

GetProjectImage(Integer)

GetProjectList(Integer[])

GetProjectMember(Integer)

GetProjectMembers(Integer)

GetProjectMembersById(Integer[])

GetProjectsFromContact(Integer)

GetProjectsFromPerson(Integer)

GetPublishedProject(Integer)

GetPublishedProjects(Integer[])

GetPublishedProjectsOnPersonId(Integer)

HasGuide(Integer)

HasGuideActivities(Integer)

IsNumberValid(Integer,String)

Merge(Integer,Integer,Bool)

OfferAutoNextStatusOnAppointmentCompleted(Integer)

SaveProjectEntity(NSProjectEntity)

SaveProjectEntityWithoutMembers(NSProjectEntity)

SaveProjectEventEntity(NSProjectEventEntity)

SaveProjectMember(NSProjectMember)

SaveProjectMembersFunctionAndComment(Integer[],Integer,String)

SetDuplicateRulesStatus(NSDuplicateRule[])

SetProjectImage(Integer,NSImage)

UpdateProjectMember(NSProjectMember)

ValidateProjectEntity(NSProjectEntity)