@ind-rcg/modeler-sfdx-cli-plugin 246.1042.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +37 -0
- package/README.md +756 -0
- package/lib/commands/modeler/workspace/add.js +1 -0
- package/lib/commands/modeler/workspace/build.js +1 -0
- package/lib/commands/modeler/workspace/cleanup.js +1 -0
- package/lib/commands/modeler/workspace/create.js +1 -0
- package/lib/commands/modeler/workspace/package.js +1 -0
- package/lib/commands/modeler/workspace/refreshLocale.js +1 -0
- package/lib/commands/modeler/workspace/server/start.js +1 -0
- package/lib/commands/modeler/workspace/upgrade.js +1 -0
- package/lib/commands/modeler/workspace/utils/base64encode.js +1 -0
- package/lib/commands/modeler/workspace/utils/generateManifest.js +1 -0
- package/lib/commands/modeler/workspace/utils/migrateContracts.js +1 -0
- package/lib/commands/modeler/workspace/validate.js +1 -0
- package/lib/constants.js +1 -0
- package/lib/hooks/init/updateCheck.js +1 -0
- package/lib/model/buildStatus.js +1 -0
- package/lib/model/workspace.js +1 -0
- package/lib/model/workspaceCommand.js +1 -0
- package/lib/shared/commandBuilder.js +1 -0
- package/lib/shared/commandExecutor.js +1 -0
- package/lib/shared/commandOutput.js +1 -0
- package/lib/types/config.js +1 -0
- package/lib/types/errors.js +1 -0
- package/lib/types/messages.js +1 -0
- package/lib/types/package.js +1 -0
- package/lib/types/results.js +1 -0
- package/lib/utils/componentHelper.js +1 -0
- package/lib/utils/errorHelper.js +1 -0
- package/lib/utils/fsHelper.js +1 -0
- package/lib/utils/generateManifestHelper.js +1 -0
- package/lib/utils/messageHelper.js +1 -0
- package/lib/utils/packageHelper.js +1 -0
- package/lib/utils/serverHelper.js +1 -0
- package/lib/utils/templateEngine.js +1 -0
- package/lib/utils/templateHelper.js +1 -0
- package/lib/utils/updateChecker.js +1 -0
- package/lib/utils/validationHelper.js +1 -0
- package/messages/modeler-workspace-add.md +45 -0
- package/messages/modeler-workspace-build.md +29 -0
- package/messages/modeler-workspace-cleanup.md +17 -0
- package/messages/modeler-workspace-create.md +21 -0
- package/messages/modeler-workspace-package.md +21 -0
- package/messages/modeler-workspace-refresh-locale.md +27 -0
- package/messages/modeler-workspace-server-start.md +37 -0
- package/messages/modeler-workspace-upgrade.md +21 -0
- package/messages/modeler-workspace-utils-base64encode.md +25 -0
- package/messages/modeler-workspace-utils-generateManifest.md +15 -0
- package/messages/modeler-workspace-utils-migrateContracts.md +23 -0
- package/messages/modeler-workspace-validate.md +29 -0
- package/messages/modeler-workspace.md +19 -0
- package/oclif.manifest.json +429 -0
- package/package.json +108 -0
- package/templates/.gitignore.tmp +4 -0
- package/templates/README.md.tmp +77 -0
- package/templates/contractTemplates/#ModuleName#/BO/README.md +1 -0
- package/templates/contractTemplates/#ModuleName#/DS/README.md +1 -0
- package/templates/contractTemplates/#ModuleName#/PL/README.md +1 -0
- package/templates/contractTemplates/#ModuleName#/PR/README.md +1 -0
- package/templates/contractTemplates/#ModuleName#/TB/README.md +1 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Bo${NAME}.businessobject.xml +22 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/CreateAsync/Bo${NAME}.AfterCreateAsync.bl.js +54 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/CreateAsync/Bo${NAME}.BeforeCreateAsync.bl.js +56 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/DoValidateAsync/Bo${NAME}.AfterDoValidateAsync.bl.js +57 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/DoValidateAsync/Bo${NAME}.BeforeDoValidateAsync.bl.js +56 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/Initialize/Bo${NAME}.AfterInitialize.bl.js +54 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/Initialize/Bo${NAME}.BeforeInitialize.bl.js +54 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/LoadAsync/Bo${NAME}.AfterLoadAsync.bl.js +57 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/LoadAsync/Bo${NAME}.BeforeLoadAsync.bl.js +56 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/SaveAsync/Bo${NAME}.AfterSaveAsync.bl.js +57 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/Bo${NAME}/Mv2/SaveAsync/Bo${NAME}.BeforeSaveAsync.bl.js +56 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/BusinessObject.md +186 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectListObjectsListObjectEventsSnipp.xml +3 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectListObjectsListObjectSnipp.xml +1 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectNestedObjectsNestedObjectSnipp.xml +1 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectObjectLookupsObjectLookupEventsSnipp.xml +3 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectObjectLookupsObjectLookupSnipp.xml +1 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectSimplePropertiesSimplePropertyEventsSnipp.xml +3 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobject/snippets/BusinessObjectSimplePropertiesSimplePropertySnipp.xml +1 -0
- package/templates/contractTemplates/BO_BusinessObject/businessobjecthelper/snippets/BusinessObjectHelperSimplePropertiesSimplePropertySnipp.xml +1 -0
- package/templates/contractTemplates/BO_BusinessObject/validationmessages/ValidationMessage.md +38 -0
- package/templates/contractTemplates/BO_BusinessObject/validationmessages/snippets/ValidationMessagesValidationMessageSnipp.xml +1 -0
- package/templates/contractTemplates/DS_DataSource/DataSource.md +319 -0
- package/templates/contractTemplates/DS_DataSource/Ds${NAME}_sf.datasource.xml +11 -0
- package/templates/contractTemplates/DS_DataSource/snippets/DataSourceAttributesAttributeSnipp.xml +1 -0
- package/templates/contractTemplates/DS_DataSource/snippets/DataSourceAttributesDerivedAttributeSnipp.xml +1 -0
- package/templates/contractTemplates/DS_DataSource/snippets/DataSourceEntitiesEntityJoinSimpleJoinConditionAttributeSnipp.xml +1 -0
- package/templates/contractTemplates/DS_DataSource/snippets/DataSourceEntitiesEntityJoinSimpleJoinConditionLiteralSnipp.xml +1 -0
- package/templates/contractTemplates/DS_DataSource/snippets/DataSourceEntitiesEntitySnipp.xml +1 -0
- package/templates/contractTemplates/ExternalFiles/#Name#.externalfile.xml +6 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Li${NAME}.listitem.xml +5 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/ListItem.md +114 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/ListObject.md +354 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Lo${NAME}.listobject.xml +12 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/DoValidateAsync/Lo${NAME}.AfterDoValidateAsync.bl.js +57 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/DoValidateAsync/Lo${NAME}.BeforeDoValidateAsync.bl.js +56 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/LoadAsync/Lo${NAME}.AfterLoadAsync.bl.js +57 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/LoadAsync/Lo${NAME}.BeforeLoadAsync.bl.js +56 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/SaveAsync/Lo${NAME}.AfterSaveAsync.bl.js +57 -0
- package/templates/contractTemplates/LO_ListObject/Lo${NAME}/Mv2/SaveAsync/Lo${NAME}.BeforeSaveAsync.bl.js +56 -0
- package/templates/contractTemplates/LO_ListObject/snippets/ListItemSimplePropertiesSimplepropertySnipp.xml +1 -0
- package/templates/contractTemplates/LU_LookupObject/Lu${NAME}/LookupObject.md +97 -0
- package/templates/contractTemplates/LU_LookupObject/Lu${NAME}/Lu${NAME}.lookupobject.xml +12 -0
- package/templates/contractTemplates/LU_LookupObject/Lu${NAME}/Mv2/LoadAsync/Lu${NAME}.AfterLoadAsync.bl.js +57 -0
- package/templates/contractTemplates/LU_LookupObject/Lu${NAME}/Mv2/LoadAsync/Lu${NAME}.BeforeLoadAsync.bl.js +56 -0
- package/templates/contractTemplates/LU_LookupObject/snippets/LookupObjectSimplePropertiesSimplePropertySnipp.xml +1 -0
- package/templates/contractTemplates/PL_PrintLayout/#Name#PDF/#Name#PDF.printlayoutv2.xml +4 -0
- package/templates/contractTemplates/PR_Process_&_UI/#ModuleName#_#Name#/#ModuleName#_#Name#.userinterface.xml +4 -0
- package/templates/contractTemplates/PR_Process_&_UI/#ModuleName#_#Name#/#ModuleName#_#Name#Process.processflow.xml +12 -0
- package/templates/contractTemplates/PR_Process_&_UI/Process.md +790 -0
- package/templates/contractTemplates/PR_Process_&_UI/UserInterface.md +1545 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionConfirmSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionCreateSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionDecisionSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionEndSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionLoadSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionLogicSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionMasterDetailSnipp.xml +24 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionNavigationSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionPrintSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionPrintV2Snipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionProcessSnipp.xml +9 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionValidationSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessBodyActionsActionViewSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessEntryEntryActionsActionCreateSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessEntryEntryActionsActionLoadSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/Process/ProcessEntryEntryActionsActionLogicSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Attachment/AttachmentFolderInfoSectionSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Attachment/AttachmentFolderSnipp.xml +24 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Banner/BannerFilterSnipp.xml +19 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Banner/Banner_WithFilterSnipp.xml +25 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Banner/Banner_WithoutFilterSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BindingList/BindingsList_DecisionsSnipp.xml +9 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BindingList/BindingsList_GroupsSnipp.xml +11 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BindingList/BindingsList_ResultsSnipp.xml +13 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlEventsSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlHierarchyBindingsBindingAddItemSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlHierarchyBindingsBindingCategoriesSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlHierarchyBindingsBindingShowCategorySnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlHierarchyDataSourcesSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingButtonSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingComboSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingDateSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingDecimalSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingDynamicSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingImageSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingStepperSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingStepper_CorrelationIdSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsBindingTextSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsResourceImageSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsBindingsResourceLabelSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlItemsContextMenuSnipp.xml +13 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlSearchAttributesSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/BreadCrumbControlSnipp.xml +22 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/BreadCrumbControl/MultiSelectionBreadCrumbControlSnipp.xml +23 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlEventsSnipp.xml +11 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlItemsBindingsBindingDateSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlItemsBindingsBindingDecimalSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlItemsBindingsBindingImageSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlItemsBindingsBindingLabelSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlItemsBindingsBindingTextSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlSettingsSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Calendar/CalendarControlSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/CheckBox/CheckBoxEventsSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/CheckBox/CheckBoxSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Cockpit/CockpitSectionsSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/DataImportWizard/DataImportWizardSnipp.xml +12 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/DatePicker/DatePickerFieldSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/EmbededList/EmbeddedListSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/EnhanceDecisionList/EnhancedDecisionListSnipp.xml +52 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/FastEntry/FastDataEntryGridSnipp.xml +69 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GoogleMaps/GoogleMapDetailsSnipp.xml +20 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GoogleMaps/GoogleMapSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupElement/GroupElementSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedButtonList/GroupedButtonListEventsSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedButtonList/GroupedButtonListFooterSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedButtonList/GroupedButtonListSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedList/GroupedListEventsSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedList/GroupedListSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedList/MultiSelectionGroupedListEventsSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/GroupedList/MultiSelectionGroupedListSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ImageButton/ImageButtonSnipp.xml +10 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ImageSelector/ImageSelectorSnipp.xml +16 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/InputArea/InputAreaMultiLineSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/InputArea/InputAreaSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ItemListLayout/ItemListLayout_ComplexSnipp.xml +13 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ItemListLayout/ItemListLayout_GridSnipp.xml +10 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ItemListLayout/ItemListLayout_TwoRowsSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/LinkBar/LinkBarSnipp.xml +12 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Lookup/LookupEventSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Lookup/LookupSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaControl/MediaControlSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlBindingsBindingDescriptionSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlBindingsBindingIsTaggedSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlBindingsBindingMediaPathSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlBindingsBindingTypeSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlEventsSnipp.xml +4 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/MediaListControl/MediaListControlSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Menu/LongPressMenuSnipp.xml +8 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Menu/MenuItemSnipp.xml +9 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Merger/MergerOneInputControlTwoButtonsMaxSnipp.xml +2 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Merger/MergerTwoInputControlsCombinedSnipp.xml +2 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Merger/MergerTwoInputControlsNoneSnipp.xml +2 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Merger/MergerTwoInputControlsOwnSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/NoDataMessageSnipp.xml +9 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/MasterDetail/Page_MasterDetail_WithDetailGroupsSnipp.xml +43 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/MasterDetail/Page_MasterDetail_WithDetailListSnipp.xml +44 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/MasterDetail/Page_MasterDetail_WithDetailTabsSnipp.xml +61 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/MasterDetail/Page_MasterDetail_WithExtendedDetailSnipp.xml +44 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/SingleSection/Page_SingleSectionScreens_GroupedElementsSnipp.xml +33 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/SingleSection/Page_SingleSectionScreens_ListSnipp.xml +41 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/SingleSection/Page_SingleSectionScreens_TabSnipp.xml +39 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/SingleSection/Page_SingleSectionScreens_WizardSnipp.xml +34 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Page/SplitScreen/Page_SplitScreenSnipp.xml +27 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SelectionBox/SelectionBoxBindingSnipp.xml +13 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SelectionBox/SelectionBoxEventsSnipp.xml +4 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SelectionBox/SelectionBoxToggleSnipp.xml +13 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlBindingsBindingEditableParametersSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlBindingsBindingEditableSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlBindingsBindingVisibleParametersSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlBindingsBindingVisibleSnipp.xml +1 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlEditabilityRolesSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/SignatureControl/SignatureControlVisibilityRolesSnipp.xml +3 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/Stepper/StepperSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/TextBar/TextBarSnipp.xml +7 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/ThemeSelection/ThemeSelectionSnipp.xml +5 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/TimePicker/TimePickerFieldSnipp.xml +6 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/UserWelcomeSnipp.xml +24 -0
- package/templates/contractTemplates/PR_Process_&_UI/snippets/UI/VisitDetailsSnipp.xml +21 -0
- package/templates/contractTemplates/TB_Table/#Name#_T.temptable.xml +11 -0
- package/templates/contractTemplates/TB_Table/snippets/#Name#.dbtable.xml +10 -0
- package/templates/contractTemplates/TB_Table/snippets/dbtable/DBTablecolumnscolumnSnipp.xml +1 -0
- package/templates/contractTemplates/TB_Table/snippets/dbtable/DBTableindexesindexSnipp.xml +3 -0
- package/templates/contractTemplates/TB_Table/snippets/temptable/TempTableColumnsColumnIsDeletedSnipp.xml +1 -0
- package/templates/contractTemplates/TB_Table/snippets/temptable/TempTableColumnsColumnSnipp.xml +1 -0
- package/templates/contractTemplates/TB_Table/snippets/temptable/TempTableindexesindexSnipp.xml +3 -0
- package/templates/contractTemplates/UI_Plugins/#Name#UiPluginV2.uipluginv2.xml +16 -0
- package/templates/templateDefinitions.json +167 -0
|
@@ -0,0 +1,790 @@
|
|
|
1
|
+
# Process (PR) Contract Definition
|
|
2
|
+
|
|
3
|
+
## Description
|
|
4
|
+
Process Contracts describe a process execution flow.
|
|
5
|
+
The main goal of this document is to have a common understanding of the different elements that constitute a definition of a Process Contract.
|
|
6
|
+
|
|
7
|
+
## Contract Defintion
|
|
8
|
+
The following sections describe all elements that can be used in a Process Contract.
|
|
9
|
+
|
|
10
|
+
## Root Node (Process Node)
|
|
11
|
+
This is the Root element in a Process Contract definition. The following attributes must be defined within this element.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
15
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
16
|
+
|Process|no|Process node (root) of a process contract| |
|
|
17
|
+
|Process.@name|String|no| Unique identifier of the process. The name must adhere to the following naming convention: <Namespace>::<Processname> - naming convention (FQN)!?|no|
|
|
18
|
+
|Process.@defaultAction|String|no|name of the Action to be executed immediatly after process initialization|no|
|
|
19
|
+
|Process.@schemaVersion |String|no |version of the design contract|no |
|
|
20
|
+
|Process.@ignoreMultiViewStack|String|yes, no default|comboBox values: "true", "false" and "[empty]"| |
|
|
21
|
+
|Process.Entry||no|Entry node, multiplicity 1, see **Entry specification**||
|
|
22
|
+
|Process.Entry.ProcessContext||no|ProcessContext node, containing variable definitions, multiplicity 1, see **ProcessContext specification**| |
|
|
23
|
+
|Process.Entry.EntryActions||no|EntryActions node, contains list of actions executed after process initialization, multiplicity 1, see **EntryActions specification**| |
|
|
24
|
+
|Process.Body| |no|Body node, multiplicity 1, see **Body specification**| |
|
|
25
|
+
|Process.Body.Actions||no|Actions node, contains list of actions defined for the process, multiplicity 1, see **Actions specification**| |
|
|
26
|
+
|Process.ExitHandlers||yes|ExitHandlers node, multiplicity 0..1, see **ExitHandlers specification**| |
|
|
27
|
+
|Process.ExternalEvents||yes|ExternalEvents node, multiplicity 0..1, see **ExternalEvents**| |
|
|
28
|
+
|
|
29
|
+
In addition to these attributes, a Process Contract must define an **Entry** element and a **Body** element. Optionally there can be an **ExitHandlers** element as well.
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
```
|
|
33
|
+
<Process name="MyApplication::OverviewProcess" defaultAction="ShowOverview" schemaVersion="1.0">
|
|
34
|
+
<Entry>
|
|
35
|
+
<!-- Entry element definition-->
|
|
36
|
+
<ProcessContext />
|
|
37
|
+
<EntryActions />
|
|
38
|
+
</Entry>
|
|
39
|
+
<Body>
|
|
40
|
+
<!-- Body Element definition -->
|
|
41
|
+
<Actions />
|
|
42
|
+
</Body>
|
|
43
|
+
<ExitHandlers>
|
|
44
|
+
<!-- ExitHandlers Element definition -->
|
|
45
|
+
</ExitHandlers>
|
|
46
|
+
</Process>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Entry
|
|
50
|
+
The Entry element in a Process Contract definition is mandatory. Within the Entry element a set of Process Context Declarations can be defined. Additionally, a set of Parameters passed to the Process as well as a List of DataSources can be specified. The Entry element may also define a set of Process Actions that will be executed as Entry Actions before the process is started.
|
|
51
|
+
|
|
52
|
+
#### ProcessContext
|
|
53
|
+
The ProcessContext element contains the list of variables declared in the process as well as the list of parameters passed to the process.
|
|
54
|
+
|
|
55
|
+
#### Properties
|
|
56
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
57
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
58
|
+
|ProcessContext| |no|ProcessContext node, multiplicity 1| |
|
|
59
|
+
|ProcessContext.Declarations| |no|Declarations node, multiplicity 1||
|
|
60
|
+
|ProcessContext.Declarations.Declaration| |no|Declaration node, multiplicity 0..N , see **ProcessContext Variable specification** | |
|
|
61
|
+
|ProcessContext.Parameters| |no|Parameters node, multiplicity 1| |
|
|
62
|
+
|ProcessContext.Parameters.Input| |no|Parameter node, multiplicity 0..N, , see **ProcessContext Parameter specification** | |
|
|
63
|
+
|
|
64
|
+
#### Example
|
|
65
|
+
```
|
|
66
|
+
<ProcessContext>
|
|
67
|
+
<Declarations>
|
|
68
|
+
<Declaration name="MyVariable" type="MyObjectClass" />
|
|
69
|
+
</Declarations>
|
|
70
|
+
<Parameters>
|
|
71
|
+
<Input name="CustomerPKey" type="DomPKey" />
|
|
72
|
+
</Parameters>
|
|
73
|
+
</ProcessContext>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
##### Declaration
|
|
77
|
+
The ProcessContext declarations section contains elements definining global process variables which can be used during the process execution or by the UI for data binding.
|
|
78
|
+
|
|
79
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
80
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
81
|
+
|@name|String|no|process variable name|check for unique variable name|
|
|
82
|
+
|@type|String|no|type of the process variable| |
|
|
83
|
+
|
|
84
|
+
##### Parameter
|
|
85
|
+
The ProcessContext parameters section contains elements defining parameters passed to the process.
|
|
86
|
+
|
|
87
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
88
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
89
|
+
|@name|String|no|process parameter name|check for unique parameter name|
|
|
90
|
+
|@type|String|no|type of the process parameter| |
|
|
91
|
+
|
|
92
|
+
### EntryActions
|
|
93
|
+
The EntryActions element contains definitions of Actions that will be executed as a part of the initialization step of the Process. Entry Actions will be executed immediately after the variable declarations are processed and before the process execution is started. Entry actions are intended to prepare the process for its execution. Typically Entry Actions are responsible for pre-loading information that are necessary to start the process. Actions of type View, Navigation and Process, which will be described later, should obviously not be used as entry actions.Entry actions follow the general rules for actions as described in chapter Action. Entry actions are performed in the order in which they are defined in the contract. After execution of all entry actions, the process defaultAction (see process root element) is executed.
|
|
94
|
+
|
|
95
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
96
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
97
|
+
|EntryActions| |no|EntryActions node, multiplicity 1| |
|
|
98
|
+
|EntryActions.Action| |no|Action node, multiplicity 0..N, see **Action specification**||
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
```
|
|
102
|
+
<EntryActions>
|
|
103
|
+
<Action name="LoadOrderCount" actionType="LOAD" type="LuOrderCount">
|
|
104
|
+
<Return name="ProcessContext::LuOrderCount" />
|
|
105
|
+
</Action>
|
|
106
|
+
</EntryActions>
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Body
|
|
110
|
+
The Body element defines a set of process actions that describe the process execution flow.
|
|
111
|
+
|
|
112
|
+
### Actions
|
|
113
|
+
The Actions element contains the definitions of the various Process Actions that are part of the process execution flow.
|
|
114
|
+
|
|
115
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
116
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
117
|
+
|Actions| |no|Actions node, multiplicity 1| |
|
|
118
|
+
|Actions.Action| |no|Action node, multiplicity 0..N, see **Action specification**||
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
```
|
|
122
|
+
<Actions>
|
|
123
|
+
<Action name="CreateValidationBo" actionType="CREATE" type="BoWizardAddProduct">
|
|
124
|
+
<Return name="ProcessContext::ValidationBo" />
|
|
125
|
+
</Action>
|
|
126
|
+
</Actions>
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Action
|
|
130
|
+
The Action element describes a specified process activity that should be executed at a given time during the process execution.Actions could be event-driven (executed when a given event occures - see Events) or could be executed explicitly during transitions in the process execution flow (see TransitionTo element). The following attribues are defined in an Action element:
|
|
131
|
+
|
|
132
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
133
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
134
|
+
|@name|String|no|name of the action||
|
|
135
|
+
|@actionType|String|no|The value of actionType must be one of the following Literals:<ul><li> LOAD<li> SAVE<li> CREATE<li> VIEW<li> LOGIC<li> PROCESS<li> DECISION<li> NAVIGATION<li> CONFIRM<li> VALIDATION<li> MASTER_DETAIL_HANDLER<li> END<li> SCAN<li> PRINT </ul>The different action types are described in the following sections. ||
|
|
136
|
+
|@call |String|used only if actionType=LOGIC|The value of the call attribute should be a full qualified name of the business method to be executed (called).| |
|
|
137
|
+
|@parameter|String|used only if actionType=DECISION|This attribute is only used in combination with a DECISION Action. It generally contains the name of the variable whose values is part of the decision criterias.||
|
|
138
|
+
|@type |String|used only if actionType= LOAD, SAVE or CREATE|In case of LOAD, SAVE and CREATE Actions the value of the type attribute is the object class type of the BusinessObject or ListObject to be loaded or saved.|
|
|
139
|
+
|@process |String|used only if actionType=PROCESS|The name of the Process to start when this action is executed. The value if a full qualified name of a given Process i.ee <Namespace>::<ProcessName>||
|
|
140
|
+
|
|
141
|
+
### LOAD Action
|
|
142
|
+
LOAD Actions are generally used to load data into an instance of a given object type. An instance of the given object type will be created before loading the data. The object type maybe for example an existing BusinessObject or ListObject.
|
|
143
|
+
|
|
144
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
145
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
146
|
+
|@name|String|no|action name|unique in list of actions|
|
|
147
|
+
|@actionType|String|no|action type, "LOAD"| |
|
|
148
|
+
|@type|String|no|valid data type, e.g. modeled data type (BO,LO,LU, Domain) or java script data type|?|
|
|
149
|
+
|Parameters| |yes|parameters node, input to the LOAD action, see **Parameters specification**| |
|
|
150
|
+
|Return| |no|return value specification of the LOAD action, see **Return specification**| |
|
|
151
|
+
|TransitionTo| |yes|continuation action specification when the LOAD action has been executed, see **TransitionTo specification**| |
|
|
152
|
+
|
|
153
|
+
### Example
|
|
154
|
+
```
|
|
155
|
+
<!-- Action definition containing parameters, return value, transition to another action -->
|
|
156
|
+
<Action name="LoadCallCustomerDetail" actionType="LOAD" type="LoCustomerCall">
|
|
157
|
+
<Parameters>
|
|
158
|
+
<Input name="bpaMainPKey" value="ProcessContext::CustomerDetail.pKey" />
|
|
159
|
+
</Parameters>
|
|
160
|
+
<Return name="ProcessContext::CustomerCallList" />
|
|
161
|
+
</Action>
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### SAVE Action
|
|
165
|
+
SAVE Actions are generally used to save an instance or a list of a given object type declared within the process. The object type maybe for example a BusinessObject or ListObject.
|
|
166
|
+
(question) All objects to be saved must be passed as Action parameters (see Parameters element for more details).
|
|
167
|
+
|
|
168
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
169
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
170
|
+
|@name|String|no|action name|unique in list of actions|
|
|
171
|
+
|@actionType|String|no|action type, "SAVE"| |
|
|
172
|
+
|Parameters| |yes|parameters node, input to the SAVE action, see **Parameters specification**| |
|
|
173
|
+
|TransitionTo| |yes|continuation action specification when the SAVE action has been executed, see **TransitionTo specification**| |
|
|
174
|
+
|
|
175
|
+
### Example
|
|
176
|
+
```
|
|
177
|
+
<!-- Action definition containing parameters, transition to another action -->
|
|
178
|
+
<Action name="SaveContactPartner" actionType="SAVE">
|
|
179
|
+
<Parameters>
|
|
180
|
+
<Object value="ProcessContext::ContactPartner" />
|
|
181
|
+
</Parameters>
|
|
182
|
+
<TransitionTo action="ReloadContactPartner"/>
|
|
183
|
+
</Action>
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
### CREATE Action
|
|
188
|
+
The CREATE Action could be used to create an instance of a given Business Object. This action may define input parameters needed to create this BO instance. The Action returns a reference to the created BO instance. The reference can be stored in the Process or Application Context.
|
|
189
|
+
|
|
190
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
191
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
192
|
+
|@name|String|no|action name|unique in list of actions|
|
|
193
|
+
|@actionType|String|no|action type, "CREATE"| |
|
|
194
|
+
|@type|String|no|valid data type, e.g. modeled data type (BO,LO,LU, Domain) or java script data type|?|
|
|
195
|
+
|Parameters| |yes|parameters node, input to the LOAD action, see **Parameters specification**| |
|
|
196
|
+
|Return| |no|return value specification of the LOAD action, see **Return specification**| |
|
|
197
|
+
|TransitionTo| |yes|continuation action specification when the LOAD action has been executed, see **TransitionTo specification**| |
|
|
198
|
+
|
|
199
|
+
### Example
|
|
200
|
+
```
|
|
201
|
+
<!-- Action definition containing parameters and return value -->
|
|
202
|
+
<Action name="CreateContactPartner" actionType="CREATE" type="BoContactPartner">
|
|
203
|
+
<Parameters>
|
|
204
|
+
<Input name="CustomerPKey" value="ProcessContext::CustomerDetail.pKey" />
|
|
205
|
+
</Parameters>
|
|
206
|
+
<Return name="ProcessContext::ContactPartnerDetail" />
|
|
207
|
+
</Action>
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### VIEW Action
|
|
211
|
+
The VIEW Action is used to render a given UI (see UIDescription element). The VIEW Action also declares event handling for the defined user interface as well as ExitHandlers used for validations.
|
|
212
|
+
|
|
213
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
214
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
215
|
+
|@name|String|no|action name|unique in list of actions|
|
|
216
|
+
|@actionType|String|no|action type, "VIEW"| |
|
|
217
|
+
|UIDescription| |no|contains reference to user interface contract, multiplicity 1|check for valid user interface ref|
|
|
218
|
+
|Events| |yes|Events node, multiplicity 1| |
|
|
219
|
+
|Events.Event| |yes|Event node, multiplicity 0..N| |
|
|
220
|
+
|Events.Event.@name|String|no|name of the event handled|check for valid event reference to user interface contract?|
|
|
221
|
+
|Events.Event.@action|String|no|name of another action of the process which should be executed when this event is raised|check for valid action|
|
|
222
|
+
|ExitHandlers| |yes|ExitHandlers node, multiplicity 1, see **ExitHandlers specification**| |
|
|
223
|
+
|
|
224
|
+
### Example
|
|
225
|
+
```
|
|
226
|
+
<!-- UI Description, Event handling and Exit Handlers -->
|
|
227
|
+
<Action actionType="View" name="ShowCallDetail">
|
|
228
|
+
<UIDescription>Call::CompleteTabUI</UIDescription>
|
|
229
|
+
<Events>
|
|
230
|
+
<Event name="completeCall" action="CheckOpenOrders" />
|
|
231
|
+
<Event name="responsibleLookup" action="OpenResponsibleLookup" />
|
|
232
|
+
</Events>
|
|
233
|
+
<ExitHandlers>
|
|
234
|
+
<ExitHandler handlerName="validateCallDate" type="CustomValidate" name="ProcessContext::MainBO">
|
|
235
|
+
<Method name="validateCallDate" />
|
|
236
|
+
</ExitHandler>
|
|
237
|
+
</ExitHandlers>
|
|
238
|
+
</Action>
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### LOGIC Action
|
|
242
|
+
The LOGIC Action is used to call a given business logic funtion from the API or a method defined within the process.
|
|
243
|
+
|
|
244
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
245
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
246
|
+
|@name|String|no|action name|unique in list of actions|
|
|
247
|
+
|@actionType|String|no|action type, "LOGIC"| |
|
|
248
|
+
|@call|String|no|name of a business logic method (of ProcessContext / ApplicationContext) or framework method|?|
|
|
249
|
+
|Parameters| |yes|parameters node, input to the LOGIC action, see **Parameters specification**| |
|
|
250
|
+
|Return| |yes|return value specification of the LOGIC action, see **Return specification**| |
|
|
251
|
+
|TransitionTo| |yes|continuation action specification when the LOGIC action has been executed, see **TransitionTo specification**| |
|
|
252
|
+
|
|
253
|
+
### Example
|
|
254
|
+
```
|
|
255
|
+
<!-- define input parameters, return values and transition to another action if applicable -->
|
|
256
|
+
<Action name="LoadRoleObjects" actionType="LOGIC" call="ProcessContext::CustomerDetail.loadRoleObjectsAsync">
|
|
257
|
+
<Parameters>
|
|
258
|
+
<Input name="bReload" type="Literal" value="0" />
|
|
259
|
+
</Parameters>
|
|
260
|
+
<TransitionTo action="SetEARightsForRolesTab" />
|
|
261
|
+
</Action>
|
|
262
|
+
|
|
263
|
+
<Action name="GetMainAddress" actionType="LOGIC" call="ProcessContext::CustomerDetail.LoCustomerAddress.getMainAddress">
|
|
264
|
+
<Return name="ProcessContext::MainAddress" />
|
|
265
|
+
</Action>
|
|
266
|
+
|
|
267
|
+
<!-- Utils.identity is a kind of echo function and return the value of the input parameter-->
|
|
268
|
+
<Action name="Set_DataLoaded" actionType="LOGIC" call="Utils.identity">
|
|
269
|
+
<Parameters>
|
|
270
|
+
<Input name="value" value="1" type="Literal" />
|
|
271
|
+
</Parameters>
|
|
272
|
+
<Return name="ProcessContext::CardReportingSurveyExceptions_DataLoaded" />
|
|
273
|
+
<TransitionTo action="SetMaximizedMode" />
|
|
274
|
+
</Action>
|
|
275
|
+
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### PROCESS Action
|
|
279
|
+
PROCESS Actions are used to start a new process (sub-process) from the current process. In the following example, the process started is Customer::AssignNewPOSWizardProcess. The Process Action may return one or more values as shown in the example. The name of the return value is a reference to a variable in the process context.
|
|
280
|
+
|
|
281
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
282
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
283
|
+
|@name|String|no|action name|unique in list of actions|
|
|
284
|
+
|@actionType|String|no|action type, "PROCESS"| |
|
|
285
|
+
|@process|String|no|name of another process|valid process of model|
|
|
286
|
+
|Parameters| |yes|parameters node, input to the PROCESS action, see **Parameters specification**| |
|
|
287
|
+
|ReturnValues| |yes|return values specification of the PROCESS action, see **ReturnValues specification**| |
|
|
288
|
+
|TransitionTo| |yes|continuation action specification when the PROCESS action has been executed, see **TransitionTo specification**| |
|
|
289
|
+
|
|
290
|
+
### Example
|
|
291
|
+
```
|
|
292
|
+
<!-- return values and transition to another action if applicable -->
|
|
293
|
+
<Action actionType="PROCESS" name="AssignNewPOSWizard" process="Customer::AssignNewPOSWizardProcess">
|
|
294
|
+
<ReturnValues>
|
|
295
|
+
<Return name="ProcessContext::PosName" value="posName" />
|
|
296
|
+
<Return name="ProcessContext::PosMetaPKey" value="posMetaPKey" />
|
|
297
|
+
<Return name="ProcessContext::PosGeometryPKey" value="posGeometryPKey" />
|
|
298
|
+
<Return name="ProcessContext::CreateNew_ButtonPressed" value="buttonPressed" />
|
|
299
|
+
</ReturnValues>
|
|
300
|
+
<TransitionTo action="AssignNewPOSWizard_Decision" />
|
|
301
|
+
</Action>
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
### NAVIGATION Action
|
|
305
|
+
New “defaultLabel” Attribute required for Process node of a Navigation Action:
|
|
306
|
+
|
|
307
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
308
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
309
|
+
|@name|String|no|action name|unique in list of actions|
|
|
310
|
+
|@actionType|String|no|action type, "NAVIGATION"| |
|
|
311
|
+
|Parameters| |yes|parameters node, input to the NAVIGATION action, see **Processes Parameters specification**| |
|
|
312
|
+
|TransitionTo| |yes|continuation action specification when the NAVIGATION action has been executed, see **TransitionTo specification**| |
|
|
313
|
+
|
|
314
|
+
### Example
|
|
315
|
+
```
|
|
316
|
+
<Action actionType="NAVIGATION" name="StartSalesNavigation">
|
|
317
|
+
<Parameters name="ProcessContext::NavigationName">
|
|
318
|
+
<Processes selectedId="Questionaire">
|
|
319
|
+
<Process id="Questionaire" image="CheckListGrey24" label="questionnaire" defaultLabel="Questionnaire" action="StartQuestionProcess" />
|
|
320
|
+
<Process id="Notes" image="NoteGrey24" label="notes" defaultLabel="Notes" action="StartNotesProcess" />
|
|
321
|
+
</Processes>
|
|
322
|
+
</Parameters>
|
|
323
|
+
<TransitionTo action="StartQuestionProcess" />
|
|
324
|
+
</Action>
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
### DECISION Action
|
|
328
|
+
The DECISION action is used to evalute an input parameter and take action based on its value.cases specification of the DECISION action, see **Case specification**
|
|
329
|
+
|
|
330
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
331
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
332
|
+
|@name|String|no|action name|unique in list of actions|
|
|
333
|
+
|@actionType|String|no|action type, "DECISION"| |
|
|
334
|
+
|@parameter|String|no|parameter name on which is used for the decision making|?|
|
|
335
|
+
|Case| |yes|at least on case has to specified for the DECISION action, see **Case specification**| |
|
|
336
|
+
|CaseEmpty| |yes| at least on case has to specified for the DECISION action, see **Case specification**| |
|
|
337
|
+
|CaseElse| |yes| at least on case has to specified for the DECISION action, see **Case specification**| |
|
|
338
|
+
|
|
339
|
+
### Example
|
|
340
|
+
```
|
|
341
|
+
<!-- Take another action based on an provided parameter -->
|
|
342
|
+
<Action name="ContextMenuResultDecision" actionType="DECISION" parameter="Event.selected">
|
|
343
|
+
<Case value="DeleteOpeningHour" action="DeleteOpeningHour" />
|
|
344
|
+
<Case value="DeleteAddress" action="DeleteAddress" />
|
|
345
|
+
<Case value="DeleteContact" action="DeleteContact" />
|
|
346
|
+
<Case value="DeletePOS" action="DeletePOS" />
|
|
347
|
+
<Case value="DiscontinuePOS" action="DiscontinuePOS" />
|
|
348
|
+
</Action>
|
|
349
|
+
```
|
|
350
|
+
### CONFIRM Action
|
|
351
|
+
The CONFIRM action is used to decide whether pending changes should be kept or discarded.
|
|
352
|
+
|
|
353
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
354
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
355
|
+
|@name|String|no|action name|unique in list of actions|
|
|
356
|
+
|@actionType|String|no|action type, "CONFIRM"| |
|
|
357
|
+
|@confirmType|String|no|confirmation message type, e.g. "Ok", "YesNo" etc.|check for supported type|
|
|
358
|
+
|Message| |no|message node, multiplicity 1| |
|
|
359
|
+
|Message.@messageId|String|no|reference to a (confirmation) message id in the model (global label contract?)|check for valid message id|
|
|
360
|
+
|Cases| |no|cases node, multiplicity 1| |
|
|
361
|
+
|Cases.Case| |no|case node, mutliplicity 1..N where N is the overall number of options for the confirmation type, see **Case specification**| |
|
|
362
|
+
|
|
363
|
+
### Example
|
|
364
|
+
```
|
|
365
|
+
<!-- Cancel Changes? -->
|
|
366
|
+
<Action name="CancelOpeningHourChanges" actionType="CONFIRM" confirmType="YesNo">
|
|
367
|
+
<Message messageId="CasConfirmCancelMsg" />
|
|
368
|
+
<Cases>
|
|
369
|
+
<Case value="Yes" action="removeCreatedOpeningHour" />
|
|
370
|
+
<Case value="No" action="" />
|
|
371
|
+
</Cases>
|
|
372
|
+
</Action>
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### VALIDATION Action
|
|
376
|
+
The VALIDATION action is used to check/validate an BO by using a validation business logic function.
|
|
377
|
+
|
|
378
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
379
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
380
|
+
|@name|String|no|action name|unique in list of actions|
|
|
381
|
+
|@actionType|String|no|action type, "VALIDATION"| |
|
|
382
|
+
|Validations| |no|validations node, multiplicity 1| |
|
|
383
|
+
|Validations.Validation| |no|validation node, multiplicity 1..N| |
|
|
384
|
+
|Validations.Validation.@name|String|no|reference to validation method (business logic) of a BO (ProcessContext / ApplicationContext variable)|check for valid validation method|
|
|
385
|
+
|TransitionTo| |yes|continuation action specification when the VALIDATION action has been executed, see **TransitionTo specification**| |
|
|
386
|
+
|
|
387
|
+
### Example
|
|
388
|
+
```
|
|
389
|
+
<!-- Validation Opening Hour after click Done Button -->
|
|
390
|
+
<Action name="ValidateOpeningHours" actionType="VALIDATION" >
|
|
391
|
+
<Validations>
|
|
392
|
+
<Validation name="ProcessContext::CustomerDetail.validateCustomerOpeningTime"/>
|
|
393
|
+
</Validations>
|
|
394
|
+
</Action>
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### MASTER DATAIL HANDLER Action
|
|
398
|
+
The MASTER DETAIL HANDLER action type is used to manage the correlation between a MasterList (List Object) and a DetailObject (Business Object).
|
|
399
|
+
|
|
400
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
401
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
402
|
+
|@name|String|no|action name|unique in list of actions|
|
|
403
|
+
|@actionType|String|no|action type, "MASTER_DETAIL_HANDLER"| |
|
|
404
|
+
|MasterList| |no|MasterList node, multiplicity 1| |
|
|
405
|
+
|MasterList.@name|String|no|reference to list object variable from ProcessContext| |
|
|
406
|
+
|MasterList.ItemUnselected| |no|ItemUnselected node, multiplicity 1| |
|
|
407
|
+
|MasterList.ItemUnselected.@type|String|no|option what should be done if an item is unselected (RELOAD, UPDATE, NONE)|check for valid option|
|
|
408
|
+
|DetailObject| |no|DetailObject node, multiplicity 1| |
|
|
409
|
+
|DetailObject.@name|String|no|reference to business object variable of ProcessContext|check for valid variable|
|
|
410
|
+
|DetailObject.@objectClass|String|no|type of the business object variable|check for valid variable type|
|
|
411
|
+
|DetailObject.Save| |no|Save node, multiplicity 1| |
|
|
412
|
+
|DetailObject.Save.@type|String|no|option when the detail object should be saved (DIRTY, ALWAYS, NEVER)|check for valid option|
|
|
413
|
+
|DetailObject.Save.@confirmation|Boolean|no|option if a confirmation is required before saving|check for valid option|
|
|
414
|
+
|DetailObject.Save.@validate|Boolean|no|option if a validation of the detail object should be performed before saving|check for valid option|
|
|
415
|
+
|DetailObject.Delete| |yes|Delete node, multiplicity 1| |
|
|
416
|
+
|DetailObject.Delete.@confirmation|Boolean|no|Should the delete action show a confirmation message Yes/No ?| |
|
|
417
|
+
|DetailObject.Delete.@messageId|String|no|The ID of the delete confirmation message label| |
|
|
418
|
+
|DetailObject.Delete.@nextCurrent|String|no|Which item will get the focus after deletion (First/Prev/Next/Last/None)| |
|
|
419
|
+
|DetailObject.Create| |yes|Create node, multiplicity 1| |
|
|
420
|
+
|DetailObject.Create@autoSave|Boolean|no|AutoSave after create action Yes/No ?| |
|
|
421
|
+
|DetailObject.Create.WizardProcess| |no|WizardProcess node| |
|
|
422
|
+
|DetailObject.Create.WizardProcess.@name|String|no|The name of a valid wizard process| |
|
|
423
|
+
|DetailObject.Create.WizardProcess@submitParameter|String|no|Valid Parameter| |
|
|
424
|
+
|DetailObject.Create.WizardProcess.Parameters| |no|Parameter-List| |
|
|
425
|
+
|DetailObject.Create.WizardProcess.Parameters.Input| |yes|Parameter-Node| |
|
|
426
|
+
|DetailObject.Create.WizardProcess.Parameters.Input.@name|String|no|self explaining| |
|
|
427
|
+
|DetailObject.Create.WizardProcess.Parameters.Input.@value|String|no|" "| |
|
|
428
|
+
|DetailObject.Create.WizardProcess.ReturnValues| |no|List of return values| |
|
|
429
|
+
|DetailObject.Create.WizardProcess.ReturnValues.Return| |yes|ReturnValue-Node||
|
|
430
|
+
|DetailObject.Create.WizardProcess.ReturnValues.Return.@name|String|no|self explaining| |
|
|
431
|
+
|DetailObject.Create.WizardProcess.ReturnValues.Return.@value|String|no|" "| |
|
|
432
|
+
|TransitionTo| |yes|continuation action specification when the VALIDATION action has been executed, see **TransitionTo specification**| |
|
|
433
|
+
|
|
434
|
+
### Example
|
|
435
|
+
```
|
|
436
|
+
<Action name="CustomerListMasterDetail" actionType="MASTER_DETAIL_HANDLER">
|
|
437
|
+
<MasterList name="ProcessContext::CustomerList">
|
|
438
|
+
<!--RELOAD|UPDATE|NONE-->
|
|
439
|
+
<ItemUnselected type="RELOAD" />
|
|
440
|
+
</MasterList>
|
|
441
|
+
<DetailObject name="ProcessContext::CustomerDetail" objectClass="BoCustomer">
|
|
442
|
+
<!--type="DIRTY|ALWAYS|NEVER" confirmation="TRUE|FALSE" validate="TRUE|FALSE" -->
|
|
443
|
+
<Save type="DIRTY" confirmation="FALSE" validate="FALSE" />
|
|
444
|
+
<Delete confirmation="true" messageId=".ConfirmDeletionID" nextCurrent="Next" />
|
|
445
|
+
<Create autoSave="true">
|
|
446
|
+
<WizardProcess name="Customer::CallCustomerReviewProcess" submitParameter="customerPKey">
|
|
447
|
+
<Parameters>
|
|
448
|
+
<Input name="CustomerPKey" value="ProcessContext::CustomerPKey" />
|
|
449
|
+
</Parameters>
|
|
450
|
+
<ReturnValues>
|
|
451
|
+
<Return name="SaveFlag" value="ProcessContext::saveFlag" />
|
|
452
|
+
</ReturnValues>
|
|
453
|
+
</WizardProcess>
|
|
454
|
+
</Create>
|
|
455
|
+
</DetailObject>
|
|
456
|
+
<TransitionTo action="TabDecision" />
|
|
457
|
+
</Action>
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
### END Action
|
|
461
|
+
The END action type is used to exit the current process.
|
|
462
|
+
|
|
463
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
464
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
465
|
+
|@name|String|no|action name|unique in list of actions|
|
|
466
|
+
|@actionType|String|no|action type, "END"| |
|
|
467
|
+
|ReturnValues| |yes|ReturnValues node, see **ReturnValues specification**| |
|
|
468
|
+
|
|
469
|
+
### Example
|
|
470
|
+
```
|
|
471
|
+
<Action actionType="END" name="End">
|
|
472
|
+
<ReturnValues>
|
|
473
|
+
<Return name="dateFrom" value="ProcessContext::DateFrom" />
|
|
474
|
+
<Return name="timeFrom" value="ProcessContext::TimeFrom" />
|
|
475
|
+
<Return name="buttonPressed" value="Event.buttonPressed" />
|
|
476
|
+
</ReturnValues>
|
|
477
|
+
</Action>
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
### SCAN Action
|
|
481
|
+
The SCAN action type is used to capture a "Scan Event"
|
|
482
|
+
|
|
483
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
484
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
485
|
+
|@name|String|no|Action Name|unique in list of actions|
|
|
486
|
+
|@actionType|String|no|action type "SCAN"| |
|
|
487
|
+
|Return| |yes|return value specification of the LOGIC action, see **Return specification**| |
|
|
488
|
+
|TransitionTo| |yes|continuation action specification when the SCAN action has been executed, see **TransitionTo specification**| |
|
|
489
|
+
|
|
490
|
+
### Example
|
|
491
|
+
```
|
|
492
|
+
<Action name="BarCode" actionType="SCAN">
|
|
493
|
+
<TransitionTo action="FindProduct" />
|
|
494
|
+
<Return name="ProcessContext::EAN" />
|
|
495
|
+
</Action>
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
### PRINT Action
|
|
499
|
+
|
|
500
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
501
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
502
|
+
|@name|String|no|Action Name|unique in list of actions|
|
|
503
|
+
|@actionType|String|no|action type "PRINT"| |
|
|
504
|
+
|Parameters| |yes|parameters node, input to the PRINT action, see **Parameters specification**| |
|
|
505
|
+
|ParameterizedInputs| |yes|parameterized input to PRINT action, specification see **ParamterizedInputs**| |
|
|
506
|
+
|TransitionTo| |yes|continuation action specification when the PRINT action has been executed, see **TransitionTo specification**| |
|
|
507
|
+
|Return| |yes|return value specification of the PRINT action, see **Return specification**| |
|
|
508
|
+
|
|
509
|
+
### Example
|
|
510
|
+
```
|
|
511
|
+
<Action name="actionPrint" actionType="PRINT" printId="anyPrintId">
|
|
512
|
+
<Parameters>
|
|
513
|
+
<Input name="param_1" value="myObject" />
|
|
514
|
+
<Input name="param_2" value="myOtherObject" />
|
|
515
|
+
</Parameters>
|
|
516
|
+
<TransitionTo action="anyOtherAction" />
|
|
517
|
+
</Action>
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
## Action Sub Elements
|
|
521
|
+
|
|
522
|
+
### Parameters
|
|
523
|
+
The Parameters element is applicable for multiple action types including LOGIC, LOAD, PROCESS, PRINT and CREATE actions. It describes the parameters passed to a certain action.
|
|
524
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
525
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
526
|
+
|Parameters| |no|Parameters node, multiplicity 1| |
|
|
527
|
+
|Parameters.Input| |no|Input node, multiplicity 1..N||
|
|
528
|
+
|Parameters.Input.@name| |no|name of the input parameter|check for unique parameter name|
|
|
529
|
+
|Parameters.Input.@type| |yes|type of the input parameter<ul><li>applicable for unbound variables only ("Literal")<li>not used for all referenced variables from ProcessContext/|ApplicationContext</ul>|check for valid type|
|
|
530
|
+
|Parameters.Input.@value| |no|reference to a ProcessContext / ApplicationContext / Event variable or Literal value|check for valid reference?|
|
|
531
|
+
|Parameters.Input@passOwnership|Boolean|yes||Only Relevant for PROCESS Actions is used if the instantiated Object should be saved in the called Process, not in the own process.||
|
|
532
|
+
|Parameters.Input@validateOnExit|Boolean|yes|Only Relevant for PROCESS Actions is used to specify if object should be validated on exit.||
|
|
533
|
+
|Filters| | |(available for parameters of PrintActions only!)| |
|
|
534
|
+
|OrderCriteria| | |(available for parameters of PrintActions only!)| |
|
|
535
|
+
|Aggregations| | |(available for parameters of PrintActions only!)| |
|
|
536
|
+
|Correlation| | |(available for parameters of PrintActions only!)| |
|
|
537
|
+
|
|
538
|
+
### Example
|
|
539
|
+
```
|
|
540
|
+
<Parameters>
|
|
541
|
+
<Input name="bpaMetaName" value="ProcessContext::BpaMetaName" />
|
|
542
|
+
<Input name="bpaMetaPKey" value="ProcessContext::BpaMetaPKey" />
|
|
543
|
+
<Input name="myValue" type="Literal" value="42" />
|
|
544
|
+
</Parameters>
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
#### Parameter Filter
|
|
548
|
+
It is possible to specify Parameter Filters for ListObjects that are passed to the print engine. Filters are optional.
|
|
549
|
+
|
|
550
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
551
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
552
|
+
|Filters| |yes|Filters node, multiplicity 1| |
|
|
553
|
+
|Filters.Filter| |yes|Input node, multiplicity 1..N| |
|
|
554
|
+
|Filters.Filter.@fieldName| |no|fieldName of filter (ListItem-Attribute)|check if valid LI attribute|
|
|
555
|
+
|Filters.Filter.@operator| |no|operator of type<ul><li>=<li><<li><=<li>><li>>=</ul>|check for valid operator|
|
|
556
|
+
|Filters.Filter.@value| |no|value to compare/check|check/validation ?|
|
|
557
|
+
|
|
558
|
+
#### Example
|
|
559
|
+
```
|
|
560
|
+
<Input name="parameter01" value="any" type="Literal">
|
|
561
|
+
<Filters>
|
|
562
|
+
<Filter fieldName="attribute" operator="EQ" value="valid" />
|
|
563
|
+
</Filters>
|
|
564
|
+
</Input>
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
#### Parameter OrderCriteria
|
|
568
|
+
It is possible to specify Parameter OrderCriteria for ListObjects that are passed to the print engine. Order Criteria are optional.
|
|
569
|
+
|
|
570
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
571
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
572
|
+
|OrderCriteria| |yes|Criteria node, multiplicity 1| |
|
|
573
|
+
|OrderCriteria.OrderCriterion| |yes|Input node, multiplicity 1..N| |
|
|
574
|
+
|OrderCriteria.OrderCriterion.@fieldName| |no|fieldName of OrderCriterion (ListItem-Attribute)|check if valid LI attribute|
|
|
575
|
+
|OrderCriteria.OrderCriterion.@direction| |no|operator of type<ul><li>ASC<li>DESC</ul>|check for valid operator|
|
|
576
|
+
|
|
577
|
+
#### Example
|
|
578
|
+
```
|
|
579
|
+
<Input name="Parameter01" value="ParameterValue" type="Literal">
|
|
580
|
+
<Filters>
|
|
581
|
+
<Filter fieldName="FilterParam" operator="EQ" value="FilterValue" />
|
|
582
|
+
</Filters>
|
|
583
|
+
<OrderCriteria>
|
|
584
|
+
<OrderCriterion fieldName="OrderParam" direction="DESC" />
|
|
585
|
+
</OrderCriteria>
|
|
586
|
+
</Input>
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
#### Parameter Aggregations
|
|
590
|
+
|
|
591
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
592
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
593
|
+
|Aggregations| |yes|Aggregations node, multiplicity 1| |
|
|
594
|
+
|Aggregation.Sum| |yes|Sum node, multiplicity 1..N| |
|
|
595
|
+
|Aggregation.Sum.@fieldName| |no|fieldName of Sum (ListItem-Attribute)|check if valid LI attribute|
|
|
596
|
+
|
|
597
|
+
#### Example
|
|
598
|
+
```
|
|
599
|
+
<Aggregations>
|
|
600
|
+
<Sum fieldName="test1" />
|
|
601
|
+
</Aggregations>
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
#### Parameter Correlation
|
|
605
|
+
|
|
606
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
607
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
608
|
+
|Correlation| |yes|Correlation node, multiplicity 1| |
|
|
609
|
+
|Correlation.@Name| |no| | |
|
|
610
|
+
|Correlation.@Value| |yes|(propertyGrid: "Correlated ListObject")| |
|
|
611
|
+
|Correlation.@Key| |yes| | |
|
|
612
|
+
|Correlation.@CorrelationKey| |yes| | |
|
|
613
|
+
|Correlation.@Prefix| |yes| | |
|
|
614
|
+
|Correlation.@TargetName| |yes| | |
|
|
615
|
+
|Correlation.Filters| |yes|Filters node, multiplicity 1||
|
|
616
|
+
|
|
617
|
+
#### Example
|
|
618
|
+
```
|
|
619
|
+
<Correlation name="demoCorr" value="TestLo" key="theKey" correlationKey="theCorrKey" prefix="_" targetName="theTargetName">
|
|
620
|
+
<Filters>
|
|
621
|
+
<Filter fieldName="corrFilter1" operator="NE" value="anyValue" />
|
|
622
|
+
<Filter fieldName="corrFilter2" operator="GE" value="anyValue" />
|
|
623
|
+
</Filters>
|
|
624
|
+
</Correlation>
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
#### Parameter Correlations Fitlers
|
|
628
|
+
Correlation Filters are equal to InputParemeter Filters
|
|
629
|
+
|
|
630
|
+
### Processes
|
|
631
|
+
The Processes element can be found at NAVIGATION actions only. It is a special type of an Parameter element that contains navigation information to different other PROCESSES.
|
|
632
|
+
|
|
633
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
634
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
635
|
+
|Parameters| |no|Parameters node, multiplicity 1| |
|
|
636
|
+
|Parameters.@name|String|no|reference to ProcessContext variable with navigation name||
|
|
637
|
+
|Parameters.Processes| |no|Processes node, multiplicity 1| |
|
|
638
|
+
|Parameters.Processes.@selectedId|String|no|identifier of the preselected process for the navigation| |
|
|
639
|
+
|Parameters.Processes.Process| |no|Process node, multiplicity 1..N| |
|
|
640
|
+
|Parameters.Processes.Process.@id|String |no|identifier of the process|check for unique identifier|
|
|
641
|
+
|Parameters.Processes.Process.@image|String|no|reference to image id|check for valid image id|
|
|
642
|
+
|Parameters.Processes.Process.@label|String|no|reference to label id|check for valid label id|
|
|
643
|
+
|Parameters.Processes.Process.@defaultLabel|String|no|default label for the process| |
|
|
644
|
+
|Parameters.Processes.Process.@action|String|no|name of another action of the process|check for valid action|
|
|
645
|
+
|Parameters.Processes.Process.@process|String|yes|reference to another process|check for valid process|
|
|
646
|
+
|
|
647
|
+
### Example
|
|
648
|
+
```
|
|
649
|
+
<Parameters name="ProcessContext::NavigationName">
|
|
650
|
+
<Processes selectedId="ItemList">
|
|
651
|
+
<Process id="ItemList" image="ShoppingCartItemGrey24" label="orderItems" defaultLabel="Items" process="Order::ItemListTabProcess" action="setCurrentTabName_itemList" />
|
|
652
|
+
<Process id="Notes" image="NoteGrey24" label="notes" defaultLabel="Notes" process="Order::NotesTabProcess" action="Notes_Load_Decision" />
|
|
653
|
+
<Process id="Header" image="InfoGrey24" label="orderHeader" defaultLabel="Header" process="Order::HeaderTabProcess" action="Workflow_Load_Decision" />
|
|
654
|
+
</Processes>
|
|
655
|
+
</Parameters>
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
### Return
|
|
659
|
+
The Return element is also applicable for multiple action types like LOGIC, LOAD, CREATE and PROCESS actions. It describes the information returned a certain action.
|
|
660
|
+
|
|
661
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
662
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
663
|
+
|Return| |no|Return node, multiplicity 1| |
|
|
664
|
+
|Return.@name|String|no|reference to ProcessContext / ApplicationContext variable| check for valid variable|
|
|
665
|
+
|
|
666
|
+
### Example
|
|
667
|
+
```
|
|
668
|
+
<Return name="ProcessContext::MainAddress" />
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### ReturnValues
|
|
672
|
+
The ReturnValues element can be used for PROCESS and END actions. It describes the data returned by an action.
|
|
673
|
+
|
|
674
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
675
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
676
|
+
|ReturnValues| |no|ReturnValues node, multiplicity 1| ☺
|
|
677
|
+
|ReturnValues.Return| |no|Return node, multiplicity 1..N| |
|
|
678
|
+
|ReturnValues.Return.@name|String|no|reference to ProcessContext / ApplicationContext variable|check for valid variable|
|
|
679
|
+
|ReturnValues.Return.@value|String|no|name of the variables returned by the process||
|
|
680
|
+
|ReturnValues.Return.@type|String|yes|used to specify Literals (type="Literal") or not existant| |
|
|
681
|
+
|
|
682
|
+
### Example
|
|
683
|
+
```
|
|
684
|
+
<ReturnValues>
|
|
685
|
+
<Return name="ProcessContext::PosName" value="posName" />
|
|
686
|
+
<Return name="ProcessContext::PosMetaPKey" value="posMetaPKey" />
|
|
687
|
+
<Return name="ProcessContext::PosGeometryPKey" value="posGeometryPKey" />
|
|
688
|
+
<Return name="ProcessContext::CreateNew_ButtonPressed" value="buttonPressed" />
|
|
689
|
+
<Return name="ProcessContext::buttonPressed" type="Literal" value="create" />
|
|
690
|
+
</ReturnValues>
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
### TransitionTo
|
|
694
|
+
The TransitionTo element can be found at different action types (LOGIC, LOAD, CREATE, SAVE, PROCESS, VALIDATION, MASTER_DETAIL_HANDLER). It is used to specify the follow-up action of a certain action.
|
|
695
|
+
|
|
696
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
697
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
698
|
+
|TransitionTo| |no|TransitionTo node, multiplicity 1| |
|
|
699
|
+
|TransitionTo.@action| |no|name of another action of the process|check for valid action. Fixed value "End" is also valid.|
|
|
700
|
+
|
|
701
|
+
### Example
|
|
702
|
+
```
|
|
703
|
+
<TransitionTo action="GetAttachmentCount" />
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
### Case
|
|
707
|
+
The Case/Cases element(s) can be found in actions of type DECISION and CONFIRM. These elements are used to evaluate a parameter and take different actions based on its value.
|
|
708
|
+
|
|
709
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
710
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
711
|
+
|Case| |yes|Case node, multiplicity 0..N| |
|
|
712
|
+
|Case.@value|String|no|value specified to match for this case| |
|
|
713
|
+
|Case.@action|String|no|name of another action of the process|check for valid action name|
|
|
714
|
+
|CaseEmpty| |yes|CaseEmpty node, multiplicity 0..1| |
|
|
715
|
+
|CaseEmpty.@action|String|no|name of another action of the process|check for valid action name|
|
|
716
|
+
|CaseElse| |yes|CaseElse node, multiplicity 0..1| |
|
|
717
|
+
|CaseElse.@action|String|no|name of another action of the process|check for valid action name|
|
|
718
|
+
|
|
719
|
+
### Example
|
|
720
|
+
```
|
|
721
|
+
<Case value="Products" action="LoadProducts" />
|
|
722
|
+
<Case value="Attachments" action="LoadAttachments" />
|
|
723
|
+
<CaseEmpty action="GetInfoTab" />
|
|
724
|
+
<CaseElse action="GetInfoTab" />
|
|
725
|
+
```
|
|
726
|
+
|
|
727
|
+
### ParameterizedInputs
|
|
728
|
+
The new parameter definition creates a list of parameter-value pairs that are used for multiple printouts with the same base parameter set. One parameter acts as the controller and the dependent parameter is linked to this controlling parameter. Both can have a type which are named parameterType and dependentType.
|
|
729
|
+
|
|
730
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
731
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
732
|
+
|ParameterizedInputs| |no|ParameterizedInputs node, multiplicity 1| |
|
|
733
|
+
|ParameterizedInputs@name|String|no|name of ParameterizedInputs| |
|
|
734
|
+
|ParameterizedInputs@dependentName|String|yes|dependentName of ParameterizedInputs| |
|
|
735
|
+
|ParameterizedInputs.ParameterizedInput| |no|Input node, multiplicity 1..N| |
|
|
736
|
+
|ParameterizedInputs.ParameterizedInput@parameterValue|String|no|value of the input parameter|check for valid reference|
|
|
737
|
+
|ParameterizedInputs.ParameterizedInput@parameterType|String|yes|type of the input parameter value|check for valid type|
|
|
738
|
+
|ParameterizedInputs.ParameterizedInput@dependentValue|String|yes|reference to a ProcessContext / ApplicationContext / Event variable or Literal value|check for valid reference|
|
|
739
|
+
|ParameterizedInputs.ParameterizedInput@dependentType|String|yes|type of the input dependent value|check for valid type|
|
|
740
|
+
|
|
741
|
+
## ExitHandlers
|
|
742
|
+
The ExitHandlers element can be used at VIEW actions as well as at the PROCESS itself.
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
746
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
747
|
+
|ExitHandlers| |no|ExitHandlers node, multiplicity 1||
|
|
748
|
+
|ExitHandlers.ExitHandler| |yes|ExitHandler node, multiplicity 0..N| |
|
|
749
|
+
|ExitHandlers.ExitHandler.@handlerName|String|no|name of the exit handler|check for unique name per process|
|
|
750
|
+
|ExitHandlers.ExitHandler.@type|String|no|type of the validation exit handler (Validate, ValidateAndSave, CustomValidate)| |
|
|
751
|
+
|ExitHandlers.ExitHandler.@name|String|no|reference to a business object variable of the ProcessContext / ApplicationContext|check for valid variable|
|
|
752
|
+
|ExitHandlers.ExitHandler.Method| |no|Method node, multiplicity 1..N| |
|
|
753
|
+
|ExitHandlers.ExitHandler.Method.@name|String|no|method of the business object specified for the exit handler|check for valid method|
|
|
754
|
+
|ExitHandlers.ExitHandler.OnValidationError| |yes|OnValidationError node, mulitplicity 0..1| |
|
|
755
|
+
|ExitHandlers.ExitHandler.OnValidationError.@transitionTo|String|no|name of another action of the process|check for valid action|
|
|
756
|
+
|
|
757
|
+
## Example
|
|
758
|
+
```
|
|
759
|
+
<ExitHandlers>
|
|
760
|
+
<ExitHandler handlerName="beforeExitCheckMainBo" type="Validate" name="ProcessContext::MainBO">
|
|
761
|
+
<OnValidationError transitionTo="StartNavigation"/>
|
|
762
|
+
</ExitHandler>
|
|
763
|
+
<ExitHandler handlerName ="beforeExitValidateSomething" type="ValidateAndSave" name="ProcessContext::AnotherBO">
|
|
764
|
+
<OnValidationError transitionTo="StartNavigation"/>
|
|
765
|
+
</ExitHandler>
|
|
766
|
+
<ExitHandler handlerName ="beforeExitValidateSomething2" type="CustomValidate" name="ProcessContext::AnotherBO">
|
|
767
|
+
<Method name="validateSimpleProperty1" />
|
|
768
|
+
<Method name="validatePropertyGroupA" />
|
|
769
|
+
<OnValidationError transitionTo="StartNavigation"/>
|
|
770
|
+
</ExitHandler>
|
|
771
|
+
</ExitHandlers>
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
## External Events
|
|
775
|
+
The ExitHandlers element can be used as PROCESS child element.
|
|
776
|
+
|
|
777
|
+
| Node / Attribute name | Type | optional | Annotation | Validations/Checks|
|
|
778
|
+
|:-----------------------|:------|:---------|:----------------------------------------|:------------------|
|
|
779
|
+
|ExternalEvents| |no|ExtenalEvents node, multiplicity 1||
|
|
780
|
+
|ExternalEvents.Event| |yes|Event node, multiplicity 0..N| |
|
|
781
|
+
|ExternalEvents.Event.@name|String|no|name of event| |
|
|
782
|
+
|ExternalEvents.Event.@action|String|no|action of event| |
|
|
783
|
+
|
|
784
|
+
## Example
|
|
785
|
+
```
|
|
786
|
+
<ExternalEvents>
|
|
787
|
+
<Event name="barcodeEvent" action="ScanAndAddProduct_External_StatusDecision" />
|
|
788
|
+
</ExternalEvents>
|
|
789
|
+
```
|
|
790
|
+
|