| Agile Product Lifecycle Management Recipe Management for Pharmaceuticals Administrator Guide Release 9.3.3 E39287-01 |
|
 Previous |
 Next |
| Agile Product Lifecycle Management Recipe Management for Pharmaceuticals Administrator Guide Release 9.3.3 E39287-01 |
|
Previous |
Next |
Object Modeling section helps you to understand how to manage database categories, attributes, views, filter views and workflow states in Agile Recipe Management for Pharmaceuticals .
Object modeling, or Metamodeling, is the construction of a collection of "concepts" within a certain domain. In Recipe Management for Pharmaceuticals , it is the ability to modify major Categories and their attributes.
Category is equivalent to a database table, but it has business logic and UI-related metadata associated with it. A Category may not always map to a single database table, it can have multiple tables associated with it, as in the case of inherited categories.
Attributes are like columns in a database table, so attributes are defined for a Category. Again attributes have much more metadata associated than a plain data type. Attributes can be of Foreign Key type, which can be used to define relationships between two categories.
A View is a collection of attributes picked up from a set of related categories. It is an equivalent of the database View with more metadata defined. Views are used to query and edit records in the database.
A Subview can be defined on any View, and it can only contain a subset of result attributes defined in the View.
Recipe Management for Pharmaceuticals has the following Folder categories:
Audit Trail Folder
Inventory Balance Folder
Base:
Analytical Management Folder
Equipment Folder
Exception Folder
Material Folder
Meta Model Folder
Print Folder
Process Folder
Recipe Folder
Standards Folder
System Folder
Within each of these folders, there are further subclassifications of Categories. Many of these categories are internally used by Recipe Management for Pharmaceuticals .
For example, within the Equipment folder is the subclassification of these business objects:
| Equipment Business Objects | ||
|---|---|---|
| Blender | Column | Dryer |
| Evaporator | Filter | Hood |
| pH Meter | Reactor | Tank |
| Pump | Scale | Scrubber |
| Sieve | Syrup can | Temperature Controller |
| Vacuum Meter | Cyromat | Distributed Solvent System |
| Flow Chart | HVAC System | InfraRed Analyzer |
| Mass Flow Volume Density Meter | Mill | Module |
| Nitrogen System | Purified Water System | Thermal Fluid System |
A classification is based on equipment with the same characteristics. For example, you can create any number of blenders, columns, and dryers. In addition, you can add your own characteristics (attributes) to each equipment type.
An example of blender characteristics (attributes) includes Calibration Frequency, Cleaning Method, Created Date, and PPM Limits.
Every time you create a new blender type, these characteristics are inherited. In addition, you can add your own characteristics.
|
Important: When creating categories, attributes, views, filter views, and workflow states, do not use reserved keywords that are used by the Recipe Management for Pharmaceuticals system. |
To search for a category, attribute, view, or subview, do the following:
In the Tools & Settings menu, select Object Modeling > select Category or Attribute or View or Subview > then select Manage.
Select a search view from the View dropdown list.
In the Search definition page, use the dropdown menus to fill in criteria of the business objects you are interested in finding.
When you have filled in sufficient criteria, click Search.
Category represents a database table that comprises attributes. These attributes are viewed through Views and Subviews. Categories in a database are associated to one another. These associations create relationships in the database among categories. This relationship creates a category hierarchical structure displaying the parent and the child relationship.
Besides the normal "manage" functions (detailed in Managing Category), you can create a new category, create a schema, and move a category from one parent to another parent category.
You can add categories:
at the same level as an existing category in the category hierarchy;
at one level below (as a child) of any existing category in the category hierarchy;
at the Base;
at the default category folders, such as, Administration, Data Modeling, Organization, People, Equipment, Material, and Process.
In the category hierarchy tree, the categories are referred to as parent categories and child categories.
You create a new category in the Base or the default folders. Creating a category involves:
Defining the category;
Adding attributes for the category;
Creating a schema for a category;
Adding views; and,
Adding subviews.
Category is classified as:
System category - a category that provides system data. A System category comprises attributes of its own, and it allows you to add data records.
Folder category - a container object. A Folder category does not allow you to add data records. It can have categories of both the System and Folder types. They are referred to as child categories, which inherit the properties of the parent category and can have attributes of their own.
Every category must have a name, database name, label, and parent category.
Base category is a default category with common attributes. This is the parent category for all the System categories.
The System categories inherit the attributes of the Base category.
You can create categories of System or Folder type in this category.
The system folders provide the data required to construct and manage the application. You can configure these folders to set up the data in the required category.
If a category belongs to a child category type, it inherits the properties of the parent category. You can add specific attributes to the category.
There are two types of attributes, namely, Inherited attributes and Category-specific attributes. The Inherited attributes are the attributes inherited from the parent category, if it is a child category.
When a new category is added, by default, it is in "Schema not created" status. The tables are not created in the database.
To create these tables, you must create a schema. A table is created in the database with the category name and the data type. The category status is updated with "Schema created." Now, records can be queried from the database. A default view for the category, including the inherited and the current attributes, is available.
To create a category:
In the Tools & Settings menu, select Object Modeling > Category > New.
In the Preface tab, select a category and then select one of the following two options:
Create child of the selected category
Create peer of the selected category
Click Next.
In the General tab, enter information for the following fields:
Name - Enter the name of the category.
Display Name - Enter the display name of the category.
DB Name - Enter the name of the table in the database for the category.
Allow Records - Select Yes, if you want to allow records.
Allow Attributes - Select Yes, if you want to allow attributes.
Description - Give a brief description of the category.
Click Next. The Details tab displays. This tab has two subtabs:
Characteristics
Attributes
In the Characteristics subtab, select any of the following options:
Allow Versioning - Select Yes, if you want to allow versioning in this category.
Allow Workflows - Select Yes, if you want to allow workflows.
Has Effectivity Dates - Select Yes, if you want the category to have start dates and end dates associated with it along with the functionality of activation and deactivation.
Marked as Business Object - Select Yes, if you want to store the statuses.
Use as Internal System Category - Select Yes, if you want to use the category as internal system category.
Icon ID - Select Icon ID to display the category.
Allow Attachments - Select Yes, if you want to allow attachments in a category.
Allow Notes - Select Yes, if you want to allow notes in a category.
Allow Multi-record Additions - Select Yes, if you want to allow multi-record additions.
Allow Locking - Select Yes, if you want to allow locking.
Click Next. In the Database subtab, enter values in the following fields:
Initial Extent - Enter the database storage parameter for the initial extent for the table.
Next Extent - Enter the database storage parameter for the next extent for the table.
PCT Free - Enter the parameter for percent free for the table.
PCT Used - Enter the parameter for percent used for the table.
Click Next.
In the Attributes subtab, click New to specify the attributes for the category. For information to add attributes, see Add New Attribute.
The attributes that you add are displayed in the Attributes subtab.
Click Finish. You have created the category and a confirmation message appears.
You can browse, search, view, modify, duplicate, export, and remove a category.
To browse for a category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Click the Browse tab to view Data Categories.
Select a category. The Category tab displays the details for the selected category.
Click the Attributes tab to view attribute details of the selected category.
Under Attributes tab there are three subtabs.
Category-Specific
Inherited
Composite Keys
You can add and edit attributes under Category-Specific subtab. You can add and edit Composite Keys for a set of attributes under the Composite Keys subtab.
Click the Views tab to view associated views of the selected category.
Click the Subviews tab to view the subviews details of the selected category.
You can also edit, remove, duplicate, create schema, refresh schema, and move categories.
You can view category details from the Search or the Browse tab.
To view details for a category using search:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
In the Search tab, perform a search for the category.
The Records pane displays the list of categories based on the search.
In Name, click on the category name for which you want to view the details. Category: View Details displays the category details such as Name, DB Name, category status, characteristics, associated attributes, views, and subviews.
You can edit the details for the category when you browse or search for the category.
Modifying a category involves:
Changing the Name, Display Name, DB Name, Is System Flag setting, Allow Attributes, Allow Records, description setting
Adding or removing associated attributes
Modifying existing attribute details
Adding or removing associated Views and Subviews
|
Note: You cannot uncheck the Allow Attachments or Allow Notes, if any attachments or notes are attached to the category. If the category has data, some of the edit operations specified above would be restricted. Please clean up all data before you attempt to make changes. |
To edit the category details:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Browse or perform a search for the category.
When you perform a search, Results displays the list of categories based on the search. Select the category for which you want to edit the details.
Click Edit. Edit Category displays the following subtabs:
General
Details
Attributes
|
Note: When you perform certain Edit on Categories like Has Effectivity, Owner BO and adding / removing attributes, the schema status changes to schema refresh. |
Enter the information in the various fields. For information about the fields, see Create New Category.
You can add, edit, remove, and duplicate the category-specific attributes. You can only duplicate the inherited attributes.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the category and a confirmation message appears.
You can create a new instance of an existing category with the same attributes, but with a different name.
While duplicating a category, you must specify a unique name for the category. All properties of the original category are duplicated, except for the data and the views of the category. The new category is in "Schema Not Created" state. You need to create schema for this category. Child categories of the category are not duplicated. The views associated with the original category and the data in the category are also not duplicated.
To duplicate a category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Browse or perform a search for the category.
When you perform a search, Records displays the list of categories based on the search. Select the category that you want to duplicate and click More > Save As.
When you browse, the category details are displayed. Click More > Save As.
In Duplicate Category, click Clear.
Enter information for the following fields:
Name - Enter the name of the category.
Display Name - Enter the display name of the category.
DB Name - Enter the name of the table in the database for the category.
Description - Give a brief description of the category.
Allow Records - Select Yes, if you want to allow records.
Select Notes and Attachments option if you want to add notes or attachments.
Click Save and Edit to change the associated details or click OK to save the duplicated category without changing the associated details. To cancel, click Cancel.
You can remove a category, only if a category:
Does not have any child categories
Does not hold any data or records in the database
Does not have any links or references defined into other categories
To remove a category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Browse or perform a search for the category.
When you perform a search, Results displays the list of categories based on the search. Select the category that you want to remove.
Click Delete.
Enter the reason for removal and click OK. You have removed the category and a confirmation message appears.
You can move a category from one parent category to another parent category. All child categories can be selected and moved to a different parent category. A child category that has data cannot be moved from one parent to another parent.
Moving a category modifies the following data in the categories:
All the properties inherited from the parent category are removed.
All the existing views are removed.
The old schema is removed and the schema has to be created again.
All the properties of the current parent are inherited.
To move a category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Click the Browse tab.
Select the category that you want to move. The details for the selected category displays.
Click More and select Move.
In Move Category, select a new parent category to where you want to move the category.
Click OK. You have moved the category and a confirmation message appears.
A newly created category is in the "Schema not created" status. That is, the supporting database tables are not created and the category is not ready to be used.
To create a schema for the category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Click the Browse tab.
Select the category for which you want to create a schema. The details for the selected category displays.
Click More and select Create Schema. The application updates the schema status as "Schema Created" and a confirmation message appears.
If any meta-data information related to schema is changed for an attribute, it is in the "Schema Refresh Required" status. You must refresh the schema to submit these changes.
The category and its views cannot be used to query or edit records in the category in this state. When the schema is refreshed, the Default View of the category is updated. A warning is displayed, if there are no Primary Keys defined for this category.
Once the schema is refreshed, the category schema status is "Schema Created."
To refresh a schema for the category:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Click the Browse tab.
Select the category that you want to refresh the schema. The details for the selected category displays.
Click More and select Refresh Schema. You have refreshed a schema and a confirmation message appears.
An attribute represents a characteristic of a category. It is stored as a column in a category table. It specifies the data type and other necessary UI and back-end properties of the category.
You can add new attributes while creating a category or from the Browse tab.
To add new attribute:
In the Tools & Settings menu, select Object Modeling > Attribute > New.
In Attribute: New, under Preface tab, select the category for which you want to add new attributes.
Click Next.
In the General tab, enter information for the following fields:
Name - Enter the name of the attribute.
Display Name - Enter the display name of the attribute
DB Name - Enter the database name of the attribute.
Data Type - Enter the type of data of the attribute.
Add External Service Call - Select Yes, if the value for the attribute is derived externally.
Description - Write a brief description of the attribute.
Click Next. The Details tab displays. This tab has three subtabs:
Characteristics
View parameters
Type Details
In the Characteristics subtab, select any of the following option(s):
Value Required - Select this option to specify that this attribute cannot have null values.
Primary Key - Select this option to specify that this attribute will be part of the Primary Key on the category.
Editable - Select this option to specify that this attribute is editable.
Allow Setting of View Privileges - Select this option if you want to allow settings of view privileges.
Indexed - Select this option for the database column created for this attribute to be indexed.
Value must be unique within category - Select this option if you want the value to be unique within the category.
Second Person Verification Required - Select this option if a second person verification is required.
Store Value in Database - Select this option if you want to store value in the database.
Auditable - Select this option to set the attribute as auditable so that all the changes on the attribute can be tracked using Audit Trail.
Click Next. In the View Parameters subtab, select any of the following option(s):
Icon ID - Enter the icon id to be displayed for the attribute.
Always Included In View - Select this option if you want the attribute to always be included in your view.
Hidden - Select this option if you do not want this attribute to be displayed on the user interface.
Display Order - Enter value for the display order of the view on the screen.
Hyperlink to Details - Select this option if you require hyperlink to details.
Method Name - Select the type of method name.
Bean Callback - Enter the value for bean callback.
Tooltip - Enter the text that needs to appear when you mouseover the hyperlink.
|
Note: If Hyperlink To Details is selected, then Method Name and Tooltip become relevant. If method is custom, then the Bean Callback needs to be specified. |
|
Note: You can select either Hidden or Editable option, but not both. |
Click Next.
In the TypeDetails subtab, enter information for the various fields. The fields are displayed based on the data type that you have selected.
|
Note: By default, for float type attribute, lead zeros in decimal fraction of value entered by user is altered to append required zeros for meeting storage precision as well as for UOM Conversion |
|
Note: If Save Entered Value is selected, you require the value entered by the user. The value entered will appear at two places - next to the standard value of the attribute in Details and in an extra column on the screens where data is displayed in tabular format, with the label in format <Attribute Label> (As Entered). Unit of measure is applicable only to the number data types. |
Click Finish. The confirmation message appears.
You can create attributes of different data types based on your requirement. There are various data types available in the application and are as follows:
Text
Number
Boolean
Date/Time
Foreign Key
Picture
Auto Sequence
File
Large Text
Attributes data types have a special subtype to enhance the requirement.
For example, text data types support Email, Phone, Validated Text, URL.
Number data types support Integer, Float, and Currency.
These enhance the ability of the user to create attributes required. With these features, a user also has the ability to represent the attribute by specifying a display name, which will be used to represent it on the UI.
Attributes are of two types:
Inherited
Category-specific
Inherited Attributes are the attributes inherited from the parent category, if it is a child category. They can only be duplicated and cannot be created, modified or removed. Inherited attributes can be duplicated to make a category-specific attribute.
Category-specific attributes are the specific attributes for the new category. Category-specific attributes can be modified, duplicated, and removed.
When you specify a category property, such as Has Effectivity, Owner BO, Versioning, or Has Workflow, system attributes are created. These system attributes cannot be modified or removed by users of the application.
You can view attribute details in Attribute: View Details. You can view information such as Attribute Name, Label and Data Type. Details displays the characteristic details, UOMs, Enumerated Values, and the Display width. You can view attributes from the Search or the Browse tab.
To view attribute details using search:
In the Tools & Settings menu, select ObjectModeling > Attribute > Manage.
Perform a search for the category.
In Results > Attribute Name, click on the attribute name link for which you want to view the details.
You can only edit the category-specific attributes and not the inherited attributes from the parent category. You can edit using search or browse. After you edit the attribute details, you have to refresh the schema for the associated category.
To edit details for the attribute:
In the Tools & Settings menu, select Object Modeling > Attribute > Manage.
Perform a search for the attribute.
Records displays the list of attributes based on the search. Select the attribute for which you want to edit the details.
Click Edit.
In Attribute: Edit, enter the information in the various fields. For information about the fields, see Add New Attribute.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the attribute and a confirmation message appears.
Duplicate an attribute to create a new attribute of a similar type. The attribute duplicated can belong to a parent or a child category. You can duplicate category-specific and inherited attributes for a category.
To duplicate details for the attribute:
In the Tools & Settings menu, select Object Modeling > Attribute > Manage.
Perform a search for the attribute.
Results displays the list of attributes based on the search. Select the attribute that you want to duplicate.
Click More > Save As.
Change the information for the following fields:
Attribute Name - Enter the name of the attribute.
Attribute Label - Enter the label of the attribute.
Attribute DB Name - Enter the database name of the attribute.
Description - Write a brief description about the attribute.
Select Duplicate All Notes and Duplicate All Attachments option if you want to add notes or attachments.
Click Save and Edit to change the associated details or click OK to save the duplicated attribute without changing the associated details. To cancel, click Cancel. You have duplicated the attribute.
You can remove an attribute, as long as both of these conditions are true:
The attribute does not have any associated data; and,
The attribute is not a part of a View or Subview.
If you try to remove an attribute that contains any data or that is associated to a View or Subview, a warning message displays. You must remove the attribute associated with the View or Subview, then you can remove the attribute.
|
Note: When the attribute is removed from a category, the schema status of that category must be updated. |
To remove an attribute:
In the Tools & Settings menu, select Object Modeling > Attribute > Manage.
Perform a search for the attribute.
Records pane displays the list of attributes based on the search. Select the attribute that you want to remove.
Click on Delete.
Enter the reason for removal and click OK. You have removed the attribute.
Reorder helps you change the display order of the attributes.
To reorder an attribute:
In the Tools & Settings menu, select Object Modeling > Category > Manage.
Select the Browse tab and select the category whose attribute you want to reorder.
On the Attributes tab, select the attribute that you want to reorder.
Click More > Reorder.
On the Attributes: Reorder screen, change the display order, as needed, and click OK.
To add icon IDs to attributes:
Open the CFMPCMImages_en_US.properties file, which is located at <AgilePLM_HOME>\config\locale
The CFMPCMImages_en_US.properties file contains a list of key value pairs.
For the attribute whose value you want to modify, In the Details > Characteristics page, for the Icon Id field, enter the key details.
For example, if the key value pair is PCM_IMG_COM_CACHE=/icons/cache.gif, enter the value PCM_IMG_COM_CACHE in the Icon Id field.
Click OK.
When you create the schema for a category, a Default View is automatically created. A Default View contains all the attributes from the base category plus all attributes from all parents. In addition, you (as Administrator or the user with privileges) create new views.
There are two types of views that can be created for a given category:
Normal or Basic view
"Tree" view
The steps to create a basic view are:
Select the category and assign a name to the view.
Determine whether it is a System view.
Determine whether it is a Result view (that is, a searchable view).
Select Search view and Result view attributes.
After you create the new view, you can decide if it has precedence over the Default view.
This task describes how to create a normal, or basic, view.
To create a view:
In the Tools & Settings menu, select Object Modeling > View > New.
In the Preface tab select a category for which you want to add the view.
Click Next.
In the General tab, enter information for the following fields:
View Name - Enter the view name.
View Label - Enter the view label.
Internal to System - Select Yes, if you want the localization value of this field to be maintained in a separate file.
Show in Search - Select Yes, if you want the view to be shown in search.
Exclude Duplicate Records - Select Yes, if you want to exclude duplicate records.
Allow Tree View - Should be set to Yes
Default Rendering - Select the view for default rendering.
Description - Write a brief description.
Click Next.
In the Related Categories tab, navigate through the tree to select the categories that need to be included in this view.
Related Categories are classified as:
Application - Categories which are not marked as system categories.
Metamodel - Categories that hold meta-data information for the Recipe Management for Pharmaceuticals application.
System - Categories that are marked with Use as Internal System Category Flag.
Child Categories - Children of the related categories.
Show Incoming - Show related categories that reference the category on which the view is being created.
Show Outgoing - Show related categories that reference the category on which the view is being created.
Based on the option selected, the related categories are shown in the tree.
Click Next.
In the Attributes tab, you can view the attributes for the selected categories. Select the attribute to be used in the Search View and Result View. A few system attributes may be selected by default.
Click Next. The Details tab displays two subtabs:
Search View
Results View
Both the subtabs display the attributes selected in the Attributes tab.
In the Search View subtab, specify the Name, Display Label and Display Order for each attribute. You can choose to hide a certain attribute from the search view by selecting the Hidden for that attribute. A few system attributes may be selected by default.
Click Next.
In the Results View subtab, specify the Display Name, Display Label and Display Order for each attribute. You can choose to hide a certain attribute from the results view by selecting the Hidden for that attribute.
Click Finish. You have added a new view, and a confirmation message appears.
|
Note: In Object Modeling, you can click Category > Manage > Browse tab. Select Category and click the Views tab. |
To create a tree view:
In the Tools & Settings menu, select Object Modeling > View > New.
In the Preface tab select a category for which you want to add the view.
Click Next.
In the General tab, enter information for the following fields:
View Name - Enter the view name.
View Label - Enter the view label.
Used By System - Select Yes, if you want the view to be used by the system.
Show in Search - Select Yes, if you want the view to be shown in search.
|
Note: If you select the Show in Search option, the view will appear on Search Screens used for searching records on any category. For example, Library Search Screens for Equipment and Material. Additional attributes, Note count, and Attachment Count columns are added to the view. |
Exclude Duplicate Records - Select Yes, if you want to exclude duplicate records.
Allow Tree View - Should be set to Yes.
Default Rendering - Select the Tree View option.
Description - Write a brief description.
Click Next.
In the Related Categories tab, select the category on which the view is being defined and the attributes to be included from related categories.
Click Next.
In the Attributes tab, the attributes for the selected categories appear. Select the attribute to be used in the Use In Search View and Use In Result View. A few system attributes are selected by default.
If you want to repeat the attribute more than once in the view, select the attribute and click Repeat, specify the Times to Repeat in Search view and Results view. Click OK.
Click Next. The Details tab appears with four subtabs:
Search View
Results View
Tree Definition
Tree Attributes
In the Search View subtab, specify the Name, Display Label and Display Order for each attribute and then click Next.
In the Results View subtab, enter information in the following fields for each attribute:
Name - Enter the name of the attribute.
Display Label - Enter the display label of the attribute.
Display Order - Enter the display order of the attribute.
Editable - Controls whether the attribute value can be edited in this field.
Required - Controls whether a value is mandatory for this attribute.
Sort Order - Sort order in conjunction with sort method controls the order in which the attributes are displayed in the results view.
Click Next.
Choose the attributes to define the tree and specify the tree level for each.
|
Note: You specify an Icon ID when defining a tree view. You use a tree definition icon to represent an attribute. |
Click Next. Choose the attributes to group by in a tree-oriented results view and specify the hierarchy level for each.
Click Finish. You have added a new tree view, and a confirmation message appears.
After you have created your view you can associate it with a specific business object so that the view can be seen while managing Alerts and Workflows.
To associate your view with the business object:
In the Tools & Settings menu, select Administration > Library > Manage Records.
Click on the Browse tab. Select Base > System Folder > Authorization Folder and click the BO View radio button.
From Records in "BO View", select the specific view record you want to see while managing Alerts and Workflows and click New.
|
Note: Select only the record which has the Is Alerts View and Is Workflow View flag set to No. |
In the General tab, enter information for the following:
Business Object - Click the icon, select the BO ID of the view and click OK.
View - Click the icon, select the view name and click OK.
Click Next.
In the Details tab, select Yes from both the Is Alerts View and Is Workflow View dropdown lists.
Click Finish. A confirmation appears that the record has been added to the business object view.
|
Note: In order to see the view that you just created, you must refresh the database cache. |
You can manage and display different types of data by creating customizable views. You can define the display order of the attributes of each category to be displayed on the screen, for each action, as views and save them in the system. You cannot remove the Default view. It can be edited with respect to making it a preferred view or by changing the display order.
You can see details for the associated views for a category from the Search tab.
To view details for the view using search, do the following:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
In View Name, click on the view name for which you want to see the details. View: View Details displays the view details such as View Name, View Label, Internal to System, Show in Search, Exclude Duplicate Records, Allow Tree View, Default Rendering and Description.
To view the history details such as Modified Time, Modified By Action, Attribute Category, Old Value, New Value, Reason For Change, click on the history icon in View: View Details.
You can change the details of the existing view attributes, add, remove or reorder view attributes. Once a view is edited, all existing objects in the application created on that view is invalidated automatically. A warning is displayed if a view is in use, while it is being edited. While editing the view, you cannot change the owner category of the view. A default view can be edited with respect to making it a preferred view or changing the display order.
You can edit view details using search or browse.
To edit details for the view:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
When you perform a search, Results displays the list of views based on the search. Select the view for which you want to edit the details.
Click Edit.
In View: Edit, enter the information in the various fields.
Click OK.
Enter the reason for the changes that you have made and click OK. The confirmation message appears.
|
Note: Default view is created by the system and cannot be edited. |
You can create a new view based on an existing view. All the attributes of the view and the associated meta data are duplicated to the new view. You can only duplicate the category-specific views.
To duplicate a view:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
When you perform a search, Results displays the list of views based on the search. Select the view that you want to duplicate.
Click More > Save As.
In View: Duplicate, click Clear.
Enter the information for the following:
View Name - Enter the name of the view.
View Label - Enter the view label.
Select Notes and Attachments option if you want to add notes or attachments.
Click Save and Edit to change the associated details or click OK to save the duplicated view without changing the associated details. You have duplicated the view and a confirmation message appears.
To cancel, click Cancel.
When removing a view, all view related data including the view attribute details are removed. All Subviews of the view are also removed. DEFAULT view on any category cannot be removed. In case of a system view, a warning message appears before removal of the view.
To remove the view:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
Results displays the list of views based on the search.
Select the view that you want to remove and click Delete.
You have removed the view and a confirmation message appears.
To set a view as the preferred view:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
Results displays the list of views based on the search.
Select the view that you want to set as the preferred view in search.
Click More and select Make Preferred.
In Reason for Change, enter your reasons for changes.
Click OK. You have set a view as the preferred view, and a confirmation message appears.
This procedure allows you to assign a default search to a particular view.
To manage saved searches:
In the Tools & Settings menu, Object Modeling > View > Manage.
Perform a search for the view.
Results displays the list of views based on the search.
Select the view for which you want to assign default search.
Click More and select Assign Default Search.
Click Manage Saved Searches. If there are no "Saved Searches", you must create a new Saved Search and then try to assign a default search to the view.
Enter information in the following fields:
Created Date
Modified Date
Created User: User ID
Modified Used: User ID
Click Search, to search with your favorite view.
Click OK, to return to the previous screen.
To reorder the display order for a View:
In the Tools & Settings menu, Object Modeling > Category > Manage.
Select the Browse tab and select the category whose view(s) you want to reorder.
On the Views tab, select the view that you want to reorder.
Click More > Reorder.
In Views: Reorder, enter the display order for each view to be shown in the View drop-down list.
Click OK. You have reordered the view and a confirmation message appears.
|
Note: The application displays only searchable views when reordering view. |
You can toggle the view only if you had selected the Show in Search option when creating the View.
To toggle the appearance of the view while performing a search:
In the Tools & Settings menu, select Object Modeling > View > Manage.
Perform a search for the view.
Results displays the list of views based on the search.
Select the view for which you want to toggle the view appearance.
Select the view. Click More and select Toggle "Show in Search".
Enter the reason for change and click OK. You have toggled views and a confirmation message appears.
A Subview is a subset of a view. It contains a collection of result attributes on the main view. A view can have many subviews. Subviews are defined in situations where you do not always want to view all the attributes connected to the view. Once you define a subview, you can switch to it on a result page and view only the attributes which are part of the subview. Results page displays only non-system subviews.
To add a new subview:
In the Tools & Settings menu, select Object Modeling > Subview > New
In Preface, select a category for which you want to add the subview.
Click Next.
In the General SubViewInformation tab, enter information for the following fields:
View Name - Enter the name of the parent view.
Subview Name - Enter the name of the subview that is being created.
Subview Label - Enter the level of the subview to be displayed in the application.
System - Select this if the subview is to be marked as a system subview.
Description - Write a brief description.
Click Next. The Attributes tab displays the attributes from the parent view.
Select the attributes that you want to include in the Subview.
Click Next.
In the Attribute Details tab, specify the display order for each attribute.
Click Finish. You have added a new subview and a confirmation message appears.
You can add, search, modify, duplicate, reorder, remove, and set preferred subview.
You can also view the details of the subview attributes in a hierarchical format. If there are any cross-category attributes added to a subview, the information about the Owner Category and Parent Foreign Key attribute is available.
To view details for the subview using search:
In the Tools & Settings menu, select Object Modeling > Subview > Manage.
Perform a search for the Subview.
In Name, click on the Subview name for which you want to see the details. Subview: Details displays the details such as View Name, Owner Category, Subview Name, Subview Label, and the associated details.
You can change the details of the existing subview attributes, add, remove and reorder subview attributes. Once you edit a subview, all existing objects in the application created on that subview are invalidated. On editing a subview that is in use, the application displays a warning.
To edit details for the subview:
In the Tools & Settings menu, select Object Modeling > Subview > Manage.
Perform a search for the Subview.
When you perform a search, Results displays the list of subviews based on the search. Select the subview for which you want to edit the details.
Click Edit.
In Subview: Edit, enter the information in the various fields. You cannot change the view information, while editing a subview.
Click OK.
Enter the reason for change and click OK. You have edited the subview and a confirmation message appears.
|
Note: You can also edit details for the associated subviews for a category from Object Modeling > Category > Manage. Select the Category and click the Subviews tab. Select the view and click Edit. |
To duplicate a subview:
In the Tools & Settings menu, select Object Modeling > Subview > Manage.
Perform a search for the Subview.
When you perform a search, Results displays the list of subviews based on the search. Select the subview that you want to duplicate.
Click More > Save As.
|
Note: You can also duplicate the associated subviews for a category from Object Modeling > Category > Manage. Select the Category and click the Subviews tab. Select the view and click More > Save As. |
In Subview: Duplicate, click Clear.
Enter the information for the following:
Subview Name - Enter the subview name.
Subview Label - Enter the subview label.
Click Save and Edit to change the associated details or click OK to save the duplicated subview without changing the associated details. To cancel, click Cancel.
You have duplicated the subview and a confirmation message appears.
To remove a Subview:
In the Tools & Settings menu, select Object Modeling > Subview > Manage.
Perform a search for the Subview.
In Results, select the Subview that you want to remove and click Delete.
You have removed the subview and a confirmation message appears.
|
Note: You can also edit details for the associated subviews for a category from Object Modeling > Category > Manage. Select the Category and click the Subviews tab. Select the view and click Delete. |
To reorder the display order for a subview:
In the Tools & Settings menu, Object Modeling > Category > Manage.
Select the Browse tab and select the category whose subview(s) you want to reorder.
On the Subviews tab, select the subview that you want to reorder.
Click More > Reorder.
In Subviews: Reorder, enter the display order for each subview.
Click OK. You have reordered the subview and a confirmation message appears.
To set a Subview as the preferred view:
In the Tools & Settings menu, select Object Modeling > Subview > Manage.
Perform a search for the subview.
When you perform a search, Results displays the list of subviews based on the search.
Select the subview that you want to set as the preferred subview.
Click More >Make Preferred.
You have set preferred subview. A confirmation message appears and a tick mark appears next to the view in the Subviews tab.
|
Note: You can also edit details for the associated subviews for a category from Object Modeling > Category > Manage. Select the Category and click the Subviews tab. Select the view and click More > Make Preferred. |
Enumerated Valid Values (EVV) are preassigned values for attributes. Recipe Management for Pharmaceuticals allows you to add or change enumerated valid values. When you want to add a new attribute that supports multiple choice values, you define a new EVV. You can add, modify, duplicate, and remove an EVV. You can also localize EVVs.
To add an enumerated valid value:
In the Tools & Settings menu, select Object Modeling > Enumerated Valid Value > New.
In the New EVV tab, enter information for the following fields:
EVV Name - Enter name of the enumerated valid value.
Description - Write a brief description about the EVV.
Data Type - Select the data type from the dropdown list.
Is System - Select Yes, if you want a system EVV.
Display In Result As - Select the display In result from the dropdown list.
Click Next.
In the Set EVV Values tab, enter information for the following:
Value - Enter the value of EVV. The value is the internal system key.
Display Value - Enter the display value of EVV. The display value is the key value that is used in the configuration files for localization and customization.
Description - Write a brief description.
Is Active - Select Yes, if you want the EVV to be active and hence, usable within the application.
Display Order - Enter value for the display order.
To specify more Enumerated Valid Values, enter the number of values that you want to add in the text box next to Add Row(s) and click Add Row(s). The rows are added to the table. For each row, specify the value details.
Click Finish. You have added an EVV and a confirmation message appears.
With appropriate rights, you can modify, duplicate, and remove enumerated valid values.
To search for EVV:
In the Tools & Settings menu, select Object Modeling > Enumerated Valid Value > Manage.
Select a search view from the View dropdown list.
In the Search Enumerated Valid Value definition area, use the dropdown menus to fill in criteria of the EVVs you are interested in finding.
When you have filled in sufficient criteria, click Search.
In EVV Name, click on the EVV name for which you want to view the details.
To edit EVV:
In the Tools & Settings menu, select Object Modeling > Enumerated Valid Value > Manage.
Perform a search for the EVV.
Select the EVV for which you want to edit the details and click Edit.
Enter information for the various fields.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the EVV and a confirmation message appears.
You can create a new instance of an existing EVV with the same details, but with a different name.
To duplicate an EVV:
In the Tools & Settings menu, select Object Modeling > Enumerated Valid Value > Manage.
Perform a search for the EVV.
In EVV Results, select the EVV that you want to duplicate and click More > Save As.
In Duplicate Enumerated Valid Values, click Clear.
Enter the EVV name.
Click Save and Edit to change the associated details or click OK to save the duplicated EVV without changing the associated details. You have duplicated the EVV and a confirmation message appears.
To cancel, click Cancel.
To remove an EVV:
In the Tools & Settings menu, select Object Modeling > Enumerated Valid Value > Manage.
Perform a search for the EVV.
In EVV Results, select the EVV that you want to remove and click Delete.
Enter the reason for removal and click OK. You have removed the EVV and a confirmation message appears.
|
Note: You cannot remove EVVs that are in use. |
For localization purposes, you can customize EVVs so that EVV values are displayed in a particular language.
To localize an EVV:
In your installation directory, go to the AGILE_HOME\AgilePharma\config\locale folder.
Open the CFMDisplayLabels_$lang$.properties file for the language you want to customize.
Enter the Display Value of the EVV value into the file and set it equal to its localized value. The format should be DISPLAY_VALUE=LOCALIZED_VALUE, e.g. ACTIVITY_TYPE_OTHER=Other.
Save file.
In Recipe Management for Pharmaceuticals , in the Tools & Settings menu, select Administration > Cache > Manage.
On the Manage page, select Localization Cache.
Click Reload Cache.
For information about how to localize other labels, see Customizing and Localizing Labels.
The Unit Of Measure (UOM) defines the unit values for a measurement that is performed. For example, a material's density can have a unit of measure defined as g/ml for grams per liter. A boiling point can be represented as a unit value of Celsius, or "C".
Units of Measure can be added individually or can be grouped for providing a list of possible units defined for an attribute. UOMs can define a conversion from one unit of measure to another.
You can add, modify, duplicate, or remove UOMs, UOM Groups, and UOM Conversions.
To add new UOM:
In the Tools & Settings menu, select Object Modeling > UOM > New.
In Add Unit of Measure, enter information for the following fields:
Name - Enter the name of the UOM.
Symbol - Select the UOM symbol.
Description - Write a brief description of the UOM.
To specify more UOMs, enter the number of UOMs that you want to add in the text box next to Add Row(s) and click Add Row(s). The rows are added to the table. For each row, specify the details.
Click Finish. You have added the UOM and a confirmation message appears.
|
Note: You can also add new UOMs when you perform a search. |
You can view, edit, duplicate, and remove Units of Measure.
To search for UOM:
In the Tools & Settings menu, select Object Modeling > UOM > Manage.
Select a search view from the View dropdown list.
In the Search UOM definition area, use the dropdown menus to fill in criteria of the UOMs you are interested in finding.
When you have filled in sufficient criteria, click Search.
To view UOM details:
In the Tools & Settings menu, select Object Modeling > UOM > Manage.
Perform a search for the UOM.
UOM Results displays a list of UOMs.
In Name, click on the UOM for which you want to view the details.
To modify a UOM:
In the Tools & Settings menu, select Object Modeling > UOM > Manage.
Perform a search for the UOM.
Select the UOM for which you want to edit the details and click Edit.
Enter information for the various fields.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the UOM and a confirmation message appears.
You can create a new instance of an existing UOM with the same attributes, but with a different name.
To duplicate a UOM:
In the Tools & Settings menu, select Object Modeling > UOM > Manage.
Perform a search for the UOM.
UOM Results displays a list of UOMs.
Select the UOM that you want to duplicate and click More > Save As.
In Duplicate Unit of Measure, enter information for the following fields:
Name - Enter the name of the UOM.
Symbol - Select a symbol from the drop-down list.
Click Clear to reset the screen.
Click Save and Edit to add the description or click OK to save the duplicated UOM without changing the description. You have duplicated the UOM and a confirmation message appears.
To remove a UOM:
In the Tools & Settings menu, select Object Modeling > UOM > Manage.
Perform a search for the UOM. UOM Results displays a list of UOMs.
Select the UOM that you want to remove and click Delete.
|
Note: You cannot remove UOMs that are in use. |
Enter the reason for removal and click OK. You have removed the UOM and a confirmation message appears.
A Unit of Measurement Group is a collection of one or more Units of Measurement. A collection of UOMs with similar characteristics can be gathered and assigned a name to form a UOM Group.
To add new UOM group:
In the Tools & Settings menu, select Object Modeling > UOM Group > New.
In the New UOM Group tab, enter information for the following fields:
Name - Enter the name of the UOM group.
Description - Write a brief description of the UOM group.
Click Next.
In the UOM Search tab, click Add to add UOMs to the group. You can change the display order for each UOM that you add.
Click Finish. You have added a new UOM group and a confirmation message appears.
|
Note: You can also add new UOM group when you perform a search. |
You can search, view, edit, duplicate, and remove a UOM Group.
To search for UOM group:
In the Tools & Settings menu, select Object Modeling > UOM Group > Manage.
Select a search view from the View dropdown list.
In the Search UOM Group definition area, use the dropdown menus to fill in criteria of the UOM Groups you are interested in finding.
When you have filled in sufficient criteria, click Search.
You can view the UOM details in UOM Group Details. You can view information such as Name, Description and a list of UOMs that belong to the group.
To view UOM group details:
In the Tools & Settings menu, select Object Modeling > UOM Group > Manage.
Perform a search for the UOM group.
UOM Group Results displays a list of UOM groups.
In Name, click on the UOM group for which you want to view the details.
To edit UOM group details:
In the Tools & Settings menu, select Object Modeling > UOM Group > Manage.
Perform a search for the UOM group.
UOM Group Results displays a list of UOM groups.
Select the UOM group for which you want to edit the details and click Edit.
Enter information for the various fields.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the UOM group and a confirmation message appears.
You can create a new instance of an existing UOM group with the same attributes, but with a different name.
To duplicate a UOM group:
In the Tools & Settings menu, select Object Modeling > UOM Group > Manage.
Perform a search for the UOM group.
UOM Group Results displays a list of UOM groups.
Select the UOM group that you want to duplicate and click More > Save As.
In Duplicate UOM Group, click Clear.
Enter the name for the new group.
Click Save and Edit to change the associated details or click OK to save the duplicated UOM group without changing the associated details. To cancel, click Cancel.
To remove a UOM group:
In the Tools & Settings menu, select Object Modeling > UOM Group > Manage.
Perform a search for the UOM group.
UOM Group Results displays a list of UOM groups.
Select the UOM group that you want to remove and click Delete.
|
Note: A UOM group that is in use cannot be removed. |
Enter the reason for removal and click OK. You have removed the UOM group and a confirmation message appears.
You can convert one Unit of Measure to another using a conversion factor or formula. A conversion formula is defined as a string expression, in which the macro @ORIGINAL_VALUE represents the value being converted.
You cannot specify conversion between UOMs if they are not from the same UOM Group.
To create a new UOM conversion:
In the Tools & Settings menu, select Object Modeling > UOM Conversion > New.
In Add UOM Conversion, enter information for the following:
From UOM - Using the search function, select the UOM to be converted.
Conversion Factor - Enter the conversion factor.
Web Service Operation - Using the search function, select the web-service operation name.
To specify more UOM conversions, enter the number of conversions that you want to add in the text box next to Add Row(s) and click Add Row(s). The rows are added to the table. For each row, specify the details.
Click Finish. The confirmation message appears. You have added a new UOM conversion
To UOM - Using the search function, select the UOM to convert into.
|
Note: If a UOM Conversion is added with a specified Web-service operation, that Web-service would be invoked each time a conversion is required between the two UOMs. Also, a Web service-based conversion will not be allowed from Search screens and the UOMs shown in the dropdown list on the Search screen would be restricted to only the UOMs in the UOM Group associated with the field and having formula-based conversion. All UOMs having Web-service-based conversions will not be displayed in this dropdown list. |
You can search, edit, duplicate, and remove a UOM Conversion.
To search for UOM conversion:
In the Tools & Settings menu, select Object Modeling > UOM Conversion > Manage.
Select a search view from the View dropdown list.
In the Search UOM Conversion definition area, use the dropdown menus to fill in criteria of the UOM Conversions you are interested in finding.
When you have filled in sufficient criteria, click Search.
You can only edit the UOM Conversion details.
To edit UOM conversion:
In the Tools & Settings menu, select Object Modeling > UOM Conversion > Manage.
Perform a search for the UOM conversion.
UOM Conversion Results displays a list of UOM conversions.
Select the UOM conversion for which you want to edit the details and click Edit.
Enter information for the various fields.
Click OK.
Enter the reason for the changes that you have made and click OK. You have edited the UOM conversion details and a confirmation message appears.
You can create a new instance of an existing UOM conversion with the same attributes, but with a different name.
To duplicate a UOM conversion:
In the Tools & Settings menu, select Object Modeling > UOM Conversion > Manage.
Perform a search for the UOM conversion.
Select the UOM conversion that you want to duplicate and click More > Save As.
In Duplicate UOM Conversion, click Clear.
For From UOM Name and To UOM Name, click the icon and select the UOMs.
Click Save and Edit to change the associated details or click OK to save the duplicated UOM conversions without changing the associated details. To cancel, click Cancel. You have duplicated the UOM conversion and a confirmation message appears.
To remove a UOM conversion:
In the Tools & Settings menu, select Object Modeling > UOM Conversion > Manage.
Perform a search for the UOM conversion.
UOM Conversion Results displays a list of UOM conversions.
Select the UOM conversion that you want to remove and click Delete.
Enter the reason for removal and click OK. You have removed the UOM conversion and a confirmation message appears.
Recipe Management for Pharmaceuticals is an internationalized application that permits companies to enter non-English label data, and allows users to see their user interface in their preferred language, which is set in PLM. For more information about how to set a user's language preference and for more details about multiple language support in PLM, see the Agile PLM Administrator Guide.
Recipe Management for Pharmaceuticals supports multiple-language support for the following:
Category names
View names
View attribute names
Filter view names
List entry labels (Pick List Values)
The items in the previous list can be localized or simply customized to suit your company's needs.
This section describes how to customize labels or localize labels. You can customize/localize Enumerated Valid Value values, category names, view names, view attribute labels, and filter names.
Unlike the PLM system, Recipe Management for Pharmaceuticals does not store localized strings in the database. The localization string key is stored in the database, while the actual localization string, or customized string, is stored in the CFMCustomLabels_$lang$.properties file. To localize or customize a label, you must override the value set in the corresponding configuration file by setting a new value in the CFMCustomLabels_$lang$.properties file. For example, if you want to use a display value that is different from one that is defined in the CFMDisplayLabels_en_US.properties file, you must create an entry in the CFMCustomabels_en_US.properties file and assign the value that you want displayed in the UI.
|
Note: You must choose the CFMCustomLabels properties file according to the chosen language preference. |
You can override values that have been set in any of the following configuration files:
CFMCategoryLabels - contains category names
CFMViewLabels - contains view names
CFMSubviewLabels - contains filter view names
CFMViewAttributeLabels - contains view attribute names
CFMDisplayLabels - contains EVV value names
|
WARNING: The files in the list above should not be modified at any time. The only exception is the CFMDIsplayLabel file, which is used for localization purposes only. See Localizing EVV Value for more information. |
To customize or localize a label:
In your installation directory, go to the AGILE_HOME\AgilePharma\config\locale folder.
Open the CFMCustomLabels_$lang$.properties file for the appropriate language.
In the designated section, enter the new key/value pair that will be overriding the original value. The format should be KEY=CUSTOMIZED_VALUE, e.g. ACTIVITY_TYPE_OTHER=Other.
Save file.
In Recipe Management for Pharmaceuticals , in the Tools & Settings menu, select Administration > Cache > Manage.
On the Manage page, select Localization Cache.
Click Reload Cache.
|
 Copyright © 2010, 2015, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|