Resource Orchestration Service:Manage custom modules

Prerequisites

You are familiar with the limits on modules. For more information, see Limits.

Create a custom module

1. Log on to the ROS console.

2. In the left-side navigation pane, choose Resources > My Modules.

3. On the My Modules page, click Create Module.

4. On the Create Module page, enter the content of the ROS module.

   For more information about the module content, see Develop a module.

   You can use the ROS online template editor to enter the template content. For more information, see Online template editor.

5. In the upper-right corner of the Create Module page, choose Import/Save Module > Save as New Module.

6. In the Save as New Module dialog box, configure the Module Name and Module Description parameters.

7. Click OK.

View a custom module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the module that you want to view.

   On the module details page, you can perform the following operations:

   • On this page, view data on the Module Details and Version Information tabs.

   • In the Version Information section, select a version from the Module Version drop-down list to view the information about the version.

   • Click the Module Content tab to view the module content.

   • Click the Properties tab to view the parameters specified in the module.

   • Click the Return Values tab to view the output information about the module.

   • Click the Sample Template tab to view the sample template that contains the module.

   For more information about properties, return values, and sample templates, see View resource types.

View registration records

1. In the left-side navigation pane, choose Resources > Registration Records.

2. On the Registration Records page, view the registration information about the module.

   Note

   You can filter a registration record by resource type or state.

Modify a custom module

Create a version for a module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, find the module that you want to manage and click Edit in the Actions column.

3. On the module details page, modify the module content.

4. In the upper-right corner of the page, choose Import/Save Module > Save as New Version.

5. In the Save as New Version dialog box, specify the Module Description parameter.

6. Click OK.

   After the module is modified, you can view the latest version of the module in the Latest Version column on the My Modules page.

   Note

   If you create a new version for a module, changes may be caused in the template in which the module is used and Version is set to latest.

Delete a version from a module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the module that you want to manage.

3. In the Module Details section, click Set Default Version on the right of Default Version.

4. In the Set Default Version dialog box, find the version that you want to delete and click Delete in the Actions column.

5. In the Are you sure you want to delete the version? message, click Confirm.

   Note

   • You cannot delete the default version of a module.

   • If you delete a version, the version becomes unavailable in ROS.

   • If you delete the latest version of a module, changes may be caused in the template in which the module is used and Version is set to latest.

Change the default version of a module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the module that you want to manage.

3. In the Module Details section, click Set Default Version on the right of Default Version.

4. In the Set Default Version dialog box, find the version that you want to set as the default version and click Set as Default in the Actions column.

5. Click OK.

   After the default version is changed, you can view the default version of the module in the Default Version column on the My Modules page.

   Note

   If you change the default version of a module, changes may be caused in the template in which the module is used and Version is set to default.

Modify the description of a module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the module that you want to manage.

3. In the Module Details section, click Edit on the right of Module Description.

4. In the Edit Module Description dialog box, enter a new description for the module.

5. Click OK.

   After the description is modified, you can view the new description of the module in the Description column on the My Modules page.

Modify the version description of a module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, click the name of the module that you want to manage.

3. In the Module Details section, click Edit on the right of Version Description.

4. In the Edit Version Description dialog box, enter a new version description for the module.

5. Click OK.

Delete a custom module

1. In the left-side navigation pane, choose Resources > My Modules.

2. On the My Modules page, find the module and click Delete in the Actions column.

3. In the Are you sure you want to delete the module? dialog box, click Confirm.

   Note

   After a module is deleted, the module becomes unavailable in ROS.