In Design Studio, a cartridge is a collection of components that you deploy into a run-time environment to support your business processes. You create Cartridge projects to contain the specifications and code that you develop. Each Cartridge project is mapped to directories in the file system and is a collection of files and folders.
You can import existing Cartridge projects into your workspace (for example, you can import Cartridge projects from a cartridge pack) or you can create new Cartridge projects in Design Studio.
When working with Inventory Cartridge projects, see the following topics:
You can import existing Cartridge projects into Design Studio. Cartridges that include customizable Java source code are packaged in a ZIP file. You can import the ZIP file or extract the ZIP file to a folder and import the Cartridge project from the folder. When you import a cartridge, it becomes a Cartridge project in the current workspace. See ”Importing Projects” for more information about importing Inventory Cartridge projects.
If you import a cartridge from a cartridge pack or a cartridge that has been protected by its creator, it will be sealed. Sealed cartridges cannot be modified without first being unsealed. See ”Sealing Projects” and ”Unsealing Projects” for more information.
Cartridges with dependencies will display errors when you import them without the required cartridges already being present in the workspace. For example, if you import a cartridge that requires one of the base cartridges, you will see errors. After all the cartridges have been imported, you can clean all the projects to remove the errors. See ”Reviewing the Error Log”, ”Problems View”, and ”Running Clean Builds” for more information. See ”Importing Projects into Design Studio using Root Directories” for more information about importing existing projects into a workspace.
You can create new Cartridge projects in Design Studio. For example, you may create a Cartridge project that contains all characteristics, another that contains all specifications, and so forth. Everything you create in Design Studio (characteristics, specifications, and rulesets, for example) resides in a project. The name you choose for a Cartridge project becomes the name of a JAR file, and everything you create within that project is automatically placed in the JAR file.
See ”Creating New Cartridge Projects” for more information about creating cartridge projects in Design Studio.
See ”Project Editor” for information about the tabs you use to define an Inventory cartridge project. See ”Reviewing the Error Log” and ”Problems View” for more information about resolving project errors and warnings.
Inventory projects have dependencies on other projects when entities in one project reference entities in a different project. For example, an Inventory project might reference data elements defined in a common model project.
If you configure a project to reference content in other projects without declaring project dependencies, Design Studio creates an error or a warning, depending on how you configured the diagnostic level (see ”Project Editor Dependency Tab” for more information about configuring the diagnostic level). Design Studio filters data that appears in dialog boxes and views based on project dependencies.
All Inventory cartridge projects have a dependency on the ora_uim_model project. You must import and open the ora_uim_model and ora_uim_mds projects in your workspace before modeling UIM entities in Design Studio.
Note:
Import the ora_uim_mds_cartproj.zip and ora_uim_model_cartproj.zip cartridge project archive files from the UIM_Home/cartridges/base directory.The ora_uim_model project is a read-only project that represents the UIM model. It supports the ability to define specifications and characteristics and is also used to validate which entity types can be assigned or referenced by configuration items.
When you create a new Inventory cartridge project, Design Studio adds the ora_uim_model project to the dependency list on the Inventory Project editor Dependency tab. Do not remove this dependency.
Note:
Inventory cartridge projects must be defined with the same target version as the required model projects in a workspace. Ensure that you import the correct version of the required model projects into a workspace. See ”Defining Cartridge Project Target Versions” for more information.See UIM Cartridge Guide for more information about the ora_uim_model project and the ora_uim_mds project.
You deploy Design Studio Inventory cartridge projects from the Environment perspective. The method that you use to deploy cartridge projects is the same for all Design Studio features. See ”Deploying Cartridge Projects” for more information.
If you are deploying into a UIM environment that is a clustered server or where UIM is running on a managed server that is separate from the administration server, you must define the wladmin.host.name and wladmin.host.port cartridge management variables. See "Design Studio for Inventory Cartridge Management Variables Tab" for more information.
Use the Project editor Cartridge Management Variables tab to define the Oracle WebLogic Server Admin Server IP address and port values. Before you deploy Design Studio for Inventory Cartridge projects, you must define the default cartridge management variables wladmin.host.name and wladmin.host.port.
This topic describes the cartridge management variables that are specific to Design Studio for Inventory. For general information about how to use the tab to add variables, see ”Project Editor Cartridge Management Variables Tab”.
| Field | Use |
|---|---|
| wladmin.host.name | Enter the host name where the WebLogic Server software resides. Contact your UIM system administrator to obtain this information.
If you are deploying to an environment where there is only one server (for example, the application is deployed to the WebLogic Admin server, use the same value that you used for the IP address of the UIM server in the Studio Environment editor Connection Information tab Address field. |
| wladmin.host.port | Enter the WebLogic Server port number. Contact your UIM system administrator to obtain this information.
If you are deploying to an environment where there is only one server (for example, the application is deployed to the Admin Server, define this value with the same value that you defined for port number of the UIM server in the Studio Environment editor Connection Information tab Address field. |
Depending on the imported project, you may need to configure the project library list. If the imported project includes a library list of the files needed to compile the project, the project library list must be configured to point to a location to pick up the cited files.
To configure the project library list within Design Studio:
Select the cartridge in the Studio Projects view.
From the Project menu, select Properties.
Select Java Build Path.
Click the Libraries tab.
The project library list contains all the files needed to compile the project.
The library path for each file starts with UIM_LIB. Therefore, you must:
Create a working directory. For example, UIM_LIB.
Copy the files from your UIM installation to the working directory you just created.
Add a new variable named UIM_LIB that points to this working directory. (The following steps show how to add the new variable.)
Click Add Variable.
The New Variable Classpath Entry dialog box appears.
Click Configure Variables.
The Preferences dialog box appears.
Click New.
The New Variable Entry dialog box appears.
In the Name field, enter UIM_LIB.
Click Folder and browse to the directory you created in a previous step.
For example, the UIM_LIB directory.
Click OK.
The Preferences dialog box appears.
Click OK.
The Classpath Variables Changed dialog box appears, suggesting that you do a full build now.
Click No.
The New Variable Classpath Entry dialog box appears.
Note:
The OK button is not available, and an error displays stating ”Variable points to...”. Click Cancel, and the new variable is added successfully.Click Cancel.
The Properties dialog box appears.
Click OK.
Open the Properties dialog box again to refresh the library list and ensure that the variable was added successfully.
You should now see the complete path in the build path.