Skip to content
This repository was archived by the owner on Mar 8, 2020. It is now read-only.

Commit 3232404

Browse files
EdProsserSimon Stone
authored andcommitted
Issues: 2242, 1801, 1791, 2079, also filters (#2405)
* Correct globalcert -> globalCert Signed-off-by: EdProsser <edward.prosser@uk.ibm.com> * Fix for 1791, deploy should be start Signed-off-by: EdProsser <edward.prosser@uk.ibm.com> * Issue 1801 - notes on participant add Signed-off-by: EdProsser <edward.prosser@uk.ibm.com> * Issue 2079 - wallet -> business networks, typos Signed-off-by: EdProsser <edward.prosser@uk.ibm.com> * Uncommenting between syntax for filters Signed-off-by: EdProsser <edward.prosser@uk.ibm.com>
1 parent 785a7a3 commit 3232404

7 files changed

Lines changed: 47 additions & 46 deletions

File tree

packages/composer-website/jekylldocs/business-network/query.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,9 @@ Currently, only the `WHERE` LoopBack filter is supported. The supported operator
8888
```
8989
{"where":{"or":[{"and":[{"field1":"foo"},{"field2":"bar"}]},{"field3":"foobar"}]}}
9090
```
91-
<!--
91+
9292
The **between** operator returns values between the given range. It accepts numbers, datetime values, and strings. If supplied with strings, the **between** operator returns results between the supplied strings alphabetically. In the example below, the filter will return all resources where the driver property is alphabetically between _a_ and _c_, inclusively.
9393

9494
```
9595
{"where":{"driver":{"between": ["a","c"]}}}
9696
```
97-
-->

packages/composer-website/jekylldocs/managing/participant-add.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ A participant can be added to a participant registry using either the API or the
1414

1515
## Before you start
1616

17-
Before you follow these steps, you must have modeled a participant in a Business
18-
Network Definition and deployed it as a Business Network.
17+
Before you follow these steps, you must have modeled a participant in a Business Network Definition and deployed it as a Business Network.
1918

20-
The procedure below shows an example using the following model of a participant
21-
from the Digital Property sample Business Network Definition: [digitalproperty-network](https://www.npmjs.com/package/digitalproperty-network)
19+
The procedure below shows an example using the following model of a participant from the Digital Property sample Business Network Definition: [digitalproperty-network](https://www.npmjs.com/package/digitalproperty-network)
20+
21+
*Please note*: If you are adding the participant using the `composer participant add` command, ensure that the JSON representation of the participant is wrapped in single quotes.
2222

2323
```
2424
namespace net.biz.digitalPropertyNetwork

packages/composer-website/jekylldocs/playground/id-cards-playground.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Business Network Cards
44
category: tasks
55
section: playground
66
sidebar: sidebars/accordion-toc0.md
7-
excerpt: Business Network Cards combine a connection profile, identity, and certificates to allow a connection to a business network in Hyperledger Composer Playground. Business Network Cards can be [created, exported and imported](./id-cards-playground.html) from the **My Wallet** page in Hyperledger Composer Playground.
7+
excerpt: Business Network Cards combine a connection profile, identity, and certificates to allow a connection to a business network in Hyperledger Composer Playground. Business Network Cards can be [created, exported and imported](./id-cards-playground.html) from the **Business Networks** page in Hyperledger Composer Playground.
88
index-order: 401
99
---
1010

@@ -29,12 +29,12 @@ Access to your Business Network is granted to another user through the provision
2929

3030
There must be a Participant existing in the business network in order to bind an Identity required to create the Business Network Card.
3131

32-
When an identity is issued within Playground, there is an option to add the Identity to your Wallet. By selecting this option a Business Network Card is created for the issued identity that is valid for the current business network. The Business Network Card will appear in your wallet once you log out of the current business network, and it is from this location where it may be exported to share with another user.
32+
When an identity is issued within Playground, there is an option to save the identity for use in your Business Networks page. By selecting this option a Business Network Card is created for the issued identity that is valid for the current business network. The Business Network Card will appear on your Business Networks page once you log out of the current business network, and it is from this location where it may be exported to share with another user.
3333

3434

35-
### Creating a Business Network Card
35+
### Creating a Business Network Card
3636

37-
1. From the **My Wallet** page, select an identity to use to connect to your business network. Click **Connect Now**. _Please note:_ You must use an identity that has permission to create new identities.
37+
1. From the **Business Networks** page, select an identity to use to connect to your business network. Click **Connect Now**. _Please note:_ You must use an identity that has permission to create new identities.
3838

3939
2. If required, create the participant to which you intend to assign the identity:
4040
- Click the **Test** tab, and click **Create New Participant**.
@@ -52,19 +52,19 @@ When an identity is issued within Playground, there is an option to add the Iden
5252

5353
6. Click **Create New**.
5454

55-
7. Click **Add to My Wallet**. Adding the Business Network Card to your wallet allows you to use it to connect to the business network, or export it for someone else to use.
55+
7. Click **Add to My Wallet**. Adding the Business Network Card to your Business Networks page allows you to use it to connect to the business network, or export it for someone else to use.
5656

57-
The **My Wallet** page should now show the new Business Network Card.
57+
The **Business Networks** page should now show the new Business Network Card.
5858

5959
<video autoplay "autoplay=autoplay" style="display:block; width:100%; height:auto;" loop="loop">
6060
<source src="{{ site.baseurl }}/assets/img/tutorials/playground/vs_code_22.mp4" type="video/mp4" />
6161
</video>
6262

6363
### Exporting a Business Network Card
6464

65-
Business Network Cards are exported from the **My Wallet** page in Playground, through interaction with the Business Network Card that you wish to export and is a one-step process.
65+
Business Network Cards are exported from the **Business Networks** page in Playground, through interaction with the Business Network Card that you wish to export and is a one-step process.
6666

67-
- On the **My Wallet** page, click the **Export** icon on the Business Network Card you wish to export. The Business Network Card should download as a `.card` file.
67+
- On the **Business Networks** page, click the **Export** icon on the Business Network Card you wish to export. The Business Network Card should download as a `.card` file.
6868

6969
_Please note_: If you export a Business Network Card that has never been used, for example to send to a new participant, it will contain the enrollment ID and enrollment secret required to obtain the certificate and private key which are then used to identify Participants. Alternatively, if you export a Business Network Card that has been used before, it will already contain the certificate and private key. For more information on Participants and Identities, please see our [main documentation](../managing/participantsandidentities.html).
7070

@@ -74,7 +74,7 @@ _Please note_: If you export a Business Network Card that has never been used, f
7474
### Creating Business Network Card Credentials
7575

7676
It is possible to provide credentials to a user to enable them to create a Business Network Card and then use it to connect to the business network for which the credentials are valid.
77-
1. From the **My Wallet** page, select an identity to use to connect to your business network. Click **Connect Now**. _Please note:_ You must use an identity that has permission to create new identities.
77+
1. From the **Business Networks** page, select an identity to use to connect to your business network. Click **Connect Now**. _Please note:_ You must use an identity that has permission to create new identities.
7878

7979
2. If required, create the participant to which you intend to assign the identity:
8080
- click the **Test** tab, and click **Create New Participant**.
@@ -108,43 +108,43 @@ It is possible to provide credentials to a user to enable them to create a Busin
108108

109109
Importing a Business Network Card allows you to connect to a deployed business network.
110110

111-
1. On the **My Wallet** page, click **Import Business Network Card** in the upper right.
111+
1. On the **Business Networks** page, click **Import Business Network Card** in the upper right.
112112

113113
2. Drag and drop, or browse, to select a Business Network Card (`.card`) file to import. Click **Import**.
114114

115-
The Business Network Card should now be visible in your wallet; you can now connect to the deployed Business Network.
115+
The Business Network Card should now be visible in your Business Networks page; you can now connect to the deployed Business Network.
116116

117117
### Connecting using Credentials
118118

119-
There are two ways a Business Network Card can be created from the **My Wallet** page.
119+
There are two ways a Business Network Card can be created from the **Business Networks** page.
120120

121121
A Business Network Card can be created using certificates, which requires the following: a _certificate_ and _private key_, provided by an admin of a business network; a _name_ for the Business Network Card; the _business network name_ for which the credentials are valid; the _Connection Profile_ details for the runtime on which the target business network is deployed.
122122

123-
To create a Business Network Card from the **My Wallet** page using _certificates_:
123+
To create a Business Network Card from the **Business Networks** page using _certificates_:
124124

125-
1. After receiving a certificate and private key, click the **Connect using credentials** button in the upper right of the **My Wallet** page.
125+
1. After receiving a certificate and private key, click the **Connect using credentials** button in the upper right of the **Business Networks** page.
126126

127127
2. If you have previously connected to the deployed runtime, select it from the displayed list, click **Next** and proceed to step 4; otherwise select the radio option to connect to a new Blockchain and click **Next**.
128128

129129
3. Specify the Connection Profile details that were provided to you and click **Save**.
130130

131131
4. Enter the _certificate_, _private key_, an _Business Network Card name_ and _business network name_, and click **Create**.
132132

133-
The Business Network Card should now be displayed in the **My Wallet** page.
133+
The Business Network Card should now be displayed in the **Business Networks** page.
134134

135135
A Business Network Card can be created using an ID and secret, through knowledge of the following: a _Enrollment ID_ and _Enrollment Secret_, generated by an admin of a business network; the _Business network name_ for which the credentials are valid; the _Connection Profile_ details for the runtime on which the target business network is deployed.
136136

137-
To create a Business Network Card from the **My Wallet** page using an _enrollment ID_ and _enrollment secret_:
137+
To create a Business Network Card from the **Business Networks** page using an _enrollment ID_ and _enrollment secret_:
138138

139-
1. After receiving an enrollment ID and enrollment secret, click the **Connect using credentials** button in the upper right of the **My Wallet** page.
139+
1. After receiving an enrollment ID and enrollment secret, click the **Connect using credentials** button in the upper right of the **Business Networks** page.
140140

141141
2. If you have previously connected to the deployed runtime, select it from the displayed list, click **Next** and proceed to step 4; otherwise select the radio option to connect to a new Blockchain and click **Next**.
142142

143143
3. Specify the Connection Profile details that were provided to you and click **Save**.
144144

145145
4. Enter the _enrollment ID_, _enrollment secret_ and _business network name_, and click **Create**.
146146

147-
The Business Network Card should now be displayed in the **My Wallet** page.
147+
The Business Network Card should now be displayed in the **Business Networks** page.
148148

149149

150150
### Manually Creating a Business Network Card

packages/composer-website/jekylldocs/playground/playground-index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ If you are new to the Playground, we recommend that you follow the [Playground T
1919

2020
# Navigating Playground
2121

22-
## The wallet page
22+
## The Business Networks page
2323

24-
The **My Wallet** page is the default Playground landing page. Here you can see all the Business Network Cards in your Wallet. Each Business Network Card provides all of the information needed to connect to a blockchain business network. It is only possible to access a blockchain business network by using a valid Business Network Card. Once connected to a deployed Business Network, you will be taken to the **Define** page.
24+
The **Business Networks** page is the default Playground landing page. Here you can see all the Business Network Cards you have available for use. Each Business Network Card provides all of the information needed to connect to a blockchain business network. It is only possible to access a blockchain business network by using a valid Business Network Card. Once connected to a deployed Business Network, you will be taken to the **Define** page.
2525

2626
![wallet-page](./images/wallet-page.png)
2727

@@ -31,7 +31,7 @@ From this page you can:
3131
- Connect to a business network. If you already have a deployed business network and a Business Network Card created for it, you can click **Connect now** to connect to the business network.
3232
- Deploy a new business network. If this is your first time using Playground, or you wish to start a new network, deploying your own network is a great place to start. When creating a new business network, you can choose to base your business network definition on a sample network, or create your own network from scratch.
3333
- Interact with Business Network Cards. Business Network Cards are used to connect to business networks which already exist, and are a combination of connection profile and identity. The card provides options to delete the identity/card, export the card, and to connect to the corresponding business network.
34-
- Import Business Network Cards. Importing an existing `.card` file from your computer is the simplest way to add a Business Network Card to your wallet.
34+
- Import Business Network Cards. Importing an existing `.card` file from your computer is the simplest way to add a Business Network Card to your Business Networks page.
3535
- Connect using a user ID and user secret. If you have been provided with a user ID and user secret by your network administrator, click **Connect using credentials** to enter them and generate a Business Network Card.
3636
- Run through the Playground tutorial. If you don't know where to start, the Playground tutorial runs through creating a business network from scratch, and performing some basic operations.
3737

@@ -43,7 +43,7 @@ Once connected to a business network using a Business Network Card, there are a
4343

4444
- In the upper-left is the name of the connection profile you're using and the business network you're connected to. In the example above, the connection profile is called _Web_ and the business network name is _basic-sample-network_.
4545
- Links to the **Define** and **Test** tabs. In the **Define** tab, you can add, modify and delete the content of your business network, and in the **Test** tab you can create assets and participants that were defined in the **Define** tab, and test the functionality of your business network.
46-
- On the upper-right is a dropdown menu displaying the identity which is being used to connect to the business network. The dropdown contains a link to the **Identity Registry**, and the ability to log out of the business network, returning to the **My Wallet** screen.
46+
- On the upper-right is a dropdown menu displaying the identity which is being used to connect to the business network. The dropdown contains a link to the **Identity Registry**, and the ability to log out of the business network, returning to the **Business Networks** page.
4747

4848
## The Define tab
4949

@@ -53,7 +53,7 @@ The Define tab is used to create, edit and update your business network.
5353

5454
On the left of the **Define** tab, you can see a list of all the files in your current business network definition. To examine the contents of a file, click on it, and it will appear in the editor view. New files can be added to your business network with the **Add a file** button. Model files, script files, access control files, and query files can be added to your business network.
5555

56-
Once you've added and modified the files for your business network definition, you can deploy the changes to your network with the **Update** button. After click **Update** you can experiment with your changes in the **Test** tab. The **Import/Replace** button allows you to import a business network, either from your own computer, or import a business network from our samples. Conversely, the **Export** button downloads your current business network as a business network archive `.bna` file.
56+
Once you've added and modified the files for your business network definition, you can deploy the changes to your network with the **Update** button. After clicking **Update** you can experiment with your changes in the **Test** tab. The **Import/Replace** button allows you to import a business network, either from your own computer, or import a business network from our samples. Conversely, the **Export** button downloads your current business network as a `.bna` file.
5757

5858
**Please note**: If two or more users are using {{site.data.conrefs.composer_full}} Playground to connect to the same instance of {{site.data.conrefs.hlf_full}}, ensure that each user refreshes their browser after the business network definition is updated by another user. Refreshing the browser accepts the changes to the business network definition made by other users. If the the business network is changed without accepting the changes of other users the changes will be lost.
5959

packages/composer-website/jekylldocs/reference/composer.network.start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ The `--option, -o` option and the `--optionsFile, -O` option allow connection sp
4545

4646
- Using the `-o` option, the endorsement policy can be sent as a single-line JSON string as follows:
4747

48-
composer network deploy -o endorsementPolicy='{"identities": [.... }'
48+
composer network start -o endorsementPolicy='{"identities": [.... }'
4949

5050
- Using the `-o` option, the endorsement policy can be sent as a file path as follows:
5151

52-
composer network deploy -o endorsementPolicyFile=/path/to/file/endorsementPolicy.json
52+
composer network start -o endorsementPolicyFile=/path/to/file/endorsementPolicy.json
5353

5454
In this case, the endorsement policy file should follow this format:
5555

@@ -58,7 +58,7 @@ The `--option, -o` option and the `--optionsFile, -O` option allow connection sp
5858

5959
- Using the `-O` option, the endorsement policy can be sent as a file path as follows:
6060

61-
composer network deploy -O /path/to/file/options.json
61+
composer network start -O /path/to/file/options.json
6262

6363
In this case, the options file should follow this format:
6464

packages/composer-website/jekylldocs/reference/composer.participant.add.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ excerpt: Hyperledger Composer Participant Add Command
1010

1111
---
1212

13-
The `composer participant add` command adds a new instance of a participant to a
14-
participant registry. See the task [Add a Participant](../managing/participant-add.html)
15-
for a walkthrough of using this command or the API.
13+
The `composer participant add` command adds a new instance of a participant to a participant registry. See the task [Add a Participant](../managing/participant-add.html) for a walkthrough of using this command or the API.
14+
15+
The `data` option must contain a serialized JSON representation of the participant to add, and must be wrapped in single quotes.
1616

1717
## Syntax
1818

@@ -34,28 +34,31 @@ Options:
3434
`--connectionProfileName, -p`
3535

3636
The connection profile name.
37+
3738
Example: `hlfv1`
3839

3940
`--businessNetworkName, -n`
4041

4142
The name of the deployed Business Network to connect to.
42-
Example:
43-
`digitalproperty-network`
43+
44+
Example: `digitalproperty-network`
4445

4546
`--enrollId, -i`
4647

4748
The enrollment ID of the identity that should be used to connect to the deployed
4849
Business Network.
50+
4951
Example: `maeid1`
5052

5153
`--enrollSecret, -s`
5254

5355
The enrollment secret of the identity that should be used to connect to deployed
5456
Business Network.
57+
5558
Example: `Xurw3yU9zI0l`
5659

5760
`--data, -d`
5861

59-
The serialized JSON representation of the participant to add to the participant
60-
registry. The data must be valid according to the model of the participant.
61-
Example: `{"$class":"net.biz.digitalPropertyNetwork.Person","personId":"mae@biznet.org","firstName":"Mae","lastName":"Smith"}`
62+
The serialized JSON representation of the participant to add to the participant registry. The data must be valid according to the model of the participant.
63+
64+
Example: `'{"$class":"net.biz.digitalPropertyNetwork.Person","personId":"mae@biznet.org","firstName":"Mae","lastName":"Smith"}'`

0 commit comments

Comments
 (0)