On an Object there exists a possibility to create an Object Action.
In a case of need to change some attributes of a request such as request status, request priority, or owner of a request and the most often used processes of this type there are designated types of Object Action.
Object Action must be placed into the workflow step to to be properly executed. For a quick addition of an Object Action there is a possibility modify a workflow step through a workflow diagram.
The exact moment of realisation of a process of an Object Action differs. Object actions can be divided into two groups:
- those which are executed at the start of a workflow step
- those which are executed at the end of a workflow step
After setting a name there is a list of usable types of an Object Action.
List of Object Actions
- Add comment to request (system) - adds comment to request from object line (defined in parameter) under system user account
- Add comment to request (current user) - adds comment to request from object line (defined in parameter) under current user account
- Add request owner - fixed
- Add request owner - fixed (Last)
- Add request owner - request line
- Add request owner - request line (Last)
- Add request watcher - fixed
- Add request watcher - request line
- Add user delegation
- Add user delegation from sub-grid
- Add/modify OrgChart category
- Add/modify OrgChart category from sub-grid
- Add/modify pattern search
- Add/modify pattern search rule
- Add/modify pattern search rule from sub-grid
- Add/modify user access
- Add/modify user access from sub-grid
- Add/modify user account
- Add/modify user account from sub-grid
- Add/modify user export list
- Add/modify user export list from sub-grid
- Add/modify user import list
- Add/modify user import list from sub-grid
- Add/modify user module access
- Add/modify user module access from sub-grid
- Add/modify user Object Visibility list
- Add/modify user Object Visibility list from sub-grid
- Add/modify user OrgChart cat. list
- Add/modify user OrgChart cat. list from sub-grid
- Add/modify user template list
- Add/modify user template list from sub-grid
- Add/modify user update action list
- Add/modify user update action list from sub-grid
- Add/modify user dashboard news
- Add/modify user dashboard news area
- Add/modify user dashboard news access
- Add/modify user dashboard news area access
- Add/modify user dashboard news from subgrid
- Add/modify user dashboard news area from subgrid
- Add/modify user dashboard news access from subgrid
- Add/modify user dashboard news area access from subgrid
- Change role and status of request (Last)
- Change role and status of request keep exclusion (Last)
- Change role and status of request (all versions)
- Deactivate OrgChart category
- Deactivate pattern search rule
- Deactivate user access
- Deactivate user account
- Deactivate user export list
- Deactivate user import list
- Deactivate user module access
- Deactivate user Object Visibility list
- Deactivate user OrgChart cat. list
- Deactivate user template list
- Deactivate user update action list
- Delete sub-grid lines
- Execute special function
- Export data - force
- Export data - pull
- Modify requestor - fixed
- Modify requestor - request line
- Notification single request
- Notification single request (Last)
- Set first user password
- Re-initialize request in current step (Last)
- Recalculate request
- Recalculate request (Last)
- Recalculate request - specific line
- Recalculate request - specific line (Last)
- Remove all request owner
- Remove all request owner (Last)
- Remove all request watcher
- Remove request owner - request line
- Remove request owner - request line (Last)
- Remove request watcher - request line
- Remove user dashboard news access
- Remove user dashboard news area access
- Reset user password
- Update request priority
Object
Every Object Action has its own definition of conditions and a parameters. Condition determinates in which case an Object Action should be executed. Parameters specify which Object lines or IDs should be used in execution.
Workflow
Created Object Action has to be assigned to particular Workflow Step (otherwise it won’t be executed). During assignation it is possible to set for what type of request should be executed. There are 3 options:
- Create - Object Action should be executed for a new requests
- Update - Object Action should be executed for a updated requests (look for update action)
- Update Empty - Object Action should be executed for a updated request that was erased in purpose (special type of update)
Example: User Management through an Object Action
In some cases it is useful to change a User setting through a requests and every attribute of User can be set by the request. Therefore many specific Object Actions were developed such as Modify User to change for example language or homepage of the particular user.
Creating user delegation through an object action
Object Action Add/modify object visibility
On an object are these Lines required:
- Line for User login
- Combobox for SYSTEM List of Objects
- Combobox for SYSTEM List of Object Visibilities
Create specific Object Visibility for chosen object.
Parameters are id of User login Line and id of combobox of Object Visibilities
Set Object Action on WF.
Would it be please possible to make this topic up to date? There is lot of new object actions already long time existing, with plenty of parameters, where is not clear what value is expected and non of them documented (For example "Add/modify user OrgChart cat. list from sub-grid, etc…).
Proper documentation would save consultants a lot of time.
Thanks a lot!
Hi Petr,
I’ve just added all missing Object Actions.
Actually the description of Object actions is not exactly needed. The title of OA is self-describing and the parameters that are required as well.
If you are not really sure what the OA does or what it requires, please send it here and I’ll describe it here.
Hi Michal,
thank you for your reply. I agree that the title of OA is self-describing and the parameters that are required as well. Problem is with the usage of the parameters. For example for OA Add/modify user OrgChart cat. list from sub-grid there are clear 6 parameters, but not clear how exactly use them:
- Sub-Grid: I suppose that should be an Id of sub-grid which holds a line with user login
- Active flag: suppose to be 1/0
- Role: Id of role I wont to assigned with the OrgChart. I suppose it can be empty.
- User Login: Id of a line on the Sub-grid from first parameters, the Id of the line which holds the User Id(s)?
- OrgChart category Value: I suppose it should be an Id of a combobox line that holds an orgchart Category - can I provide any reference (with the OrgChart) or shall I use SYSTEM: OrgChart Category? Can this line be from Object level (
idxxxm) or must it be on the Sub-grid level (idyyy)?
- OrgChart category request visibility: I suppose this is actually the “Browser” option and value can be 0/1?
Thanks for answer. I will go throw the User Management Module to see how the object actions are working, so I don’t need it urgent. Never the less I thing that detailed docs is never a mistake.
It’s really easy… you should provide links to proper ObjectLineID where the information can be found or exact number.
Role example:
- set object line
id1234 where the information of roleID is stored.
- set proper number (14, 16, 19…).
Another Object Action has been introduced to the list of available ones. It is - Change role and status of request (all versions)
This Object action (and Periodic action) is similar to the existing one Change role and status of request, nevertheless, this one is specific and should be used to move request to completed or canceled state only. This means that the choice of states will be restricted to those defined in admin as completed or canceled type.
Object action will serve to set ALL versions of the request to desired state, not only the current version. E.g. removal of the all versions to cancelled state, hence removing the record from database. Use and handle with care.
Utilisation: good use of the OA …in case you have several times updated transactions of a Vendor, where for instance Amount is the value, which is changing with the versions… in case you would like to remove the entire records of the transaction when the amount = target (e.g. 0) you would need to get rid of all versions of the request. Today, you could use OA - special function and write an update statement to deactivate request versions based on request code. After introducing this new OA, you can easily define the status and role and conditions without coding to achieve the same.
Note the action will be available in set of Object actions as well as Periodic actions.
Please update the list.
1 Like
Hello @michal.jurnik, thank you for helping us, I would like to join this particular conversation as well. I am quite new here and I must confirm what @petr.skruzny wrote about unclear use of parameters. I guess as a new member I am not alone in asking for more detailed documentation, some aspect that are clear for seniors are complete mystery for me. Maybe if I can explain on one example what happens in my head and what I was looking for in documentation?
I am creating object action that should add/modify OrgChart from regular request. There are three parameters needed. Name of object action and parameter names are clear to me, but not which value should I put in. The third parameter OrgChart group, for example. I would like to add records to an OrgChart named ‘Facility’. So I tried to put ‘Facility’. It was not working, and I have no idea why. Did I put incorrect format? Or is it because any of two previous parameters are incorrect? I do not know and I have no way to find out, no error log appeared. So next I try to put pure value without parenthesis: Facility. Not working. OK, so let´s try to put string ‘Facility’ into some support input line inside the request, which will hold value ‘Facility’, and object action parameter will hold ID of that support line, because also previous two parameters contain ID of request input lines, right? Not working. So maybe string ‘Facility’ was correct and the process fails because first two parameters are incorrect, so I also play with previous parameters. Not working.
By trial and error and combining a lot of possibilities I found out that what I have to do is to create manually OrgChart category first. After it is created I check ID of the category, which is id3. And into Object Action parameter I must put not id3, but 3. It works now. Only after achieving success I began to understand the idea behind conversation aswer (screenshot is helpful, thank you), which made me feel a little bit stupid, I must admit.
It happens quite often to me, that I solve something by trial and error. I guess during the time my sixth sense will develop and I will hit the correct value on second or third try as a true professional, but I think a lot of time could be saved by detailed documentation. Maybe there is some unified approach common to all parameter values. If yes, maybe a documentation of this approach would help?
Of course I do not ask for tautology definition (which I sometimes also see) which does not help user and which makes author ask ‘Why do I have to write such an obvious thing…’ I hope my example of how I think as a newbie can help creating documentation.
I am gratefull for every article that is explaining things in a way that even I as a new user of Xeelo can run complex processes. I use forum pages really often, it helps a lot and I would like you to know that I appreciate effort that creators put into it.
