11 Configuring a Software Library

11.9.2.1 Creating Generic Components

To create a generic component from the Software Library Home page, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select a custom folder that is not owned by Oracle.

   Note: You cannot create a generic component in an Oracle Owned Folder. To create a custom folder, see Section 11.9.1.

3. From the Actions menu, select Create Entity and click Component. Alternately, right click the custom folder, and from the menu, select Create Entity and click Component.

4. From the Create Entity: Component dialog box, select Generic Component and click Continue.

   Enterprise Manager Cloud Control displays the Create Generic Component: Describe page.

5. On the Describe page, enter the Name, Description, and Other Attributes that describe the entity.

   Note: The component name must be unique to the parent folder that it resides in. Sometime even when you enter a unique name, it may report a conflict, this is because there could be an entity with the same name in the folder that is not visible to you, as you do not have view privilege on it.

   Click +Add to attach files that describe the entity better like readme, collateral, licensing, and so on. Ensure that the file size is less than 2 MB.

   In the Notes field, include information related to the entity like changes being made to the entity or modification history that you want to track.

6. On the Configure page, you can customize the generic component that you are creating by adding some new properties or updating the existing properties of the component.

   Note: Select Shared Type to reuse the component property. Shared Type can be stored as a template, which can be used for creating different and more complicated top level types.

   To add a new property, do the following, and click Next:

   1. Select Top Level Type or Shared Type, and click Add.

   2. Enter a unique name for the property. Depending on the property type selected, enter an initial or default value for the property.

   3. To add a constraint, specify the Minimum or Maximum value for the selected property type, and click Add Constraint.

      The Configured Constraints table lists all the constraints added. To remove a particular constraint from the property, select the property and click Remove.

7. On the Select Files page, you can select one or more files to be associated with the entity. Select one of the following options:

   • Upload Files: If you want to upload some entity files from the local file system or the agent machine to the selected destination location.

     To select the destination location, in the Specify Destination section, in the Upload Location field, click the magnifier icon to select one of the following options:

     • OMS Shared FileSystem

     • OMS Agent FileSystem

     The corresponding Storage Type and Location Path of the selected location is populated.

     Note:

     To upload the files, the status of the storage location to which the files are to be uploaded should be Active.

     If you select OMS Agent Filesystem location, then ensure that you have the necessary privileges to access the location

     In the Specify Source section, enter the location from where the files are being sourced, these locations can either be local file system or a remote file system monitored by the Management Agent. Select one of the following options for File Source:,:

     • If you select Local Machine, and click Add, the Add File dialog box appears. Click Browse to select the entity file from the source location, and give a unique name, and click OK.

       You can upload the files to any of the configured storage locations available in OMS Shared Filesystem location or OMS Agent Filesystem location

     • If you select Agent Machine, select the name of the host machine from where you want to pick up the entity files. Click +Add and log into the host machine with the desired credentials. For more information about the different credential types and their setup, see Oracle Enterprise Manager Lifecycle Management Guide.

       Once you log into the host machine, browse to the location where the files to be uploaded are present. You can upload the files to any of the configured storage locations available in OMS Shared Filesystem location or OMS Agent Filesystem location.

   • Refer Files: If you select the Refer Files option, you only need to enter the source location details, since you are not technically uploading anything to the Software Library. In the Specify Source section, select from HTTP, NFS, or Agent Storage types, and click OK. The corresponding Storage Type and Location Path of the selected location is populated.

     Click +Add to reference the entity present at the selected Referenced File Location. In the Add Referenced File dialog box, enter a relative path to the file under Base Location. Click Stage As to organize the file in a temporary stage location with a unique name.

     For details about each of these storage options, see Section 11.6.3

8. On the Set Directives page, click Choose Directives to associate a component with one or more directives. Click Next.

9. On the Review page, review all the details, and click Finish to create the component and upload it on the Software Library.

11.9.2.2 Creating Directives

Directives are entities in the Software Library that represent a set of instructions to be performed. These are constructs used to associate scripts with software components and images. These scripts contain directions on how to interpret and process the contents of a particular component or an image.

To create a directive from a Software Library Home page, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select a custom folder that is not owned by Oracle.

   Note: You cannot create a generic component in an Oracle Owned Folder. To create a custom folder, see Section 11.9.1.

3. From Actions menu, select Create Entity and click Directive. Enterprise Manager Cloud Control displays the Create Entity: Directives wizard.

4. On the Describe page, enter the Name, Description, and Other Attributes that describe the entity.

   Note: The component name must be unique to the parent folder that it resides in. Sometime even when you enter a unique name, and it may report a conflict, this is because there could be an entity with the same name in the folder that is not visible to you, as you do not have view privilege on it.

   Click +Add to attach files that describe the entity better like readme, collateral, licensing, and so on. Ensure that the file size is less than 2 MB.

   In the Notes field, include information related to the entity like changes being made to the entity or modification history that you want to track.

5. On the Configure page, specify the command line arguments that must be passed to the directive to configure it. This command provides the parameters required to execute the directive.

   To add the command line arguments or parameters, click Add.

   In the Add Command Line Arguments dialog box, enter the values in the following fields:

   • Argument Prefix, is a switch or a constant command line argument.

     The Argument Prefix eliminates the error-prone task of manually specifying the order of the parameter executions in a given directive. This is specially useful when a directive is made of multiple parameters.

     Oracle recommends that you create command line arguments using an Argument Prefix.

   • Property Name, is the name of the property, that must be a string value.

   • Argument Suffix, is the text that must follow the command line property.

     Though the suffix is rarely used, it determines how the parameters must be executed, based on the suffix value.

   For example, if the command line argument you want to pass is as follows:

   ./test.sh -user={username}

   Then,

   Argument Prefix is: –user

   Property Name is: username

   All the parameters added appear in the order of addition against the Command Line field.

   To change the order of the parameter or edit any property of an existing parameter, click Edit.

   To remove any of the parameters, click Remove.

   In the Configuration Properties section, select either Bash or Perl as defined in the script.

   Select Run Privileged to run the script with root privileges.

6. On the Select Files page, you can select one or more files to be associated with the entity. Select one of the following options:

   • Upload Files: If you want to upload some entity files from the local file system or the agent machine to the selected destination location.

     To select the destination location, in the Specify Destination section, in the Upload Location field, click the magnifier icon to select one of the following options:

     • OMS Shared FileSystem

     • OMS Agent FileSystem

     The corresponding Storage Type and Location Path of the selected location is populated.

     Note:

     To upload the files, the status of the storage location to which the files are to be uploaded should be Active.

     If you select OMS Agent Filesystem location, then ensure that you have the necessary privileges to access the location

     In the Specify Source section, enter the location from where the files are being sourced, these locations can either be local file system or a remote file system monitored by the Management Agent. Select one of the following options for File Source:,:

     • If you select Local Machine, and click Add, the Add File dialog box appears. Click Browse to select the entity file from the source location, and give a unique name, and click OK.

       You can upload the files to any of the configured storage locations available in OMS Shared Filesystem location or OMS Agent Filesystem location

     • If you select Agent Machine, select the name of the host machine from where you want to pick up the entity files. Click +Add and log into the host machine with the desired credentials. For more information about the different credential types and their setup, see Oracle Enterprise Manager Lifecycle Management Guide.

       Once you log into the host machine, browse to the location where the files to be uploaded are present. You can upload the files to any of the configured storage locations available in OMS Shared Filesystem location or OMS Agent Filesystem location.

   • Refer Files: If you select the Refer Files option, you only need to enter the source location details, since you are not technically uploading anything to the Software Library. In the Specify Source section, select from HTTP, NFS, or Agent Storage types, and click OK. The corresponding Storage Type and Location Path of the selected location is populated.

     Click +Add to reference the entity present at the selected Referenced File Location. In the Add Referenced File dialog box, enter a relative path to the file under Base Location. Click Stage As to organize the file in a temporary stage location with a unique name.

     For details about each of these storage options, see Section 11.6.3

7. On the Review page, review all the details, and click Finish to create the component and upload it on the Software Library.

11.9.4.1 Accessing Software Library Home Page

To access the Software Library Home page, from the Enterprise menu, select Provisioning and Patching, then select Software Library.

11.9.4.2 Accessing Software Library Administration Page

To access the Software Library Administration page, from the Setup menu, select Provisioning and Patching, then select Software Library.

11.9.4.3 Granting or Revoking Privileges

An Enterprise Manager user requires, at the very least, a view privilege on an entity for the entity to be visible on the Software Library Home. The owner or super administrator can choose to grant additional privileges like edit (Update notion) or manage (or full) or at a later point of time, revoke the previously granted privilege.

To grant or revoke privileges, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. To grant or revoke fine-grained privileges to the other users on any entity that you own, select the custom entity and from Actions menu, click Grant/Revoke Privileges.

3. On Grant/Revoke Privileges on: <entity_name> window, you can either grant or revoke Software Library privileges depending on the users roles and responsibilities in the organization.

   Granting Privileges: To grant one or more new privileges, click +Add and search for the users. You can grant them one of the following privileges on the entity you own:

   • View Software Library Entity: This is normally an operator privilege where the user can only view the entity on the Software Library Home. The user cannot edit or manage the entity. All the Oracle owned entities can be viewed by all Enterprise Manager users.

   • Edit Software Library Entity: This is a designer privilege where a user has Create, Update, and Edit privileges on the entity.

   • Manage Software Library Entity: This is a super-administrator privilege where the user has complete access on the entity. With this privilege, you can grant or revoke accesses on this entity to other users, or delete the entity.

   Revoking Privileges: To revoke previously granted privileges, select the user and click Remove.

4. Click Update to apply the selected grants on the entity.

11.9.4.4 Moving Entities

To move all the revisions of an entity from one folder to another, do the following:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select an entity or alternately, search and select an entity.

   For more information about searching for an entity, see Section 11.9.4.9.

3. From the Actions menu, click Move Entity and accept the confirmation.

4. From the Move Entity dialog box, select the destination folder for the entities and click Set New Parent Folder.

   Note: Ensure that the source and the destination folders are not owned by Oracle, as you cannot move or edit them.

11.9.4.5 Changing Entity Maturity

When an entity is created from the Enterprise Manager Home, it is present in an Untested state. It is the responsibility of a designer to test the entity, and change the maturity level based on the test result.

To manage the lifecycle and indicate the quality (maturity level) of an entity, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select an entity or alternately, search and select an entity.

   For more information about searching for an entity, see Section 11.9.4.9.

3. From the Actions menu, click Change Maturity to change the maturity value an entity after testing.

For example, an Oracle Database Clone component would be tested by selecting it in a deployment procedure interview flow that provisions a database. Once the entity is tested, the designer can change the maturity of the entity to either Beta or Production based on test results. Only when the entity is marked with Production level, the Operator can use it.

11.9.4.6 Adding Notes to Entities

To log information about the changes or updates made to an existing entity, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select an entity or alternately, search and select an entity.

   For more information about searching for an entity, see Section 11.9.4.9.

3. From Actions menu, click Notes to include any important information related to the entity. You can also add notes while editing an entity.

   The most recent note appears on top of the table, and the older notes appear below.

4. After updating the details, click Finish to submit the changes, and return to the Software Library Home page.

11.9.4.7 Adding Attachments to Entities

To add or upload files that are typically documents (like README, installation, configuration) related to the software the entity represents, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select an entity or alternately, search and select an entity.

   For more information about searching for an entity, see Section 11.9.4.9.

3. From Actions menu, click Attachments to include one or more files related to the entity. These files contain some important information about the entity. You can also attach files while editing an entity.

   For example, you can attach a readme file to a patch or a component, attach a test script to a directive and so on. However, you must ensure that the file size of each attachment is not more than 2 MB.

4. Click Finish to submit the changes, and return to the Software Library Home page.

11.9.4.8 Viewing, Editing, and Deleting Entities

To view, edit, or delete the details of an entity, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, select an entity or alternately, search and select an entity.

   For more information about searching for an entity, see Section 11.9.4.9.

3. To manage an existing entity, select the entity and perform any of the following functions:

   • View: Click View icon on the table to view the details of an entity. You cannot update the properties of the entity from here.

   • Edit: Click Edit icon on the table to update the properties of an entity.

     If you are satisfied with the details, click Save and Upload to make the changes available on the Software Library Home page.

   • Delete: Click Delete icon to remove the entity from the Software Library Home page.

     Note: By deleting an entity, the entity is no longer available for selection, viewing, or editing, and will not be displayed on the Software Library Home page. However, the entity continues to exist in the repository and the associated files, if uploaded, continue to exist in the respective disk storage. To delete the entity completely from the repository and the associated files from the file system, you must purge the deleted entities from the administration page. The purge job not only deletes the files associated with the deleted entity, but removes the deleted entities itself from the repository tables. For more information about how to purge the deleted entities from the storage location, see Section 11.10.4

11.9.4.9 Searching Entities

To search for an entity, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. To search for an entity, perform one of the following operations:

   1. Find: On the Software Library Home page, you can search for an entity by its Name, Description, or Type. Select the search category, enter the desired value and then click the arrow icon.

      On clicking the arrow icon, the result page displays a number of matching results, and allows you to toggle between the result rows by clicking the up and down arrows.

   2. Search: To perform a detailed search for an entity, click Search. The search option, by default, allows you to search by Name, Description, Maturity, Status, Type, File Name and Revision to retrieve a more granular search result.

      Note: If you choose entities that have associated subtypes (like Components), then the page is refreshed with Subtype as an additional search category.

      Specify appropriate values in All or Any of the search fields, and click Search.

      To add more search parameters, in the Advanced Search section, click Add Fields menu and, select the desired search fields. The selected fields appear in the Advanced Search section as new search parameters. This new search feature enables you to refine your search, and drill down to the most accurate and desired search result.

      To revert to the simple search view, click Close Search.

11.9.4.10 Exporting Entities

To export selected entities, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, from the Actions menu, click Export to export entities present in the Software Library as a Provisioning Archive (PAR) file.

   The PAR file can be used for recreating the entities on an Enterprise Manager with a different repository.

3. On the Export Software Library Entities page, do the following:

   • Click +Add to search and select an entity.

   • In Directory Location, enter a directory location accessible to OMS for storing the generated PAR files.

   • In PAR File, enter the name of the PAR file with a .par extension generated during export.

   • To encrypt and securely store all the secret property values of the PAR file being exported, enter a value in the Oracle Wallet Password field.

     Note: Specify the same password for importing this PAR file. For more information on importing, see Section 11.9.4.11.

   • Select Exclude Associated Files, to exclude the files, binaries, or scripts associated with an entity, from being exported.

   For example, let us consider that you have a separate test and production environment and want to import only the entities that have been tested and certified in the test environment into production. The entities exported from the test system are made available as a Provisioning Archive (PAR) file. You can now choose to import this PAR file into the production system (which is identical to the test system) and use the tested entities.

4. Click Submit to submit an export job. Once the job runs successfully, the selected entities from the Software Library are exported as a PAR file.

11.9.4.11 Importing Entities

To import PAR (Provisioning Archive) files into the Software Library or deploy them to an OMS, perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. On the Software Library Home page, from Actions menu, click Import to import the PAR files.

3. On the Import Software Library Entities page, specify the PAR File to be imported.

   To import the PAR file successfully, in the Password field, enter the same password that was set on the PAR file to secure the secret property values during export.

   For example, let us consider that you have a separate test and production environment and want to import only the entities that have been tested and certified in the test environment into production. The entities exported from the test system are made available as a Provisioning Archive (PAR) file. You can now choose to import this PAR file into the production system (which is identical to the test system) and use the tested entities.

4. If a revision of the entity being imported already exists in Software Library, then you can overwrite the existing entity with a newer revision during import by selecting Force New Revision.

   Note: If a revision of the entity being imported already exists in the repository, and you do not select the Force New Revision option, then import process fails.

5. Click Submit to submit an import job. On successful completion of the job, the PAR files are imported into the Software Library.

11.9.4.12 Staging Files Associated With an Entity

For transferring the files associated with an entity to a specific target host follow the steps outlined in this section.

Prerequisites

Ensure that you meet the following prerequisites before staging the files associated with an entity:

1. Only hosts that are monitored by the Enterprise Manager can be specified as the destination for staging the files associated with an entity.

2. Only files that have been successfully uploaded to the entity (hence, in Ready status) can be selected for staging.

   Note:

   To verify if the entity has any files in the Ready state, follow these steps:

   1. Select the entity, and click View.

   2. On the View Entity page, select Select Files tab, to verify the files associated with the entity.

   3. Unless there is at least one file with a Ready status, you cannot proceed with the staging process.

3. Only users with Create Job Privileges can stage the files associated with an entity.

4. If the source files to be staged are on NFS, then the credentials used for browsing the destination target should have root permissions to be able to mount the NFS location.

Staging Procedure

Log in to Enterprise Manager Cloud Control with designer privileges, and perform the following steps:

1. From the Enterprise menu, select Provisioning and Patching, then select Software Library.

2. Select the entity, and from Actions menu, select Stage Entity.

3. On the Stage Entity page, the entity details, the source upload location, and the selected entity files are displayed.

   You can optionally select the Overwrite files on the staging location to overwrite an existing version of the same file. If not, ignore this option and proceed.

4. In the Staging Destination section, select the destination host target (Management Agent) that is reporting to the OMS, where you want to stage these entity files.

   To select a location on the Management Agent target to host the files, you must log in to the host target and select a location to host the files.

5. Click Submit.

6. To verify the status of the submitted job, from Enterprise menu, select Job, then click Activity.