BPMS Services – Use Cases and Applications - DBP - Designer Manual

13.1.2.2.7. Sample – Terminate Active Tasks for Specific DomainObject

13.1.2.2.8.1. Method – GetFileFromControl (DmsService)

BPMS Services encompass a wide range of functionalities and capabilities that are essential for the smooth operation of the platform. Each service serves a specific purpose and provides valuable features to enhance the overall user experience and enable efficient workflow management.

Some of the key services include:

ActivityService

Service Method	Service Method Signature	Purpose	Documentation
GetCurrentStateByProcessId	string GetCurrentStateByProcessId (string currentState, Guid processId)	——	——
GetCurrentState	string GetCurrentState (string currentState, Guid processVersionId)	——	——

CalendarService

Connection to Outlook and local timesheet

Service Method	Service Method Signature	Purpose	Documentation
CreateEvent	ServiceResult CreateEvent (string subject, string body, DateTime date, TimeSpan start, TimeSpan end, List<‍‍‍‍‍‍‍‍‍‍Guid‍‍‍‍‍‍‍‍‍‍> users = null, string room = null, bool allowOverlap = false)	Create a meeting/event	——
CreateDateRangeFullDayEvents	ServiceResult CreateDateRangeFullDayEvents (string subject, string body, DateTime startDate, DateTime endDateExcluded, List<‍‍‍‍‍‍‍‍‍‍Guid‍‍‍‍‍‍‍‍‍‍> users = null, string room = null, bool allowOverlap = false)	——	——
CheckAvailability	List<‍‍‍‍‍‍‍‍‍‍EventView‍‍‍‍‍‍‍‍‍‍> CheckAvailability (DateTime date, TimeSpan start, TimeSpan end, List<‍‍‍‍‍‍‍‍‍‍Guid‍‍‍‍‍‍‍‍‍‍> users = null, string room = null)	Check if users are available	——
CheckAvailability	List<‍‍‍‍‍‍‍‍‍‍EventView‍‍‍‍‍‍‍‍‍‍> CheckAvailability (DateTime startDate, DateTime endDate, List<‍‍‍‍‍‍‍‍‍‍Guid‍‍‍‍‍‍‍‍‍‍> users = null, string room = null)	Check if users are available	——
GetSuggestedMeetingTimes	List<‍‍‍‍‍‍‍‍‍‍EventView‍‍‍‍‍‍‍‍‍‍> GetSuggestedMeetingTimes (DateTime date, int duration, List<‍‍‍‍‍‍‍‍‍‍Guid‍‍‍‍‍‍‍‍‍‍> users = null, string room = null)	Get suggested meeting times	——
DeleteEvents	ServiceResult DeleteEvents (string meetingIds)	Delete meeting	——

DataSourceService

public DataTable ExecuteQuery(BaseTemplate connection, string query)

public string GenerateSelectQuery(DataTable dataTable, List<‍KeyValuePair<‍string, string‍>‍> schemadeclaration)

DelegationService

DmsService

Access to file storages, file attachment controls

Service Method	Service Method Signature	Purpose	Documentation
GetFileFromControl	List<‍‍‍‍‍‍‍‍‍‍DmsFile‍‍‍‍‍‍‍‍‍‍> GetFileFromControl (string groupId, bool isWithContent = true)	Get file from file attachment control	Documentation
GetFileContent	byte[] GetFileContent (string groupId, Guid fileId)	——	——
GetFileStream	Stream GetFileStream (string groupId, Guid fileId)	——	——
SaveAttachFile	Guid SaveAttachFile (byte[] buffer, string name)	——	——
SaveAttachFile	void SaveAttachFile (byte[] buffer, string name, Guid fileId)	——	——
AddAttachFile	Guid AddAttachFile (byte[] buffer, string name, string groupId)	——	——
SaveLocalFileAsAttachment	Guid SaveLocalFileAsAttachment (string filePath)	——	——
GetWordFormat	string GetWordFormat (string fileName, string appName, bool isPdf = false, bool isPrint = false)	——	——
GetAppFileContent	byte[] GetAppFileContent (string fileName, IFormObject formObject)	——	——
CustomFilesSaveFile	void CustomFilesSaveFile (string folder, string filename, byte[] filedata)	——	——
CustomFilesSaveFile	void CustomFilesSaveFile (string filename, byte[] filedata, params string[] paths)	——	——
CustomFilesSaveFile	void CustomFilesSaveFile (string folder, string filename, Stream inputStream)	——	——
CustomFilesSaveFile	void CustomFilesSaveFile (string filename, Stream inputStream, params string[] paths)	——	——
CustomFilesDeleteFolder	void CustomFilesDeleteFolder (string folder)	——	——
ParseWord	List<‍‍‍‍‍‍‍‍‍‍(string Header, string Section)‍‍‍‍‍‍‍‍‍‍> ParseWord (DmsFile file)	——	——
ZipFolder	void ZipFolder (string folderPath, string zipFullFileName)	——	——
UnzipFile	void UnzipFile (string zipFilePath, string unzipFolderPath)	——	——
GetFlatFileList	List<‍‍‍‍‍‍‍‍‍‍FileInfo‍‍‍‍‍‍‍‍‍‍> GetFlatFileList (string path)	——	——

DomainObjectService

Manipulating with entity objects (Domain Objects – DO)

Service Method	Service Method Signature	Purpose	Documentation
GetDomainObject	T GetDomainObject <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>(Guid objectId)	Get domain object by type and ID	——
CreateDomainObject	T CreateDomainObject <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>()	Create a new domain object	Documentation
CreateDomainObject	DomainObjectBase CreateDomainObject (Type domainObjectType)	Create a new domain object	——
CreateDomainObject	DomainObjectBase CreateDomainObject (Type domainObjectType, Guid id)	Create a new domain object with predefined ID	——
DeleteDomainObject	void DeleteDomainObject (DomainObjectBase domainObject)	Delete domain object	——
SaveDomainObject	void SaveDomainObject (DomainObjectBase domainObject)	——	——
SaveDomainObject	void SaveDomainObject (DomainObjectBase domainObject, Guid Id)	——	——
UpdateDomainObject	void UpdateDomainObject (DomainObjectBase domainObject)	——	——
GetAll	IList<‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍> GetAll <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>()	Get all domain objects of a specific type	——
GetFirst	T GetFirst <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>()	Get the first domain object of a specific type	——
GetEvents	PossibleEvent GetEvents (DomainObjectBase domainObject)	Get list of events available at the current state of the process	——
GetDomainObjectState	string GetDomainObjectState <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>(Guid objectId)	Get the current object state	——
GetDomainObjectTracking	string GetDomainObjectTracking <‍‍‍‍‍‍‍‍‍T‍‍‍‍‍‍‍‍‍>(Guid objectId)	Get object process tracking number	——
ReadFirstSheetOfExcel	DataTable ReadFirstSheetOfExcel (byte[] data, int indexIncrement = 0)	——	——
ReadOfExcel	DataTable ReadOfExcel (byte[] data, string sheetName, int indexIncrement = 0)	——	——
ReadOfExcel	DataTable ReadOfExcel (string fileName, string sheetName, int indexIncrement = 0)	——	——

EPCService

Connection to EPC

Service Method	Service Method Signature	Purpose	Documentation
GetAccessToken	string GetAccessToken (string baseUrl, string userName, string password)^obsolete	Get EPC access token	——
Login	bool Login (string baseUrl, string userName, string password, out List<‍‍‍‍‍‍‍‍‍string‍‍‍‍‍‍‍‍‍> errors)^{new 14.1}	Log in to EPC using local settings	Documentation
Login	bool Login (out List<‍‍‍‍‍‍‍‍‍string‍‍‍‍‍‍‍‍‍> errors)^{new 14.1}	Log in to EPC using global settings	Documentation
EPCGlobalURL	string EPCGlobalURL {get;}^{new 14.1}	Get Base URL from global settings	——
EPCGlobalUser	string EPCGlobalUser {get;}^{new 14.1}	Get Username from global settings	——
GetContent	string GetContent (string baseUrl, string envId, string accessToken)	Get raw content from EPC call	——
GetObjects	List<‍‍‍‍‍‍‍‍‍EPCObject‍‍‍‍‍‍‍‍‍> GetObjects(string api, Dictionary<‍‍‍‍‍‍‍‍‍string, object‍‍‍‍‍‍‍‍‍> parameters = null, string language = “en”)^{new 14.1}	Get a list of objects (environments etc.)	Documentation
GetUsers	List<‍‍‍‍‍‍‍‍‍EPCUser‍‍‍‍‍‍‍‍‍> GetUsers (string language = “en”)^{new 14.1}	Get a list of users	Documentation
ActionCreate	bool ActionCreate (EPCAction action, Guid envId)^{new 14.1}	Create an Action item	——
ActionDelete	bool ActionDelete (string actionId)^{new 14.1}	Delete an Action item	——

FolderService

FormService

Works with forms, form behaviors, form controls

Service Method	Service Method Signature	Purpose	Documentation
GetFormPrincipals	List<‍‍‍FormPrincipal‍‍‍> GetFormPrincipals (Guid formBehaviourId)	Get a list of the principals who have access to the form behavior	——
AddPrincipalsToForm	void AddPrincipalsToForm (Guid formBehaviourId, List<‍‍‍string‍‍‍> principals)	Make form behavior accessible for given principals	——
RemoveFormPrincipals	void RemoveFormPrincipals (Guid formBehaviourId, List<‍‍‍string‍‍‍> principals)	Remove principals from form behavior assignees	——
RemoveAllFormPrincipals	void RemoveAllFormPrincipals (Guid formBehaviourId)	Remove all principals from form behavior assignees	——
SaveFormProperties	void SaveFormProperties (Guid formBehaviourId, string title, Guid? category, int? order, List<‍‍‍Principal‍‍‍> principals)	Change form behavior properties	——
GetTemplates	List<‍‍‍(string language, Guid id, string filename, byte[] content)‍‍‍> GetTemplates (Guid formBehaviourId)	Get a list of export templates attached to the form behavior	——
SetTemplate	void SetTemplate (Guid formBehaviourId, string language, string filename, byte[] content)	Add an export template to the form behavior	——
SetFilter	void SetFilter (string sourceControlId, List<‍‍‍ClauseItem‍‍‍> filters)^{new 14.0}	Set a filter for a grid on a form like search panel does	Documentation
SetFilter	void SetFilter (IControl control, List<‍‍‍ClauseItem‍‍‍> filters)^{new 14.0}	Set a filter for a grid on a form like search panel does	Documentation
ClearFilter	void ClearFilter (string sourceControlId)^{new 14.0}	Clear a grid filter	Documentation
ClearFilter	void ClearFilter(IControl control)^{new 14.0}	Clear a grid filter	Documentation