Technical documentation for ADF projects - how to and best practices

Hi,
I have a question how to create technical documentation for ADF project expecialy ADF BC and ADF Faces. Is there any tool or JDev plugin for that purpose? What informations should contains documentation for that project, any principles ?Has anybody any experienece. Are there something like documentation best practices for ADF projects? E.g. how to create documentation for bussiness components.
Kuba

I'm not sure there is "best practices" but some of the things that can help people understand are:
An ADF BC diagram - this will describe all your ADF BC objects - just drag your components into a new empty diagram
A JSF page flow - to show how pages are called.
Java class diagram - for Java code that is not in the above two
One more thing to consider - since ADF BC, JSF page flow and JSPX pages are all XML based - you could write XSL files that will actually transform them into any type of documentation you want.

Similar Messages

Can anybody explain what is support for ADF Project and to solve the Issues

Hi,
I am new to ADF and i am currently associated to ADF Support Project.
Can anybody explain what is support for ADF Project and to solve the Issues when the ADF Project is in Live.
we are getting the Tickets for the Issues.
Thanks in advance.

I agree with Timo.
It depends on the size of the project, user base, technologies, etc. We use lot of technologies in fusion middleware stack. We get tickets in many areas.
In your case, it could be anything like user training issues (user may not know how to use the some system features), browser issues like blank screen, bugs in code like JBO errors (failed to validate, another user has changed row, failed to lock the record, NullPointerException, IllegalArgumentException etc), business logic issues, page may not render properly, performance issues, partial commit issues, application server issues, authentication issues. If you use web services you might get web services related problems.

Documentation for as is, to be,and gap analysisin sd implementation project

how to prepare documentation for as is, to be,and gap analysisin sd implementation project?

Dear Chandu,
Please go through this link it will help you about ASAP methedology(AS IS process , TO BE process and GAP anolysis) to Implement a SAP project.
http://www.sapedition.com/5/asap_methodology.html
I hope it will help you,
Regards,
Murali.

I need to know how many downloads individual albums and songs had off of iTunes for a project, how do I find these numbers?

I need to know how many downloads individual albums and songs had off of iTunes for a project, how do I find these numbers?

Ed...maybe a little less time gaming and a bit more time in English class? They got this thing called punctuation and sentences now. Last things first; there is no amount of money that can change your GPU so you can scratch that expense off the list. So you need a battery and a fan? Where do you live? USA? We can help you find a battery but where did you plan to have the new fan put in?

Integration documentation for sap sd with fico and mm

hi Sappers,
I need Documentation for SAP SD with FICO and MM Module
its very urgent.
mail id : [email protected]

Some basic information :
FI-MM: The integration between FI-MM happens in T-code: OBYC
1. When PO is created :
No Entry -
2. When GR is posted
 Inventory Account dr (Transaction Key BSX in OBYC)
 To GRIR account (T.Key WRX in T-code OBYC)
3. When Invoice is posted
 GRIR account Dr.
 Vendor account Cr.
4. Payment made to Vendor
 Vendor A/c Dr
 To Bank Clearing A/c Cr.
Points to know : Movement Types, Assignment of Movement types to T-keys (T-code OMJJ), Value string (I also need some information on this) , OMWN and OMWB transactions.
There is a close integration b/w FI & MM, actually document flows from MM to FI in the following areas such as,
 1. Movement Types:
Used to enable the system to find the predefined posting rules determining how the accounts of financial accounting system are to be posted & to update the stock fields in the matrl master data.(Goods Receipt, Goods Issue, etc)
 2. Valuation Class:
Assignment of material to grp of gl account, used to determine the gl accounts that are updated as a result of goods movement.
3. Transaction/Event key:
Used to control the storage or filing of documents & assignment of documents.Used to differeniate b/w various transactions such as goods movement tht occur in inventory.
 4. Material Type:
Each material should assign mtrl type in mtrl master record used to update whether changes made in qty are updated in material master record & change in value also updated in stock account.
 FI-SD Integration:
The integration is done in T-code VKOA
 1. Sales Order Created
 -No Entry-
2. PGI done (Goods issue)
 Cost of Goods Sold Dr (Configured in OBYC GBB T-Key)
 To Inventory Account
 3. Billing document released to Accounting
 Customer Account Dr.
 To Sales Revenue Account (ERL T-key in Pricing procedure)
Note : The GL account is assigned to this ERL in VKOA
 4. Payment Received
 Bank Clearing A/c Dr
 Customer A/c Cr.
Points to Know : Good to understand the pricing procedure and how the different transaction keys are used like ERL, ERS etc

Technical documentation for Procurement Scenario

Hi,
Does anyone have the technical documentation for the Procurement Scenario? We would like to enhance this scenario but first, we would like to understand all the components it uses, from the user interface layer down to the backend layer. So far all the documentation I have seen from SAP are for business/functional demonstrations, but there are no documents that go into the technical level.
Any help would be greatly appreciated.

Hi basilio,
see these links
https:/.../irj/sdn/go/portal/prtroot/docs/webcontent/uuid/ff03d072-0501-0010-aa88-8018506a2ebe?prtmode=print - 32k
help.sap.com/saphelp_srm30/helpdata/en/d3/4b9c3b122efc6ee10000000a114084/content.htm - 47k
help.sap.com/bp_bblibrary/600/Documentation/J49_Scen_Overview_EN_TH.ppt
www.learn4good.com/jobs/language/english/search_resumes/info_technology/uk_england/cv/205032/ - 42k
thanks
karthik
happy learning

Re:Technical Specs for BI project respectively is-retail

Hi Gurus,
I am looking for some documents on Creating Technical Specs for BI project, as my prokect is in the initial stage.
Hence we require to collect relevant info for implementing the(respectively is-retail) FI-CO, SD & MM with BI project.
I will be assigning points.
My ID is: [email protected]
Thank you.
Regards,
Pradeep Kandepu
Edited by: pradeep kandepu on Jun 8, 2008 5:34 PM

Hi,
Check this link,
[Functional & Tech specs;
Hope this helps you.

Can anyone recommend tips and best practices for FrameMaker-to-RoboHelp migration ?

Hi. I'm planning a migration from FM (unstructured) to RH. I'd appreciate any tips and best practices for the migration process. (Note that at the moment I plan to import the FM documents into, not link to them from, RH.)
For example, my current FM files are presently not optimally "chunked", so that autoconverting FM file sections (based on, say, Header 1 paragraph layout) won't always result in an optimal topic set. I'm thinking of going through the FM docs and inserting dummy paragraphs with a tag somethike like "topic_break", placed in more appropriate locations that the existing headers. Then, during import to RH, I'd use the topic_break paragraph to demark the topics. Is this a good technique? Beyond paragraph-based import delineation, do you know of any guidelines for redrafting FM chapter file content into RH topics?
Also, are there any considerations/gotchas in the areas of text review workflow, multiple authoring, etc. after the migration? (I've not managed an ongoing RH doc project before, so any advice would be greatly appreciated.
Thanks in advance!
-Kurt
BTW, the main reason for the migration: Info is presently scattered in various (and way to many) PDF files. There's no global index. I'd like to make a RoboHelp HTML interface (probably WebHelp layout) so it can be a one-stop documentation shop for users.

Jeff
Fm may produce better output for your requirements but for many what Rh produces works just fine. My recent finding re Word converting images to JPG before import will mean a better experience for many.
Once Rh is set up, and it's not difficult, for many its printed documents will do the job. I would say try it and then judge.
See www.grainge.org for RoboHelp and Authoring tips
@petergrainge

FWSM interface monitoring and best practices documentation.

Hello everyone
I have a couple of questions regarding vlan interface monitoring and best practices specifically for this service module.
I couldn’t find a suggestion or guideline as for how to define a VLAN interface on a management station. The FWSM total throughput is 5.5gbs and the interfaces are mapped to vlans carried on trunks over 10gb etherchannels. Is there a common practice, or past experience, to set some physical parameters to logical interfaces? "show interface" command states BW as unknown.
Additionally, do any of you have a document addressing best practices for FWSM? I have this for other platforms and general recommendations based on newer ASA versions but nothing related to FWSM.
Thanks a lot!
Regards
Guido

Hi,
If you are looking for some more command to check for the throughput through the module:-
show firewall module <number> traffic
Also , I think as this is End of life , you might have to check for some old documentation from Cisco on the best practices.
http://www.cisco.com/c/en/us/products/collateral/switches/catalyst-6500-series-switches/prod_white_paper0900aecd805457cc.html
https://supportforums.cisco.com/discussion/11540181/ask-expertconfiguring-troubleshooting-best-practices-asa-fwsm-failover
Thanks and Regards,
Vibhor Amrodia

EFashion sample Universes and best practices?

Hi experts,
Do you all think that the eFashion sample Universe was developed based on the best practices of Universe design? Below is one of my questions/problems:
Universe is designed to hide technical details and answer all valid business questions (queries/reports). For non-sense questions, it will show 'incompatible' etc. In the eFashion sample, I tried to compose a query to answer "for a period of time, e.g. from 2008.5 to 2008.9, in each week for each product (article), it's MSRP (sales price) and sold_price and margin and quantity_sold and promotion_flag". I grabed the Product.SKUnumber, week from Time period, Unit Price MSRP from Product, Sold at (unit price) from Product, Promotions.promotion, Margin and Quantity sold from Measures into the Query Panel. It gives me 'incompatible' error message when I try to run it. I think the whole sample (from database data model to Universe schema structure/joins...) is flawed. In the Product_promotion_facts table, it seems that if a promotion lasts for more than one week, the weekid will be the starting week and duration will indicate how long it lasts. In this design, to answer "what promotions run in what weeks" will not be easy because you need to join the Product_promotion_facts with Time dimention using "time.weekid between p_prom.weekid and p_prom.weekid+duration" assuming weekid is in sequence, instead of simple "time.weekid=p_prom.weekid". The weekid joins between Shop_fact and product_promotion_facts and Calendar_year_lookup are very confusing because one is about "the week the sales happened" and the other "the week the promotion started". No tools can smart enough to resolve this ambitious automatically. Then the shortcut join between shop_facts and product_promotion_facts. it's based on the articleid alone. obviously the two have to be joined on both article and time (using between/and, not the simple weekid=weekid in this design), otherwise the join doesn't make sense (a sale of one article on one day joins to all the promotions to this article of all time?).
What do you think?
thanks.
Edward

You seem to have the idea that finding out whether a project uses "best practices" is the same as finding out whether a car is blue. Or perhaps you think there is a standards board somewhere which reviews projects for the use of "best practices".
Well, it isn't like that. The most cynical viewpoint is that "best practices" is simply an advertising slogan used by IT consultants to make them appear competent to their prospective clients. But basically it's a value judgement. For example using Hibernate may be a good thing to do in many projects, but there are projects where it would not be a good thing to do. So you can't just say that using Hibernate is a "best practice".
However it's always a good idea to keep your source code in a repository (CVS, Subversion, git, etc.) so I think most people would call that a "best practice". And you could talk about software development techniques, but "best practice" for a team of three is very different from "best practice" for a team of 250.
So you aren't going to get a one-paragraph description of what features you should stick in your project to qualify as "best practices". And you aren't going to get a checklist off the web whereby you can rate yourself for "best practices" either. Or if you do, you'll find that the "best practice" involves buying something from the people who provided the checklist.

How to get Best practices solution

Hi,
       We want to apply Best practices in our server.
       Please inform how to get best practices by solution manager or SAP servive merket place.
Best regards,
   Gaito

Use your Secure user id to login to hxxp://service.sap.com . Click on "Quick Links" on top right corner of market place. Under "Software downloads", navigate to "Installations and Upgrades" link.
You can search for "Best Practices" from here.

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

How to download best practices from solman

Dear Gurus,
Pls guide me in how to download best practices from solman.

Dear Gurus,
Awaiting for your Answers.

EP Naming Conventions and Best Practices documents

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

Hi,
Check this:
Best Practices in EP
http://help.sap.com/saphelp_nw04/helpdata/en/43/6d9b6eaccc7101e10000000a1553f7/frameset.htm
Regards,
Praveen Gudapati

How to use best practices installation tool?

Hello!
can anyone share me some useful links/doc which can guide me how to use best practices installation tool (/SMB/BBI) ?
any responses will be awarded,
Regards,
Samson

hi,
will you please share the same ?
thanks in advance

Technical documentation for ADF projects - how to and best practices

Similar Messages

Maybe you are looking for