Class Process

    • Field Detail

      • PROPERTY_ID

        public static final String PROPERTY_ID
        Property id stored in column Obuiapp_Process_ID in table OBUIAPP_Process
        Help: Process Defintion is a re implementation of Process with 3.0 infrastructure.
        See Also:
        Constant Field Values
      • PROPERTY_CREATIONDATE

        public static final String PROPERTY_CREATIONDATE
        Property creationDate stored in column Created in table OBUIAPP_Process
        See Also:
        Traceable, Constant Field Values
      • PROPERTY_CREATEDBY

        public static final String PROPERTY_CREATEDBY
        Property createdBy stored in column Createdby in table OBUIAPP_Process
        See Also:
        Traceable, Constant Field Values
      • PROPERTY_UPDATEDBY

        public static final String PROPERTY_UPDATEDBY
        Property updatedBy stored in column Updatedby in table OBUIAPP_Process
        See Also:
        Traceable, Constant Field Values
      • PROPERTY_SEARCHKEY

        public static final String PROPERTY_SEARCHKEY
        Property searchKey stored in column Value in table OBUIAPP_Process
        Help: A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order). Usually, company's internal identifiers for various records (products, customers, etc) are stored here.
        See Also:
        Constant Field Values
      • PROPERTY_NAME

        public static final String PROPERTY_NAME
        Property name stored in column Name in table OBUIAPP_Process
        See Also:
        Constant Field Values
      • PROPERTY_DESCRIPTION

        public static final String PROPERTY_DESCRIPTION
        Property description stored in column Description in table OBUIAPP_Process
        Help: A description is limited to 255 characters.
        See Also:
        Constant Field Values
      • PROPERTY_HELPCOMMENT

        public static final String PROPERTY_HELPCOMMENT
        Property helpComment stored in column Help in table OBUIAPP_Process
        Help: The Help field contains a hint, comment or help about the use of this item.
        See Also:
        Constant Field Values
      • PROPERTY_DATAACCESSLEVEL

        public static final String PROPERTY_DATAACCESSLEVEL
        Property dataAccessLevel stored in column Accesslevel in table OBUIAPP_Process
        Help: Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories: - System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client or All (AD_CLIENT=anything, AD_ORG_ID=anything)
        See Also:
        Constant Field Values
      • PROPERTY_JAVACLASSNAME

        public static final String PROPERTY_JAVACLASSNAME
        Property javaClassName stored in column Classname in table OBUIAPP_Process
        Help: The classname is used when generating a representation of the table in java (the entity or business object). The classname is the simplename of the class (so without the package name). Often the AD_Table.name can be used here. The combination of classname and package needs to be unique.
        See Also:
        Constant Field Values
      • PROPERTY_BACKGROUND

        public static final String PROPERTY_BACKGROUND
        Property background stored in column Isbackground in table OBUIAPP_Process
        Help: This identifies a background process that will be run without any user interaction and needs to be scheduled properly before it will be run using the "Process Scheduling" window.
        See Also:
        Constant Field Values
      • PROPERTY_MODULE

        public static final String PROPERTY_MODULE
        Property module stored in column AD_Module_ID in table OBUIAPP_Process
        Help: Indicates the module the element forms part of.
        See Also:
        Constant Field Values
      • PROPERTY_UIPATTERN

        public static final String PROPERTY_UIPATTERN
        Property uIPattern stored in column Uipattern in table OBUIAPP_Process
        Help: Defines the UI Pattern that the object implements.
        See Also:
        Constant Field Values
      • PROPERTY_ISMULTIRECORD

        public static final String PROPERTY_ISMULTIRECORD
        Property isMultiRecord stored in column IsMultiRecord in table OBUIAPP_Process
        Help: Multi Record allows to execute the process in multiple records at the same time. When this flag is set, multiple records can be selected in grid mode and the process can be executed in all of them at the same time.
        See Also:
        Constant Field Values
      • PROPERTY_REQUIRESEXPLICITACCESSPERMISSION

        public static final String PROPERTY_REQUIRESEXPLICITACCESSPERMISSION
        Property requiresExplicitAccessPermission stored in column Is_Explicit_Access in table OBUIAPP_Process
        Help: When processes are executed from a button in a window, by default, they inherit permissions granted to the window. So if the window is accessible it can be executed without the need of explicitly granting access for that role to the process. This behavior can be overwritten by the "Secured Process" preference. Processes with "Requires Explicit Access Permission" flag set to true, do not inherit permissions from the window but they always require the role to be explicitly granted to this process.
        See Also:
        Constant Field Values
      • PROPERTY_CLIENTSIDEVALIDATION

        public static final String PROPERTY_CLIENTSIDEVALIDATION
        Property clientSideValidation stored in column Clientsidevalidation in table OBUIAPP_Process
        Help: JavaScript function to be executed before invoking the backend Handler. This function (manually coded), can: - Perform validations on the parameters, being possible to prevent execution in case these validations are not satisfied. - Request for additional info to complete the parameter values.
        See Also:
        Constant Field Values
      • PROPERTY_ISGRIDLEGACY

        public static final String PROPERTY_ISGRIDLEGACY
        Property isgridlegacy stored in column Isgridlegacy in table OBUIAPP_Process
        Help: This flags is used to specify if this process should be compatible with the legacy parameter windows. The legacy parameter windows could only contain one grid, so the _selection and _allRows properties of the grid were directly accessible in the handler from the params object. I.e: JSONArray gridRows = jsonparams.getJSONArray(ApplicationConstants.ALL_ROWS_PARAM); New process definitions should access these value like this: JSONObject myGridItem = jsonparams.getJSONObject("myGridItemName"); JSONArray myGridSelectedRows = myGridItem.getJSONArray("_selection"); The 'Compatibility with Legacy Grids' flag should only be checked if its handler retrieves the grid values in the old way.
        See Also:
        Constant Field Values
      • PROPERTY_LOADFUNCTION

        public static final String PROPERTY_LOADFUNCTION
        Property loadFunction stored in column ON_Load_Function in table OBUIAPP_Process
        Help: In this field a javascript function can be defined. This function will be executed when the parameter window is loaded, just after the default values are set.
        See Also:
        Constant Field Values
      • PROPERTY_CANADDRECORDSTOASELECTOR

        public static final String PROPERTY_CANADDRECORDSTOASELECTOR
        Property canAddRecordsToASelector stored in column IsCanAddRecordsToSelector in table OBUIAPP_Process
        Help: By selecting this flag, the process will be available in the 'Defined Selector' window. This process has to be capable of adding records to a selector.
        See Also:
        Constant Field Values
      • PROPERTY_REFRESHFUNCTION

        public static final String PROPERTY_REFRESHFUNCTION
        Property refreshFunction stored in column ON_Refresh_Function in table OBUIAPP_Process
        Help: In this field a javascript function can be defined. This function will be executed when the parameter window refresh action be invoked. For example, if the process has a child-process, once the child-process finishes, it will invoke a refresh of the parent process. Since each process has its particularities, a custom refresh function should be defined in case the process be susceptible of being refreshed/reloaded.
        See Also:
        Constant Field Values
      • PROPERTY_OBUIAPPPARAMETERLIST

        public static final String PROPERTY_OBUIAPPPARAMETERLIST
        Property oBUIAPPParameterList stored in table OBUIAPP_Process
        See Also:
        Constant Field Values
      • PROPERTY_OBUIAPPPROCESSTRLLIST

        public static final String PROPERTY_OBUIAPPPROCESSTRLLIST
        Property oBUIAPPProcessTrlList stored in table OBUIAPP_Process
        See Also:
        Constant Field Values
      • PROPERTY_OBUIAPPPROCESSACCESSLIST

        public static final String PROPERTY_OBUIAPPPROCESSACCESSLIST
        Property oBUIAPPProcessAccessList stored in table OBUIAPP_Process
        See Also:
        Constant Field Values
      • PROPERTY_OBUIAPPREPORTLIST

        public static final String PROPERTY_OBUIAPPREPORTLIST
        Property oBUIAPPReportList stored in table OBUIAPP_Process
        See Also:
        Constant Field Values
    • Constructor Detail

      • Process

        public Process()