Hi All,

I am currently reworking the workflows and as there is currently no 
fixed naming convention, I want to make a proposal on this.

Some newer workflows partially use "I18N_OPENXPKI_WF_TYPE*" (Id of the 
Workflow) and "I18N_OPENXPKI_WF_ACTIVITY*" (Name of the Action) already

I would suggest to use "I18N_OPENXPKI_WF_VAL*"  and 
"I18N_OPENXPKI_WF_COND*" as common prefix for Validators and Conditions. 
For better reading I would also suggest "I18N_OPENXPKI_WF_ACL_*" as 
shortcut for ACL Conditions and to rename the Action prefix to  
I18N_OPENXPKI_WF_ACTION*", so the prefix matches the name of the XML Tag.

For the individual names one should use or at least derive the name from 
the actual package name which provides the default implementation. To 
give some freedom to 3rd parties, we might relax this to just use a 
unique prefix.

The "state" names exist only inside one workflow and therefore do not 
need any unification. For the descriptions of the states and workflows, 
the concept already used in 
workflow_def_certificate_revocation_request.xml looks fine for me:

workflow-type is I18N_OPENXPKI_WF_TYPE_<workflow name>
state description is I18N_OPENXPKI_WF_STATE_<workflow name>_<state name>

Workflow name is equal to the name of the xml file. If the state 
description should be reused within similar workflows, it would be wise 
to split the workflow name in a group part and an individual part and 
use the fomer one for the description tags.

Some of the naming rule were used in the new NICE Workflow, avail on 
github 
https://github.com/oliwel/openxpki/tree/feature/nice/trunk/deployment/etc/templates/nice
 
- Any comments are welcome

Oliver

-- 
Protect your environment -  close windows and adopt a penguin!
PGP-Key: 3B2C 8095 A7DF 8BB5 2CFF  8168 CAB7 B0DD 3985 1721


------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual 
desktops for less than the cost of PCs and save 60% on VDI infrastructure 
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
OpenXPKI-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openxpki-devel

Reply via email to