Bewerken: Workflow Commands — Common

Sectie: Overzicht

Reden:

## Overzicht

| Command | Inputs | Outputs | Beschrijving |
|---------|--------|---------|--------------|
| `Accessibility_GetThemes` | `Language`?: `CountryCode?`, `CurrentTheme`?: `string` | `Themes`: `IList<AccessibilityTheme>`, `CurrentThemeObject`?: `AccessibilityTheme` | Gets accessibility themes |
| `AddCalendarDaysToDate` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`: `UltimoDateTime`, `NumberOfDays`: `decimal`, `CorrectToStartOfWorkingDay`?: `bool?`, `RoundToMinutes`?: `bool?` | `CalculatedDate`: `UltimoDateTime` |  |
| `AddCalendarHoursToDate` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`: `UltimoDateTime`, `NumberOfHours`: `decimal`, `CorrectToStartOfWorkingDay`?: `bool?`, `RoundToMinutes`?: `bool?` | `CalculatedDate`: `UltimoDateTime` |  |
| `AddCalendarMinutesToDate` | `StartDate`: `UltimoDateTime`, `NumberOfMinutes`: `int`, `WorkSchedule`?: `IWorkSchedule`, `CorrectToStartOfWorkingDay`?: `bool?` | `CalculatedDate`: `UltimoDateTime` |  |
| `AddCalendarTimeSpanPercentageToDate` | `Percentage`: `decimal`, `FromDate`: `UltimoDateTime?`, `TillDate`: `UltimoDateTime?`, `RoundToMinutes`?: `bool`, `WorkSchedule`?: `IWorkSchedule` | `DateTimePercentage`: `UltimoDateTime?` |  |
| `AddFileToArchive` | `ArchiveFileName`: `UltimoString`, `FileName`: `UltimoString`, `File`: `StreamContainer` | — | Add file to zip archive in the file service. If the archive does not exists, a new archive will be created. |
| `AddFrequencyToDate` | `Frequency`: `IFrequency`, `Interval`: `int`, `StartDate`: `UltimoDateTime?` | `CalculatedDate`: `UltimoDateTime` |  |
| `AddTimeUnitsToDate` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`: `UltimoDateTime`, `Quantity`: `decimal`, `TimeUnit`: `ITimeUnit`, `RoundToMinutes`?: `bool?` | `CalculatedDate`: `UltimoDateTime?` |  |
| `AddWeeksToWeekOfYear` | `NumberOfWeeks`: `int` | — |  |
| `Address_CallZipCodeApi` | `UrlForApiCall`: `string`, `Timeout`?: `int?` | `ResponseStatus`?: `short`, `ApiResponse`?: `string`, `ErrorMessage`?: `string` | Calls the zip code API v2 and returns JSON string with address info |
| `Address_DeserializeZipCodeApiResponse` | `ApiResponse`: `string` | `Street`?: `string`, `City`?: `string`, `Municipality`?: `string`, `Province`?: `string`, `Latitude`?: `decimal`, `Longitude`?: `decimal`, `GeocodeX`?: `decimal`, `GeocodeY`?: `decimal`, `ErrorMessage`?: `string`, `DeserializationErrors`?: `ZipCodeApiDeserializationErrors`, `AddressInfoFound`?: `bool` | Deserializes the JSON that was returned by the zip code API and returns Address fields if successful |
| `ApplicationElement_IsAuthorized` | `ApplicationElementId`: `UltimoString` | `IsAuthorized`: `bool` | Checks if user can execute a specific application element |
| `Application_ToggleServiceModeUct` | — | — |  |
| `ArticleCreateExchangePart_CheckConfiguration` | `Article`: `IArticle`, `EquipmentContext`?: `Context`, `CreateAsEquipment`: `bool` | — |  |
| `CalculateCompanyMoney` | `ToCalculate`: `TransactionMoney`, `Decimals`?: `int?`, `Date`?: `UltimoDateTime?` | `Calculated`: `CompanyMoney` | Calculate company money from transaction money |
| `CalculateCurrency` | `ToCalculate`: `TransactionMoney`, `ConversionFactor`: `short`, `Rate`: `decimal` | `Calculated`: `CompanyMoney` | Calculate currency |
| `CalculateNextDateAndWorkPeriod` | `WorkPeriodIds`: `IList<string>`, `NumberOfWorkPeriodsToAdd`: `int`, `CurrentWorkPeriod`: `IWorkPeriod`, `CurrentDate`: `UltimoDateTime`, `Pattern`: `TimeslotPattern` | `TargetDate`?: `UltimoDateTime`, `TargetWorkPeriod`?: `IWorkPeriod`, `OccurrencesText`?: `string`, `PatternText`?: `string` |  |
| `CalculateTransactionMoney` | `ToCalculate`: `CompanyMoney`, `Currency`: `ICurrency`, `Decimals`?: `int?`, `Date`?: `UltimoDateTime?` | `Calculated`: `TransactionMoney` | Calculate transaction money from company money or transaction money |
| `CalculateVatPrice` | `Percentage`: `decimal`, `InPriceIsTotal`: `bool`, `InPrice`?: `CompanyMoney` | `OutPrice`?: `CompanyMoney`, `OutVatPrice`?: `CompanyMoney` | CalculateVatPrice |
| `CalculateWorkTime` | `DateFrom`: `UltimoDateTime`, `DateTill`: `UltimoDateTime`, `WorkSchedule`: `IWorkSchedule` | `WorkTime`: `int` |  |
| `ChangeElevateRightsPassword` | `NewPassword`: `UltimoString`, `CurrentPassword`: `UltimoString` | — |  |
| `CheckDatesAgainstWorkSchedule` | `WorkSchedule`: `IWorkSchedule`, `StartTime`: `UltimoDateTime`, `EndTime`: `UltimoDateTime` | `IsAvailable`?: `bool` |  |
| `CheckForRecordAuthorization` | `EntityName`?: `UltimoString` | `RecordAuthorizationActive`: `bool` |  |
| `CheckOtherActiveUsers` | — | `OtherActiveUser`: `bool` |  |
| `ClearCache` | — | — | Clear cache (fileservice, ummsettings, selfservice, users, groups, screen info, status info, ...) |
| `ComparePath` | `Path1`: `string`, `Path2`: `string` | `Equal`: `bool` | Compare two paths if they are equal |
| `CompareValueInUltimoStringWithObjectOfSpecificType` | `ValueAsUltimoString`?: `UltimoString`, `ValueObject`?: `object`, `DataType`: `UltimoString` | `ComparisonResult`?: `int?` | Compares the value of an UltimoString with an object of specific data type |
| `ContextMenu_CreateAction` | `Description`?: `UltimoString`, `LabelCode`?: `UltimoString`, `TextParameters`?: `WorkflowDictionary<object>`, `ApplicationElementId`: `UltimoString`, `Properties`?: `WorkflowDictionary<object>` | `ContextMenuAction`?: `ContextMenuItemModel`, `IsAuthorized`: `bool` | Creates a context menu action with given description (optionally via label code) and AE id, optionally adding workflow properties |
| `ContextMenu_CreateGroup` | `Description`?: `UltimoString`, `Items`?: `IList<ContextMenuItemModel>` | `ContextMenuGroup`: `ContextMenuItemModel` | Creates a context menu group with given description, optionally adding context menu items |
| `ContextMenu_GetActionsForConfiguration` | `ApplicationElementId`: `UltimoString`, `Exceptions`?: `IList<UltimoString>` | `ContextMenuActions`: `List<ContextMenuItemModel>` | Returns a list of context menu action templates that are found under a specific application structure element in the AET and for which the user is authorized |
| `ConvertBase64ToFile` | `FileName`: `string`, `Data`: `string` | — | Convert Base64 To File |
| `ConvertDateToWorkingDay` | `Date`: `UltimoDateTime`, `WorkSchedule`?: `IWorkSchedule` | `CalculatedDate`: `UltimoDateTime` |  |
| `ConvertFileToBase64` | `FileName`: `string` | `Data`: `string` | Convert File To Base64 |
| `ConvertJsonToXml` | `JsonDocument`: `StreamContainer` | `XmlDocument`: `XmlDocumentContainer` |  |
| `ConvertLDAPDate` | `Input`: `string` | `Output`?: `UltimoDateTime?` |  |
| `ConvertSecretStringToString` | `InputValue`: `SecretString` | `OutputValue`?: `string` | Convert SecretString to string |
| `ConvertValue` | `InputValue`: `decimal`, `InputDerivedUnit`: `DerivedUnit`, `OutputDerivedUnit`: `DerivedUnit` | `OutputValue`: `decimal` |  |
| `CorrectWorkingTimesToWorkSchedule` | `DateTime`: `UltimoDateTime`, `WorkSchedule`: `IWorkSchedule`, `SetToEnd`?: `bool` | `CalculatedDateTime`: `UltimoDateTime` |  |
| `CreateExcelDocument` | `DefinitionName`: `string`, `FileName`: `string`, `ExcelVersion`?: `string` | `Guid`: `Guid` | CreateExcelDocument |
| `CreateLegendData` | `Width`: `int`, `Groups`?: `IList<ILegendItemGroup>` | `LegendData`: `ILegendData` | Creates a legend data model, optionally adding legend item groups |
| `CreateLegendItem` | `Description`?: `UltimoString`, `LabelCode`?: `UltimoString`, `TextParameters`?: `WorkflowDictionary<object>`, `IconName`?: `UltimoString`, `Color`?: `UltimoString`, `BackgroundColor`?: `UltimoString` | `LegendItem`: `ILegendItem` | Creates a legend item model |
| `CreateLegendItemGroup` | `Title`?: `UltimoString`, `LabelCode`?: `UltimoString`, `TextParameters`?: `WorkflowDictionary<object>`, `Items`?: `IList<ILegendItem>` | `LegendItemGroup`: `ILegendItemGroup` | Creates a legend item group model, optionally adding legend items |
| `CreateWordDocument` | `Template`: `StreamContainer`, `DocumentType`?: `string`, `Parameters`?: `IWorkflowDictionary` | `Document`: `StreamContainer` | Create Microsoft Word document based upon template. |
| `Culture_GetAvailableCultures` | `CurrentCulture`?: `string`, `DateTime`?: `UltimoDateTime?` | `Cultures`: `List<CultureDescriptor>`, `CurrentCultureObject`?: `CultureDescriptor`, `ApplicationCultureObject`: `WorkflowDictionary<CultureDescriptor>` | Gets available cultures |
| `Database_Optimize` | `Timeout`?: `int?` | — | Database_Optimize |
| `DateTimeAddTimeSpan` | `TimeSpan`?: `Duration?` | — |  |
| `DateTimeProperties` | `StartDate`: `Date` | `FirstDayOfMonth`?: `string`, `NewStartDate`?: `Date?` |  |
| `DeleteUploadedFile` | `FileName`: `string` | — | Delete an uploaded file and cleanup the upload directory |
| `Document_CheckIfPhysicallyPresent` | `Document`: `IDocument` | `IsPresent`: `bool` | Document_CheckIfPhysicallyPresent |
| `Document_GetDocumentFromDomainObject` | `DomainObject`: `IDomainObject`, `FindMethod`: `DocumentFindMethod`, `DocumentFileType`: `DocumentFileType`, `SkipSelf`: `bool` | `Document`?: `IDocument` | Document_GetDocumentFromDomainObject |
| `DomainObject_AppendComment` | `DomainObject`: `IDomainObject`, `Property`: `string`, `AddTextAboveTotalText`: `bool`, `TextToAppend`?: `object`, `ShowDateTime`?: `bool`, `DateTimeToShow`?: `UltimoDateTime`, `ShowEmployee`?: `bool`, `EmployeeToShow`?: `IEmployee`, `EmployeeDescriptionToShow`?: `UltimoString`, `ShowAdditionalHeader`?: `bool`, `AdditionalHeaderDescription`?: `UltimoString`, `AdditionalHeaderFontStyles`?: `IList<string>`, `AdditionalHeaderSuppressSpacing`?: `bool`, `ShowHorizontalLine`?: `bool` | — |  |
| `DomainObject_AttachDocument` | `DomainObject`: `IDomainObject`, `PropertyName`: `string`, `Document`: `IDocument` | `ValidPropertyNames`?: `string`, `AttachSuccessful`?: `bool` |  |
| `DomainObject_CheckPartOf` | `DomainObject`: `IDomainObject`, `PartOfPropertyName`: `string` | `PartOfErrorType`: `PartOfErrorType`, `OtherDomainObject`?: `IDomainObject`, `ChainWithPartOfIds`?: `string` | Performs checks to see if the DomainObject has a part-of relationship with itself. |
| `DomainObject_Copy` | `Source`: `object` | — |  |
| `DomainObject_DeleteCheckForRecordAuthorization` | `DomainObject`: `IDomainObject` | — |  |
| `DomainObject_DeleteImagesInFileService` | `DomainObject`: `IDomainObject` | — |  |
| `DomainObject_GetDefaultScreenName` | `DomainObject`: `IDomainObject` | `DefaultScreenName`: `string` | Return the default screen name for the domain object passed in |
| `DomainObject_GetEquipmentForProcessFunction` | `DomainObject`: `IDomainObject` | `Equipment`?: `IEquipment` | Gets the Equipment for ProcessFunction on the DomainObject which can be a Job, PmJob and PmWorkOrder. |
| `DomainObject_GetInfoScreenName` | `DomainObject`: `IDomainObject` | `InfoScreenName`: `string` | Return the default info screen name for the domain object passed in |
| `DomainObject_GetNextStatusesToShow` | `DomainObject`: `IDomainObject` | `TableName`?: `string`, `DefaultStatus`: `Status`, `PossibleStatuses`: `List<Status>` | Get possible next statuses to show for domainobject |
| `DomainObject_GetParentDomainObjects` | `Children`: `IList<IDomainObject>`, `Recursive`?: `bool`, `IncludeChildren`?: `bool` | `FoundDomainObjects`: `IList<IDomainObject>` |  |
| `DomainObject_GetProgressStatusHistoryItem` | `DomainObject`: `IDomainObject`, `OldProgressStatus`?: `IProgressStatus`, `NewProgressStatus`: `IProgressStatus` | `ObjectProgressStatusHistory`?: `IObjectProgressStatusHistory` | DomainObject_GetProgressStatusHistoryItem, gets the ObjectProgressStatusHistory item with the highest Id for the given DomainObject and progress status transition. |
| `DomainObject_GetPropertyNameForEntity` | `EntityName`: `string`, `DomainObject`?: `IDomainObject`, `DomainObjectName`?: `string`, `DoNotValidateForeignKeyExists`?: `bool` | `PropertyName`?: `string`, `ColumnName`?: `string` | Get the first property name for a domainobject in an specific entity |
| `DomainObject_GetPropertyNamesForEntity` | `EntityName`: `string`, `DomainObject`?: `IDomainObject`, `DomainObjectName`?: `string`, `DoNotValidateForeignKeyExists`?: `bool` | `PropertyNames`: `IList<string>` | Get names of all properties for a domainobject in an specific entity |
| `DomainObject_GetUnderlyingDomainObjects` | `Ancestors`: `IList<IDomainObject>`, `Recursive`?: `bool`, `IncludeAncestors`?: `bool` | `FoundDomainObjects`: `IList<IDomainObject>` |  |
| `DomainObject_HasStatusTransition` | `DomainObject`: `IDomainObject`, `OldStatus`: `Status?`, `NewStatus`: `Status?` | `HasStatusTransition`: `bool`, `TableName`?: `string` | Return true/false if DomainObject has status transition for the statuses passed in |
| `DomainObject_MoveUploadedImagesToAppropriateFolder` | `DomainObject`: `IDomainObject`, `FileNamesPerImageFileProperty`: `WorkflowDictionary<UltimoString>` | — |  |
| `DomainObject_ThrowMessageIfDeleteModeIsTrash` | `DomainObject`: `IDomainObject` | — |  |
| `DomainObject_ValidateDelete` | `DomainObject`: `IDomainObject` | — |  |
| `DomainObjects_UpdateOrderOnProperty` | `DomainObjectsToUpdate`: `List<IDomainObject>`, `UpdatedDomainObject`: `IDomainObject`, `OrderPropertyName`: `string`, `OldOrderValue`?: `short?`, `DetermineOldOrderValueAndCheckNewOrderValue`?: `bool` | — |  |
| `EnergyReportData_GetBuildingCompareDataForReport` | `Frequency`?: `string`, `DateFrom`?: `Date`, `DateTill`?: `Date`, `MeasureCode`: `string`, `ConstructionYearFrom`?: `int`, `ConstructionYearTill`?: `int`, `Owner`?: `string`, `Site`?: `string`, `Vendor`?: `string`, `Purpose`?: `string` | `Guid`?: `Guid` |  |
| `EnergyReportData_GetDataForReport` | `Frequency`?: `string`, `DateFrom`?: `Date`, `DateTill`?: `Date`, `MeasureCode`?: `string`, `Meters`?: `IList<string>`, `Meter1`?: `string`, `Meter2`?: `string`, `Meter3`?: `string`, `Meter4`?: `string`, `Meter5`?: `string` | `Guid`?: `Guid` |  |
| `EnergyReportData_GetDomainObjectDataForReport` | `DateFrom`?: `Date`, `DateTill`?: `Date`, `Frequency`?: `string`, `MeasureCode`: `string`, `DomainObject`: `IDomainObject` | `Guid`?: `Guid` |  |
| `EntitiesForAuthorization` | — | `EntitiesForAuthorization`: `IList<string>` |  |
| `Entity_GetInternalContextName` | `TableName`: `string`, `ReturnNumberWhenNoDescriptionFound`?: `bool` | `ShortInternalNames`: `List<string>`, `LongInternalNames`?: `List<string>` |  |
| `ExportConnector_CreateAttachmentArchive` | `ExportGuid`: `Guid`, `FilesToAdd`: `IList<ExportAttachment>` | — | Create attachment Archive |
| `ExportConnector_CreateExportDocument` | `Document`: `IDocument`, `ExportObject`: `ExportObject`, `ExtraPropertiesToAdd`?: `IList<string>` | `ExportAttachment`: `ExportAttachment` | Create export document for export data ExportConnector. |
| `ExportConnector_CreateExportObject` | `EntityName`: `string`, `ChangeStatusTo`?: `Status?`, `Data`: `object` | `ExportObject`: `ExportObject` | Create export object for export data ExportConnector. |
| `ExportConnector_GetData` | `ExportConnector`: `IExportConnector`, `FilterValues`?: `IDictionary` | `Data`: `IList<ExportObject>`, `ErrorOutput`?: `string` | Get data based on filters and properties for ExportConnector. |
| `ExportConnector_GetXsltParameters` | `ExportConnector`: `IExportConnector` | `Parameters`: `WorkflowDictionary<string>` | Get xslt parameters |
| `ExtractFileFromArchive` | `ArchiveFileName`: `UltimoString`, `FileName`: `UltimoString`, `TargetFileName`: `UltimoString` | — | Extract a single file from an archive. |
| `File_GetInfo` | `FullName`: `string` | `LastModifiedDate`: `UltimoDateTime`, `Size`: `long` | Get info for a file retrieved via its full file name |
| `File_IsBinary` | `FullName`: `string` | `IsBinary`: `bool` | Determine if a file retrieved via its full file name is a binary file |
| `FindDayOccurrence` | `StartDate`: `Date`, `DayOfWeek`: `DayOfWeek`, `Day`: `IDay`, `DayOccurrence`: `int`, `FrequencyCode`: `FrequencyPeriod` | `CalculatedDate`: `Date` |  |
| `FindExchangeRate` | `AllowCurrencyNotFound`?: `bool`, `BaseCurrency`?: `ICurrency`, `CounterCurrency`?: `ICurrency`, `Date`?: `UltimoDateTime?` | `ConversionFactor`: `short`, `Rate`: `decimal` | Find ExchangeRate |
| `FindExchangeRateForBookDate` | `AllowCurrencyNotFound`?: `bool`, `BaseCurrency`?: `ICurrency`, `CounterCurrency`?: `ICurrency`, `Date`?: `Date?` | `ConversionFactor`: `short`, `Rate`: `decimal` | Find ExchangeRate for a bookdate |
| `FindFirstDay` | `StartDate`: `Date`, `DayOfWeek`: `DayOfWeek?`, `Day`: `IDay` | `CalculatedDate`: `Date` |  |
| `FullText_Search` | `SearchDomain`: `UltimoString`, `SearchDomainAsString`?: `bool`, `SearchText`: `UltimoString`, `SearchContext`?: `Context`, `SearchStatus`?: `Status` | `Results`: `IList<IDomainObject>` |  |
| `GetArchiveFileList` | `ArchiveFileName`: `UltimoString` | `FileNames`: `IList<string>` | Returns a list of filenames in an archive. The filename includes the directory. |
| `GetCalendarDaysBetweenDates` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`?: `UltimoDateTime?`, `EndDate`?: `UltimoDateTime?`, `RoundToMinutes`?: `bool?` | `NumberOfDays`: `decimal` |  |
| `GetCalendarHoursBetweenDates` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`?: `UltimoDateTime?`, `EndDate`?: `UltimoDateTime?`, `RoundToMinutes`?: `bool?` | `NumberOfHoursWithQuarters`?: `decimal`, `NumberOfHours`?: `long`, `NumberOfHoursExact`?: `decimal`, `RemainingMinutes`?: `long`, `RemainingQuarters`?: `long` |  |
| `GetCalendarMinutesBetweenDates` | `WorkSchedule`?: `IWorkSchedule`, `StartDate`?: `UltimoDateTime?`, `EndDate`?: `UltimoDateTime?`, `RoundToMinutes`?: `bool?` | `NumberOfMinutes`: `long` |  |
| `GetColumnLabelFromSelectionList` | `ColumnName`: `string`, `TableName`: `string`, `SelectionListConfiguration`: `string` | `ColumnLabel`: `string` | GetColumnLabelFromSelectionList |
| `GetCountryCodes` | `CurrentCountry`?: `string` | `Countries`: `List<CountryInfoDescriptor>`, `CurrentCountryObject`?: `CountryInfoDescriptor`, `ApplicationCountryObject`: `CountryInfoDescriptor` | GetCountryCodes |
| `GetCultures` | — | `CultureCodes`: `IList<UltimoString>`, `CultureNames`: `IDictionary<string, UltimoString>` | GetCultures |
| `GetCustomerSatisfactionCodes` | — | `CustomerSatisfactionCodes`: `IList<UltimoString>`, `CustomerSatisfactionDescriptions`: `WorkflowDictionary<UltimoString>` | GetCustomerSatisfactionCodes |
| `GetDataFromExcel` | `ExcelData`: `StreamContainer`, `ValidateHashCode`: `bool`, `ValidateErrorCount`: `bool`, `ThrowOnError`: `bool` | `XmlDocument`?: `XmlDocumentContainer`, `HashCode`?: `string`, `ErrorOutput`?: `string` | Get data from excel |
| `GetDateFromWeekAndDay` | `Week`: `WeekOfYear`, `DayId`: `UltimoString` | `Date`?: `Date` |  |
| `GetDomainObjectsForEntityNameAndPropertyFilters` | `EntityName`: `UltimoString`, `PropertyFilters`: `WorkflowDictionary<object>`, `Top`?: `int?`, `OrderBy`?: `string`, `SortOrderAscending`?: `bool` | `DomainObjects`: `IList<IDomainObject>`, `DomainObject`?: `IDomainObject` | Returns the DomainObjects for an entity that match the property Filters |
| `GetFieldLabel` | `FieldName`: `UltimoString`, `TableName`: `UltimoString`, `ViewfieldConfigName`?: `UltimoString`, `ForPrimaryTable`?: `bool?`, `CountryCode`?: `object` | `FieldLabel`: `UltimoString` | Gets the label text for a field. |
| `GetFieldWidth` | `FieldName`: `string` | `FieldWidth`?: `int` | Get Field Width of database field |
| `GetFileFromArchive` | `ArchiveFileName`: `UltimoString`, `FileName`: `UltimoString` | `File`: `StreamContainer` | Returns a single file from anarchive. |
| `GetGuidFromExcel` | `ExcelFileName`: `UltimoString` | `Guid`: `Guid` | Get guid from excel |
| `GetImportStatusFromExcel` | `ExcelFileName`: `UltimoString` | `IsImported`: `bool`, `InsertCount`: `int`, `UpdateCount`: `int`, `SkipCount`: `int`, `ErrorCount`: `int` | Get Import Status from excel |
| `GetLabel` | `LabelCode`: `Code`, `TextParameters`?: `WorkflowDictionary<object>` | `LabelValue`: `UltimoString` | GetLabel |
| `GetLinkedProgressStatuses` | `FromProgressStatus`: `IProgressStatus`, `ToProgressStatus`: `IProgressStatus` | `LinkedProgressStatuses`: `IList<IProgressStatus>` | Returns a list of unique progress statuses that are linked via progress status flows to the progress status passed in |
| `GetPercentageForCalendarTimeSpan` | `PercentageDate`: `UltimoDateTime?`, `RangeFromDate`: `UltimoDateTime?`, `RangeTillDate`: `UltimoDateTime?`, `MinutesOnHold`?: `decimal?`, `WorkSchedule`?: `IWorkSchedule` | `Percentage`: `decimal` |  |
| `GetProgressStatusContextForJobContext` | `JobContext`: `Context?` | `ProgressStatusContext`: `Context` | Returns the progress status context for a given job context |
| `GetPropertyValue` | `DomainObject`: `IDomainObject`, `PropertyName`: `string` | `PropertyValue`?: `object` | Get value of property that corresponds with columnname. |
| `GetReservationLineDescriptions` | `ChangedReservationLines`: `IList<IReservationLine>`, `TextChanged`: `bool` | `ReservationLineDescriptions`: `WorkflowDictionary<string>` | Get the appropriate descriptions for the reservation lines that changed compared to the reservation line being updated |
| `GetScreenName` | `ApplicationElementId`: `string` | `ScreenName`: `string` |  |
| `GetTextTemplate` | `TemplateId`: `string` | `BodyText`: `string` | GetTextTemplate |
| `GetTimeSpan` | `StartTime`?: `UltimoDateTime?`, `NewTime`?: `UltimoDateTime?` | `Difference`: `Duration` |  |
| `GetUserCountryCode` | — | `CountryCode`: `CountryCode` | GetUserCountryCode |
| `HasAutoKey` | `EntityName`: `UltimoString` | `HasAutoKey`: `bool` | Return true/false if entity uses auto key |
| `HasContext` | `EntityName`: `UltimoString`, `Context`: `object`, `ThrowExceptionWhenEntityNotValid`?: `bool`, `ThrowExceptionWhenContextNotValid`?: `bool` | `EntityNameValid`?: `bool?`, `ContextInputValid`?: `bool?`, `HasContext`: `bool`, `FoundContext`?: `Context?` | Sets DTO.HasContext to true if given context is defined for given entity, false if it is not. |
| `HasLicenseForModule` | `ModuleName`: `UltimoString` | `HasLicenseForModule`: `bool` | Return true/false if (non-user limited) module is licensed |
| `HasPropertyOrForeignKey` | `EntityName`: `UltimoString`, `PropertyName`: `string`, `ThrowExceptionWhenEntityNotValid`?: `bool`, `ThrowExceptionWhenPropertyNotValid`?: `bool`, `AliasDictionary`?: `IDictionary<string, string>` | `EntityNameValid`?: `bool?`, `PropertyExists`?: `bool`, `PropertyEntityName`?: `string`, `PropertyColumnName`?: `string`, `PropertyTypeName`?: `string`, `PropertyIsForeignKey`?: `bool?`, `PropertyIsMultipleLayersDeep`?: `bool?`, `PropertyIsMultilingual`?: `bool?`, `PropertyIsNeutral`?: `bool?` | Checks if the given entity has a specific property and whether it is a foreign key |
| `HasStatus` | `EntityName`: `UltimoString`, `Status`: `object`, `ThrowExceptionWhenEntityNotValid`?: `bool`, `ThrowExceptionWhenStatusNotValid`?: `bool` | `EntityNameValid`?: `bool?`, `StatusInputValid`?: `bool?`, `HasStatus`: `bool`, `FoundStatus`?: `Status?` | Sets DTO.HasStatus to true if given status is defined for given entity, false if it is not. |
| `HtmlColumn_GetComment` | `CurrentDescription`?: `UltimoString`, `AddDescription`?: `UltimoString`, `Date`: `UltimoDateTime`, `Employee`: `IEmployee` | `CombinedDescription`?: `UltimoString` | Appends a comment to a given comment |
| `HttpRequest_Execute` | `Url`: `string`, `Method`?: `string`, `HttpHeaders`?: `string`, `Timeout`?: `int?`, `PostData`?: `TextDocumentContainer`, `RequestEncoding`?: `string`, `UseExpect100Continue`?: `bool?`, `HttpUserName`?: `string`, `HttpPassword`?: `string`, `Credential`?: `ICredential` | `ResponseData`?: `StreamContainer`, `ResponseStatus`?: `int`, `ErrorMessage`?: `string` | Execute HttpRequest |
| `IconManager_UploadFiles` | `UploadedFileNames`: `IList<string>` | — | Handles (multiple) uploaded icon files |
| `IconManager_UploadFontArchive` | `UploadedFileNames`: `IList<string>` | — | Handles uploaded font archive |
| `ImportConnector_GetXsltParameters` | `ImportConnector`: `IImportConnector` | `Parameters`: `WorkflowDictionary<string>` | Get xslt parameters |
| `ImportConnector_SaveAttachments` | `AttachmentZipFile`: `string`, `Files`: `WorkflowDictionary<string>` | — | ImportConnector_SaveAttachments |
| `InsertAndGenerateId` | `EntityName`: `UltimoString`, `EntityContext`: `Context` | `CreatedObject`: `IDomainObject` | Creates and inserts into the database an object for the given entity and generates a unique id from a GUID. |
| `IsAuthorizationSet` | — | `IsSet`: `bool` | IsAuthorizationSet |
| `IsAuthorized` | `RuleName`: `UltimoString` | `IsAuthorized`: `bool` | IsAuthorized |
| `IsDateWithinBoundsOfSchedule` | `WorkSchedule`?: `IWorkSchedule`, `Date`: `Date` | `Result`: `bool` |  |
| `IsProgressStatusTransitionValid` | `OldProgressStatus`: `IProgressStatus`, `NewProgressStatus`: `IProgressStatus` | `IsProgressStatusTransitionValid`: `bool` | Return true/false if progress status transition for the statuses passed in is valid |
| `Kanban_CheckIfBoardExists` | `ApplicationElementId`: `Guid`, `Filters`: `WorkflowDictionary<UltimoString>`, `Company`: `ICompany` | `BoardId`: `UltimoString` |  |
| `Kanban_CreateBoardForApplicationElement` | `ApplicationElementId`: `Guid`, `Description`: `string`, `Filters`: `WorkflowDictionary<UltimoString>`, `Company`: `Company` | `BoardId`: `UltimoString` |  |
| `Kanban_GetApplicationElementsForTemplate` | `TemplateName`: `string` | `ApplicationElements`: `IList<KanbanApplicationElementModel>` |  |
| `Kanban_GetBoard` | `BoardId`: `UltimoString` | `BoardModel`: `KanbanBoardSettingsModel` |  |
| `Kanban_GetTemplate` | `ApplicationElementId`: `Guid` | `BoardTemplate`: `KanbanTemplateSettingsModel` |  |
| `License_AddCertificate` | `License`: `IUltimoLicense`, `Certificate`: `string` | — | Add certificate to license. |
| `License_AddExtraCulture` | `License`: `IUltimoLicense`, `CultureName`: `UltimoString` | — | Add extra culture to license. |
| `License_AddModule` | `License`: `IUltimoLicense`, `ModuleName`: `UltimoString`, `UserLimit`: `int` | — | Add module to license. |
| `License_AddSelfServiceWhitelistWorkflow` | `License`: `IUltimoLicense`, `WorkflowName`: `UltimoString` | — | Add selfservice workflow to whitelist to license. |
| `License_AddUserCertificate` | `License`: `IUltimoLicense`, `UserId`: `UltimoString`, `Name`: `UltimoString`, `SecurityLevel`: `int`, `EndDate`: `Date` | — | Add user certificate to license. |
| `License_Create` | — | `License`: `IUltimoLicense` | Create new license. |
| `License_Save` | `License`: `IUltimoLicense`, `FileName`: `UltimoString` | — | Save license. |
| `List_GetGroupingByElement` | `GroupedValues`: `IList<object>`, `CurrentIndex`: `int` | `KeyObject`: `object`, `ValueObject`: `IList<object>` | List_GetGroupingByElement |
| `ObjectFeature_GetSingularValue` | `ObjectFeature`: `IObjectFeature` | `ValueType`: `FeatureValueType`, `Value`?: `object` | Returns the relevant singular value and value type for an ObjectFeature |
| `ObjectProgressStatusHistory_Insert` | `Date`: `UltimoDateTime`, `RemarkText`?: `UltimoString`, `Employee`: `IEmployee`, `NewProgressStatus`: `IProgressStatus`, `OldProgressStatus`?: `IProgressStatus`, `DomainObject`: `IDomainObject`, `DomainObjectTextField`?: `string`, `AddTextAboveTotalText`?: `bool` | — | Creates a progress status history record |
| `ObjectProgressStatus_ValidateDuplications` | `ObjectProgressStatus`: `IObjectProgressStatus` | `DuplicateDomainObject`?: `IDomainObject` | Finds whether there are duplicate records. if so removes current item and gives back a message to show in workflow |
| `ObjectServiceDeskReportType_ValidateDuplications` | `ObjectServiceDeskReportType`: `IObjectServiceDeskReportType` | `DuplicateDomainObject`?: `IDomainObject` | Finds whether there are duplicate records. if so removes current item and gives back a message to show in workflow |
| `OciConnector_IsAuthorized` | `ApplicationElementId`: `UltimoString`, `OciConnector`: `IOciConnector` | `IsAuthorized`: `bool` | Checks if user can execute a specific OciConnector |
| `OciConnector_ParsePostData` | `Input`: `StreamContainer`, `OciConnector`: `IOciConnector`, `UseGrouping`: `bool`, `Action`?: `ConnectorAction?` | `XmlData`: `XmlDocumentContainer` |  |
| `Package_UploadPackages` | `UploadedFileNames`: `IList<string>` | — | Handles (multiple) uploaded packages |
| `PlotPlanMarker_CreateMarkerModel` | `PlotPlanMarker`: `IPlotPlanMarker`, `Description`?: `string`, `IconName`?: `string`, `IconColor`?: `string`, `IconBackgroundColor`?: `string`, `Text`?: `string`, `TextColor`?: `string`, `MarkerShape`?: `MarkerShape`, `ShapeColor`?: `string`, `PinnedMarkerBackgroundColor`?: `string` | `Marker`: `PlotPlanMarkerModel` | Creates a marker model object for a plot plan marker |
| `ProlongPeriod` | `BeginDate`: `Date`, `EndDate`: `Date` | `Dates`: `IList<Date>` | ProlongPeriod |
| `QueryLDAPServer` | — | — |  |
| `RecordAuthorization` | `DefaultRecord`?: `IDomainObject`, `Records`?: `IList<IDomainObject>`, `Values`?: `IList<UltimoString>`, `ExcludableColumns`?: `string`, `RemoveExcludableColumns`?: `string`, `ExcludableObjectProperties`?: `string`, `RemoveExcludableObjectProperties`?: `string`, `ExcludeCircularReferences`: `bool`, `TableName`?: `string`, `EntityName`?: `string`, `JustPrimaryTableFilter`?: `bool`, `ForceRecordAuthorization`?: `bool?`, `NoDefaultRecord`?: `bool`, `AddRecordAuthorizationRecordLinks`?: `IList<IRecordAuthorizationRecordLink>`, `RemoveRecordAuthorizationRecordLinks`?: `IList<IRecordAuthorizationRecordLink>` | — |  |
| `RecordAuthorizationSqlWhereClause` | `TableName`: `string`, `UserId`?: `string`, `SelectionListConfiguration`?: `string` | `SqlWhereClause`: `string` | RecordAuthorizationSqlWhereClause |
| `ReleaseDomainObjects` | `DomainObjects`?: `IList<IDomainObject>` | — | ReleaseDomainObjects |
| `RemoveAttachmentIfNotInUse` | `EmailAttachment`: `IEmailAttachment` | — | Delete attachment in FileService if not in use anymore. |
| `RemoveFileFromArchive ` | `ArchiveFileName`: `UltimoString`, `FileName`: `UltimoString` | — | Remove a single file from an archive. |
| `RemoveUnusedAttachments` | — | `Count`: `int` | Delete attachment in FileService if not in use anymore. |
| `RepairViewfieldConfiguration` | — | — |  |
| `Report_GetFactoryReportFile` | `ReportName`: `string` | `ReportFile`: `StreamContainer` |  |
| `Report_GetFactoryReportNames` | — | `ReportNames`: `IList<string>` |  |
| `ResetDomainService` | — | — | Reset the domain service. Used to rebuild mappings after the mapping has been changed in the database. |
| `RoundNumberOfHours` | `GrossHours`: `decimal`, `RoundMethod`: `RoundHours`, `RoundedHoursMinimumValueIsRoundingUnit`?: `bool?` | `RoundedHours`: `decimal` |  |
| `Scenario_Exists` | `ScenarioName`: `UltimoString` | `ScenarioExists`: `bool` | Checks if a scenario exists (is loaded by the scenario service) |
| `Scenario_GetInfo` | `ScenarioName`: `UltimoString` | `ScenarioExists`: `bool`, `LastEditDate`?: `UltimoDateTime?`, `LastEditedBy`?: `string`, `AuthorizationLevel`?: `int`, `Published`?: `bool` | Returns information about the scenario. For example the last date it was edited and if there are unpublished changes. |
| `Scenario_ResetHistory` | `ScenarioName`: `UltimoString` | — | Reset unpublished files. Clear history. |
| `Screen_GetScreensWithoutInfoBoxForTable` | `ScreenName`: `UltimoString` | `AvailableScreens`: `List<AvailableScreen>` | Return all screens without infoBox from the given screen' table. |
| `SiteCheck` | `DomainObject`: `IDomainObject` | — |  |
| `StartNewBookYear` | — | — |  |
| `StateAgenda_FindTimeslots` | `StateAgenda`?: `IStateAgenda`, `StartDate`: `Date`, `EndDate`?: `Date?`, `Statuses`?: `IList<Status>`, `ExcludeStateTimeslot`?: `IStateTimeslot` | `StateTimeslots`: `IList<IStateTimeslot>` |  |
| `SurveyAssessment_CalculateScores` | `SurveyAssessment`: `ISurveyAssessment` | — |  |
| `Survey_CalculateScores` | `Survey`: `ISurvey` | — |  |
| `TimeUnitType_ConvertQuantity` | `TimeUnitTypeFrom`: `TimeUnitType`, `TimeUnitTypeTo`: `TimeUnitType`, `Quantity`: `decimal`, `RoundMethod`?: `RoundHours`, `WorkSchedule`?: `IWorkSchedule` | `ConvertedQuantity`: `decimal` |  |
| `TimeUnitType_FormatStringWithOneValue` | `TimeUnitType`: `TimeUnitType`, `Quantity`: `decimal` | `FormattedString`: `string` |  |
| `TimeUnitType_FormatStringWithTwoValues` | `QuantityFirst`: `decimal`, `TimeUnitTypeFirst`: `TimeUnitType`, `QuantitySecond`: `decimal`, `TimeUnitTypeSecond`: `TimeUnitType` | `FormattedString`: `string` |  |
| `TimeZone_GetAvailableTimeZones` | — | `TimeZones`: `List<ITimeZone>`, `ApplicationTimeZone`: `ITimeZone` | Gets available timezones |
| `TimeslotPattern_GetNextTimeslot` | `TimeslotPattern`: `TimeslotPattern`, `AfterDateTime`?: `UltimoDateTime?` | `Timeslot`?: `Timeslot` |  |
| `TranslationApply` | `DictionaryDirectory`: `string`, `FileToApply`: `string`, `UntranslatedLogFile`: `string` | `TranslatedCount`: `int`, `UntranslatedCount`: `int` |  |
| `TranslationApplyCustom` | `CreateFilledToTranslate`?: `bool` | — |  |
| `TranslationExtractCustom` | `TranslateMessages`?: `bool`, `TranslateApplicationElements`?: `bool`, `TranslateScreens`?: `bool`, `TranslateMenus`?: `bool`, `TranslateExplorers`?: `bool`, `TranslateReports`?: `bool`, `TranslateViewfieldConfiguration`?: `bool`, `TranslateContextDescriptions`?: `bool`, `TranslateStatusDescriptions`?: `bool`, `TranslateTextTemplates`?: `bool`, `TranslateGridWidgets`?: `bool`, `TranslateDashboards`?: `bool`, `CreateFilledToTranslate`?: `bool` | — |  |
| `TranslationTranslateCustom` | `TranslateMessages`?: `bool`, `TranslateApplicationElements`?: `bool`, `TranslateScreens`?: `bool`, `TranslateMenus`?: `bool`, `TranslateExplorers`?: `bool`, `TranslateReports`?: `bool`, `TranslateViewfieldConfiguration`?: `bool`, `TranslateContextDescriptions`?: `bool`, `TranslateStatusDescriptions`?: `bool`, `TranslateTextTemplates`?: `bool`, `TranslateGridWidgets`?: `bool`, `TranslateDashboards`?: `bool` | — |  |
| `Translation_GetInstalledLanguagePacks` | — | `InstalledLanguagePacks`: `IList<string>` |  |
| `Translation_GetTablesWithMissingTranslations` | — | `Tables`: `IList<string>` |  |
| `UmmSettingUpdateManageStockPerWarehouse` | — | — | UmmSettingUpdateManageStockPerWarehouse |
| `UserCertificate_Change` | `Certificate`: `UltimoString`, `SecurityLevel`?: `int?`, `EndDate`?: `Date?`, `Password`?: `UltimoString` | `NewCertificate`: `UltimoString` | Change certificate for uct user. |
| `UserCertificate_ChangeEndDate` | `Certificate`: `UltimoString`, `OldPassword`: `UltimoString`, `NewPassword`: `UltimoString`, `EndDate`: `Date` | `NewCertificate`: `UltimoString` | Change enddate and change password. |
| `UserCertificate_Create` | `Name`: `UltimoString` | `Certificate`: `UltimoString` | Create certificate for uct user. |
| `UserCertificate_GetInformation` | `Certificate`: `UltimoString` | `Name`?: `UltimoString`, `UserId`?: `UltimoString`, `SecurityLevel`?: `int`, `EndDate`?: `Date` | Get information from certificate. |
| `UserCertificate_Install` | `Certificate`: `UltimoString` | — | Install certificate for uct user. |
| `User_AddApplicationElementToDashboard` | `ApplicationElementId`: `string`, `DomainObject`?: `IDomainObject`, `Description`?: `string`, `MainTabIndex`?: `int?`, `TabIndex`?: `int?`, `PanelId`: `string` | `ApplicationElementTitle`: `string` | Add application element to dashboard panel |
| `User_CheckSingleTimeZone` | `RecordsSelected`: `IList<ISite>`, `RecordsToSelectFrom`?: `IList<ISite>` | `Count`: `int`, `SelectedTimeZone`?: `UltimoString`, `UserHasAccessToMultipleTimeZones`?: `bool` |  |
| `User_GetDashboardPanels` | — | `PanelIds`: `IList<UltimoString>`, `PanelDescriptions`: `WorkflowDictionary<UltimoString>` | Get available dashboard panels |
| `User_GetRecordAuthorizationSettingsForEntity` | `EntityName`: `UltimoString`, `User`: `IUser`, `CompanyId`?: `UltimoString` | `DomainObjects`?: `IList<IDomainObject>`, `DefaultObject`?: `IDomainObject`, `UsedProperty`: `string`, `RecordAuthorizationSetting`?: `IRecordAuthorizationSetting`, `Excludes`?: `IList<IRecordContext>`, `RecordLinks`?: `IList<IRecordAuthorizationRecordLink>` |  |
| `User_HasRecordAuthorizationSettings` | `User`: `IUser` | `UserHasRecordAuthorizationSettings`: `bool` |  |
| `User_ServiceLogOn` | `LogOnName`: `UltimoString`, `UserType`: `UltimoUserType`, `TimeZone`?: `UltimoString`, `CompanyId`?: `UltimoString` | — | User_ServiceLogOn |
| `ValidateProperties` | `Input`?: `object`, `EntityName`?: `string`, `Identifier`?: `string`, `Properties`?: `WorkflowDictionary<object>`, `DoNotThrow`?: `bool` | `IsValid`?: `bool`, `Message`?: `string` | Validate properties length for domain object or list of domain objects |
| `ValidateRecordAuthorization` | — | `RecordName`?: `string` | Validates records could still be found for tables which are used in record authorization |
| `VerifyPasswordToPolicy` | `Password`?: `UltimoString` | `IsValid`: `bool`, `Reason`: `string` |  |
| `Workflow_CreateScenario` | `WorkflowName`: `string` | — | Generate a scenario for an existing workflow. |
| `Workflow_Exists` | `WorkflowName`: `UltimoString` | `WorkflowExists`: `bool` | Checks if a workflow exists (is loaded by the workflow service) |
| `Workflow_GetInfo` | `WorkflowName`: `UltimoString` | `WorkflowExists`: `bool`, `LastEditDate`?: `UltimoDateTime?`, `LastEditedBy`?: `string`, `AuthorizationLevel`?: `int`, `UserContentLevel`?: `int?`, `Published`?: `bool` | Returns information about the workflow. For example the last date it was edited and if there are unpublished changes. |
| `Workflow_ResetHistory` | `WorkflowName`: `UltimoString` | — | Reset unpublished files. Clear history. |
| `WriteResultToExcel` | `ExcelData`: `StreamContainer`, `ImportResult`: `XmlDocumentContainer`, `SaveFileName`: `string`, `InsertCount`: `int`, `UpdateCount`: `int`, `SkipCount`: `int`, `ErrorCount`: `int`, `HashCode`: `string` | — | Write Result To Excel |