Portal items - naming conventions

Hi,
I'm curious to hear of the naming convention that you folks use for your Portal.
When creating a remote portlet for example, I'll need to create a webservice and a portlet, so I might name them like this (assume this is a small calendar portlet):
My Calendar - Web service <-- for the web service
My Calendar - Portlet <-- for the portlet
But then I wonder if I even need the "Web service" and "Portlet" text as these are usually clear from the context.
As someone with very little experience with ALUI I'm keen to hear what others have done and how its worked out.
Thanks,
James.

Hello James...
Here are a few examples of some of the naming conventions we employ:
1. We add " Web Service" to the end of the name of each web service. When the web service is only used to instantiate one portlet, we name the web service <Portlet Name> Web Service. When it can be used to instantiate many portlets (e.g. has an accompanying template), we name the web service <Descriptive Name> Web Service.
2. We give portlets a concise and descriptive name. The name of the portlet shows up in its title bar when it is displayed on a page (unless you hide the title bar), so using a convention like <Descriptive Name> - Portlet would add extranneous information to that title, decreasing usability.
3. We add "Job" to the end of the name of each job operation - mainly to increase effectiveness of Admin Object Search when configuring the Automation service
4. We name admin folders that contain crawlers and jobs <Descriptive name> Crawlers and Jobs - again, to increase effectiveness of Admin Object Search when configuring the Automation service
Naming conventions are important, but they become more important with more distributed portal deployments. If you allow community managers to access administration and let them create their own admin objects, you'll want to have some governance in place that explains the rules (without making them so complicated they become an annoyance).
My two cents... Hope it helps...
Danya
Portal Administrator
Lear Corporation
Edited by: Danya D. Smith on Sep 16, 2008 9:03 AM

Similar Messages

Item Naming Conventions

Hi,
I've been using APEX for a while now, however a new user recently asked me a question: Instead of prefixing a new item with the "PX_" why not label it to some unique value?
Ex: Instead of "P20_START_DATE" (where P20 is referencing some products) use "PRODUCT_START_DATE" as the item name. That way if you copy the page you won't need to change the references in your source code etc.
He does make a valid point about removing the prefix so that you can use the variable throughout the application.
I agree with this in very small applications, however in larger applications i can see a lot of issues arising.
Comments/Thoughts?

Martin,
Even though the item is defined at the page-level, the scope is across the entire application. So for copying items within the same application, this wouldn't work - you can only define one item names PRODUCT_START_DATE in an application.
Also, there are times where you may need to modify the attributes of a particular item. Having something named P20_START_DATE immediately clues me into where I defined this item. Having named it PRODUCT_START_DATE gives me no clue, and now I need to use the Item Finder to figure out where it's defined in my application.
Joel

Naming Conventions for EP

Hi all,
There some official document about Naming Conventions for EP?
Thanks.

Hi,
Portal objects naming convention.
The portal objects should utilize the following naming convention.
Folders: com.companyname.[functional area].[sub functional area].folders.[folder name]
Iview: com.companyname.[functional area].iviews.[Iview name]
Pages: com.companyname.[functional area].pages.[page name]
Transports: com.companyname.[functional area].transports.[Transport name]
Role: com.companyname.[functional area].[sub functional area].roles.[role name]
Worksets: com.companyname.[functional area].[sub functional area].worksets.[workset name]
Hope it helps.
Thanks
Mona

BPEL naming convention

Hi Folks,
I am looking for Oracle BPEL naming convention and coding standards. Tried to search at oracle site as well as on internet but didnt find anything.
Could you please help me with some document/link for naming convention and coding standards.
Thanks
Amit

Hi Amit,
Was able to pull this info from my inrenal repo..thanks to the people who made this :)
Naming Convention: ActivityDescription_suffix_
* ActivityDescription should use camel casing.
copyLeadInfo_asgn
Process Activities
     Services
     ESB Services
Item      suffix      Item      suffix      Item      suffix
Assign      asgn      AQ Adapter      aq      Routing Service      rs
Compensate      cmpnst      Database Adapter      db      SOAP Service      ss
Decide      dcd      Decision Service      dsvc      Custom Adapter      ca
Email      eml      EJB Web Service      ews
Empty      ept      File Adapter      fl
Fax      fax      Java Web Service      jws
Flow      flw      JMS Adapter      jms
FlowN      flwn      MQ Adapter      mq
Human Task      hmntsk      Oracle Applications      oraapps
Invoke      invk      Partner Link      pl
Java Embedding      jvEmbd      FTP Adapter      ftp
Pager      pgr
Pick      pck
Receive      rcv
Reply      rply
Scope      scp
Sequence      sqn
SMS      sms
Switch      swth
Terminate      trmnt
Throw      thrw
Transform      xfrm
Voice      vc
Wait      wt
While      whl
Sensor Actions      snrctn
Sensor Activity      snsrcvt
Sensor Variable      snsrvrbl
Fault Sensor      snsrflt
Also, you can refer : http://my.oracle.com/portal/page/myo/emea/Communities/Technology/EMEA_SOA_Integration/KA
Hope it helps!
Regards
Anirudh Pucha

AppleScript To Save Messages As PDFs With Specific Naming Convention

I am looking for an Applescript that:
1: Prompts and allows the user to select one or more Apple Mail email messages from within Mail (10.4, 10.5, 10.6).
2: Prompts and allows the user to select a save-to folder.
3: For each message, saves it as a PDF file in the save-to folder, using the following naming convention for the PDF file:
"YYYY-MM-DD HH.MM.SS Email From FIRSTNAME LASTNAME - SUBJECT",
"YYYY-MM-DD HH.MM.SS Email To FIRSTNAME LASTNAME - SUBJECT",
where in the email date-sent stamp (if I am the sender) or date-received stamp (if I am the recipient):
YYYY = the year
MM = the two-digit month
DD = the two-digit day
HH = the two-digit hour (in 24-hour time)
MM = the two-digit minute
SS = the two-digit second
FIRSTNAME is the email sender's first name for email that I receive (or is the email recipient's first name for email that I send)
LASTNAME is the email sender's last name for email that I receive (or is the email recipient's first name for email that I send)
SUBJECT = the email's subject line
For example: 2010-04-10 16.32.48 Email From Kris Ryan - Status Of Payroll Updates.pdf
For example: 2010-04-10 16.33.55 Email To Sue Anderson - RE Status Of Payroll Updates.pdf (Colon omitted after "RE".)
4: For each attachment to the message, saves it as a PDF file in the same directory using the naming convention:
"YYYY-MM-DD HH.MM.SS Email From FIRSTNAME LASTNAME Z Attachment - NUMBER - FILENAME",
where:
YYYY-MM-DD HH.MM.SS Email From FIRSTNAME LASTNAME = as above
NUMBER = an integer representing the attachment number (1, 2, ...) sorted according to filename alphabetical order
FILENAME = the name of the file attached to the email, including its extension (.docx, .xlsx, etc.)
The letter "Z" sorts the attachment PDFs after its respective parent email in the directory.
For example: 2010-04-10 16.32.48 Email From Kris Ryan Z Attachment - 1 - List Of Suggestions To Moore.doc.pdf
For example: 2010-04-10 16.32.48 Email From Kris Ryan Z Attachment - 2 - Proposed Salary Adjustments.xls.pdf
For example: 2010-04-10 16.32.48 Email From Kris Ryan Z Attachment - 3 - Salary History.pps.pdf
Note: The email attachment may consist of a PDF or MS Office file (Word, Excel, Power Point); however, a smart implementation will be able to handle any attachment kind. If the attachment is a PDF file, then save it "as is" using the stipulated naming convention, without passing it through Distiller.
Thank you.
Kurt Todoroff

Well, that's quite a spec sheet.
Here's a start, you can easily edit the script to get what you need:
<pre style="
font-family: Monaco, 'Courier New', Courier, monospace;
font-size: 10px;
font-weight: normal;
margin: 0px;
padding: 5px;
border: 1px solid #000000;
width: 720px; height: 340px;
color: #000000;
background-color: #E6E6EE;
overflow: auto;"
title="this text can be pasted into the AppleScript Editor">
Set a Mail Rule to Save Message and Attachment to Desktop.
To save attachments to another another folder on the desktop (i.e. Attachments) create the folder and then
change tell application "Finder" to set pathToAttachments to (path to desktop folder as string) & "Attachments:"
using terms from application "Mail"
on perform mail action with messages theMessages
tell application "Finder" to set ptd to (path to desktop folder) as string
tell application "Finder" to set pathToAttachments to (path to desktop folder) as string
tell application "Mail"
repeat with theMessage in theMessages
set d_recd to date received of theMessage as string
set d_recd to ReplaceText(d_recd, ":", " ") of me
set d_recd to ReplaceText(d_recd, ",", " ") of me
set theText to content of theMessage
if theMessage's mail attachments is not {} then
repeat with theAttachment in theMessage's mail attachments
set theFileName to pathToAttachments & (theMessage's subject) & " (Attachment From " & (theMessage's sender) & " Sent " & d_recd & ")" & space & theAttachment's name
try
save theAttachment in theFileName
on error errnum
end try
end repeat
end if
set theFile to ptd & (theMessage's subject) & " (From " & (theMessage's sender) & " Sent " & d_recd & ")" & ".txt"
set theFileID to open for access file theFile with write permission
write theText to theFileID
close access theFileID
end repeat
end tell
end perform mail action with messages
end using terms from
on ReplaceText(theString, fString, rString)
set current_Delimiters to text item delimiters of AppleScript
set AppleScript's text item delimiters to fString
set sList to every text item of theString
set AppleScript's text item delimiters to rString
set newString to sList as string
set AppleScript's text item delimiters to current_Delimiters
return newString
end ReplaceText</pre>

Variable naming conventions

Hi all,
I come from a mostly JAVA background. Big emphasis in that arena on encapsulation and modularization of code to help facilitate ease of maintenance and reuse...in theory I sometimes struggle with variable naming conventions within my ABAP code because I'm not all together certain there are any. In C or C++ I might use a derivation of Hungarian notation to name varaibles...and in JAVA I might observe certain object oriented rules regarding varaible naming...I find myself using a combination of those two protocols in my ABAP code. Does anyone have any suggestions for how I might name global and lcoal variables within my code?
regards,
Mat

Hi,
Please check this links perhaps they may help.
http://help.sap.com/saphelp_nw04/helpdata/en/92/c2b084bc1d11d2958700a0c94260a5/content.htm
https://websmp101.sap-ag.de/~sapdownload/011000358700004455192006E/NameConventions.pdf
http://help.sap.com/saphelp_nw04/helpdata/en/2a/6b0b1f547a11d189600000e829fbbd/content.htm
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/docs/library/uuid/011ccf90-0201-0010-92a7-b319adf89b73
http://web.mit.edu/sapr3/dev/newdevstand.html
Regards,
Ferry Lianto

Checking naming convention of internal tables in code inspector

Can anyone please explain how in the code inspector can I check names of internal tables (like it_) that I use in a report program ? I know that I can specify it_ in Programming Convention -> Naming Convention->Program Global -> Data but this entry is not specific to internal tables as it also applies to variables and work areas. Apart from this is there any entry I can maintain in the Extended Naming Conventions for Programs(introduced in ECC 6.0)? Kindly reply at the earliest.

Hi,
Check these links for implementing the custom conventions in the code inspector
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/library/nw/how%20to%20build%20a%20new%20check%20for%20the%20code%20inspector
https://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/library/webas/abap/evaluating%20the%20quality%20of%20your%20abap%20programs%20and%20other%20repository%20objects%20with%20the%20code%20inspector
hope it helps you.
Thanks!

Export-Import and Naming convention question

All,
Newbie here. Have a question related to the naming convention for SAP R/3 system and XI manual export/import process. We are currently in the development environment where our R/3 systems are named as D55CLNT400, D56CLNT300 etc (first 3 characters are the system id, and last 3 are the client number.) This is per the XI best practices convention.
The question i have is - if we name the technical system as above - and export the configuration objects from the Dev to Test environment - where the R/3 systems are named as T55CLNT400, T56CLNT300 (similar naming structure). Does it mean that we need to manually change almost all of the items in the Test environment on the configuration side (like business sytem name, interface determination, receiver determination etc)
Is this the correct way or are we missing something??? I would have preferred a way - where we needed to only update the communication channel parameters.
Thanks.
Message was edited by:
thezone

In the SLD, create three Business System Groups: DEV, QAS and PRD.
In each of these groups, you must have the relevant application servers (in your case, R/3s) and one integration server (XI).
Then, for each Business System in Group DEV, define a transport target in QAS group.
In your case, the transport landscape should be like this:
D55CLNT400 -> T55CLNT400
D56CLNT300 -> T56CLNT300
XI_DEV -> XI_QAS
Do the same for the QAS group (defining transport targets in PRD group). Observe that you need to have the same number of Business Systems in each group for this to work properly.
Now, when you transport your configuration objects from XI_DEV to XI_QAS, all the Business Systems in DEV landscape will be replaced for the equivalent ones in QAS landscape.
More info: http://help.sap.com/saphelp_nw2004s/helpdata/en/ef/a21e3e0987760be10000000a114084/frameset.htm
Regards,
Henrique.

Hard to find ripping naming conventions

?In Mediasource Player 3.3, I had a really hard time finding the naming convention settingsdialog. It is in the media folder format settings option. I ended up with a bunch of ripped tracksthat had the track name twice and couldn't find the option. Hopefully this thread will help someoneso they don't have to struggle as much as I did. In the Settings pop-up the PC Music Library tab,and the Properties button under the first item which is the name of your current PC Music libraryname. I had failed to change the last box on the bottom right from track name to none. Ta paj692

I guess the argument against your argument is that your code should be as self-documenting as possible. In your code, I'll see "Event". Great. java.awt.Event? No (annoyance #1 already). Your base Event? I wouldn't know, need to check the imports first. Aaahh, scrolled up and saw: your special implementation Event it was. Although, I will not see that if I'm not familiar with your package structure and you're doing package imports.
Create packages for functional groups, otherwise you'll end up with loads of unnecessary public declarations because your helper classes are splattered all over the place and can't just rely on in-package visibility.
And by the way, using polymorphism properly like you don't seem to do, you'll screw yourself, because you'll in future have to do things like:
Event ev = new com.mystuff.special.implementation.Event();Because you can't import both the interface/superclass and the implementation. Congratulations.

EP Naming Conventions and Best Practices

Hi all
Please provide me EP Naming Conventions and Best Practices documents
Thanks
Vijay

Hi Daya,
For SAP Best Practices for Portal, read thru these documents :-
[SAP Best Practices for Portal - doc 1 |http://help.sap.com/bp_epv170/EP_US/HTML/Portals_intro.htm]
[SAP Best Practices for EP |http://www.sap.com/services/pdf/BWP_SAP_Best_Practices_for_Enterprise_Portals.pdf]
And for Naming Conventions in EP, please go through these two links:-
[Naming Conventions in EP|naming standards;
[EP Naming Conventions |https://websmp210.sap-ag.de/~sapidb/011000358700005875762004E]
Hope this helps,
Regards,
Shailesh
Edited by: Shailesh Kumar Nagar on May 30, 2008 4:09 PM

[svn:fx-3.x] 12371: The main AccImpl was updated to handle accessible naming conventions differently than before .

Revision: 12371
Revision: 12371
Author:   [email protected]
Date:     2009-12-02 08:51:12 -0800 (Wed, 02 Dec 2009)
Log Message:
The main AccImpl was updated to handle accessible naming conventions differently than before. This change was made to make the 3.x branch consistent with the trunk changes. The updated methods allows the accessibilityName property to overwrite the logic that was previously used to build the accessible name for components that were inside of forms. This method also provides a method to allow developers to specificy that no form heading or form item label should be included in the accessibilityName for the form field by using a space.
QE notes: none
Doc notes: none
Bugs: n/a
Reviewer: Gordon
Tests run: checkintests
Is noteworthy for integration: no
Modified Paths:
    flex/sdk/branches/3.x/frameworks/projects/framework/src/mx/accessibility/AccImpl.as

Revision: 12371
Revision: 12371
Author:   [email protected]
Date:     2009-12-02 08:51:12 -0800 (Wed, 02 Dec 2009)
Log Message:
The main AccImpl was updated to handle accessible naming conventions differently than before. This change was made to make the 3.x branch consistent with the trunk changes. The updated methods allows the accessibilityName property to overwrite the logic that was previously used to build the accessible name for components that were inside of forms. This method also provides a method to allow developers to specificy that no form heading or form item label should be included in the accessibilityName for the form field by using a space.
QE notes: none
Doc notes: none
Bugs: n/a
Reviewer: Gordon
Tests run: checkintests
Is noteworthy for integration: no
Modified Paths:
    flex/sdk/branches/3.x/frameworks/projects/framework/src/mx/accessibility/AccImpl.as

Naming conventions in EP

Hi all,
we are currently in the process of preparing for Buisness Package certification in Enterprise Portal.
While going through the Test Plan provided by SAP describing the guidelines and the naming conventions.
Is there any thing that should be especially noted when we do the naming of EP folders and other EP components.Any help on these naming conventions is welcome.
Regards
Rohit.

Hi Rohit,
Please refer to the Vendor Structuring Guide (a.k.a. How to Certify Portal Content document) for more information on the naming conventions. You should have received this together with the test plan.
If you cannot locate this document, please contact your assigned integration consultant and/or complete and return the project registration document as much as you can so that the consultant can get back to you with any corrections that might be necessary.
Regards,
Mustafa.

Naming Conventions - programmer refuses to stick to them... what to do?

A fellow programmer on my team, though good, often refuses to abide by naming conventions, or seem even to be aware that many have existed and use that knowledge accordingly.
Today, for example, he created a class (not an interface) called Createable. I pointed out to him that convention over the years has been that classes ending in '-able' were usually interfaces, or might be suspected to BE interfaces by other programmers looking at his code.
He said he didn't care.
I then later noticed he had an interface defined in another package called 'Createable'. So he had made two classes of the same name in different packages, one an interface and one not.
Our boss doesn't seem to mind this kind of thing (he just wants us to get the work done and isn't interested in quibbling over things like naming convensions). Perhaps I'm a bit stern about these kinds of things, but it really gets my goat when this happens.
What's your opinion, Java Community?
- Tim
Edited by: user2052552 on Feb 3, 2011 12:41 PM

user2052552 wrote:
A fellow programmer on my team, though good, often refuses to abide by naming conventions, or seem even to be aware that many have existed and use that knowledge accordingly.
Many conventions? As in your team doesn't have a convention but you want them to follow one which is unspecified?
Today, for example, he created a class (not an interface) called Createable. I pointed out to him that convention over the years has been that classes ending in '-able' were usually interfaces, or might be suspected to BE interfaces by other programmers looking at his code.
English is a limited language.
Is 'Manager' suitable for the name of a class or an interface?
If only the latter then what do I call a class that represents something that "manages"?
He said he didn't care.
I then later noticed he had an interface defined in another package called 'Createable'. So he had made two classes of the same name in different packages, one an interface and one not.
Our boss doesn't seem to mind this kind of thing (he just wants us to get the work done and isn't interested in quibbling over things like naming convensions). Perhaps I'm a bit stern about these kinds of things, but it really gets my goat when this happens.
What's your opinion, Java Community?First it is a management problem.
Second there are proven techniques for producing better code. Coding conventions are not one of those.
Third if an organization is such that it is using other proven techniques, then coding conventions might have some measurable impact on quality, but lacking other techniques (or lacking all techniques) there can be no measurable impact as it would be less than the noise level caused by other correctable items.
Fourth as a point about what measurable techniques are the classes that the developer is creating actually Objects (Object Oriented Objects)? Versus random collections of functionality for example? The latter would be a far more serious problem than naming. And does that developer, and all of the other developers, use inheritence appropriately? Again misuse there would be a far more serious problem.

Naming Conventions für PDC Objects

Dear all,
has anybody a document describing the naming conventions for PDC Object.
Example:
iv_xxxx for iViews
ro_xxxx for Roles
etc.
Thanks for help
Roman

Hi Roman,
check the SAP ASAP Roadmap for Enterprise Portal which can be found in [the SAP Service Marketplace|http://service.sap.com/roadmaps].
There you have several so called "accelerators" - one of those is a best practice document for naming conventions.
Look at Chapter 3.3.1.3
(I know because it is my slide set setup during an implementation project )
Hth,
Michael

Report naming conventions?

what are these report naming conventions that show/get prefixed to items etc. by default in the object navigator.
1) Q_      is Query
2) G_     is Group
3) M_     is ?
4) R_     is ?
5) F_     is ?
6) B_     is ?

what are these report naming conventions that show/get prefixed to items etc. by default in the object navigator.
1) Q_ is Query
2) G_ is Group
3) M_ is ?
4) R_ is ?
5) F_ is ?
6) B_ is ?
3) M_ is Group Frame
4) R_ is Repeating Frame
5) F_ is Field
6) B_ is Boiler Text

Portal items - naming conventions

Similar Messages

Maybe you are looking for