بسمه تعالي

NamAvaran , نام آوران

سند

مجموعه قراردادهاي انتخاب و نامگذاري

در Oracle Designer

تهيه و تدوين :
عليرضا صائبي
شركت نام آوران
1379

فهرست مطالب

فهرست مطالب
تاريخچه
مقدمه
اشياء منتخب
قراردادهاي نامگذاري اشياء
برخي قراردادها در پيشبرد پروژه

تاريخچه

نسخه	تاريخ	شرح
1.0.1	25/11/1379	تدوين ساختار کلي سند
1.0.2	5/2/1386	بازنگري سند

[بازگشت به فهرست مطالب ...]

مقدمه

در اين سند سعي شده است تا اشياء مورد استفاده در Oracle designer‌ و برخي قراردادهاي نامگذاري آنها بصورتي هرچند خلاصه مدون شود و در ابتدا برخي از موجوديتهايي كه تكميل اطلاعات آنها ضروري به نظر ميرسد عنوان شده و در ادامه قراردادهايي براي نامگذاري آنها بيان شود.

[بازگشت به فهرست مطالب ...]

اشياء منتخب

در اين بخش برخي از اشياء انتخاب شده براي پيشبرد پروژه در Oracle designer را معرفي ميكنيم .

Container	Propoerty	عنوان	كاربري
*Application system*	Comment	نسخه	عنوان بندي سند
	Description	عنوان پروژه
	Summary	مرور کلي
	Notes	چشم اندازي از محصول
*Application system* *(ue)*	Author	تدوينگر
*User defined set*	History\Version	نسخه	تاريخچه
	History\Description	شرح	تاريخچه
	Scope	دامنه کاربرد	مقدمه
	Purpose	هدف
	References	منابع و مراجع
*Business terminology*	Name	عنوان	تعاريف و مفاهيم
*Business terminology*	Description	مفهوم	تعاريف و مفاهيم
*Problem*	Comment	مشکل اصلي	توضيح مشکلات اصلي
	Description	اثرات مشکل
	Notes	راه حل مناسب
*Location*	Name	ذينفعان	مشخصات ذينفعان
	Code	کد ذينفع
	Contact	نماينده
	Comment	نقش در پروژه
*Business unit*	Name	عنوان کاربر (فارسي)	مشخصات کاربران سازماني
	Short name	کد کاربر (لاتين)
	Role responsibilities	وظائف کاربر
	Description	توضيحات نقش کاربري
	Parent	ارتباط با نقش پدر (سلسله مراتب چارت سازماني)
*User defined set*	Software\Database	بانک اطلاعاتي	محيط کاري کاربر
	Software\Client OS	سيستم عامل سرويس گيرنده
	Software\Server OS	سيستم عامل سرويس دهنده
	Hardware\Network	شبکه	سخت افزار
	Hardware\Client spec.	مشخصات سرويس گيرنده
	Hardware\Server spec.	مشخصات سرويس دهنده
	Development environment	محيط پياده سازي
	Performance requirements	نيازمنديهاي اجرائي
	Environmental requirements	نيازمنديهاي محيطي
*User requirements (ue)*	Name	نيازمندي	نيازمنديهاي کاربران سازماني
	Degree	درجه اهميت
	Problem	مشکلات ايجاد شده
	Current solution	راه حل کنوني
	(Function mapping)	راهکار پيشنهادي
*User defined set*	Nonfunctional requirements\Notes	نيازمنديهاي غير کارکردي
	Acceptance plan	پذيرش و ارزشيابي محصول
	Constraints\Name	عنوان	محدوديتها
	Constraints\Description	شرح
	Priority	اولويتها/عنوان
*Assumptions*	Description	شرح	فرضيات و نيازمنديها
*Objectives*	Name	عنوان	اهداف و خلاصه اي از توانمنديها
	Type	نوع
	Description	شرح توانمندي
*Resources (ue)*	Name	عنوان	منابع اجرائي
	Type	نوع
	Business unit owner	محل استقرار
*Business function*	Label	کد کارکرد	کارکرد
	Short definition	عنوان فارسي کارکرد
	Description	خصوصيات کارکرد(خصوصيات محصول)
	Sequence in parent	ترتيب کاري
	Frequency	فرکانس فراخواني کارکرد
	Frequency unit	واحد فرکانس
	Function type	نوع کارکرد
	Application logic comment	نحوه عمل کارکرد (براي پياده سازي)
*Business function (ue)*	User/Help text	راهنماي کاربري کارکرد
*Entity*	Name	نام (فارسي)	موجوديت (مدل داده اي)
	Short name	نام (لاتين)
	Plural	نام جدول متناظر
	Data warehouse type	نوع استفاده در انباره داده ها
	Description	شرح موجوديت
*Entity attributes*	Name	نام (لاتين با توجه به استانداردهاي نامگذاري)	اقلام داده موجوديت
	Domain	دامنه مورد استفاده
	Sequence	ترتيب
	Format	فرمت (عددي / رشته اي / تاريخ / ...)
	Average length	طول متوسط
	Max length	حداکثر طول
	Optional	اجباري/اختياري
	Derivation expression	قوانين تجزيه
	Description	شرح قلم اطلاعاتي
*Business function/entity usage*	Entity	موجوديت مورد استفاده	ماتريس كاركرد/موجوديت
*Business function/entity usage*	CRUD	نحوه استفاده کارکرد از موجوديت	ماتريس كاركرد/موجوديت
*Tables*	Name	نام جدول (متناظر با plural موجوديت مرتبط)	جدول اطلاعاتي
	Alias	نام مخفف
	Description	شرح (در صورت نياز)
	Index	وابسته به نياز و محيط بانک اطلاعاتي
	Foreign keys	وابسته به نياز و محيط بانک اطلاعاتي
	Primary keys	وابسته به نياز و محيط بانک اطلاعاتي
	Unique keys	وابسته به نياز و محيط بانک اطلاعاتي
	Check constraints	وابسته به نياز و محيط بانک اطلاعاتي
*Columns*	Name	نام ستون (لاتين با توجه به استانداردهاي نامگذاري)	ستونهاي اطلاعاتي جداول
*Columns*	Description	شرح	ستونهاي اطلاعاتي جداول
*Domains*	Name	نام دامنه (لاتين با توجه به استاندارد نامگذاري)	دامنه
	Att\Format	فرمت (در قلم داده موجوديت)
	Att\Average length	طول متوسط (در قلم داده موجوديت)
	Att\Max length	حداکثر طول (در قلم داده موجوديت)
	Col\Format	فرمت (در جدول اطلاعاتي)
	Col\Average length	طول متوسط (در جدول اطلاعاتي)
	Col\Max length	حداکثر طول (در جدول اطلاعاتي)

[بازگشت به فهرست مطالب ...]

قراردادهاي نامگذاري اشياء

Business units

Short name : BU + [business unit layer no. ] + [Subsystem Code] + [Sequence]
Name : Persian real name of business units

Locations

Name : Persian real name of location
Type : Type name that considered privately in each project

Domains

Name : DM + _ + [ domain name]

Entities

Name : Persian real name of entity
Short name : Abbreviation or acronym of real entity name
Plural : Tbl + _ + [Subsystem code] + [Considered real table name]

Attributes (name) if : -

Primary key : Pk + _ +[real entity name or its acronym] + _ + id
Title : [real attribute name] + _ + title
Names : [real attribute name] + _ + name
Item Count : [real Item name] + _ + cnt
Date : [real operation name ] + _ + date
Item amount : [real attribute name] + _ + amount
Description : [real attribute name] + _ + desc
Row numbers : Row_Num
Flags : [real attribute usage name] + flag
Boolean attr. : Is + _ + [real condition name]
Sequences : [real attribute name] + _ + seq
Codes : [real attribute name] + _ + code
Identifiers : [real attribute name] + _ + id
Other : [real attribute name]

UID(s) If :-

Union key : [real key name/or real operation of key] + _ + uk
Primary foreign key : [real key name/or real operation of key] + _ + pf
Primary key : [real key name/or real operation of key] + _ + pk
Relation’s name : Fk + _ + [source attribute name] + _ + id

Business Functions

Label : [Subsystem code] + [sequence in alphabet i.e. a , aa , ab , ac , …]
Short def. : [Persian real name of function or its operation title]
Sequence in parent : 10 , 20 , 30 ,

Diagrams

Name : FHD + _ + [Subsystem code]
Title : [Persian real name of diagram]

Name : ERD + _ + [Subsystem code]
Title : [Persian real name of diagram]

Name : PM + _ + [Subsystem code] + _ + [short definition of PM’s root function]
Title : [Persian real name of diagram]

Name : DSD + _ + [Subsystem code]
Title : [Persian real name of diagram]

Externals

Name : [Persian real name of external]
Short name if :-

Function : [English real name of external] + _ + opr
Organization : [English real name of external] + _ + org
Entity : [English real name of external] + _ + end

Process events :

Name : [Persian real name of process events ]

Table definition

Name : Tbl + _ + [Subsystem code] + _ + [real table name]
Display title : [Persian real name of table]

Columns :-

Foreign keys : Fk + _ + [source attribute name] + _ + id
Other types : Named previously in the entity attr. Naming method

Data stores

Name : [Persian real name of data store[1]]
Type : [real name of category that considered for this data store]

View definition

Name : Vw + _ + [Subsystem code] + _ + [real name of view / it’s data group]
Display title : [Persian real name of view]

Snapshot definitions

Name : Snp + _ + [Subsystem code] + _ + [real name of snapshot]
Display title : [Persian real name of materialized view]

Database

Name : [real name of DB]
Local name : [real name of DB]

Storage definitions

Label : Stg + _ + [real person of storage]

Tablespaces

Name : [real table space name]

Rollback segments

Name : [real rollback segment name]

[بازگشت به فهرست مطالب ...]

برخي قراردادها در پيشبرد پروژه

در اين بخش به ارائه برخي قراردادها در روش ساخت نمودارهاي مورد استفاده ميپردازيم.

[بازگشت به فهرست مطالب ...]

ساخت BUN

Business unit هاي يك سيستم (چارت سازماني بهره برداران ) با توجه بر موارد زير ساخته ميشود :
تمامي بهره برداران سيستم بايستي در اين قسمت مستند شده و مشخصات آنها بترتيب زير آورده شود .

Name
در اين قسمت نام فارسي بهره بردار نگاشته ميشود .

Description
در اين قسمت شرح كاركرد وي داده شده و در مورد آن توضيحاتي ارائه ميشود .

Head count
در صورتيكه در واحدي كه يك BUN حساب ميشود چند نفر به كار واحدي بپردازند براي همه آنها يك BUN در نظر گرفته ميشود و صرفا تعداد آنها با پارامتر Head count مشخص ميشود .

Role responsibilities
اين پارامتر همانطور كه از نامش پيداست بيانگر مسئوليت آن BUN ميباشد

Roll Skill 1
بيانگر سطح تخصصي مورد نياز براي آن BUN ميباشد .(مثلا كارشناس و … )

[بازگشت به فهرست مطالب ...]

ساخت ERD

اين مستند با توجه به موارد زير ساخته ميشود :
ابتدا موجوديتها از سطوح كلان ساخته شده و به تدريج به سطوج جزئي تر شكسته شده و حاصل يك ERD غير نرمال بوده كه پس از عمليات نرمال سازي , تا سطوح مورد نظر نرمال ميگردد .
روابط موجوديتها با نام صفت شاخص (صفتي كه منتقل ميشود ) بصورت زير نگاشته ميشود :
در سمت پدر ارتباط : نام صفت PK_
در سمت فرزند ارتباط : نام صفت FK_
بدين صورت در زمان ساخت Constraint مربوطه بر روي (در زمان Transform) اين Constraint دقيقا با نام FK… ساخته ميشود .
نيز نوع رابطه بر اساس نوع صفت مقصد تعيين ميشود . يعني اگر صفت مقصد Mandatory باشد انتهاي ارتباط Solid انتخاب ميشود و در غير اينصورت Weak .
در مورد سمت پدر ارتباط نيز معمولا ارتباط Weak است مگر مواردي كه Solid بودن آنرا نوع كاربري از آن تعيين نمايد .
در مورد اطلاعات هر Entity نيز از جمله مواردي كه اطلاعات آنها تكميل ميگردد Volume ها ميباشند كه بترتيب زير تكميل ميگردند :
Initial volume : تعداد ركورد اوليه در نظر گرفته شده براي اين موجوديت در هنگام نصب نرم افزار (بصورت متوسط براي واحد هاي مختلف)
Growth rate : تعداد افزايش ركورد در واحد زمان (كه معمولا يك واحد بر حسب نوع كاركرد سيستم براي همه استاندارد ميشود)
Min & Max volume : در اين دو قسمت كمترين و بيشترين تعداد ركورد موجود در نرم افزار نگاشته ميشود .
در زمان ساخت بانك اطلاعاتي و براي ساخت گزارش Detail sizing بانك از اين دو پارامتر (initial volume , Annual growth rate) براي ساخت Storage ها و Tablespace ها استفاده خواهد شد .

براي هر زير سيستم (بسته به بزرگي هر زير سيستم) يك ERD در نظرگرفته ميشود و در آن از موجوديتهاي مربوط به ساير سيستمها استفاده ميشود .

[بازگشت به فهرست مطالب ...]

ساخت PM

اين مستند صرفا براي Terminal level Functions ساخته شده و بيانگر گردش عمليات واقعي در سازمان خواهند بود . يعني هر BUN دقيقا تمامي عملياتي را كه انجام ميدهد در اين مستند آورده خواهد شد .
هر نمودار براي يك Root Function ساخته خواهد شد كه تابعي است كه يك سطح تا Terminal level فاسله دارد و پدر كاركردهائي است كه در اين PM آورده خواهد شد .
درمرحله اول تمام BUN هاي مورد نياز در اين Terminal level function در نمودار Include خواهند شد .
در مرحله بعدي تمام توابعي كه قبلا در FHD زده شده است Include شده و در مقابل BUN مناسب خودقرار خواهند گرفت .
قابل ذكر است در اين مرحله براي Datastore ها و يا Systematic functions يك BUN متناظر با زير سيستم مورد نظر ساخته شده و در نظرگرفته ميشود و Datastore ها و Systematic functions به آنها Assign ميشود .
به اين ترتيب هيچ Objectي در Unspecified area قرار نميگيرد .
سپس Process flow ها را (از Function به Function) با رنگ آبي رسم ميكنيم و نوع آنها را نيز در برخورد به مقصد تعيين ميكنيم .(And / Or )
سپس Data flow هاي Save & Load را (فقط) رسم نموده و Load هاي متوالي براي يك تابع را براي جلوگيري از ناخوانائي رسم نميكنيم .(Data flowها را با خطوط سياه رنگ رسم ميكنيم . )
سپس Icon مناسب را براي هر كاركرد تنظيم نموده و PM را تماما Animate ميكنيم . فقط در صور خاصي ممكن است كه Animate كردن PM ملاك Validity check آن نباشد كه در آن موارد نيز توضيحات بايستي ارائه شود .
همچنين Trigger / Outcome دقيقا بر اساس ورودي و خروجيهاي سيستم در جاي خود بايستي ساخته شوند .يك Trigger نقطه شروع يك كاركرد و يك Outcome خروجي مستقيم يا يك رخداد از خروجي يك كاركرد ميباشد .
در مورد هر رخداد اطلاعات زير تكميل ميشود :
Name : نام فارسي رخداد
Type : بسته به نوع Trigger/Outcome تعيين ميشود .
فركانس وقوع بر حسب پريود مورد نياز تعيين ميشود .
Description : در اين قسمت تمامي توضيحات مربوط به نحوه رخداد و يا ساير اطلاعات مورد نياز براي اين Trigger/Outcome آورده ميشود .

[بازگشت به فهرست مطالب ...]

ساخت FHD

براي ساخت FHD ابتدا ليست زير سيستمها و سپس فرآيندهاي هر زير سيستم را بصورت درختي در اين محيط رسم كرده و مطابق استانداردهاي نامگذاري ابتداي اين جزوه توابع و صفات آنها را نامگذاري مي نمائيم ، سپس بنابر تقسيم بندي مورد نياز براي دسته بندي كاركرد هر زير سيستم و فرآيندهاي آن كاركردهاي مورد نظر را در سطوح پاييني و زير فرآيندهاي مربوط خود را ساخته و اطلاعات آنها را وارد مي نمائيم .
براي هر تابع بسته به نحوه عملكرد آن و نيز فركانس وقوع در واحد زمان اطلاعات مناسب را وارد مي نمائيم ، همچنين از مهمترين اطلاعاتي كه براي كاركرد وارد مي شود توضيحات مربوط به كاركرد آن فرايند – تابع و يا ماژول مي باشد كه اين موارد نيز درهمين مستند تكميل مي گردد .
نيز اطلاعات مربوط به نحوه استفاده يك تابع از موجوديتهاي مختلف و صفات آن موجوديتها از طريق همين دياگرام مستند مي شود . .بدين ترتيب كه :
اگر تابع جاري از موجوديت استفاده CRUD داشته باشد به صورت مستقيم Flag مربوطه تيك زده مي شود و مورد other نيز بطور پيش فرض براي تاييدات د رنظر گرفته شده است و در صورتي كه براي استفاده اي غير از تاييدات بكار رود اين تغيير در قسمت notes توضيح داده خواهد شد همچنين در صورتي كه استفاده تابع ازيك موجوديت صرفا به صفت خاصي محدود گردد و يا صفت خاصي از آن موجوديت بايستي مورد تاكيد قرار گيرد آن صفت در قسمت نحوه استفاده تابع از صفات موجوديتها مستند مي گردد .
از ديگر مواردي كه در اين دياگرام تكميل مي گردد ترتيب اجراي توابع در يك فرايند است كه از طريق فيلد Sequence parent مستند مي گردد ، بدين معني كه ترتيب اجراي ماژولها يا كاركرد هاي مختلف از طريق اين فيلد در اين دياگرام تعيين مي گردد.
پس از طي مراحل فوق دياگرام FHD براي هر زير سيستم آماده بوده و ميتوان از آن ماژولهاي فاز طراحي فيزيكي را Generate نمود از جمله استفاده هايي كه از اطلاعات FHD در اين متد انجام مي پذيرد ساخت ماژولها – ساخت ماتريسهاي كاركرد / موجوديت ، ماتريس كاربر/ كاركرد( از طريق مدل پردازشي مربوط به هر كاركرد) ، ماتريس كاربر / موجوديت و مواردي از اين دست مي باشند . نيز از ترتيب اجراي در نظر گرفته شده براي كاركردهاي يك فرايند د رتدوين روال اجرائي گردش عمليات سازماني نيز استفاده مي شود .
علت جداسازي FHD براي هر زير سيستم آن است كه به اين ترتيب خوانائي FHD و زمان Load آن بهبود يافته و در نتيجه اين دياگرام و محتويات آن قابل استفاده مي باشد . با توجه به استانداردهاي نامگذاري ذكر شده اين دياگرام و محتويات آن بصورت فارسي قابل مشاهده مي باشد كه در فهم سريعتر و خوانائي بالاتر مستند موثر است .
نيز لازم به ذكر است كه در اين متد Entity & Attribute usage صرفا براي Terminal level functions ورود اطلاعات ميشود .

[بازگشت به فهرست مطالب ...]

® شركت خدمات نرم افزاري نام آوران عصر اطلاعات

http://www.itage-na.com
http://www.natcc.biz

eMail : info@natcc.biz

سند مجموعه قراردادهاي انتخاب و نامگذاري در Oracle Designer

فهرست مطالب

تاريخچه

مقدمه

اشياء منتخب

قراردادهاي نامگذاري اشياء

برخي قراردادها در پيشبرد پروژه

ساخت BUN

ساخت ERD

ساخت PM

ساخت FHD

سند

مجموعه قراردادهاي انتخاب و نامگذاري

در Oracle Designer