XQuery Coding Standards

Are there any XQuery coding standards defined for use in OSM?
Or does Oracle provide any such standards for naming conventions, variable names, the case-sensitivity etc?
Or are the standards similar to what we follow for Java?
Please help.
Thanks in advance!

OSM does not dictate a specific set of coding guidelines for XQuery, just as it does not for Java. Normally coding guidelines (whether for Java, XQuery or other technologies) would be defined for a given project based on the best practices and experiences of the System Integrator or Service Provider that is implementing OSM.
Given that XQuery is an industry standard language, we would encourage you to follow best practices established in the industry.
Generally, for XQuery code that the OSM product team writes we follow Java style naming conventions and style wherever applicable. This is a convention we find reasonable given our team routinely writes and reviews both XQuery and Java code so having the same naming convention makes sense.
If there are are additional more specific questions you have on this topic feel free to ask them and we'll do our best to help you.
Regards,
Brian Dueck
VP - Product Strategy and Design
Oracle Communications
Edited by: brian.dueck on Jul 4, 2011 1:59 PM

Similar Messages

  • What are the best coding standards for ADF 11g?

    Hi,
    Do we have any link that will suggest the best coding standard practices used for ADF 11g?
    I am looking out from the perspective of some standards that can be defined before starting my project to know the team on how to
    1. Minimize Duplicity and max reusability of code
    2. Package the code
    3. Resource bundle usage and its calls
    4. Maintainning format consistency eg. date display format, number format
    5. Exception handling
    6. Logging
    7. Namiing conventions
    Also then we might have standards on
    1. Task flow dev.
    2. EO and VO creation standards
    3. UI development standards [purely ADF component based]
    Thanks in advance
    Edited by: user8925296 on May 26, 2010 3:24 PM

    The ADF Enterprise Methodology Group has a page on standards that gives you a starting point on many of your questions: http://groups.google.com/group/adf-methodology/web/adf-coding-standards
    John

  • Please help regarding PLSQL coding standards

    Hi,
    Can you please send any document for PL/SQL coding standards,
    Please help.. I did nt find any good resources on net regarding..
    Pleease help me if any pdf regarding are exitst to my mail id
    [email protected]
    Thanks and Regards
    asp

    I did nt find any good resources on net regarding..Here is a list from the net for you to start with (courtesy of many of the fellow posters here in these forums), and there will be plenty more. Just need to search correctly.
    http://www.redhat.com/docs/manuals/waf/rhea-dg-waf-en-6.0/ap-sql-standards.html
    http://www.orafaq.com/faqplsql.htm
    http://www.williamrobertson.pwp.blueyonder.co.uk/documents/plsqlcodingstandards.html
    http://www.orafaq.com/node/48
    http://apex.oracle.com/pls/otn/f?p=2853:4:11598658413321972351::NO::P4_QA_ID:3262
    http://www.bbc.co.uk/guidelines/newmedia/technical/databases.shtml
    Message was edited by:
    Kamal Kishore
    Message was edited by:
    Kamal Kishore

  • OO ABAP and BSP coding standards

    Hi,
    Can anyone send me the documnet for OO ABAP and BSP coding standards.
    Points will be rewarded.
    Regards
    Sandeep Reddy

    Hi,
    Can anyone send me the documnet for OO ABAP and BSP coding standards.
    Points will be rewarded.
    Regards
    Sandeep Reddy

  • R12.2.0 online pathcing coding standard - table alias name = shcema name

    We are getting coding standard violation error for particular file saying schema name is hard coded in the file. But actually we didn't use any table name with schema name.
    For ex.
    select xle.event_id from xla_events xle;
    Here the table xla_event doesn't use any schema name, but the "XLE" is a schema name in database. Because of this we are getting code standard violation error.
    This shouldn't be a coding violation.

    Please post the details of the application release, database version and OS.
    We are getting coding standard violation error for particular file saying schema name is hard coded in the file. But actually we didn't use any table name with schema name.How do you get this error?
    For ex.
    select xle.event_id from xla_events xle;
    Here the table xla_event doesn't use any schema name, but the "XLE" is a schema name in database. Because of this we are getting code standard violation error.
    This shouldn't be a coding violation.What is the complete error message? What is the patch you are trying to apply?
    Thanks,
    Hussein

  • Peer reviews,coding standards and audit norms

    hi,
    what is meant by peer reviews, coding standards and audit norms in development project of ABAP.
    regds:
    balakrishna.

    Hi Bala,
    Peer review: The code which is written by the developer will be cross checked by one of the team member if the code fulfills the technical spec or not.
    Coding Standards: In a project the client and the software service provider will have an understanding regarding naming convention of all variables, constants, internal table, select-options, etc.
    Example: if it is a select-options the field should be named with the first letter S_ then you will write S_Matnr, and for variables you have to follow V_ then V_maktx.
    Audit norms: Audit norms will depend on the organization so it does not have any standard answer.
    Regards,
    Lakshmikanth

  • SAP coding Standards

    Hi techies,
    Can any one give me the coding standards for ABAP suggested by SAP.??
    no company or client specfic coding standards... only SAP Labs suggested coding standards
    Useful inputs on this will be highly appreciated.
    Thanks in advance
    ~Lakshmiraj~~

    Hi,
    <b>Check this URL.</b>
    http://web.mit.edu/sapr3/dev/newdevstand.html
    In this link, first u have introduction,
    then how to update this guide,
    abap/4 background then only
    <b>CODING STANDARD</b>
    <b>Regards,
    Jackie.</b>

  • Coding standard

    Hi,
    can anyone provide me with details about the new ABAP coding standards in Netweaver 2004s.If there is anything specific
    to BI 7.0, that will be really great.
    Thanks

    Hi Vaishali,
           I think this Link will give you some information about
           Coding Standards in Netweaver 2004
           Link is:-
              http://www.sap.com/platform/netweaver/pdf/BWP_SB_SAP_NetWeaver_Platform_2004.pdf
    Reward points if contents are useful...
    Regards,
    Mandeep.

  • One of worst  function module released by SAP in terms of coding standard

    Hi ,
      I have ever come across SAP function module in terms of Coding standard.
    "J_1I4_GET_ACTUAL_DUTY_IN_LIV".
    Please if any one knows SAP Quality team id please forward this function module to them.
    I do know how SAP has released this kind of function module
    Thanks
    Venkat
    Moderator message: moved to general discussions forum.
    Edited by: Thomas Zloch on Oct 4, 2011 10:42 PM

    LoL!
    [SAP Note 783224 - Rollback of the note 429073|https://service.sap.com/sap/support/notes/783224] is high priority...
    Important:
    The changes provided have to be applied MANUALLY. These changes cannot be applied via S Note or Note Assistant.
    The comments, notes about changes and some corrections to previous notes which changed the FM (manually) mention legal requirements very often...
    It is quite possible that the developer author is a lawyer
    Cheers,
    Julius

  • Implementation of Oracle Coding Standards and Code Quality Checks

    I wanted to implement a list of coding standards and code quality checks for my oracle packages,functions,views,tableetc .
    for example
    All variables with number datatype should start with N_ and charcter type with C_ in all my tables & views definition.
    This can be identified during peer review & can be corrected, but i think this is a repeated process which i don want to burden the developers rather i wanted a tool which does all these kind of checks which can be automated.
    Is there any tool which does this operation or can someone give me a little idea how can i automate these stuffs bu creating a generic oracle procedure which can run through all the tables,views and generate a error report for those which are deviating from the standards.
    Thus we can reduce the manual effort spent on peer review, please suggest.
    thanks in advance

    maru wrote:
    I wanted to implement a list of coding standards and code quality checks for my oracle packages,functions,views,tableetc .
    for example
    All variables with number datatype should start with N_ and charcter type with C_ in all my tables & views definition.Hungarian notation is dead. It has no place in modern programming languages. Has no place in PL/SQL. Anit ain't just me saying that.
    +"Encoding the type of a function into the name (so-called Hungarian notation) is brain damaged—the compiler knows the types anyway and can check those, and it only confuses the programmer."+
    Linus Torvalds
    +"No I don't recommend 'Hungarian'. I regard 'Hungarian' (embedding an abbreviated version of a type in a variable name) a technique that can be useful in untyped languages, but is completely unsuitable for a language that supports generic programming and object-oriented programming—both of which emphasize selection of operations based on the type an arguments (known to the language or to the run-time support). In this case, 'building the type of an object into names' simply complicates and minimizes abstraction."+
    Bjarne Stroustrup
    2) Conditional Statements
    IF (x = 1) --> Wrong
    IF ((x = 1) AND (y = 2)) --> wrong
    IF x = 1 AND y = 2 --> RightIdiotic rules. The simple rule should be readability of code. Not how many brackets to use, and when not to use brackets. Minute standards like detracts from designing and writing proper code, fast and efficiently.
    There are many more rules (which is specific to ur application) which can be incorporated in the tool, there by giving consistency ,readability and easy to maintain for the developers.Bull. The more rules there are, the more difficult it becomes for programmers to write code. As it is no longer about writing readable and flexible and performing code - it is about double checking every single statement line against a huge list of rules about do's and dont's. It is not about getting the programmer focusing on solving the problem - it is about distracting the programmer with a complex and large rule list of how the code should look like.
    Sorry - but this rubs me the wrong way. In that environment, I would be the first to tell you to shove your "+many more rules+".
    I've developed systems in over a dozen languages over the years. I've seen all kinds of standards. The standards that work are those that are short, simple and sensible. Hungarian notation is not sensible. Writing reserved words in uppercase is not sensible. Dictating how brackets should be used is not sensible.
    What is sensible is using the de facto naming standards in use today - as per .Net Guidelines for Names (MSDN) and Code Conventions for the Java Programming Language.
    What is sensible is providing guidelines like bulk collection needs to be justified (not possible using SQL only) and use the limit clause to manage memory spend on the collection variable. Or how packages need to be used to modularise code, providing a public interface and private implementation.
    Standards are about creating a sensible and easy-to-use framework for writing code. It is not about creating a list of a 1001 rules that a developer needs to remember and adhere to, as if the developer is now part of some weird religious sect that has rules for every single aspect of human behaviour.

  • What are the coding standards we need to follow?

    While developing SAPUI5 applications what are the coding standards we need to follow.

    Hi,
    Refer SAPUI5 SDK - Demo Kit
    Regards,
    Chandra

  • ECATT coding standards

    Hi all,
    Anyone have documents related to the coding standards of eCATT sripts,
    any template like thing to follow the coding of eCATT scripts,
    What will be the best method to follow to achieve a good quallity of eCATT scripts
    in performance and look and feel purposes,
    If any one is haveing idea about the above mentioned points, please let me know,
    Thankyou in advance,
    Regards,
    Chandra shekhar.A

    Hi Chandra Shekhar,
    There are no standard rules saying you need to follow these standards to prepare a eCATT as far as I am aware of.
    All you could do is try to differentiate your script in 2 main parts..
    Preparation
    Executionable.
    In the preparation part you perform all the preparation steps like:
    Checking for necessary input values,
    Manupulations to be done to the input values,
    Adding prefixes or changing the dates, when they fall in public holidays etc to values in some cases....
    These preparation stuff will help you very much to save a lot of executionable time as you would check for all the values in the beginning of the execution and if they fail at the preparation, you would save lot of time.
    In the Executionable part,
    Place all your recording ( SAPGUI/TCD/... )
    All the runtime modifications / manipulations
    Also use Message..EndMessage Blocks here..
    Try to keep your script as indented as possible.
    These are some points which might help you to have a good, understandable & indented scripts.
    Hope this helps.
    Best regards,
    Harsha
    PS: Reward points as applicable for all responding.
    null

  • Coding Standard / Notation

    Dear all,
    can anybody give me a hint if there is a complete document with a ABAP Coding Standard/Notation. I am looking for rules to use in my programs like this:
    P_ for parameters
    s_ for select options
    gv_ for global variables
    lv_ for local variables
    pv_ for passed variables in forms
    gt_ for global itabs
    lt_ for local itabs
    gs_ for global structures
    ls_ for local structures
    co_ for constants
    Kind regards
    Roman

    hi roman,
    adding to the above.
    chk this.
    internal table  - > int_ or it_
    work area - > wa_
    field stricture - > fs_
    flags - > wg_
    constants - > wc_
    fields of screen - > wf_
    rgds,
    anver
    if hlped mark points

  • Coding standards for developing java iviews

    Hi All,
    Are there any coding standards to be explicitly followed to develop Java iviews in SAP Enterprise Portal ? Does SAP has any specific java coding standards to get the SAP certification for the developed iviews ?
    regards,
    sreeram

    Hi Sreeram,
    > Are there any coding standards to be explicitly
    > followed to develop Java iviews in SAP Enterprise
    > Portal ?
    No. What you can find (for example within the PDK doc or partially created by wizards) are templates for the different kind of iViews, especially for JSPDynPages. But you have to care - even these templates are not really "clean" - there are objects used to store data which shouldn't...
    > Does SAP has any specific java coding standards to get
    > the SAP certification for the developed iviews ?
    No. What is needed is the proper use of namespaces, but this primarily concerns portal objects within the PCD. Some implementation things are to be considered, for example if i18n is offered, it really has to work. But SAP does not care about the source code of the iViews.
    Hope it helps
    Detlev
    PS: Please consider to reward points for helpful answers on SDN. Thanks in advance!

  • Wht is ment by coding standards?

    hi,
    Can any one tell me wht is ment by coding standards. Wht r the tips to be followed when we r developing a application. so tht the application consists of good coding standards...
    thanks
    [email protected]

    Wht r the tips to be followed when
    we r developing a application. so tht the application
    consists of good coding standards...There are many books out there and through the generations of code, they only change slightly. When you read the books on 'coding standards', keep in mind at some point you will probably want someone to pay you for coding--at that point you will have to adhear to their corporate coding standards, if they officially exist or are implied by the project lead.
    I don't know of much else that will frost the attitude of a lead quicker t'ward a very compitent developer than one that insists the corporate standard is "not appropriate" or "bad coding practice". It may be, but until it is officially changed, or you are fired, they are paying you to make it their way.

Maybe you are looking for