Skip to content

Commit

Permalink
Updates for Docs nitpicks, Transaction Processor Function doc update. (
Browse files Browse the repository at this point in the history
…hyperledger-archives#2241)

* Update for docs nitpicks

* Transaction Processor Functions Update
  • Loading branch information
EdProsser authored and mbwhite committed Sep 27, 2017
1 parent a14dcc0 commit d256ec8
Show file tree
Hide file tree
Showing 10 changed files with 278 additions and 82 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Before you begin adding events to your business network, you should have a good
1. Events are defined in the model file (`.cto`) of your business network definition, in the same way as assets and participants. Events use the following format:


event BasicEvent identified by eventId {
event BasicEvent {
}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@ To run {{site.data.conrefs.composer_full}} and {{site.data.conrefs.hlf_full}}, w

The following are prerequisites for installing the required development tools:

```
Operating Systems: Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12
Docker Engine: Version 17.03 or higher
Docker-Compose: Version 1.8 or higher
Node: 6.x (note version 7 is not supported)
npm: v3.x or v5.x
git: 2.9.x or higher
Python: 2.7.x
A code editor of your choice, we recommend VSCode.
```
- Operating Systems: Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12
- Docker Engine: Version 17.03 or higher
- Docker-Compose: Version 1.8 or higher
- Node: 6.x (note versions 7 and higher are not supported)
- npm: v3.x or v5.x
- git: 2.9.x or higher
- Python: 2.7.x
- A code editor of your choice, we recommend VSCode.

**Please do not install {{site.data.conrefs.composer_full}} as a superuser - or use 'sudo' or the 'root' user, if on Linux (doing will cause issues installation errors). {{site.data.conrefs.composer_full}} should be installed as non-privileged user.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ This tutorial will take you through how to install and run the {{site.data.conre

In order to install {{site.data.conrefs.composer_full}} Playground, you need the following software installed:

* Docker Engine 17.03 or greater
* Docker Compose 1.8 or greater
- Operating Systems: Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12
- Docker Engine 17.03 or greater
- Docker Compose 1.8 or greater

*Please note:* If you've previously used {{site.data.conrefs.composer_full}} Playground locally or {{site.data.conrefs.hlf_full}} and wish to clear everything and start again, the following commands will delete any running containers and delete all downloaded images, (be careful if you're using other Docker images on your machine):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The {{site.data.conrefs.composer_full}} Playground provides a user interface for

If you are new to the Playground, we recommend that you follow the [Playground Tutorial](../tutorials/playground-guide.html) that will guide you through the process of creating, deploying and testing a new blockchain business network before you start interacting with ID cards.

**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.

---

# Navigating Playground
Expand Down Expand Up @@ -53,6 +55,8 @@ On the left of the **Define** tab, you can see a list of all the files in your c

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.

**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.

## The Test tab

The **Test** tab is used to test the deployed business network by using the asset types, participant types, and transactions which you defined in the **Define** tab.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The `composer network undeploy` command **permanently disables a business networ
**Please Note**: When using the `undeploy` command with a business network running on {{site.data.conrefs.hlf_full}} v1.0, the business network remains running, but will become unresponsive. The business network **cannot be redeployed or updated once the `undeploy` command has been issued.** This is because the business network is already deployed, but has been set to be unresponsive.

```
composer network undeploy -a <business-network-archive> -n <connection-profile-name> -i <enrollment-id> -s <enrollment-secret>
composer network undeploy -n <business-network-name> -p <connection-profile-name> -i <enrollment-id> -s <enrollment-secret>
```

Note that **after undeploy the business network definition can no longer be used**, however the docker container
Expand All @@ -26,7 +26,7 @@ definition must be explicitly stopped and removed if no longer needed.
```
--help Show help [boolean]
-v, --version Show version number [boolean]
--archiveFile, -a The business network archive file name [string] [required]
--businessNetworkName, -n The business network name [string] [required]
--connectionProfileName, -p The connection profile name [string]
--enrollId, -i The enrollment ID of the user [string] [required]
--enrollSecret, -s The enrollment secret of the user [string]
Expand Down
20 changes: 3 additions & 17 deletions packages/composer-website/jekylldocs/reference/cto_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,9 @@ A {{site.data.conrefs.composer_full}} CTO file is composed of the following elem

Your organization namespace is defined in the namespace line of your model (`.cto`) file, and all resources created are implicitly part of this namespace.

As well as defining new classes of asset, participant, event, and transaction, there is a system namespace which contains the base definitions of asset, event, participant, and transaction. These base definitions are abstract types which are implicitly extended by all assets, events, participants, and transactions.
As well as defining new classes of asset, participant, event, and transaction, there is a [system namespace](https://github.com/hyperledger/composer/blob/master/packages/composer-common/lib/system/org.hyperledger.composer.system.cto) which contains the base definitions of asset, event, participant, and transaction. These base definitions are abstract types which are implicitly extended by all assets, events, participants, and transactions.

Represented as a `.cto` model file, the system namespace is as follows:

```
namespace org.hyperledger.composer.system
abstract asset Asset { }
abstract participant Participant { }
abstract transaction Transaction {
o DateTime timestamp
}
abstract event Event {
o DateTime timestamp
}
```

In the system namespace definitions, asset and participant have no required values. Events and transactions are defined by an eventId or transactionId and a timestamp.
In the system namespace definitions, asset and participant have no required values. Events and transactions are defined by an eventId or transactionId and a timestamp. The system namespace also includes definitions of registries, historian records, identities, and a number of system transactions.

>If you have defined an event or transaction including an eventId, transactionId, or timestamp, you must delete the eventId, transactionId, or timestamp properties.
Expand Down Expand Up @@ -273,4 +259,4 @@ The example below retrieves the 3rd argument to the foo decorator attached to th
```
const val = myField.getDecorator('foo').getArguments()[2];
```
```
Loading

0 comments on commit d256ec8

Please sign in to comment.