CHelper Functions

لغو فرایند

پرونده‌ها و پرونده‌های مرتبط با آن‌ها، شامل پرونده‌های هم‌سطح، فرزند و والد، را لغو می‌کند.

CHelper.abortProcess(Me, CaseId, AbortOption, AbortReason)

الحاق سندها از آرایه فایل‌ها

سندهای موجود در یک آرایه فایل را بسته به تابع انتخاب‌شده، در یک سند PDF یا Word ادغام می‌کند.

PDF

CHelper.ConcatDocumentsFromFilesArrayToPDF(filesArray)

Word

CHelper.ConcatDocumentsFromFilesArrayToWord(filesArray)

الحاق سندها از دو XPath

سندهای موجود در دو XPath متفاوت را بسته به تابع انتخاب‌شده، در یک سند PDF یا Word ادغام می‌کند.

PDF

CHelper.ConcatDocumentsFromTwoXpathsToPDF(Me, Xpath1, Xpath2)

Word

CHelper.ConcatDocumentsFromTwoXpathsToWord(Me, Xpath1, Xpath2)

الحاق سندها از XPath

سندهای موجود در یک XPath را بسته به تابع انتخاب‌شده، در یک سند PDF یا Word ادغام می‌کند.

PDF

CHelper.ConcatDocumentsFromXpathFileToPDF(Me, XPath)

Word

CHelper.ConcatDocumentsFromXpathFileToWord(Me, XPath)

تبدیل تاریخ از time zone سرور به time zone کاربر

یک تاریخ در UTC+0، یعنی زمان سرور، را به تاریخ و زمان متناظر در time zone کاربر تبدیل می‌کند.

CHelper.ConvertServerTimetoUserTime(idUser, serverTime)

تبدیل تاریخ از time zone کاربر به time zone سرور

یک مقدار date-time مرتبط با time zone کاربر را به زمان سرور، یعنی UTC+0، تبدیل می‌کند.

CHelper.ConvertUserTimetoServerTime(idUser, Date)

تبدیل تاریخ از time zone سرور به یک time zone مشخص

یک تاریخ در UTC+0، یعنی زمان سرور، را به تاریخ متناظر در time zone مشخص‌شده تبدیل می‌کند.

CHelper.ConvertServerTimeToTimeZoneTime("sTimeZoneName", serverTime)

تبدیل تاریخ از یک time zone مشخص به time zone سرور

یک مقدار date-time را از time zone مشخص‌شده به زمان سرور، یعنی UTC+0، تبدیل می‌کند.

CHelper.ConvertTimeZoneTimeToServerTime(st"sTimeZoneName", timeZoneTime):

شمارش

شمارشs the number of elements of an Entity.

CHelper.entityListشمارش("entityName", filter)

فعال‌سازی اجرای غیرهمزمان

این تابع id فعالیت غیرهمزمانی را که می‌خواهید فعال کنید به عنوان پارامتر می‌گیرد و آن را فعال می‌کند.

CHelper.EnableAsynchExecution(WorkitemId)

فعال‌سازی wait job

این تابع id کار زمان‌بندی‌شده‌ای را که می‌خواهید فعال کنید به عنوان پارامتر می‌گیرد و آن را فعال می‌کند.

CHelper.EnableWaitJob(WaitJobId)

دریافت همه work itemهای غیرهمزمان گیرکرده

این تابع همه فعالیت‌های غیرهمزمان مسدودشده را بازیابی می‌کند.

CHelper.GetAllStuckAsyncWorkitems()

دریافت همه wait jobهای گیرکرده

این تابع همه کارهای زمان‌بندی‌شده مسدودشده را بازیابی می‌کند.

CHelper.GetAllStuckWaitJobs()

دریافت WorkItemهای تخصیص‌یافته

همه WorkItemهایی را برمی‌گرداند که به یک کاربر مشخص تخصیص فعال دارند.

CHelper.getAssignedWorkItems(Me, CaseId, CurrentAsigneeId, IncludeSubProcesses)

دریافت attribute

مقدار یک attribute مشخص از یک رکورد مشخص در یک entity را برمی‌گرداند.

CHelper.getAttrib(sEntityName, oEntityKey, sAttribName)

دریافت Boolean

اگر پارامتر برابر باشد true برمی‌گرداند 1 or true ، و در غیر این صورت false برمی‌گرداند.

CHelper.getBoolean(value)

دریافت شیء پرونده

شیء پرونده را بدون نیاز به context برمی‌گرداند.

CHelper.getCaseById(CaseId)

دریافت کاربران پرونده

کاربرانی را که روی یک پرونده کار کرده‌اند به دست می‌آورد.

CHelper.getCaseUsers(CaseNumber)

دریافت زمان جاری برای کاربر

زمان جاری کاربر را به دست می‌آورد.

CHelper.GetCurrentTimeForUser(idUser)

دریافت مدت‌زمان مؤثر

برمی‌گرداند the اختلاف زمانی را بر حسب دقیقه و فقط با در نظر گرفتن روزهای کاری برمی‌گرداند.

CHelper.getEffectiveDuration(Me, Start, End)

دریافت مدت‌زمان مؤثر for user

برمی‌گرداند the اختلاف زمانی را بر حسب دقیقه و فقط با در نظر گرفتن روزهای کاری کاربر مشخص‌شده برمی‌گرداند.

CHelper.getEffectiveDurationForUser(i dUser , Start, End)

دریافت attribute از entity

مقداری را از یک Entity غیرمرتبط با Data Model به دست می‌آورد.

CHelper.getEntityAttrib(Entity, ValueToReturn, filter, filterParameters)

دریافت تاریخ تخمینی

با دریافت یک تاریخ اولیه و یک بازه زمانی، و با در نظر گرفتن Working Time Schema، یک تاریخ برمی‌گرداند.

CHelper.getEstimatedDate(Me, dtFromDate, iDuration)

دریافت تاریخ تخمینی for user

با دریافت user id، تاریخ شروع و تعداد دقیقه‌ها، یک تاریخ برمی‌گرداند.

CHelper.getEstimatedDateForUser(idUser, dtFromDate, iDuration)

دریافت تاریخ تخمینی from user date time

یک تاریخ را با در نظر گرفتن time schema و timezone کاربر محاسبه می‌کند.

CHelper.getEstimatedDateFromUserDateTime(UserId,iDuration)

دریافت مقدار محلی‌سازی‌شده

مقدار یک attribute محلی‌سازی‌شده entity را با استفاده از زبان کاربر جاری برمی‌گرداند.

CHelper.GetLocalizedValue(EntityName, AttribName, SurrogateKeyValue)

دریافت مقدار بعدی sequence

مقدار بعدی یک sequence را به دست می‌آورد.

CHelper.GetNextSeqValueStr("SequenceName")

دریافت مقدار پارامتر

مقدار یک پارامتر سفارشی را به دست می‌آورد.

CHelper.getParameterValue(parameterName)

دریافت Id فرایند والد

شناسه والد یک فرایند فرزند را بدون نیاز به context بازیابی می‌کند.

CHelper.getParentProcessId(caseId, wfclassName)

دریافت Id فرایندهای هم‌سطح

شناسه‌های فرایندهای هم‌سطح یک فرایند مشخص را به دست می‌آورد؛ یعنی Sub-Processهایی که Process والد یکسان دارند.

CHelper.getSiblingProcessesId(Me, WfClassName)

دریافت Solution date

با دریافت یک تاریخ اولیه و یک بازه زمانی، و با در نظر گرفتن Working Time Schema و تعطیلات، یک تاریخ برمی‌گرداند.

CHelper.getSolutionDate(Me, dtFromDate, iDuration)

دریافت solution date برای کاربر

با دریافت user id، تاریخ شروع و تعداد دقیقه‌ها، یک تاریخ برمی‌گرداند و Working Time Schema و تعطیلات کاربر را در نظر می‌گیرد.

CHelper.getSolutionDateForUser(idUser, dtFromDate, iDuration)

دریافت String Extended

مقدار ذخیره‌شده در یک شیء Extended را بازیابی می‌کند.

CHelper.GetStringExtended("ExtendedObjectName", Default value, Culture)

دریافت Id همه Sub-Processها

شناسه همه فرایندهای فرزند را به دست می‌آورد.

CHelper.getSubProcessesId(Me)

دریافت Id مربوط به Sub-Processهای مشخص

شناسه همه فرایندهای فرزند مشخص‌شده را به دست می‌آورد.

CHelper.getSubProcessesId(Me, WfClassName)

دریافت کاربران برای Position

فهرستی از کاربرانی را به دست می‌آورد که یک Position مشخص را در سازمان دارند.

CHelper.getUsersForPosition(posName)

دریافت کاربران فیلترشده برای position

اگر پارامتر "filterActive" برابر true باشد، فهرستی از کاربران فعالی را به دست می‌آورد که یک Position مشخص را در سازمان دارند.

CHelper.getUsersForPosition(posName, filterActive)

دریافت کاربران برای role

فهرستی از کاربرانی را به دست می‌آورد که یک Role مشخص را در سازمان دارند.

CHelper.getUsersForRole(roleName)

دریافت کاربران فیلترشده برای role

اگر پارامتر true باشد، فهرستی از کاربران فعالی را به دست می‌آورد که یک Role مشخص را در سازمان دارند.

CHelper.getUsersForRole(roleName, filterActive)

دریافت کاربران برای skill

فهرستی از کاربرانی را به دست می‌آورد که یک Skill مشخص را در سازمان دارند.

CHelper.getUsersForSkill(skillName)

دریافت کاربران فیلترشده برای skill

اگر پارامتر true باشد، فهرستی از کاربران فعالی را به دست می‌آورد که یک Skill مشخص را در سازمان دارند.

CHelper.getUsersForSkill(skillName, filterActive)

دریافت offset برای location

اختلاف time zone یک location با زمان سرور، یعنی UTC+0، را بر حسب دقیقه برمی‌گرداند.

CHelper.GetOffsetForLocation(idLocation)

دریافت offset برای organization

اختلاف time zone یک organization با زمان سرور، یعنی UTC+0، را بر حسب دقیقه برمی‌گرداند.

CHelper.GetOffsetForOrganization(idOrganization )

دریافت offset برای user

اختلاف time zone تعریف‌شده برای یک کاربر مشخص با زمان سرور، یعنی UTC+0، را بر حسب دقیقه برمی‌گرداند.

CHelper.GetOffsetForUser(idUser)

دریافت offset برای working time zone

اختلاف بین time zone تعریف‌شده در WorkingTimeZone key و زمان سرور، یعنی UTC+0، را بر حسب دقیقه برمی‌گرداند.

CHelper.GetOffsetForWorkingTimeZone()

دریافت کاربران بر اساس Persona

برای نام entity مربوط به Persona داده‌شده، آرایه‌ای از شیءهای Persona برمی‌گرداند.

CHelper.GetUsersForPersona("PersonaName")

دریافت Personaها برای کاربر

همه Personaهای یک کاربر مشخص را به دست می‌آورد.

GetPersonasForUser("User Id")

GetPersonasForUser("User Id","PersonaName")

دریافت XSD

schema از پیش تعریف‌شده هر entity را مطابق پیکربندی انجام‌شده در Bizagi Studio به دست می‌آورد.

CHelper.getXSD(entityName, xsdName)

دریافت XSL

فایل transformation از پیش تعریف‌شده‌ای را که برای یک entity ثبت کرده‌اید، مطابق پیکربندی Bizagi Studio، به دست می‌آورد.

CHelper.getXSL(entityName, xslName)

اعطای دسترسی به پرونده

به کاربر داده‌شده برای پرونده داده‌شده دسترسی اعطا می‌کند.

CHelper.GrantCaseAccess(idCase, idUser)

بررسی خالی بودن

برمی‌گرداند اگر شیء مشخص‌شده به عنوان پارامتر خالی باشد true، و در غیر این صورت false برمی‌گرداند.

CHelper.IsEmpty(Variable)

بررسی null بودن

برمی‌گرداند true if the object specified as parameter is null; otherwise, returns false.

CHelper.IsNull(Variable)

بررسی روز کاری

بررسی می‌کند که یک Date روز کاری است یا نه.

CHelper.IsWorkingDay(Me,Date)

بررسی روز کاری for user

بررسی می‌کند که یک Date برای کاربر مشخص روز کاری است یا نه.

CHelper.IsWorkingDayForUser(idUser, Date)

بررسی ساعت کاری

برمی‌گرداند true if a specific date falls under the organization's working time schema; otherwise, it returns false.

CHelper.IsWorkingMinute(Me, Date)

بررسی ساعت کاری for user

برمی‌گرداند true if a specific date falls under the given user's working time schema; otherwise, it returns false.

CHelper.IsWorkingMinuteForUser(idUser, Date)

دریافت کاربر بعدی برای تخصیص بر اساس بار کاری

برمی‌گرداند the id of the next user available for assignment by load.

CHelper.LoadAssig(AssigneeList, Me)

پرونده جدید

یک پرونده جدید با کاربر ایجادکننده تعریف‌شده ایجاد می‌کند.

CHelper.NewCase(idUser,WFClassName)

پرونده جدید with business information

بر اساس اطلاعات ارائه‌شده در پارامتر ورودی، یعنی رشته XML، یک پرونده جدید ایجاد می‌کند.

CHelper.NewCase(XML)

اجرای activity

یک activity را اجرا می‌کند؛ معادل فشار دادن دکمه NEXT است.

CHelper.PerformActivity(XML_ActivityInfo)

اجرای cancel intermediate event

یک cancellation ایجاد می‌کند و فایل log مربوط به cancellation را اضافه می‌کند.

CHelper.RaiseCancelIntermediateEvent(message)

اجرای error intermediate event

activity جاری را متوقف می‌کند و مسیر عادی را به سمت مسیر خطا منحرف می‌کند. این تابع یک فایل log خطا اضافه می‌کند.

CHelper.RaiseErrorIntermediateEvent(message)

اجرای cancel end event

Sub-Process تراکنشی را متوقف می‌کند و مسیر عادی را به سمت مسیر cancel منحرف می‌کند.

CHelper.RaiseCancelEndEvent(message)

اجرای error end event

Sub-Process تراکنشی را متوقف می‌کند و مسیر عادی را به سمت مسیر خطا منحرف می‌کند.

CHelper.RaiseErrorEndEvent(message)

بازنشانی مقدار sequence

مقدار seed یک sequence را با دریافت نام sequence به عنوان ورودی، به مقدار اولیه آن بازنشانی می‌کند.

اگر از CHelper.ResetSequenceValue استفاده می‌کنید، اطلاعات Rules API را بخوانید، چون استفاده از این تابع ملاحظات مهمی دارد.

CHelper.ResetSequenceValue("SequenceName")

Resolve کردن Vocabulary

مقدار ذخیره‌شده در یک Vocabulary مشخص را به دست می‌آورد.

CHelper.resolveVocabulary(Me, VocabularyName)

دریافت کاربر بعدی برای تخصیص بر اساس sequence

id کاربر بعدیِ در دسترس برای تخصیص بر اساس sequence را برمی‌گرداند.

CHelper.SecuentialAssig(AssigneeList, Me)

تنظیم attribute

مقدارهای attribute مشخص را از رکوردهای مشخص یک entity تغییر می‌دهد.

اگر از CHelper.setAttrib استفاده می‌کنید، اطلاعات این لینک را با دقت بخوانید، چون استفاده از این تابع ملاحظات مهمی دارد.

CHelper.setAttrib(sEntityName, oEntityKey, sAttribName, oAttribValue)

اجرای event

یک intermediate Event موجود در Bizagi را که نوع مشخصی برای آن تعریف نشده است اجرا می‌کند.

CHelper.setEvent(Me, Caseid, eventName, null)

CHelper.setEvent(xml)

بررسی وجود فرایندهای باز

بررسی می‌کند که برای یک شماره ایجاد پرونده مشخص، پرونده باز وجود دارد یا نه.

CHelper.thereAreOpenProcesses(CaseNumber)

بررسی وجود فرایندهای باز

بررسی می‌کند که برای یک شماره ایجاد پرونده مشخص و WfClassName، پرونده باز وجود دارد یا نه.

CHelper.thereAreOpenProcesses(caseNumber, wfclassName)

نمایش خطای اعتبارسنجی

یک پیام خطا را در Work Portal نمایش می‌دهد.

CHelper.ThrowValidationError(message)

نمایش هشدار اعتبارسنجی

یک پیام هشدار سفارشی را در Work Portal نمایش می‌دهد.

CHelper.ThrowValidationAlert(message)

تبدیل به base64

فایل‌ها را به base64 تبدیل می‌کند.

CHelper.ToBase64(data)

تبدیل به Integer

یک string را به Integer تبدیل می‌کند.

CHelper.ToInt(sText)

Trace

traceهای تعریف‌شده توسط کاربر را که به صورت دستی در Business Rules قرار داده شده‌اند، در log ثبت می‌کند.

CHelper.trace(sFileName, sText)

به‌روزرسانی metadata در ECM

اطلاعات کسب‌وکار را برای ذخیره‌سازی در ECM به یک سند نگاشت می‌کند.

CHelper.UpdateECMMetadata(Me, data, XPath)

اجبار attribute برای استقرار

Bizagi را مجبور می‌کند attributeهایی را که در deployment لحاظ نشده‌اند، وارد کند.

CHelper.usingXPath(xpath)

CHelper.usingXPath(EntityName, xpath)