vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Managing Products 

Create, stage, and manage the lifecycle of products in the Lite, Enterprise, and Hybrid plans.

For details of the ways in which you can manage your Products, see [Managing your Products](https://www.ibm.com/support/knowledgecenter/SSFS6T/com.ibm.apic.apionprem.doc/task_product_management.html) in the API Connect knowledge center.



 Product lifecycle 

When you manage your Product versions, you move them through a series of lifecycle states, from initially staging a draft Product version to an environment, through to publishing to make the Product version available to your application developers, and to eventual retiring and archiving. The following table and diagram describe the various Product lifecycle states for a Product version.



Table 1. API Management Product lifecycle states

 State Description 

 Draft Product is not deployed and is not associated with an API Connect Catalog. 
 Staged An immutable copy of the Product version is deployed to the target 
 environment. Staged is the initial state when you stage from a draft Product. When a Product is in 
 the staged state, it is not yet visible to, or subscribable by, any developers. 
 Published The Product version is visible to, and subscribable by, the targeted 
 developers or communities. 
 Deprecated The Product version is visible only to developers whose applications are 
 currently subscribed. No new subscriptions to the Product are possible. 
 Retired The Product version cannot be viewed or subscribed to, and all of the 
 associated APIs are stopped. A retired Product version is displayed by default in the 
 Products page in the API Manager UI. 
 Archived The Product version cannot be viewed or subscribed to, and all of the 
 associated APIs are stopped. The Product version is not displayed by default in the Products page in the API Manager UI. 





 Product lifecycle flows 

The following diagram shows the possible lifecycle states for a Product version, and the Product management operations that move a Product version from one lifecycle state to another; for example, the Retire operation moves a Product version from the Published to the Retired state.

!
Please read that information carefully. This process must be executed for the console for EACH service instance in the participating network (i.e. if you manage more than one IBM Blockchain Platform SaaS instance ID, it would need to be run from each console separately).

From a high-level, the migration process entails the following actions:



1. Checking version compatibility
2. Creating new login credentials for the new customer-hosted console
3. Redeploying the Fabric nodes (CAs, peers, orderers) with the IBM Support for Hyperledger Fabric images
4. Deploying a new console in the IBM Blockchain Platform cluster and copying the console data from the IBM Blockchain Platform SaaS console
5. Exporting the current wallet identities and importing them into the new console



Once launched, the migration tool will walk you through the steps above. Once migrated, start using the [IBM Support for Hyperledger Fabric documentation](https://www.ibm.com/docs/en/hlf-support/1.0.0).





 Troubleshooting based on migration tool messages 

The migration tool allows you to retry the migration process from any point where the tool stopped on a previous attempt. Choosing to retry is a non-destructive process and can correct issues in some cases. Retrying the migration is an initial troubleshooting step that is suggested.



 Failure during step two: Migrating Fabric nodes 

The console may display a message similar to:

failed to update annotations for deployment orderer1node1 for ... Operation cannot be fulfilled on deployments.apps "orderer1node1": the object has been modified please apply your changes to the latest version and try again"

This indicates there was a problem updating a deployment, but the migration process continues even though the console has displayed this message.

To check if the migration has proceeded to create a new Fabric Operations Console and copy console data, check if a new console pod has been created.



* List pods in the namespace where blockchain components are located: kubectl get pods -n BLOCKCHAIN_NAMESPACE
Managing data collections 

After the processing of a new data collection is finished, you can see a summary of the settings that are applied to your collection from the Manage collections page.

For more information about how to create a collection, see [Creating collections](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections).



 Managing data 

The Manage data page is available in installed deployments starting with the 4.6.5 release of IBM Cloud Pak for Data.

After you create a collection and the documents in the collection are indexed, you can see a list of the documents from the Manage data page.



1. Open the Manage collections page.
2. Click to open the collection that you want to change.
3. Click the Manage data tab.

A list of the documents in the collection is displayed.
4. Optional: You can change the information that is displayed.

To change the fields that are shown in the view, click the Settings icon at the start of the view. Choose a different field for the first and second columns, and then click Apply.

For example, you can change the fields in the view to accomplish the following goals:



* Get the document ID for a document that you want to work with by using the API.
* Find the parent document for a document. Some file types, such as CSV or JSON files, generate subdocuments when they are added to a collection, for example. And splitting a document turns one document into multiple document segments.
* Retrieve the original file name for a document.
* Find out how many pages are in a document.



The custom settings that you apply are not retained. The default field settings are shown the next time that you access the page.
5. Optional: You can delete a document from the collection from this page. For more information, see [Excluding content from query results](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-hide-data).







 Changing how a data source is processed 

You can change settings that were applied to a collection when it was created.
Managing your account, resources, and access docs 

Leverage the interacting components and systems in your account for resource, user, and access management. Get started by setting up your IBM cloud account, learn about setting up an enterprise, or explore assigning access to resources quickly with IBM Cloud Identity and Access Management (IAM).

 Developer tools 

[API & SDK reference](https://cloud.ibm.com/docs?tab=api-docs&subCategory=account&category=platform_services)[CLI reference](https://cloud.ibm.com/docs/account?topic=cli-manage-catalogs-plugin)[Terraform reference](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs)

 Recommended content 

[Learn about different account types Learn about the differences between Trial, Pay-As-You-Go, and Subscription account types.](https://cloud.ibm.com/docs/account?topic=account-accounts)[Setting up your IBM Cloud account Learn how to set up account authentication, manage your account settings, effectively organize resources in your account, and control access to resources.](https://cloud.ibm.com/docs/account?topic=account-account-getting-started)[Assigning access to resources Get up and running quickly with IBM Cloud Identity and Access Management (IAM) by setting up access groups for quick access assignments, inviting users to your account, and managing their access.](https://cloud.ibm.com/docs/account?topic=account-access-getstarted)

 Video library 

[!
This is why you should click Export to export this identity to your local file system. If you switch browsers, you will need to import the identity from your file system into the Wallet of your new browser.
3. Then, click Export to download the key pair to your file system and secure them.



* The Administrators certificate section of the side panel contains the signing certificates keys of your admins. The certificate that you generated by clicking Generate in the section above can be found in the first row of the field. If you want to use multiple admin identities to operate your network, you can paste additional certificates into admin certificate fields.



Because your admin certs are passed to your nodes and channels by using the MSP definition, you need to ensure that each of your node and organization admin certificates is stored in the MSP. When you use the console to create an orderer, peer, or channel, you need to Associate one of the identities you exported in your Wallet with the admin certificates that were provided to the MSP definition. When you encounter an Associate identity section or panel, select an identity that you generated and saved to the Wallet when creating the MSP definition.



* On the Review MSP information panel, review the information that you specified for this MSP.



After you have selected your CA, MSP ID, and either specified or created an admin, click Create MSP definition. It should now be listed as an organization in the Organizations tab. Because an MSP is the representation of an organization in the network, you select the MSP definition when you deploy your nodes (identifying the organization the node belongs to), are joined to the consortium (by an ordering service admin), create a channel, join a channel, edit a channel, or perform any action where you have to specify the organization that is performing the action.





 Downloading a connection profile 

After you create an organization MSP definition and create peers with that organization MSP definition, you can download a connection profile that can be used by a client application to connect to your network via one or more gateway peers. The gateway peers are the peers that are specified in the connection profile, and they are used to perform service discovery to find all of the endorsing peers in the network that will endorse transactions.
To place the order, ensure that the account to be charged is correct, review and accept the terms, and then click Create.





 Results if you saved a configuration 

You get a console notification that the configuration is saved successfully, and then you can find the template in the Instance configurations list. Next, you can manage the configuration template by viewing or deleting it in the Instance configurations list.





 Results if you placed an order 



1. The deployment of the instance starts automatically and you receive confirmation that the order is being processed. You can check the deployment status, including any issues that might require your attention, by viewing the Deployment history tab of the instance details.
2. If you experience vSAN Health alerts and warnings, see [How do I manage vSAN Health alerts and warnings?](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-trbl_vsan_alerts)
3. When the instance is successfully deployed, the components that are described in [Technical specifications for vCenter Server instances](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-vc_vcenterserveroverviewvc_vcenterserveroverview-specs) are installed on your VMware virtual platform. If you ordered add-on services, the deployment of the services starts after your order is completed.
4. When the instance is ready to use, its status changes to Available, and then you receive a notification by email.
5. When you order a secondary instance, the VMware vSphere Web Client for the primary instance (linked to the secondary one) might be restarted after your secondary instance order is completed.



Next, you can view and manage the vCenter Server instance that you ordered.

You must manage the IBM Cloud for VMware Solutions components that are created in your IBM Cloud account only from the VMware Solutions console, not the IBM Cloud infrastructure customer portal, or any other means outside of the console. If you change these components outside of the VMware Solutions console, the changes are not synchronized with the console.
* The basket duplicates some of the product data in this record, enough to record the state of the items purchased at the point of sale.
* The document doesn't contain fields that mark the status of the order. More documents would be added later to record payments and delivery.
* The database automatically generates a document _id when it inserts the document into the database.
* A unique identifier (order_id) is supplied with each purchase record to reference the order later.



When the customer places an order, typically at the point when they enter the check out phase on the website, a purchase order record is created similar to the previous example.



 Generating your own unique identifiers (UUIDs) 

In a relational database, sequential "auto incrementing" numbers are often used. While in distributed databases, data is spread around a cluster of servers, and longer UUIDs are used to ensure that documents are stored with their unique ID.

To create a unique identifier for use in your application, such as an order_id, call the [GET _uuids endpoint](https://cloud.ibm.com/apidocs/cloudantgetuuids) on the IBM Cloudant API. The database generates an identifier for you. The same endpoint can be used to generate multiple IDs by adding a count parameter, for example, /_uuids?count=10.





 Recording payments 

When the customer successfully pays for their items, more records are added to the database to record the order.



 Example of a payment record 

{
"_id": "bf70c30ea5d8c3cd088fef98ad678e9e",
"type": "payment",
"account_id": "985522332",
"order_id": "320afa89017426b994162ab004ce3383",
"value": 6.46,
"method": "credit card",
"payment_reference": "AB9977G244FF2F667"
}
...
{
To use the Management Utilities, you need to [order IBM-supported smart cards and smart card readers](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-prepare-management-utilitiesorder-smart-card-and-reader) and follow the instructions in [Initializing service instances by using smart cards and the Management Utilities](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-initialize-hsm-management-utilities).

The following diagram illustrates the relationship between various components when you use the Management Utilities to initialize a service instance.

Zoom

![The architecture of using smart cards and the Management Utilities](https://cloud.ibm.com/docs-content/v1/content/217f108cc44e2ce15fb692d4b57b4c628464e908/hs-crypto//images/tke-application-architecture.svg)

Figure 1. Using smart cards and the Management Utilities to initialize service instances



* The Smart Card Utility Program

One of the two applications that are installed as part of the Management Utilities. It sets up and manages the smart cards that are used by the Trusted Key Entry application.
* The Trusted Key Entry application

One of the two applications that are installed as part of the Management Utilities. It uses smart cards to load master keys in service instances and perform other configuration tasks for service instances.







 Understanding smart cards 

A smart card looks like a credit card with an embedded chip. The chip can perform a limited set of cryptographic operations and is loaded with custom software. In the Management Utilities, the Smart Card Utility Program loads custom software on the smart card to create two types of smart cards:



* Certificate authority smart cards

The Certificate authority smart cards establish a set of smart cards that can work together, called a smart card zone.
* EP11 smart cards

Enterprise PKCS #11 (EP11) smart cards hold an administrator signature key and up to 85 master key parts.
My key custodian - deployer Manages and deploys keys. For a complete key lifecycle, both Creator and Deployer roles are needed. To implement separation of duties, assign Creator and Deployer role to different people. <br><br> * hs-crypto.managed-keys.preactivation-activate<br> * hs-crypto.managed-keys.preactivation-destroy<br> * hs-crypto.managed-keys.active-deactivate<br> * hs-crypto.managed-keys.active-install<br> * hs-crypto.managed-keys.active-uninstall<br> * hs-crypto.managed-keys.deactivated-install<br> * hs-crypto.managed-keys.deactivated-reactivate<br> * hs-crypto.managed-keys.deactivated-uninstall<br> * hs-crypto.managed-keys.read<br> * hs-crypto.managed-keys.list<br> * hs-crypto.managed-keys.write<br> * hs-crypto.managed-keys.distribute<br> * hs-crypto.managed-keys.write-dates<br> * hs-crypto.managed-keys.write-tags<br> * hs-crypto.target-keystores.read<br> * hs-crypto.target-keystores.list<br> * hs-crypto.key-templates.read<br> * hs-crypto.key-templates.list<br> * hs-crypto.vaults.read<br> * hs-crypto.vaults.list<br><br><br> 
 My reader Performs read-only actions for auditing purposes.
Managing APIs, products, and catalogs 

Managing APIs, catalogs, and products in IBM® API Connect for IBM Cloud® involves a series of tasks to maintain catalogs where developers can create and test APIs, and to manage the lifecycle of the products containing APIs that are published for customer use.



 API administration tasks in API Connect 

Every provider organization has its own set of APIs, catalogs, and products. While the API Developer creates APIs and products, the API Administrator manages them, along with the catalogs where development work takes place.

After an API developer creates a set of APIs, the API administrator manages the distribution. The API administrator defines Plans that determine access to the APIs, bundles a set of related APIs and Plans into Products, and publishes them to the consumer Developer Portals. The API administrator also manages the Catalogs and Spaces where API developers create and test APIs. API Administrators should read the topics in the "Managing catalogs and products" section of the extended V10 Reserved documentation.

You can perform API management tasks in the API Manager interface, or in the toolkit command-line interface. For information on working with the toolkit, see [Setting up your toolkit](https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.toolkit.doc/ri_toolkit.html) in the extended V10 Reserved documentation.



 Managing catalogs 

A catalog is a staging target where developers can create and test APIs before publishing them for customers to use. Each provider organization can create multiple catalogs. Catalogs are useful for organizing products and APIs for testing before you make them available to consumer organizations. For more information on managing catalogs, see the following topics in the extended V10 documentation:



* [Creating catalogs](https://www.ibm.com/support/knowledgecenter/SSMNED_v10cloud/com.ibm.apic.apionprem.doc/create_env.html)
Managing a blueprint environment is an iterative cycle of applying changes to the deployed environment to maintain currency and compliance.



 Updating blueprint environments 

After deployment, blueprint environments will continue to evolve through managed change, implemented as updates to the blueprint template, automation modules, and inputs.

Changes to the environment are first prepared as version updates to the blueprint template and input files. The blueprint configuration is updated in Schematics with the updated template and input versions. These changes are then applied to the blueprint environment. This two-step process ensures controlled application of change first to the blueprint configuration and template, then second to the cloud resources. In a future release the deployment plan will be presented for review in a separate step before it can be applied.

During this lifecycle stage, the blueprint environment will be updated many times. Changes are applied to the cloud resources to satisfy changing application requirements. Additionally to maintain platform currency and compliance as security policies evolve. Scheduled operations will run compliance checks, and run drift detection on the environment.

As noted earlier, IBM® authored automation modules are maintained and refreshed by IBM® to support new service features, maintain IBM Cloud® currency and to address evolving security compliance requirements. It is suggested that blueprint configurations, and templates are regularly updated to use the current version of modules and these updates are applied to deployed environments. The risk of not performing regular updates is that the environments lose currency, compliance, and cease to be manageable through Schematics automation.

Review the section on blueprint version management to understand how to manage change to blueprint templates and input YAML files by using Git tags and branches.

The two-step process to update a blueprint environment is illustrated in the diagram.

Zoom

![blueprint update flow](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics//images/new/bp-update.svg)

blueprint update flow



1. Edit the blueprint template, and the input YAML files to implement the proposed changes to the environment.



* You can use any text editor.
In either case, because this new admin identity would only be an admin of the peer and not the organization that owns the peer, it preserves a separation of roles between the organization admin (the sign cert listed in the MSP, which might also be the peer admin in the console where the peer was created), and the new admin of the peer which was just created and associated. This peer admin would not be an organization admin by default. However, if it fits a use case to make an identity the admin of both the organization and an imported peer, this is achievable, see [Updating an organization MSP definition](https://cloud.ibm.com/docs/blockchain?topic=blockchain-ibp-console-organizationsibp-console-govern-update-msp).

Note that this flow would be most practical for a peer, since the admins of ordering nodes do not have many responsibilities in the IBM Blockchain Platform.

If you don't intend to operate the node (or in the case of a multi-node ordering service, the nodes), you do not have to import and associate an admin identity.



 Exporting and importing admin identities into the Wallet 

To export an identity, open the Wallet tab and click on the identity you want to export. In the Identity details panel that pops up, you have two options. You can click the Export identity button, which will bundle your signing certificate and private key into a JSON file, and download it to your local filesystem (note that you should always keep a copy of all your identities locally). Alternatively, you can download .pem certificates for both your signing certificate and private keys.

To import a new identity, open the Wallet tab and click Add identity. If you want to upload .pem certificates manually, click New identity and use the fields under Manual entry to give the identity a name and to upload the signing certificate and private key of the identity. If you have a JSON that was exported from another console, click Upload JSON and then Add files, then select the appropriate JSON from your local file system and click Add identity.